tencentcloud-sdk-essbasic 3.0.756 → 3.0.758

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f676d8df1c2297a4e7f3a0681ee99209fdd6b7cb
-  data.tar.gz: 709f6eb062b8ac12263bb75d2f962f0c756f0693
+  metadata.gz: 7d9bcfd0542e46c93738c829fbdd15370dfc6ab9
+  data.tar.gz: ff14b6de07145b3b0ca1a50169e8862709f05296
 SHA512:
-  metadata.gz: c31c3e5ab62bf55929a12181bbf88dbc4f5bad1d88622c284a44e7b4cdd66c07507fde4671ef096ed74109876a9f3e8dff04d67b4c849b2d86eaf71bbc6c5713
-  data.tar.gz: 3472323f6dd786df4363fb93768004d626610230e6ece57715f4f7e7ffcfa144e713c5f218f2e06da3c6511d045624b545748e8ad249a3f5098b59591d9f7bd0
+  metadata.gz: 551e2b7a33b84eb971ea53b95c5a881e9b2058b8433feaceb139f0e0e92edf730e59063a26dea2e7038c2a251c5415554352f9ece426f0fc48658bf65e324c39
+  data.tar.gz: 260f67004dd5bc47a21e9ea3fe0ac17cec7ef55fa96ee45c1d360a7bf99a8105a41e08494cb554f4c491ea859164bda5638f69e8d5acb5ec5346931ff9ca7f82

data/lib/VERSION

@@ -1 +1 @@
-3.0.756
+3.0.758

data/lib/v20210526/client.rb

@@ -1061,6 +1061,9 @@ module TencentCloud
         # 使用此接口，用来绑定企业实名员工的角色，
         # 支持以电子签userId、客户系统openId两种方式进行绑定。
 
+        # 对应控制台的操作如下图
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
+
         # @param request: Request instance for ChannelCreateUserRoles.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserRolesRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserRolesResponse`
@@ -1136,6 +1139,9 @@ module TencentCloud
 
         # 通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
 
+        # 对应控制台的操作如下图
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
+
         # @param request: Request instance for ChannelDeleteRoleUsers.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDeleteRoleUsersRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDeleteRoleUsersResponse`
@@ -1301,7 +1307,7 @@ module TencentCloud
         # 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
 
 
-        # <font color="red">**系统默认角色**</font>说明可参考下表
+        # <font color="red">系统默认角色</font>说明可参考下表
 
         # | 角色名称| 建议授予对象 | 角色描述 |
         # | --- | --- | --- |
@@ -1310,6 +1316,8 @@ module TencentCloud
         # | **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
         # | **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
 
+        # 附件：<a href="https://dyn.ess.tencent.cn/guide/apivideo/roles.xlsx" target="_blank">点击下载角色对应的权限点的excel文档</a>
+
         # @param request: Request instance for ChannelDescribeRoles.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeRolesRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeRolesResponse`
@@ -2332,8 +2340,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 在已发起的签署流程中，我们支持对签署截止日期进行延期操作，主要涉及以下两个维度：
-        # 1. 合同（流程）维度：只需要传递流程ID。这将对尚未设定签署截止时间的合同（流程）和发起合同（流程）时的签署人进行延期操作。
+        # 在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
+        # 1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
         # 2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。
 
         # 此接口有如下限制条件：

data/lib/v20210526/models.rb

@@ -1745,6 +1745,8 @@ module TencentCloud
       class ChannelCreateFlowByFilesResponse < TencentCloud::Common::AbstractModel
         # @param FlowId: 合同流程ID，为32位字符串。
         # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+
+        # [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowId: String
         # @param Approvers: 签署方信息，如角色ID、角色名称等
@@ -2666,6 +2668,9 @@ module TencentCloud
         # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
+
+
+        # [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
         # @type NeedRelievedFlowId: String
         # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
         # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
@@ -3104,7 +3109,15 @@ module TencentCloud
 
       # ChannelCreateUserRoles请求参数结构体
       class ChannelCreateUserRolesRequest < 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 RoleIds: 绑定角色的角色id列表，最多 100 个
         # @type RoleIds: Array
@@ -5200,8 +5213,7 @@ module TencentCloud
       # CreateConsoleLoginUrl返回参数结构体
       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/H5/SHORT_H5</td> <td>30天</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/H5/SHORT_H5</td> <td>30天</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td>  </tr> </tbody> </table>
