tencentcloud-sdk-ess 3.0.659 → 3.0.660

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: efc4c0633580ab9b74dbd7f13cd53b701ff8ea6f
4
- data.tar.gz: 9f433efe62a9562e0bcb92a387f90be00227e524
3
+ metadata.gz: 9eed30651867f40a38aa3196b66dabb8e2515a2b
4
+ data.tar.gz: 961e2478e0a7529f550a907ed111e5f2b7427354
5
5
  SHA512:
6
- metadata.gz: 7626bc5059f0a2f9905e7f31d36a76252718c3e4a2f4bdcdfb71ba376286f6f5e3266c011f40a64699ec5b801841270d8443693a1e23adee0ca789e59b18dc1d
7
- data.tar.gz: c2825ba3fdd0513c9ba379632138183e793d6a9131cc9217674f500de494691e04221ce23b3383a08fa43018458f7cf944bdb06945d5283668bda785f5ff2b5c
6
+ metadata.gz: 0823a3c206f92087891e07317f92aeb3640e3adfe01012b76028820f66b9b27b8a7ee554b469a32a1badeae7d724e6052ff01812321a0f1dfb934700904248ac
7
+ data.tar.gz: 2813e4efbb3c840c2fd89654bf4f9791cd1193fc47b82a6cf086da6b0e4ca93a71a9df3fcde8bcce7a6ae3e7b0f763ded7929aae21affee8a719989e15e7745b
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.659
1
+ 3.0.660
@@ -218,7 +218,14 @@ module TencentCloud
218
218
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
219
219
  end
220
220
 
221
- # 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
221
+ # 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
222
+ # 1. 创建印章
223
+ # 2. 创建模板
224
+ # 3. 修改模板
225
+ # 4. 预览模板
226
+ # 5. 预览合同流程
227
+
228
+ # 用户可以通过这些链接快速将其集成到自己的系统中。
222
229
 
223
230
  # @param request: Request instance for CreateEmbedWebUrl.
224
231
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateEmbedWebUrlRequest`
@@ -271,12 +278,13 @@ module TencentCloud
271
278
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
272
279
  end
273
280
 
274
- # ### 适用场景
275
- # 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
276
- # 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
277
- # ### 限制条件
278
- # - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
279
- # - 他方企业仅支持通过姓名+手机号补充
281
+ # 适用场景:
282
+ # 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
283
+
284
+ # 限制条件:
285
+ # 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
286
+ # 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
287
+ # 3. 他方企业仅支持通过姓名+手机号进行补充。
280
288
 
281
289
  # @param request: Request instance for CreateFlowApprovers.
282
290
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowApproversRequest`
@@ -387,8 +395,9 @@ module TencentCloud
387
395
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
388
396
  end
389
397
 
390
- # 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
391
- # 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
398
+ # 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
399
+
400
+ # 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
392
401
 
393
402
  # @param request: Request instance for CreateFlowGroupByTemplates.
394
403
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesRequest`
@@ -582,7 +591,7 @@ module TencentCloud
582
591
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
583
592
  end
584
593
 
585
- # 绑定员工与对应角色
594
+ # 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
586
595
 
587
596
  # @param request: Request instance for CreateIntegrationUserRoles.
588
597
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationUserRolesRequest`
@@ -676,7 +685,11 @@ module TencentCloud
676
685
 
677
686
  # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
678
687
 
679
- # 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
688
+ # 注:
689
+ # <ul>
690
+ # <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
691
+ # <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
692
+ # </ul>
680
693
 
681
694
  # @param request: Request instance for CreatePersonAuthCertificateImage.
682
695
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
@@ -972,7 +985,7 @@ module TencentCloud
972
985
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
973
986
  end
974
987
 
975
- # 解绑员工与对应角色关系
988
+ # 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
976
989
 
977
990
  # @param request: Request instance for DeleteIntegrationRoleUsers.
978
991
  # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationRoleUsersRequest`
@@ -1266,33 +1279,9 @@ module TencentCloud
1266
1279
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1267
1280
  end
