tencentcloud-sdk-essbasic 3.0.736 → 3.0.738

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05f5042e618337304e71628f4df722f1b4d841a9
-  data.tar.gz: 6c7db02bc400a30cea9d7bf81277633e7c0c1b82
+  metadata.gz: 7adc98cd882e4ab742eea1fcd4ed585675a1dbc4
+  data.tar.gz: b2208f4936fee98d094dfa2cdd3d29dfc7777c48
 SHA512:
-  metadata.gz: 7b62e01d8f5014c1386f7754a6274767a725929e3a9c3a7a03789b3acedccda1185f262f63e12bf2d05453a6c374d858a9832613a1ffb5b8babd3822429fd896
-  data.tar.gz: a408a614f7e38fc68e27016e4382f7b1548a7629be12a1d7d3286fa057ac7bf8ccd8b5fcb1b3d258884ee1fbc2b7d4503c1faa158c390bcc5bc5b543ae3e575c
+  metadata.gz: dd6cfabe73e537620621eb0707ef1b746c36dc4f744a022690b9401f02273b90b0a943f695a8162fdd135bbfc093f18721399994d9958b55613b01420bc88238
+  data.tar.gz: 712a9b65006d35b1a10b832210251ba775a4902a43ce85bdeb6c073272c0d434c4513cdb855eb3758559fca62fcc082178b52ed8302caa59b9502fd8771cc4cd

data/lib/VERSION

@@ -1 +1 @@
-3.0.736
+3.0.738

data/lib/v20210526/client.rb

@@ -1843,8 +1843,8 @@ module TencentCloud
         # |  WEIXINAPP  | 短链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
         # |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
         # |  CHANNEL  | 带有H5引导页的跳转腾讯电子签小程序签署场景 |  点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景;  签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
-        # |APP| 贵方App跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
-        # |APP| 贵方小程序跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
+        # |APP| <font color="red">贵方APP</font>跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
+        # |APP| <font color="red">贵方小程序</font>跳转腾讯电子签小程序签署场景|  贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
 
         # @param request: Request instance for CreateSignUrls.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsRequest`
@@ -2036,14 +2036,20 @@ module TencentCloud
         end
 
         # 查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
-        # 1. 企业自动签
-        # 2. 企业与港澳台居民签署合同
-        # 3. 使用手机号验证签署方身份
-        # 4. 骑缝章
-        # 5. 拓宽签署方年龄限制
-        # 6. 下载企业合同/文件
 
-        # 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
+        # 1. **企业自动签**
+        # 2. **企业与港澳台居民签署合同**
+        # 3. **使用手机号验证签署方身份**
+        # 4. **骑缝章**
+        # 5. **拓宽签署方年龄限制**
+        # 6. **下载企业合同/文件**
+        # 7. **隐藏合同经办人姓名**
+
+        # 对应能力开通页面在子客控制台-企业中心-拓展服务，如下图所示:
+
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg)
+
+        # 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
 
         # @param request: Request instance for DescribeExtendedServiceAuthInfo.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeExtendedServiceAuthInfoRequest`
@@ -2239,28 +2245,21 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。
+        # 管理企业扩展服务 ，企业经办人需要是企业超管或者法人。
 
         # 跳转小程序的几种方式：主要是设置不同的EndPoint
         # 1. 通过链接Url直接跳转到小程序，不需要返回
         # 设置EndPoint为WEIXINAPP，得到链接打开即可。
 
         # 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
-        # 跳转到小程序的实现，参考官方文档
-        # https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
-        # 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+        # 跳转到小程序的实现，参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
         # 设置EndPoint为APP，得到path。
 
-        # 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
-        # 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
-        # 全屏方式：
-        # （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
-        # 半屏方式：
-        # （https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
-        # 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+        # 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
+        # 跳转到小程序的实现，参考官方文档（分为<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>
         # 设置EndPoint为APP，得到path。
 
-        # 其中小程序的原始Id如下，或者查看小程序信息自助获取。
+        # 4.其中小程序的原始Id如下，或者查看小程序信息自助获取。
 
         # | 小程序 | AppID | 原始ID |
         # | ------------ | ------------ | ------------ |

data/lib/v20210526/models.rb

@@ -964,6 +964,8 @@ module TencentCloud
       # ChannelCreateBatchCancelFlowUrl返回参数结构体
       class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
         # @param BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
+
+        # 注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # @type BatchCancelFlowUrl: String
         # @param FailMessages: 与入参的FlowIds数组一致,   成功生成到撤销链接中,则为"",   不能撤销合同则为失败原因
         # @type FailMessages: Array
@@ -1184,13 +1186,17 @@ module TencentCloud
       class ChannelCreateBatchSignUrlResponse < TencentCloud::Common::AbstractModel
         # @param SignUrl: 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
 
-        # 注: `非小程序和APP集成使用`
+        # 注:
+        # 1. 非小程序和APP集成使用
+        # 2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # @type SignUrl: String
         # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
         # @type ExpiredTime: Integer
         # @param MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
 