+        # <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/H5/SHORT_H5</td> <td>30天</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/H5/SHORT_H5</td> <td>30天</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td>  </tr> </tbody> </table>
 
         # 注：
         # 1. <font color="red">链接仅单次有效</font>，每次登录需要需要重新创建新的链接
@@ -5442,6 +5454,8 @@ module TencentCloud
       class CreateFlowsByTemplatesResponse < TencentCloud::Common::AbstractModel
         # @param FlowIds: 生成的合同流程ID数组，合同流程ID为32位字符串。
         # 建议开发者妥善保存此流程ID数组，以便于顺利进行后续操作。
+
+        # [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
         # @type FlowIds: Array
         # @param CustomerData: 第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
         # @type CustomerData: Array
@@ -6541,6 +6555,8 @@ module TencentCloud
         # @param TemplateId: 合同模板ID，为32位字符串。
 
         # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
+
+        # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
         # @type TemplateId: String
         # @param ContentType: 查询模板的内容
 
@@ -6553,6 +6569,9 @@ module TencentCloud
         # 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
         # 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
         # 4. `若传递此参数，分页参数(Limit,Offset)无效`
+
+
+        # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
         # @type TemplateIds: Array
         # @param Limit: 指定每页返回的数据条数，和Offset参数配合使用。
 
@@ -7591,6 +7610,8 @@ module TencentCloud
         # 如果使用模板发起接口，此参数为必填。
 
         # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
+
+        # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
         # @type TemplateId: String
         # @param FlowApprovers: 多个签署人信息，最大支持50个签署方
         # @type FlowApprovers: Array
@@ -8227,8 +8248,8 @@ module TencentCloud
         # @type Deadline: Integer
         # @param RecipientId: 签署方角色编号，为32位字符串
         # <ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
-        # <li>通过[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)发起合同，或通过[模板发起合同-创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)时，返回参数[Approvers](https://qian.tencent.com/developers/companyApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
-        # <li>也可通过[查询合同流程的详情信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo)接口查询签署人的RecipientId编号</li></ul>
+        # <li>通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同，或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/CreateFlowsByTemplates)时，返回参数[FlowApprovers](https://test.qian.tencent.cn/developers/partnerApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
+        # <li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
         # @type RecipientId: String
 
         attr_accessor :Agent, :FlowId, :Deadline, :RecipientId
@@ -10044,17 +10065,33 @@ module TencentCloud
         # 支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
         # <br/>
         # @type WebEmbedThemeColor: String
-
-        attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor
-
-        def initialize(displaysignbrandlogo=nil, webembedthemecolor=nil)
+        # @param AuthenticateBackground: 企业认证页背景图（base64图片）
+        # @type AuthenticateBackground: String
+        # @param HideAuthenticateNavigationBar: 隐藏企业认证页面导航栏，取值如下：
+        # <ul><li> **true**：隐藏企业认证页面导航栏</li>
+        # <li> **false**：显示企业认证页面导航栏（默认）</li></ul>
+        # @type HideAuthenticateNavigationBar: Boolean
+        # @param HideAuthenticateTopLogo: 隐藏企业认证顶部logo，取值如下：
+        # <ul><li> **true**：隐藏企业认证顶部logo</li>
+        # <li> **false**：显示企业认证顶部logo（默认）</li></ul>
+        # @type HideAuthenticateTopLogo: Boolean
+
+        attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor, :AuthenticateBackground, :HideAuthenticateNavigationBar, :HideAuthenticateTopLogo
+
+        def initialize(displaysignbrandlogo=nil, webembedthemecolor=nil, authenticatebackground=nil, hideauthenticatenavigationbar=nil, hideauthenticatetoplogo=nil)
           @DisplaySignBrandLogo = displaysignbrandlogo
           @WebEmbedThemeColor = webembedthemecolor
+          @AuthenticateBackground = authenticatebackground
+          @HideAuthenticateNavigationBar = hideauthenticatenavigationbar
+          @HideAuthenticateTopLogo = hideauthenticatetoplogo
         end
 
         def deserialize(params)
           @DisplaySignBrandLogo = params['DisplaySignBrandLogo']
           @WebEmbedThemeColor = params['WebEmbedThemeColor']
+          @AuthenticateBackground = params['AuthenticateBackground']
+          @HideAuthenticateNavigationBar = params['HideAuthenticateNavigationBar']
+          @HideAuthenticateTopLogo = params['HideAuthenticateTopLogo']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.756
+  version: 3.0.758
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common