1268
1281
 
1269
- # 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
1270
-
1271
- # 通过子企业影子账号查询主企业员工账号
1272
-
1273
- # @param request: Request instance for DescribeIntegrationMainOrganizationUser.
1274
- # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserRequest`
1275
- # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserResponse`
1276
- def DescribeIntegrationMainOrganizationUser(request)
1277
- body = send_request('DescribeIntegrationMainOrganizationUser', request.serialize)
1278
- response = JSON.parse(body)
1279
- if response['Response'].key?('Error') == false
1280
- model = DescribeIntegrationMainOrganizationUserResponse.new
1281
- model.deserialize(response['Response'])
1282
- model
1283
- else
1284
- code = response['Response']['Error']['Code']
1285
- message = response['Response']['Error']['Message']
1286
- reqid = response['Response']['RequestId']
1287
- raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1288
- end
1289
- rescue TencentCloud::Common::TencentCloudSDKException => e
1290
- raise e
1291
- rescue StandardError => e
1292
- raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1293
- end
1282
+ # 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
1294
1283
 
1295
- # 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
1284
+ # 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
1296
1285
 
1297
1286
  # @param request: Request instance for DescribeIntegrationRoles.
1298
1287
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest`
@@ -1245,21 +1245,21 @@ module TencentCloud
1245
1245
  # @param Operator: 执行本接口操作的员工信息。
1246
1246
  # <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1247
1247
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1248
- # @param EmbedType: WEB嵌入资源类型。
1249
- # <br/>CREATE_SEAL: 生成创建印章的嵌入页面
1250
- # <br/>CREATE_TEMPLATE:生成创建模板的嵌入页面
1251
- # <br/>MODIFY_TEMPLATE:生成编辑模板的嵌入页面
1252
- # <br/>PREVIEW_TEMPLATE:生成预览模板的嵌入页面
1253
- # <br/>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
1254
- # <br/>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
1255
- # <br/>EXTEND_SERVICE:生成拓展服务的嵌入页面
1256
- # <br/>PREVIEW_FLOW:生成预览合同的嵌入页面
1257
- # <br/>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面
1248
+ # @param EmbedType: WEB嵌入资源类型,支持以下类型
1249
+ # <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
1250
+ # <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
1251
+ # <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
1252
+ # <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
1253
+ # <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
1254
+ # <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
1255
+ # <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
1256
+ # <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
1257
+ # <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
1258
1258
  # @type EmbedType: String
1259
1259
  # @param BusinessId: WEB嵌入的业务资源ID
1260
- # <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
1261
- # <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
1262
- # <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
1260
+ # <ul><li>PREVIEW_SEAL_DETAIL,必填,取值为印章id</li>
1261
+ # <li>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id</li>
1262
+ # <li>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id</li><ul>
1263
1263
  # @type BusinessId: String
1264
1264
  # @param Agent: 代理企业和员工的信息。
1265
1265
  # <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -1325,16 +1325,23 @@ module TencentCloud
1325
1325
 
1326
1326
  # CreateFlowApprovers请求参数结构体
1327
1327
  class CreateFlowApproversRequest < TencentCloud::Common::AbstractModel
1328
- # @param Operator: 调用方用户信息,userId 必填
1328
+ # @param Operator: 执行本接口操作的员工信息。
1329
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1329
1330
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1330
- # @param FlowId: 签署流程编号
1331
+ # @param FlowId: 合同流程ID,为32位字符串。
1332
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1333
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1331
1334
  # @type FlowId: String
1332
- # @param Approvers: 补充签署人信息
1335
+ # @param Approvers: 补充企业签署人信息。
1336
+
1337
+ # - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
1338
+
1339
+ # - 如果不指定,则使用姓名和手机号进行补充。
1333
1340
  # @type Approvers: Array
1334
- # @param Initiator: 企微消息中的发起人
1341
+ # @param Initiator: 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
1335
1342
  # @type Initiator: String
1336
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作
1337
-
1343
+ # @param Agent: 代理企业和员工的信息。
1344
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1338
1345
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1339
1346
 
1340
1347
  attr_accessor :Operator, :FlowId, :Approvers, :Initiator, :Agent
@@ -1750,15 +1757,22 @@ module TencentCloud
1750
1757
 
1751
1758
  # CreateFlowGroupByTemplates请求参数结构体
1752
1759
  class CreateFlowGroupByTemplatesRequest < TencentCloud::Common::AbstractModel
1753
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1760
+ # @param Operator: 执行本接口操作的员工信息。
1761
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1754
1762
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1755
- # @param FlowGroupName: 合同组名称,最大长度200个字符
1763
+ # @param FlowGroupName: 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1756
1764
  # @type FlowGroupName: String
1757
- # @param FlowGroupInfos: 合同组的子合同信息,支持2-50个子合同
1765
+ # @param FlowGroupInfos: 合同(流程)组的子合同信息,支持2-50个子合同
1758
1766
  # @type FlowGroupInfos: Array
1759
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1767
+ # @param Agent: 代理企业和员工的信息。
1768
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1760
1769
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1761
- # @param FlowGroupOptions: 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
1770
+ # @param FlowGroupOptions: 合同(流程)组的配置项信息。
1771
+ # 其中包括:
1772
+ # <ul>
1773
+ # <li>是否通知本企业签署方</li>
1774
+ # <li>是否通知其他签署方</li>
1775
+ # </ul>
1762
1776
  # @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
1763
1777
 
1764
1778
  attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
@@ -2493,13 +2507,13 @@ module TencentCloud
2493
2507
 
2494
2508
  # CreateIntegrationUserRoles请求参数结构体
2495
2509
  class CreateIntegrationUserRolesRequest < TencentCloud::Common::AbstractModel
2496
- # @param Operator: 操作人信息,UserId必填
2510
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
2497
2511
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2498
2512
  # @param UserIds: 绑定角色的用户id列表,不能重复,不能大于 100 个
2499
2513
  # @type UserIds: Array
2500
- # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
2514
+ # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
2501
2515
  # @type RoleIds: Array
2502
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2516
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2503
2517
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2504
2518
 
2505
2519
  attr_accessor :Operator, :UserIds, :RoleIds, :Agent
@@ -3591,7 +3605,7 @@ module TencentCloud
3591
3605
 
3592
3606
  # CreateUserAutoSignEnableUrl返回参数结构体
3593
3607
  class CreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
3594
- # @param Url: 个人用户自动签的开通链接, 短链形式
3608
+ # @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
3595
3609
  # @type Url: String
3596
3610
  # @param AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3597
3611
 
@@ -3809,13 +3823,13 @@ module TencentCloud
3809
3823
 
3810
3824
  # DeleteIntegrationRoleUsers请求参数结构体
3811
3825
  class DeleteIntegrationRoleUsersRequest < TencentCloud::Common::AbstractModel
3812
- # @param Operator: 操作人信息,userId必填
3826
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3813
3827
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3814
- # @param RoleId: 角色id
3828
+ # @param RoleId: 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3815
3829
  # @type RoleId: String
3816
3830
  # @param Users: 用户信息,最多 200 个用户,并且 UserId 和 OpenId 二选一,其他字段不需要传
3817
3831
  # @type Users: Array
3818
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3832
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3819
3833
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3820
3834
 
3821
3835
  attr_accessor :Operator, :RoleId, :Users, :Agent
@@ -4675,64 +4689,30 @@ module TencentCloud
4675
4689
  end
4676
4690
  end
4677
4691
 
4678
- # DescribeIntegrationMainOrganizationUser请求参数结构体
4679
- class DescribeIntegrationMainOrganizationUserRequest < TencentCloud::Common::AbstractModel
4680
- # @param Operator: 操作人信息,userId必填
4681
- # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4682
-
4683
- attr_accessor :Operator
4684
-
4685
- def initialize(operator=nil)
4686
- @Operator = operator
4687
- end
4688
-
4689
- def deserialize(params)
4690
- unless params['Operator'].nil?
4691
- @Operator = UserInfo.new
4692
- @Operator.deserialize(params['Operator'])
4693
- end
4694
- end
4695
- end
4696
-
4697
- # DescribeIntegrationMainOrganizationUser返回参数结构体
4698
- class DescribeIntegrationMainOrganizationUserResponse < TencentCloud::Common::AbstractModel
4699
- # @param IntegrationMainOrganizationUser: 主企业员工账号信息
4700
- # 注意:此字段可能返回 null,表示取不到有效值。
4701
- # @type IntegrationMainOrganizationUser: :class:`Tencentcloud::Ess.v20201111.models.IntegrationMainOrganizationUser`
4702
- # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4703
- # @type RequestId: String
4704
-
4705
- attr_accessor :IntegrationMainOrganizationUser, :RequestId
4706
-
4707
- def initialize(integrationmainorganizationuser=nil, requestid=nil)
4708
- @IntegrationMainOrganizationUser = integrationmainorganizationuser
4709
- @RequestId = requestid
4710
- end
4711
-
4712
- def deserialize(params)
4713
- unless params['IntegrationMainOrganizationUser'].nil?
4714
- @IntegrationMainOrganizationUser = IntegrationMainOrganizationUser.new
4715
- @IntegrationMainOrganizationUser.deserialize(params['IntegrationMainOrganizationUser'])
4716
- end
4717
- @RequestId = params['RequestId']
4718
- end
4719
- end
4720
-
4721
4692
  # DescribeIntegrationRoles请求参数结构体
4722
4693
  class DescribeIntegrationRolesRequest < TencentCloud::Common::AbstractModel
4723
- # @param Operator: 操作人信息,UserId必填
4694
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId
4695
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4724
4696
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4725
- # @param Limit: 指定每页多少条数据,单页最大200
4697
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4726
4698
  # @type Limit: Integer
4727
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4699
+ # @param Agent: 代理企业和员工的信息。
4700
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4728
4701
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4729
- # @param Filters: 查询的关键字段:
4730
- # Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
4731
- # Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
4732
- # Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
4733
- # Key:"IsReturnPermissionGroup"Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
4702
+ # @param Filters: 查询的关键字段,支持Key-Value单值查询。可选键值对如下:
4703
+ # <ul>
4704
+ # <li>Key:"RoleType",查询角色类型,Values可选:
4705
+ # <ul><li>**"1"**:查询系统角色</li><li>**"2"**:查询自定义角色</li></ul>
4706
+ # </li><li>Key:"RoleStatus",查询角色状态,Values可选:
4707
+ # <ul><li>**"1"**:查询启用角色</li><li>**"2"**:查询禁用角色</li></ul>
4708
+ # </li><li>Key:"IsGroupRole",是否查询集团角色,Values可选:
4709
+ # <ul><li>**"0"**:查询非集团角色</li><li>**"1"**:查询集团角色</li></ul>
4710
+ # </li><li>Key:"IsReturnPermissionGroup",是否返回角色对应权限树,Values可选:
4711
+ # <ul><li>**"0"**:接口不返回角色对应的权限树字段</li><li>**"1"**:接口返回角色对应的权限树字段</li></ul>
4712
+ # </li>
4713
+ # </ul>
4734
4714
  # @type Filters: Array
4735
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4715
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
4736
4716
  # @type Offset: Integer
4737
4717
 
4738
4718
  attr_accessor :Operator, :Limit, :Agent, :Filters, :Offset
@@ -4769,13 +4749,13 @@ module TencentCloud
4769
4749
 
4770
4750
  # DescribeIntegrationRoles返回参数结构体
4771
4751
  class DescribeIntegrationRolesResponse < TencentCloud::Common::AbstractModel
4772
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4752
+ # @param Offset: 指定分页返回的页码。页码从0开始,最大为2000
4773
4753
  # @type Offset: Integer
4774
- # @param Limit: 指定每页多少条数据,单页最大200
4754
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4775
4755
  # @type Limit: Integer
4776
- # @param TotalCount: 符合查询条件的总的角色数
4756
+ # @param TotalCount: 符合查询条件的总角色数。
4777
4757
  # @type TotalCount: Integer
4778
- # @param IntegrateRoles: 企业角色信息列表
4758
+ # @param IntegrateRoles: 企业角色信息列表。
4779
4759
  # @type IntegrateRoles: Array
4780
4760
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4781
4761
  # @type RequestId: String
@@ -5430,21 +5410,24 @@ module TencentCloud
5430
5410
 
5431
5411
  # 补充签署人信息
5432
5412
  # - RecipientId 必须指定
5433
- # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5413
+ # - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5434
5414
  # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
5435
5415
  class FillApproverInfo < TencentCloud::Common::AbstractModel
5436
- # @param RecipientId: 对应模板中的参与方ID
5416
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5417
+ # 模板发起合同时,该参数为必填项。
5418
+ # 文件发起合同是,该参数无需传值。
5419
+ # 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5437
5420
  # @type RecipientId: String
5438
5421
  # @param ApproverSource: 签署人来源
5439
5422
  # WEWORKAPP: 企业微信
5440
5423
  # <br/>仅【企微或签】时指定WEWORKAPP
5441
5424
  # @type ApproverSource: String
5442
- # @param CustomUserId: 企业自定义账号ID
5443
- # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
5425
+ # @param CustomUserId: 企业微信UserId
5426
+ # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
5444
5427
  # @type CustomUserId: String
5445
- # @param ApproverName: 补充签署人姓名
5428
+ # @param ApproverName: 补充企业签署人员工姓名
5446
5429
  # @type ApproverName: String
5447
- # @param ApproverMobile: 补充签署人手机号
5430
+ # @param ApproverMobile: 补充企业签署人员工手机号
5448
5431
  # @type ApproverMobile: String
5449
5432
 
5450
5433
  attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile
@@ -5762,9 +5745,10 @@ module TencentCloud
5762
5745
  # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5763
5746
  # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5764
5747
  # @type ApproverIdCardNumber: String
5765
- # @param RecipientId: 签署方经办人在模板中的参与方ID
5766
- # <br/>模板发起合同时,该参数为必填项
5767
- # <br/>文件发起合同是,该参数无序传值
5748
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5749
+ # 模板发起合同时,该参数为必填项。
5750
+ # 文件发起合同是,该参数无需传值。
5751
+ # 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5768
5752
  # @type RecipientId: String
5769
5753
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
5770
5754
 
@@ -6638,33 +6622,6 @@ module TencentCloud
6638
6622
  end
6639
6623
  end
6640
6624
 
6641
- # 主企业员工账号信息
6642
- class IntegrationMainOrganizationUser < TencentCloud::Common::AbstractModel
6643
- # @param MainOrganizationId: 主企业id
6644
- # 注意:此字段可能返回 null,表示取不到有效值。
6645
- # @type MainOrganizationId: String
6646
- # @param MainUserId: 主企业员工UserId
6647
- # 注意:此字段可能返回 null,表示取不到有效值。
6648
- # @type MainUserId: String
6649
- # @param UserName: 主企业员工名
6650
- # 注意:此字段可能返回 null,表示取不到有效值。
6651
- # @type UserName: String
6652
-
6653
- attr_accessor :MainOrganizationId, :MainUserId, :UserName
6654
-
6655
- def initialize(mainorganizationid=nil, mainuserid=nil, username=nil)
6656
- @MainOrganizationId = mainorganizationid
6657
- @MainUserId = mainuserid
6658
- @UserName = username
6659
- end
6660
-
6661
- def deserialize(params)
6662
- @MainOrganizationId = params['MainOrganizationId']
6663
- @MainUserId = params['MainUserId']
6664
- @UserName = params['UserName']
6665
- end
6666
- end
6667
-
6668
6625
  # ModifyApplicationCallbackInfo请求参数结构体
6669
6626
  class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
6670
6627
  # @param Operator: 执行本接口操作的员工信息。
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.659
4
+ version: 3.0.660
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-14 00:00:00.000000000 Z
11
+ date: 2023-09-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common