tencentcloud-sdk-essbasic 3.0.756 → 3.0.757

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f676d8df1c2297a4e7f3a0681ee99209fdd6b7cb
4
- data.tar.gz: 709f6eb062b8ac12263bb75d2f962f0c756f0693
3
+ metadata.gz: 0e902657a899c85badf75063914af56bbc8c7367
4
+ data.tar.gz: 12a0b5b1e641852bc0ad907f3ccd0bc9abe80bcf
5
5
  SHA512:
6
- metadata.gz: c31c3e5ab62bf55929a12181bbf88dbc4f5bad1d88622c284a44e7b4cdd66c07507fde4671ef096ed74109876a9f3e8dff04d67b4c849b2d86eaf71bbc6c5713
7
- data.tar.gz: 3472323f6dd786df4363fb93768004d626610230e6ece57715f4f7e7ffcfa144e713c5f218f2e06da3c6511d045624b545748e8ad249a3f5098b59591d9f7bd0
6
+ metadata.gz: 8e2913f97c2a6f198d5c83f7d924ba84a1c4d0708f9387317e264aecff9cf27cf2c4d86030e7f11e3d7d9c343ccbc694e7a7613c133f4fa3212359c7507d1e44
7
+ data.tar.gz: ffbb79b877cca67e11139ece452a67a6641b7a0f72f676564a69d3e8d88203b3c2eec051b6a6ba8249ff615a9d120b20930413450ddab44153a54bee86864436
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.756
1
+ 3.0.757
@@ -1061,6 +1061,9 @@ module TencentCloud
1061
1061
  # 使用此接口,用来绑定企业实名员工的角色,
1062
1062
  # 支持以电子签userId、客户系统openId两种方式进行绑定。
1063
1063
 
1064
+ # 对应控制台的操作如下图
1065
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
1066
+
1064
1067
  # @param request: Request instance for ChannelCreateUserRoles.
1065
1068
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserRolesRequest`
1066
1069
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserRolesResponse`
@@ -1136,6 +1139,9 @@ module TencentCloud
1136
1139
 
1137
1140
  # 通过此接口,删除员工绑定的角色,支持以电子签userId、客户系统userId两种方式调用。
1138
1141
 
1142
+ # 对应控制台的操作如下图
1143
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
1144
+
1139
1145
  # @param request: Request instance for ChannelDeleteRoleUsers.
1140
1146
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDeleteRoleUsersRequest`
1141
1147
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDeleteRoleUsersResponse`
@@ -1301,7 +1307,7 @@ module TencentCloud
1301
1307
  # 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
1302
1308
 
1303
1309
 
1304
- # <font color="red">**系统默认角色**</font>说明可参考下表
1310
+ # <font color="red">系统默认角色</font>说明可参考下表
1305
1311
 
1306
1312
  # | 角色名称| 建议授予对象 | 角色描述 |
1307
1313
  # | --- | --- | --- |
@@ -1310,6 +1316,8 @@ module TencentCloud
1310
1316
  # | **经办人**|企业法务负责人等 | 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。 |
1311
1317
  # | **业务员**|销售员、采购员 等| 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。 |
1312
1318
 
1319
+ # 附件:<a href="https://dyn.ess.tencent.cn/guide/apivideo/roles.xlsx" target="_blank">点击下载角色对应的权限点的excel文档</a>
1320
+
1313
1321
  # @param request: Request instance for ChannelDescribeRoles.
1314
1322
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeRolesRequest`
1315
1323
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeRolesResponse`
@@ -2332,8 +2340,8 @@ module TencentCloud
2332
2340
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2333
2341
  end
2334
2342
 
2335
- # 在已发起的签署流程中,我们支持对签署截止日期进行延期操作,主要涉及以下两个维度:
2336
- # 1. 合同(流程)维度:只需要传递流程ID。这将对尚未设定签署截止时间的合同(流程)和发起合同(流程)时的签署人进行延期操作。
2343
+ # 在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
2344
+ # 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
2337
2345
  # 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
2338
2346
 
2339
2347
  # 此接口有如下限制条件:
@@ -1745,6 +1745,8 @@ module TencentCloud
1745
1745
  class ChannelCreateFlowByFilesResponse < TencentCloud::Common::AbstractModel
1746
1746
  # @param FlowId: 合同流程ID,为32位字符串。
1747
1747
  # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1748
+
1749
+ # [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
1748
1750
  # 注意:此字段可能返回 null,表示取不到有效值。
1749
1751
  # @type FlowId: String
1750
1752
  # @param Approvers: 签署方信息,如角色ID、角色名称等
@@ -2666,6 +2668,9 @@ module TencentCloud
2666
2668
  # 第三方平台子客企业和员工必须已经经过实名认证
2667
2669
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2668
2670
  # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
2671
+
2672
+
2673
+ # [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2669
2674
  # @type NeedRelievedFlowId: String
2670
2675
  # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
2671
2676
  # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
@@ -3104,7 +3109,15 @@ module TencentCloud
3104
3109
 
3105
3110
  # ChannelCreateUserRoles请求参数结构体
3106
3111
  class ChannelCreateUserRolesRequest < TencentCloud::Common::AbstractModel
3107
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3112
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3113
+
3114
+ # 此接口下面信息必填。
3115
+ # <ul>
3116
+ # <li>渠道应用标识: Agent.AppId</li>
3117
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3118
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3119
+ # </ul>
3120
+ # 第三方平台子客企业和员工必须已经经过实名认证
3108
3121
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3109
3122
  # @param RoleIds: 绑定角色的角色id列表,最多 100 个