-        # 注: `小程序和APP集成使用`
+        # 注:
+        # 1. 小程序和APP集成使用
+        # 2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # @type MiniAppPath: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -5109,10 +5115,10 @@ module TencentCloud
         # 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
         # @type MenuStatus: String
         # @param Endpoint: 生成链接的类型：
-        # <ul><li>**PC**：(默认)web控制台链接, 需要在PC浏览器中打开</li>
+        # <ul><li>**PC**：(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
         # <li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
-        # <li>**SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
-        # <li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li></ul>
+        # <li>**SHORT_URL**：<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
+        # <li>**APP**：<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li></ul>
         # @type Endpoint: String
         # @param AutoJumpBackEvent: 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：
         # <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
@@ -5174,9 +5180,11 @@ module TencentCloud
       class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
         # @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
         # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead>  <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr>  <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td>  </tr>  <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td>  </tr> </tbody> </table>
+
         # 注：
-        # `1.链接仅单次有效，每次登录需要需要重新创建新的链接`
-        # `2.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
+        # 1. <font color="red">链接仅单次有效</font>，每次登录需要需要重新创建新的链接
+        # 2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
+        # 3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # @type ConsoleUrl: String
         # @param IsActivated: 子客企业是否已开通腾讯电子签，
         # <ul><li> **true** :已经开通腾讯电子签</li>
@@ -6279,10 +6287,11 @@ module TencentCloud
 
         # 此接口下面信息必填。
         # <ul>
-        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
-        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
-        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
         # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
 
         attr_accessor :Agent
@@ -6762,11 +6771,12 @@ module TencentCloud
         # @param Type: 扩展服务类型
         # <ul>
         # <li>AUTO_SIGN             企业自动签（自动签署）</li>
-        # <li>  OVERSEA_SIGN          企业与港澳台居民*签署合同</li>
+        # <li>  OVERSEA_SIGN          企业与港澳台居民签署合同</li>
         # <li>  MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
         # <li> PAGING_SEAL           骑缝章</li>
         # <li> DOWNLOAD_FLOW         授权渠道下载合同 </li>
         # <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
+        # <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
         # </ul>
         # @type Type: String
         # @param Name: 扩展服务名称
@@ -7325,10 +7335,12 @@ module TencentCloud
 
       # 签署人签署链接信息。
       class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
-        # @param SignUrl: 签署短链接。</br>
+        # @param SignUrl: 签署短链接。
+
         # 注意:
-        # - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
-        # - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
+        # 1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+        # 2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
+        # 3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # @type SignUrl: String
         # @param ApproverType: 签署人类型。
         # - **PERSON**: 个人
@@ -7337,10 +7349,12 @@ module TencentCloud
         # @type Name: String
         # @param Mobile: 签署人手机号。
         # @type Mobile: String
-        # @param LongUrl: 签署长链接。</br>
+        # @param LongUrl: 签署长链接。
+
         # 注意:
-        # - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
-        # - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
+        # 1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+        # 2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
+        # 3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LongUrl: String
 
@@ -8111,16 +8125,19 @@ module TencentCloud
         # @param ServiceType:   扩展服务类型
         # <ul>
         # <li>AUTO_SIGN             企业自动签（自动签署）</li>
-        # <li>  OVERSEA_SIGN          企业与港澳台居民*签署合同</li>
+        # <li>  OVERSEA_SIGN          企业与港澳台居民签署合同</li>
         # <li>  MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
         # <li> PAGING_SEAL           骑缝章</li>
         # <li> DOWNLOAD_FLOW         授权渠道下载合同 </li>
         # <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
+        # <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
         # </ul>
         # @type ServiceType: String
         # @param Operate: 操作类型
-        # OPEN:开通
-        # CLOSE:关闭
+        # <ul>
+        # <li>OPEN : 开通</li>
+        # <li>CLOSE : 关闭</li>
+        # </ul>
         # @type Operate: String
         # @param Endpoint: 链接跳转类型，支持以下类型
         # <ul>
@@ -8154,8 +8171,8 @@ module TencentCloud
         # @param OperateUrl: 操作跳转链接，有效期24小时
         # 若操作时没有返回跳转链接，表示无需跳转操作，此时会直接开通/关闭服务。
 
-        # 当操作类型是 OPEN 且 扩展服务类型是  AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接，
-        # 返回的链接需要平台方自行触达超管或法人，超管或法人点击链接完成服务开通操作。
+        # 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接，
+        # 返回的链接需要平台方自行触达超管或法人，超管或法人点击链接完成服务开通操作
         # @type OperateUrl: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -9183,6 +9200,8 @@ module TencentCloud
       # 签署链接内容
       class SignUrlInfo < TencentCloud::Common::AbstractModel
         # @param SignUrl: 签署链接，过期时间为90天
+
+        # 注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignUrl: String
         # @param Deadline: 合同过期时间戳，单位秒
@@ -9597,7 +9616,7 @@ module TencentCloud
         # @type Components: Array
         # @param Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
         # @type Recipients: Array
-        # @param SignComponents: 此模版中的签署控件列表
+        # @param SignComponents: 此模板中的签署控件列表
         # @type SignComponents: Array
         # @param TemplateType: 模板类型：1-静默签；3-普通模板
         # @type TemplateType: Integer

metadata

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