3110
3123
  # @type RoleIds: Array
@@ -5200,8 +5213,7 @@ module TencentCloud
5200
5213
  # CreateConsoleLoginUrl返回参数结构体
5201
5214
  class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
5202
5215
  # @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
5203
- # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th>
5204
- # <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>
5216
+ # <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>
5205
5217
 
5206
5218
  # 注:
5207
5219
  # 1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
@@ -5442,6 +5454,8 @@ module TencentCloud
5442
5454
  class CreateFlowsByTemplatesResponse < TencentCloud::Common::AbstractModel
5443
5455
  # @param FlowIds: 生成的合同流程ID数组,合同流程ID为32位字符串。
5444
5456
  # 建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。
5457
+
5458
+ # [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5445
5459
  # @type FlowIds: Array
5446
5460
  # @param CustomerData: 第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
5447
5461
  # @type CustomerData: Array
@@ -6541,6 +6555,8 @@ module TencentCloud
6541
6555
  # @param TemplateId: 合同模板ID,为32位字符串。
6542
6556
 
6543
6557
  # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
6558
+
6559
+ # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6544
6560
  # @type TemplateId: String
6545
6561
  # @param ContentType: 查询模板的内容
6546
6562
 
@@ -6553,6 +6569,9 @@ module TencentCloud
6553
6569
  # 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
6554
6570
  # 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
6555
6571
  # 4. `若传递此参数,分页参数(Limit,Offset)无效`
6572
+
6573
+
6574
+ # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6556
6575
  # @type TemplateIds: Array
6557
6576
  # @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
6558
6577
 
@@ -7591,6 +7610,8 @@ module TencentCloud
7591
7610
  # 如果使用模板发起接口,此参数为必填。
7592
7611
 
7593
7612
  # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
7613
+
7614
+ # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7594
7615
  # @type TemplateId: String
7595
7616
  # @param FlowApprovers: 多个签署人信息,最大支持50个签署方
7596
7617
  # @type FlowApprovers: Array
@@ -8227,8 +8248,8 @@ module TencentCloud
8227
8248
  # @type Deadline: Integer
8228
8249
  # @param RecipientId: 签署方角色编号,为32位字符串
8229
8250
  # <ul><li>若指定了此参数,则只调整签署流程中此签署人的签署截止时间,否则调整合同整体的签署截止时间(合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间)</li>
8230
- # <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>
8231
- # <li>也可通过[查询合同流程的详情信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo)接口查询签署人的RecipientId编号</li></ul>
8251
+ # <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>
8252
+ # <li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
8232
8253
  # @type RecipientId: String
8233
8254
 
8234
8255
  attr_accessor :Agent, :FlowId, :Deadline, :RecipientId
@@ -10044,17 +10065,33 @@ module TencentCloud
10044
10065
  # 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
10045
10066
  # <br/>
10046
10067
  # @type WebEmbedThemeColor: String
10047
-
10048
- attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor
10049
-
10050
- def initialize(displaysignbrandlogo=nil, webembedthemecolor=nil)
10068
+ # @param AuthenticateBackground: 企业认证页背景图(base64图片)
10069
+ # @type AuthenticateBackground: String
10070
+ # @param HideAuthenticateNavigationBar: 隐藏企业认证页面导航栏,取值如下:
10071
+ # <ul><li> **true**:隐藏企业认证页面导航栏</li>
10072
+ # <li> **false**:显示企业认证页面导航栏(默认)</li></ul>
10073
+ # @type HideAuthenticateNavigationBar: Boolean
10074
+ # @param HideAuthenticateTopLogo: 隐藏企业认证顶部logo,取值如下:
10075
+ # <ul><li> **true**:隐藏企业认证顶部logo</li>
10076
+ # <li> **false**:显示企业认证顶部logo(默认)</li></ul>
10077
+ # @type HideAuthenticateTopLogo: Boolean
10078
+
10079
+ attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor, :AuthenticateBackground, :HideAuthenticateNavigationBar, :HideAuthenticateTopLogo
10080
+
10081
+ def initialize(displaysignbrandlogo=nil, webembedthemecolor=nil, authenticatebackground=nil, hideauthenticatenavigationbar=nil, hideauthenticatetoplogo=nil)
10051
10082
  @DisplaySignBrandLogo = displaysignbrandlogo
10052
10083
  @WebEmbedThemeColor = webembedthemecolor
10084
+ @AuthenticateBackground = authenticatebackground
10085
+ @HideAuthenticateNavigationBar = hideauthenticatenavigationbar
10086
+ @HideAuthenticateTopLogo = hideauthenticatetoplogo
10053
10087
  end
10054
10088
 
10055
10089
  def deserialize(params)
10056
10090
  @DisplaySignBrandLogo = params['DisplaySignBrandLogo']
10057
10091
  @WebEmbedThemeColor = params['WebEmbedThemeColor']
10092
+ @AuthenticateBackground = params['AuthenticateBackground']
10093
+ @HideAuthenticateNavigationBar = params['HideAuthenticateNavigationBar']
10094
+ @HideAuthenticateTopLogo = params['HideAuthenticateTopLogo']
10058
10095
  end
10059
10096
  end
10060
10097
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.756
4
+ version: 3.0.757
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud