tencentcloud-sdk-ess 3.0.659 → 3.0.661

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: efc4c0633580ab9b74dbd7f13cd53b701ff8ea6f
4
- data.tar.gz: 9f433efe62a9562e0bcb92a387f90be00227e524
3
+ metadata.gz: 8203a8f6ec01f0f5223561028324c870829a70df
4
+ data.tar.gz: cdab9adfb6a50eb4d376b6240bd3a88a79eaeea3
5
5
  SHA512:
6
- metadata.gz: 7626bc5059f0a2f9905e7f31d36a76252718c3e4a2f4bdcdfb71ba376286f6f5e3266c011f40a64699ec5b801841270d8443693a1e23adee0ca789e59b18dc1d
7
- data.tar.gz: c2825ba3fdd0513c9ba379632138183e793d6a9131cc9217674f500de494691e04221ce23b3383a08fa43018458f7cf944bdb06945d5283668bda785f5ff2b5c
6
+ metadata.gz: 225fd4adcc422dd7529f35e696f0c41a7257f8c3e6dce362da345006dda8e03d506f4b51401e293a88c5feaaaf3aa8f40ad6be82b91d01a0bfa048156d0daf2d
7
+ data.tar.gz: 62dee719075e925a6a25fcf1556835d637ffe58211e974bf4b28efc57a53103301f3b46d717c920faf88b6d292d0ca93920d4b7bb683f49319525b5473007bb4
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.659
1
+ 3.0.661
@@ -29,7 +29,7 @@ module TencentCloud
29
29
  end
30
30
 
31
31
 
32
- # 将电子签系统员工userId与客户系统员工openId进行绑定
32
+ # 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
33
33
 
34
34
  # @param request: Request instance for BindEmployeeUserIdWithClientOpenId.
35
35
  # @type request: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdRequest`
@@ -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`
@@ -500,7 +509,7 @@ module TencentCloud
500
509
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
501
510
  end
502
511
 
503
- # 通过此接口,创建企业的部门,支持绑定客户系统部门ID。
512
+ # 此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
504
513
 
505
514
  # @param request: Request instance for CreateIntegrationDepartment.
506
515
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationDepartmentRequest`
@@ -524,8 +533,7 @@ module TencentCloud
524
533
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
525
534
  end
526
535
 
527
- # 创建员工,此接口会发送提醒员工实名的短信,如果通过手机号发现员工已经创建,则不会重新创建,会发送短信提醒员工实名
528
- # 注意:此接口支持企微组织架构的 openid 创建员工,这种场景下传递明文的企微 openid 到WeworkOpenId字段即可(企微明文的 openid 一定要在应用的可见范围内才行),通过企微创建的员工,会发送企微消息去提醒实名
536
+ # 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
529
537
 
530
538
  # @param request: Request instance for CreateIntegrationEmployees.
531
539
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationEmployeesRequest`
@@ -582,7 +590,7 @@ module TencentCloud
582
590
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
583
591
  end
584
592
 
585
- # 绑定员工与对应角色
593
+ # 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
586
594
 
587
595
  # @param request: Request instance for CreateIntegrationUserRoles.
588
596
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationUserRolesRequest`
@@ -676,7 +684,11 @@ module TencentCloud
676
684
 
677
685
  # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
678
686
 
679
- # 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
687
+ # 注:
688
+ # <ul>
689
+ # <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
690
+ # <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
691
+ # </ul>
680
692
 
681
693
  # @param request: Request instance for CreatePersonAuthCertificateImage.
682
694
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
@@ -921,7 +933,7 @@ module TencentCloud
921
933
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
922
934
  end
923
935
 
924
- # 通过此接口,删除企业的部门。
936
+ # 此接口(DeleteIntegrationDepartment)用于删除企业的部门信息。
925
937
 
926
938
  # @param request: Request instance for DeleteIntegrationDepartment.
927
939
  # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationDepartmentRequest`
@@ -945,10 +957,11 @@ module TencentCloud
945
957
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
946
958
  end
947
959
 
948
- # 移除员工
949
- # 这里分两个场景
950
- # 如果不传交接人的ReceiveUserId或者ReceiveOpenId,则会直接把这个人进行离职
951
- # 如果传了交接人,会把离职人未处理完的合同交接给交接人后再离职
960
+ # 该接口(DeleteIntegrationEmployees)用于移除企业员工,同时可选择是否进行离职交接。
961
+ # - 如果不设置交接人的ReceiveUserId或ReceiveOpenId,则该员工将被直接移除而不进行交接操作。
962
+ # - 如果设置了ReceiveUserIdReceiveOpenId,该员工未处理的合同将会被系统交接给设置的交接人,然后再对该员工进行离职操作。
963
+
964
+ # 注:`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。`
952
965
 
953
966
  # @param request: Request instance for DeleteIntegrationEmployees.
954
967
  # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationEmployeesRequest`
@@ -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`
@@ -1218,7 +1231,7 @@ module TencentCloud
1218
1231
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1219
1232
  end
1220
1233
 
1221
- # 通过此接口,查询企业的部门,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
1234
+ # 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
1222
1235
 
1223
1236
  # @param request: Request instance for DescribeIntegrationDepartments.
1224
1237
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationDepartmentsRequest`
@@ -1242,7 +1255,7 @@ module TencentCloud
1242
1255
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1243
1256
  end
1244
1257
 
1245
- # 查询企业员工列表,每次返回的数据量最大为20
1258
+ # 此接口(DescribeIntegrationEmployees)用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
1246
1259
 
1247
1260
  # @param request: Request instance for DescribeIntegrationEmployees.
1248
1261
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationEmployeesRequest`
@@ -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`
@@ -1316,7 +1305,8 @@ module TencentCloud
1316
1305
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1317
1306
  end
1318
1307
 
1319
- # 此API接口用户查询加入集团的成员企业
1308
+ # 此API接口用来查询加入集团的成员企业信息
1309
+ # 适用场景:子企业在加入集团后,主企业可能通过此接口获取到所有的子企业列表,方便进行展示和统计
1320
1310
 
1321
1311
  # @param request: Request instance for DescribeOrganizationGroupOrganizations.
1322
1312
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeOrganizationGroupOrganizationsRequest`
@@ -1504,7 +1494,7 @@ module TencentCloud
1504
1494
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1505
1495
  end
1506
1496
 
1507
- # 通过此接口,更新企业的部门信息,支持更新部门名、客户系统部门ID、部门序列号。
1497
+ # 此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。
1508
1498
 
1509
1499
  # @param request: Request instance for ModifyIntegrationDepartment.
1510
1500
  # @type request: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationDepartmentRequest`
@@ -1588,7 +1578,9 @@ module TencentCloud
1588
1578
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1589
1579
  end
1590
1580
 
1591
- # 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
1581
+ # 此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
1582
+
1583
+ # 注:`在调用此接口时,需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`
1592
1584
 
1593
1585
  # @param request: Request instance for UnbindEmployeeUserIdWithClientOpenId.
1594
1586
  # @type request: :class:`Tencentcloud::ess::V20201111::UnbindEmployeeUserIdWithClientOpenIdRequest`
@@ -22,7 +22,9 @@ module TencentCloud
22
22
  # @param Name: 超管名
23
23
  # 注意:此字段可能返回 null,表示取不到有效值。
24
24
  # @type Name: String
25
- # @param Mobile: 超管手机号
25
+ # @param Mobile: 超管手机号,打码显示
26
+ # 示例值:138****1569
27
+
26
28
  # 注意:此字段可能返回 null,表示取不到有效值。
27
29
  # @type Mobile: String
28
30
 
@@ -377,13 +379,16 @@ module TencentCloud
377
379
 
378
380
  # BindEmployeeUserIdWithClientOpenId请求参数结构体
379
381
  class BindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
380
- # @param Operator: 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
382
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId
383
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
381
384
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
382
- # @param UserId: 电子签系统员工UserId
385
+ # @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
386
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
383
387
  # @type UserId: String
384
- # @param OpenId: 客户系统OpenId
388
+ # @param OpenId: 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
385
389
  # @type OpenId: String
386
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
390
+ # @param Agent: 代理企业和员工的信息。
391
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
387
392
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
388
393
 
389
394
  attr_accessor :Operator, :UserId, :OpenId, :Agent
@@ -411,7 +416,8 @@ module TencentCloud
411
416
 
412
417
  # BindEmployeeUserIdWithClientOpenId返回参数结构体
413
418
  class BindEmployeeUserIdWithClientOpenIdResponse < TencentCloud::Common::AbstractModel
414
- # @param Status: 绑定是否成功,1表示成功,0表示失败
419
+ # @param Status: 绑定是否成功。
420
+ # <ul><li>**0**:失败</li><li>**1**:成功</li></ul>
415
421
  # @type Status: Integer
416
422
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
417
423
  # @type RequestId: String
@@ -1245,21 +1251,21 @@ module TencentCloud
1245
1251
  # @param Operator: 执行本接口操作的员工信息。
1246
1252
  # <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1247
1253
  # @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:生成查看合同详情的嵌入页面
1254
+ # @param EmbedType: WEB嵌入资源类型,支持以下类型
1255
+ # <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
1256
+ # <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
1257
+ # <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
1258
+ # <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
1259
+ # <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
1260
+ # <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
1261
+ # <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
1262
+ # <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
1263
+ # <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
1258
1264
  # @type EmbedType: String
1259
1265
  # @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
1266
+ # <ul><li>PREVIEW_SEAL_DETAIL,必填,取值为印章id</li>
1267
+ # <li>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id</li>
1268
+ # <li>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id</li><ul>
1263
1269
  # @type BusinessId: String
1264
1270
  # @param Agent: 代理企业和员工的信息。
1265
1271
  # <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -1325,16 +1331,23 @@ module TencentCloud
1325
1331
 
1326
1332
  # CreateFlowApprovers请求参数结构体
1327
1333
  class CreateFlowApproversRequest < TencentCloud::Common::AbstractModel
1328
- # @param Operator: 调用方用户信息,userId 必填
1334
+ # @param Operator: 执行本接口操作的员工信息。
1335
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1329
1336
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1330
- # @param FlowId: 签署流程编号
1337
+ # @param FlowId: 合同流程ID,为32位字符串。
1338
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1339
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1331
1340
  # @type FlowId: String
1332
- # @param Approvers: 补充签署人信息
1341
+ # @param Approvers: 补充企业签署人信息。
1342
+
1343
+ # - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
1344
+
1345
+ # - 如果不指定,则使用姓名和手机号进行补充。
1333
1346
  # @type Approvers: Array
1334
- # @param Initiator: 企微消息中的发起人
1347
+ # @param Initiator: 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
1335
1348
  # @type Initiator: String
1336
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作
1337
-
1349
+ # @param Agent: 代理企业和员工的信息。
1350
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1338
1351
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1339
1352
 
1340
1353
  attr_accessor :Operator, :FlowId, :Approvers, :Initiator, :Agent
@@ -1750,15 +1763,22 @@ module TencentCloud
1750
1763
 
1751
1764
  # CreateFlowGroupByTemplates请求参数结构体
1752
1765
  class CreateFlowGroupByTemplatesRequest < TencentCloud::Common::AbstractModel
1753
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1766
+ # @param Operator: 执行本接口操作的员工信息。
1767
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1754
1768
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1755
- # @param FlowGroupName: 合同组名称,最大长度200个字符
1769
+ # @param FlowGroupName: 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1756
1770
  # @type FlowGroupName: String
1757
- # @param FlowGroupInfos: 合同组的子合同信息,支持2-50个子合同
1771
+ # @param FlowGroupInfos: 合同(流程)组的子合同信息,支持2-50个子合同
1758
1772
  # @type FlowGroupInfos: Array
1759
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1773
+ # @param Agent: 代理企业和员工的信息。
1774
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1760
1775
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1761
- # @param FlowGroupOptions: 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
1776
+ # @param FlowGroupOptions: 合同(流程)组的配置项信息。
1777
+ # 其中包括:
1778
+ # <ul>
1779
+ # <li>是否通知本企业签署方</li>
1780
+ # <li>是否通知其他签署方</li>
1781
+ # </ul>
1762
1782
  # @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
1763
1783
 
1764
1784
  attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
@@ -2288,18 +2308,19 @@ module TencentCloud
2288
2308
  # @param Operator: 执行本接口操作的员工信息。
2289
2309
  # 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
2290
2310
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2291
- # @param DeptName: 部门名称,不超过50个字符
2311
+ # @param DeptName: 部门名称,最大长度为50个字符。
2292
2312
  # @type DeptName: String
2293
- # @param Agent: 代理企业和员工的信息。
2294
- # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2313
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2295
2314
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2296
- # @param ParentDeptId: 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2315
+ # @param ParentDeptId: 电子签父部门ID
2316
+ # 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
2297
2317
  # @type ParentDeptId: String
2298
- # @param ParentDeptOpenId: 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2318
+ # @param ParentDeptOpenId: 第三方平台中父部门ID
2319
+ # 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
2299
2320
  # @type ParentDeptOpenId: String
2300
- # @param DeptOpenId: 客户系统部门ID,不超过64个字符
2321
+ # @param DeptOpenId: 客户系统部门ID,最大长度为64个字符。
2301
2322
  # @type DeptOpenId: String
2302
- # @param OrderNo: 排序号,1~30000范围内
2323
+ # @param OrderNo: 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
2303
2324
  # @type OrderNo: Integer
2304
2325
 
2305
2326
  attr_accessor :Operator, :DeptName, :Agent, :ParentDeptId, :ParentDeptOpenId, :DeptOpenId, :OrderNo
@@ -2333,7 +2354,7 @@ module TencentCloud
2333
2354
 
2334
2355
  # CreateIntegrationDepartment返回参数结构体
2335
2356
  class CreateIntegrationDepartmentResponse < TencentCloud::Common::AbstractModel
2336
- # @param DeptId: 电子签部门ID
2357
+ # @param DeptId: 电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
2337
2358
  # @type DeptId: String
2338
2359
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2339
2360
  # @type RequestId: String
@@ -2353,13 +2374,15 @@ module TencentCloud
2353
2374
 
2354
2375
  # CreateIntegrationEmployees请求参数结构体
2355
2376
  class CreateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
2356
- # @param Operator: 操作人信息,userId必填
2377
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId
2378
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2357
2379
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2358
- # @param Employees: 待创建员工的信息,不超过20个。
2359
- # 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
2360
- # 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
2380
+ # @param Employees: 待创建员工的信息,最多不超过20个。
2381
+ # 其中入参Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持设置。
2382
+ # 在创建企微企业员工场景下,只需传入WeworkOpenId,无需再传其他信息。
2361
2383
  # @type Employees: Array
2362
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2384
+ # @param Agent: 代理企业和员工的信息。
2385
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2363
2386
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2364
2387
 
2365
2388
  attr_accessor :Operator, :Employees, :Agent
@@ -2392,7 +2415,7 @@ module TencentCloud
2392
2415
 
2393
2416
  # CreateIntegrationEmployees返回参数结构体
2394
2417
  class CreateIntegrationEmployeesResponse < TencentCloud::Common::AbstractModel
2395
- # @param CreateEmployeeResult: 创建员工的结果
2418
+ # @param CreateEmployeeResult: 创建员工的结果。包含创建成功的数据与创建失败数据。
2396
2419
  # @type CreateEmployeeResult: :class:`Tencentcloud::Ess.v20201111.models.CreateStaffResult`
2397
2420
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2398
2421
  # @type RequestId: String
@@ -2493,13 +2516,13 @@ module TencentCloud
2493
2516
 
2494
2517
  # CreateIntegrationUserRoles请求参数结构体
2495
2518
  class CreateIntegrationUserRolesRequest < TencentCloud::Common::AbstractModel
2496
- # @param Operator: 操作人信息,UserId必填
2519
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
2497
2520
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2498
2521
  # @param UserIds: 绑定角色的用户id列表,不能重复,不能大于 100 个
2499
2522
  # @type UserIds: Array
2500
- # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
2523
+ # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
2501
2524
  # @type RoleIds: Array
2502
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2525
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2503
2526
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2504
2527
 
2505
2528
  attr_accessor :Operator, :UserIds, :RoleIds, :Agent
@@ -3591,7 +3614,7 @@ module TencentCloud
3591
3614
 
3592
3615
  # CreateUserAutoSignEnableUrl返回参数结构体
3593
3616
  class CreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
3594
- # @param Url: 个人用户自动签的开通链接, 短链形式
3617
+ # @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
3595
3618
  # @type Url: String
3596
3619
  # @param AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3597
3620
 
@@ -3700,12 +3723,13 @@ module TencentCloud
3700
3723
  # @param Operator: 执行本接口操作的员工信息。
3701
3724
  # 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
3702
3725
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3703
- # @param DeptId: 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
3726
+ # @param DeptId: 电子签中的部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
3704
3727
  # @type DeptId: String
3705
3728
  # @param Agent: 代理企业和员工的信息。
3706
3729
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3707
3730
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3708
- # @param ReceiveDeptId: 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
3731
+ # @param ReceiveDeptId: 交接部门ID
3732
+ # 待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
3709
3733
  # @type ReceiveDeptId: String
3710
3734
 
3711
3735
  attr_accessor :Operator, :DeptId, :Agent, :ReceiveDeptId
@@ -3749,11 +3773,15 @@ module TencentCloud
3749
3773
 
3750
3774
  # DeleteIntegrationEmployees请求参数结构体
3751
3775
  class DeleteIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
3752
- # @param Operator: 操作人信息,userId必填
3776
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
3777
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3753
3778
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3754
- # @param Employees: 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
3779
+ # @param Employees: 待移除员工的信息。应符合以下规则:
3780
+ # <ul><li>UserId和OpenId不可同时为空。</li>
3781
+ # <li>若需要进行离职交接,交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
3755
3782
  # @type Employees: Array
3756
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3783
+ # @param Agent: 代理企业和员工的信息。
3784
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3757
3785
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3758
3786
 
3759
3787
  attr_accessor :Operator, :Employees, :Agent
@@ -3786,7 +3814,9 @@ module TencentCloud
3786
3814
 
3787
3815
  # DeleteIntegrationEmployees返回参数结构体
3788
3816
  class DeleteIntegrationEmployeesResponse < TencentCloud::Common::AbstractModel
3789
- # @param DeleteEmployeeResult: 员工删除数据
3817
+ # @param DeleteEmployeeResult: 员工删除结果。包含成功数据与失败数据。
3818
+ # <ul><li>**成功数据**:展示员工姓名、手机号与电子签平台UserId</li>
3819
+ # <li>**失败数据**:展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
3790
3820
  # @type DeleteEmployeeResult: :class:`Tencentcloud::Ess.v20201111.models.DeleteStaffsResult`
3791
3821
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3792
3822
  # @type RequestId: String
@@ -3809,13 +3839,13 @@ module TencentCloud
3809
3839
 
3810
3840
  # DeleteIntegrationRoleUsers请求参数结构体
3811
3841
  class DeleteIntegrationRoleUsersRequest < TencentCloud::Common::AbstractModel
3812
- # @param Operator: 操作人信息,userId必填
3842
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3813
3843
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3814
- # @param RoleId: 角色id
3844
+ # @param RoleId: 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3815
3845
  # @type RoleId: String
3816
3846
  # @param Users: 用户信息,最多 200 个用户,并且 UserId 和 OpenId 二选一,其他字段不需要传
3817
3847
  # @type Users: Array
3818
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3848
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3819
3849
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3820
3850
 
3821
3851
  attr_accessor :Operator, :RoleId, :Users, :Agent
@@ -3958,11 +3988,11 @@ module TencentCloud
3958
3988
  end
3959
3989
  end
3960
3990
 
3961
- # 集成版员工部门信息
3991
+ # 集成版员工部门信息。
3962
3992
  class Department < TencentCloud::Common::AbstractModel
3963
- # @param DepartmentId: 部门id
3993
+ # @param DepartmentId: 部门ID。
3964
3994
  # @type DepartmentId: String
3965
- # @param DepartmentName: 部门名称
3995
+ # @param DepartmentName: 部门名称。
3966
3996
  # @type DepartmentName: String
3967
3997
 
3968
3998
  attr_accessor :DepartmentId, :DepartmentName
@@ -4524,14 +4554,18 @@ module TencentCloud
4524
4554
  # @param Operator: 执行本接口操作的员工信息。
4525
4555
  # 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
4526
4556
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4527
- # @param QueryType: 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
4557
+ # @param QueryType: 查询类型,支持以下类型:
4558
+ # <ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>
4559
+ # <li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>
4528
4560
  # @type QueryType: Integer
4529
4561
  # @param Agent: 代理企业和员工的信息。
4530
4562
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4531
4563
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4532
- # @param DeptId: 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
4564
+ # @param DeptId: 查询的部门ID
4565
+ # 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
4533
4566
  # @type DeptId: String
4534
- # @param DeptOpenId: 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
4567
+ # @param DeptOpenId: 查询的客户系统部门ID
4568
+ # 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
4535
4569
  # @type DeptOpenId: String
4536
4570
 
4537
4571
  attr_accessor :Operator, :QueryType, :Agent, :DeptId, :DeptOpenId
@@ -4561,7 +4595,7 @@ module TencentCloud
4561
4595
 
4562
4596
  # DescribeIntegrationDepartments返回参数结构体
4563
4597
  class DescribeIntegrationDepartmentsResponse < TencentCloud::Common::AbstractModel
4564
- # @param Departments: 部门列表
4598
+ # @param Departments: 部门信息列表。部门信息根据部门排序号OrderNo降序排列,根据部门创建时间升序排列。
4565
4599
  # @type Departments: Array
4566
4600
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4567
4601
  # @type RequestId: String
@@ -4588,18 +4622,25 @@ module TencentCloud
4588
4622
 
4589
4623
  # DescribeIntegrationEmployees请求参数结构体
4590
4624
  class DescribeIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
4591
- # @param Operator: 操作人信息,userId必填
4625
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
4626
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4592
4627
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4593
- # @param Limit: 指定每页多少条数据,单页最大20
4628
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 20
4594
4629
  # @type Limit: Integer
4595
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4630
+ # @param Agent: 代理企业和员工的信息。
4631
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4596
4632
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4597
- # @param Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
4598
- # 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
4599
- # 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
4600
- # 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
4633
+ # @param Filters: 查询的关键字段,支持Key-Values查询。可选键值如下:
4634
+ # <ul>
4635
+ # <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
4636
+ # <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["NotVerified"]**:查询未实名的员工</li></ul></li>
4637
+ # <li>Key:**"DepartmentId"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**["DepartmentId"]**</li>
4638
+ # <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
4639
+ # <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
4640
+ # <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
4641
+ # </ul>
4601
4642
  # @type Filters: Array
4602
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
4643
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
4603
4644
  # @type Offset: Integer
4604
4645
 
4605
4646
  attr_accessor :Operator, :Limit, :Agent, :Filters, :Offset
@@ -4636,15 +4677,15 @@ module TencentCloud
4636
4677
 
4637
4678
  # DescribeIntegrationEmployees返回参数结构体
4638
4679
  class DescribeIntegrationEmployeesResponse < TencentCloud::Common::AbstractModel
4639
- # @param Employees: 员工数据列表
4680
+ # @param Employees: 员工信息列表。
4640
4681
  # 注意:此字段可能返回 null,表示取不到有效值。
4641
4682
  # @type Employees: Array
4642
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
4683
+ # @param Offset: 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
4643
4684
  # 注意:此字段可能返回 null,表示取不到有效值。
4644
4685
  # @type Offset: Integer
4645
- # @param Limit: 指定每页多少条数据,单页最大20
4686
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 20
4646
4687
  # @type Limit: Integer
4647
- # @param TotalCount: 符合条件的员工数量
4688
+ # @param TotalCount: 符合条件的员工数量。
4648
4689
  # @type TotalCount: Integer
4649
4690
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4650
4691
  # @type RequestId: String
@@ -4675,64 +4716,30 @@ module TencentCloud
4675
4716
  end
4676
4717
  end
4677
4718
 
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
4719
  # DescribeIntegrationRoles请求参数结构体
4722
4720
  class DescribeIntegrationRolesRequest < TencentCloud::Common::AbstractModel
4723
- # @param Operator: 操作人信息,UserId必填
4721
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId
4722
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4724
4723
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4725
- # @param Limit: 指定每页多少条数据,单页最大200
4724
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4726
4725
  # @type Limit: Integer
4727
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4726
+ # @param Agent: 代理企业和员工的信息。
4727
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4728
4728
  # @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"]表示接口返回角色对应的权限树字段
4729
+ # @param Filters: 查询的关键字段,支持Key-Value单值查询。可选键值对如下:
4730
+ # <ul>
4731
+ # <li>Key:"RoleType",查询角色类型,Values可选:
4732
+ # <ul><li>**"1"**:查询系统角色</li><li>**"2"**:查询自定义角色</li></ul>
4733
+ # </li><li>Key:"RoleStatus",查询角色状态,Values可选:
4734
+ # <ul><li>**"1"**:查询启用角色</li><li>**"2"**:查询禁用角色</li></ul>
4735
+ # </li><li>Key:"IsGroupRole",是否查询集团角色,Values可选:
4736
+ # <ul><li>**"0"**:查询非集团角色</li><li>**"1"**:查询集团角色</li></ul>
4737
+ # </li><li>Key:"IsReturnPermissionGroup",是否返回角色对应权限树,Values可选:
4738
+ # <ul><li>**"0"**:接口不返回角色对应的权限树字段</li><li>**"1"**:接口返回角色对应的权限树字段</li></ul>
4739
+ # </li>
4740
+ # </ul>
4734
4741
  # @type Filters: Array
4735
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4742
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
4736
4743
  # @type Offset: Integer
4737
4744
 
4738
4745
  attr_accessor :Operator, :Limit, :Agent, :Filters, :Offset
@@ -4769,13 +4776,13 @@ module TencentCloud
4769
4776
 
4770
4777
  # DescribeIntegrationRoles返回参数结构体
4771
4778
  class DescribeIntegrationRolesResponse < TencentCloud::Common::AbstractModel
4772
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4779
+ # @param Offset: 指定分页返回的页码。页码从0开始,最大为2000
4773
4780
  # @type Offset: Integer
4774
- # @param Limit: 指定每页多少条数据,单页最大200
4781
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4775
4782
  # @type Limit: Integer
4776
- # @param TotalCount: 符合查询条件的总的角色数
4783
+ # @param TotalCount: 符合查询条件的总角色数。
4777
4784
  # @type TotalCount: Integer
4778
- # @param IntegrateRoles: 企业角色信息列表
4785
+ # @param IntegrateRoles: 企业角色信息列表。
4779
4786
  # @type IntegrateRoles: Array
4780
4787
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4781
4788
  # @type RequestId: String
@@ -4808,19 +4815,28 @@ module TencentCloud
4808
4815
 
4809
4816
  # DescribeOrganizationGroupOrganizations请求参数结构体
4810
4817
  class DescribeOrganizationGroupOrganizationsRequest < TencentCloud::Common::AbstractModel
4811
- # @param Operator: 操作人信息,userId必填
4818
+ # @param Operator: 执行本接口操作的员工信息,userId必填。
4819
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4812
4820
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4813
- # @param Limit: 指定每页多少条数据,单页最大1000
4821
+ # @param Limit: 指定分页每页返回的数据条数,单页最大1000
4814
4822
  # @type Limit: Integer
4815
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
4823
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
4816
4824
  # @type Offset: Integer
4817
4825
  # @param Name: 查询成员企业的企业名,模糊匹配
4818
4826
  # @type Name: String
4819
- # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
4827
+ # @param Status: 成员企业加入集团的当前状态
4828
+ # <ul><li> **1**:待授权</li>
4829
+ # <li> **2**:已授权待激活</li>
4830
+ # <li> **3**:拒绝授权</li>
4831
+ # <li> **4**:已解除</li>
4832
+ # <li> **5**:已加入</li>
4833
+ # </ul>
4820
4834
  # @type Status: Integer
4821
4835
  # @param Export: 是否导出当前成员企业数据
4836
+ # <ul><li> **false**:不导出(默认值)</li>
4837
+ # <li> **true**:导出</li></ul>
4822
4838
  # @type Export: Boolean
4823
- # @param Id: 成员企业机构 ID,在PC控制台 集团管理可获取
4839
+ # @param Id: 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
4824
4840
  # @type Id: String
4825
4841
 
4826
4842
  attr_accessor :Operator, :Limit, :Offset, :Name, :Status, :Export, :Id
@@ -4851,10 +4867,10 @@ module TencentCloud
4851
4867
 
4852
4868
  # DescribeOrganizationGroupOrganizations返回参数结构体
4853
4869
  class DescribeOrganizationGroupOrganizationsResponse < TencentCloud::Common::AbstractModel
4854
- # @param Total: 查询到的符合条件的成员企业总数量
4870
+ # @param Total: 符合查询条件的资源实例总数量。
4855
4871
  # 注意:此字段可能返回 null,表示取不到有效值。
4856
4872
  # @type Total: Integer
4857
- # @param JoinedTotal: 已授权待激活的企业数量
4873
+ # @param JoinedTotal: 已授权待激活的子企业总数量
4858
4874
  # 注意:此字段可能返回 null,表示取不到有效值。
4859
4875
  # @type JoinedTotal: Integer
4860
4876
  # @param ActivedTotal: 已加入的企业数量(废弃,请使用ActivatedTotal)
@@ -4866,7 +4882,7 @@ module TencentCloud
4866
4882
  # @param List: 成员企业信息列表
4867
4883
  # 注意:此字段可能返回 null,表示取不到有效值。
4868
4884
  # @type List: Array
4869
- # @param ActivatedTotal: 已加入的企业数量
4885
+ # @param ActivatedTotal: 已加入的子企业总数量
4870
4886
  # 注意:此字段可能返回 null,表示取不到有效值。
4871
4887
  # @type ActivatedTotal: Integer
4872
4888
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -5351,11 +5367,12 @@ module TencentCloud
5351
5367
  class FailedUpdateStaffData < TencentCloud::Common::AbstractModel
5352
5368
  # @param DisplayName: 用户传入的名称
5353
5369
  # @type DisplayName: String
5354
- # @param Mobile: 用户传入的手机号
5370
+ # @param Mobile: 用户传入的手机号,明文展示
5355
5371
  # @type Mobile: String
5356
5372
  # @param Reason: 失败原因
5357
5373
  # @type Reason: String
5358
- # @param UserId: 用户Id
5374
+ # @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5375
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
5359
5376
  # @type UserId: String
5360
5377
  # @param OpenId: 员工在第三方平台的openId
5361
5378
  # @type OpenId: String
@@ -5430,21 +5447,24 @@ module TencentCloud
5430
5447
 
5431
5448
  # 补充签署人信息
5432
5449
  # - RecipientId 必须指定
5433
- # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5450
+ # - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5434
5451
  # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
5435
5452
  class FillApproverInfo < TencentCloud::Common::AbstractModel
5436
- # @param RecipientId: 对应模板中的参与方ID
5453
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5454
+ # 模板发起合同时,该参数为必填项。
5455
+ # 文件发起合同是,该参数无需传值。
5456
+ # 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5437
5457
  # @type RecipientId: String
5438
5458
  # @param ApproverSource: 签署人来源
5439
5459
  # WEWORKAPP: 企业微信
5440
5460
  # <br/>仅【企微或签】时指定WEWORKAPP
5441
5461
  # @type ApproverSource: String
5442
- # @param CustomUserId: 企业自定义账号ID
5443
- # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
5462
+ # @param CustomUserId: 企业微信UserId
5463
+ # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
5444
5464
  # @type CustomUserId: String
5445
- # @param ApproverName: 补充签署人姓名
5465
+ # @param ApproverName: 补充企业签署人员工姓名
5446
5466
  # @type ApproverName: String
5447
- # @param ApproverMobile: 补充签署人手机号
5467
+ # @param ApproverMobile: 补充企业签署人员工手机号
5448
5468
  # @type ApproverMobile: String
5449
5469
 
5450
5470
  attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile
@@ -5762,9 +5782,10 @@ module TencentCloud
5762
5782
  # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5763
5783
  # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5764
5784
  # @type ApproverIdCardNumber: String
5765
- # @param RecipientId: 签署方经办人在模板中的参与方ID
5766
- # <br/>模板发起合同时,该参数为必填项
5767
- # <br/>文件发起合同是,该参数无序传值
5785
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5786
+ # 模板发起合同时,该参数为必填项。
5787
+ # 文件发起合同是,该参数无需传值。
5788
+ # 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5768
5789
  # @type RecipientId: String
5769
5790
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
5770
5791
 
@@ -6461,13 +6482,20 @@ module TencentCloud
6461
6482
  # @param Alias: 成员企业别名
6462
6483
  # 注意:此字段可能返回 null,表示取不到有效值。
6463
6484
  # @type Alias: String
6464
- # @param OrganizationId: 成员企业id
6485
+ # @param OrganizationId: 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
6465
6486
  # 注意:此字段可能返回 null,表示取不到有效值。
6466
6487
  # @type OrganizationId: String
6467
- # @param UpdateTime: 更新时间,时间戳,单位秒
6488
+ # @param UpdateTime: 记录更新时间, unix时间戳,单位秒
6468
6489
  # 注意:此字段可能返回 null,表示取不到有效值。
6469
6490
  # @type UpdateTime: Integer
6470
- # @param Status: 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
6491
+ # @param Status: 成员企业加入集团的当前状态
6492
+ # <ul><li> **1**:待授权</li>
6493
+ # <li> **2**:已授权待激活</li>
6494
+ # <li> **3**:拒绝授权</li>
6495
+ # <li> **4**:已解除</li>
6496
+ # <li> **5**:已加入</li>
6497
+ # </ul>
6498
+
6471
6499
  # 注意:此字段可能返回 null,表示取不到有效值。
6472
6500
  # @type Status: Integer
6473
6501
  # @param IsMainOrganization: 是否为集团主企业
@@ -6479,16 +6507,18 @@ module TencentCloud
6479
6507
  # @param AdminInfo: 企业超管信息
6480
6508
  # 注意:此字段可能返回 null,表示取不到有效值。
6481
6509
  # @type AdminInfo: :class:`Tencentcloud::Ess.v20201111.models.Admin`
6482
- # @param License: 企业许可证
6510
+ # @param License: 企业许可证Id,此字段暂时不需要关注
6483
6511
  # 注意:此字段可能返回 null,表示取不到有效值。
6484
6512
  # @type License: String
6485
- # @param LicenseExpireTime: 企业许可证过期时间,时间戳,单位秒
6513
+ # @param LicenseExpireTime: 企业许可证过期时间,unix时间戳,单位秒
6486
6514
  # 注意:此字段可能返回 null,表示取不到有效值。
6487
6515
  # @type LicenseExpireTime: Integer
6488
- # @param JoinTime: 成员企业加入集团时间,时间戳,单位秒
6516
+ # @param JoinTime: 成员企业加入集团时间,unix时间戳,单位秒
6489
6517
  # 注意:此字段可能返回 null,表示取不到有效值。
6490
6518
  # @type JoinTime: Integer
6491
- # @param FlowEngineEnable: 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
6519
+ # @param FlowEngineEnable: 是否使用自建审批流引擎(即不是企微审批流引擎)
6520
+ # <ul><li> **true**:是</li>
6521
+ # <li> **false**:否</li></ul>
6492
6522
  # 注意:此字段可能返回 null,表示取不到有效值。
6493
6523
  # @type FlowEngineEnable: Boolean
6494
6524
 
@@ -6603,10 +6633,10 @@ module TencentCloud
6603
6633
 
6604
6634
  # 部门信息
6605
6635
  class IntegrationDepartment < TencentCloud::Common::AbstractModel
6606
- # @param DeptId: 部门ID
6636
+ # @param DeptId: 部门ID
6607
6637
  # 注意:此字段可能返回 null,表示取不到有效值。
6608
6638
  # @type DeptId: String
6609
- # @param DeptName: 部门名
6639
+ # @param DeptName: 部门名。
6610
6640
  # 注意:此字段可能返回 null,表示取不到有效值。
6611
6641
  # @type DeptName: String
6612
6642
  # @param ParentDeptId: 父部门ID
@@ -6615,7 +6645,7 @@ module TencentCloud
6615
6645
  # @param DeptOpenId: 客户系统部门ID
6616
6646
  # 注意:此字段可能返回 null,表示取不到有效值。
6617
6647
  # @type DeptOpenId: String
6618
- # @param OrderNo: 序列号
6648
+ # @param OrderNo: 序列号。
6619
6649
  # 注意:此字段可能返回 null,表示取不到有效值。
6620
6650
  # @type OrderNo: Integer
6621
6651
 
@@ -6638,33 +6668,6 @@ module TencentCloud
6638
6668
  end
6639
6669
  end
6640
6670
 
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
6671
  # ModifyApplicationCallbackInfo请求参数结构体
6669
6672
  class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
6670
6673
  # @param Operator: 执行本接口操作的员工信息。
@@ -6727,18 +6730,18 @@ module TencentCloud
6727
6730
  # @param Operator: 执行本接口操作的员工信息。
6728
6731
  # 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
6729
6732
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
6730
- # @param DeptId: 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
6733
+ # @param DeptId: 电子签部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
6731
6734
  # @type DeptId: String
6732
6735
  # @param Agent: 代理企业和员工的信息。
6733
6736
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6734
6737
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
6735
- # @param ParentDeptId: 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
6738
+ # @param ParentDeptId: 电子签父部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
6736
6739
  # @type ParentDeptId: String
6737
- # @param DeptName: 部门名称,不超过50个字符
6740
+ # @param DeptName: 部门名称,最大长度为50个字符。
6738
6741
  # @type DeptName: String
6739
- # @param DeptOpenId: 客户系统部门ID,不超过64个字符
6742
+ # @param DeptOpenId: 客户系统部门ID,最大长度为64个字符。
6740
6743
  # @type DeptOpenId: String
6741
- # @param OrderNo: 排序号,1~30000范围内
6744
+ # @param OrderNo: 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
6742
6745
  # @type OrderNo: Integer
6743
6746
 
6744
6747
  attr_accessor :Operator, :DeptId, :Agent, :ParentDeptId, :DeptName, :DeptOpenId, :OrderNo
@@ -7495,50 +7498,52 @@ module TencentCloud
7495
7498
  end
7496
7499
  end
7497
7500
 
7498
- # 企业员工信息
7501
+ # 企业员工信息。
7499
7502
  class Staff < TencentCloud::Common::AbstractModel
7500
- # @param UserId: 用户在电子签平台的id
7501
- # 注:创建和更新场景无需填写
7503
+ # @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
7504
+ # 注:`创建和更新场景无需填写。`
7502
7505
  # @type UserId: String
7503
- # @param DisplayName: 显示的用户名/昵称
7506
+ # @param DisplayName: 显示的用户名/昵称。
7504
7507
  # @type DisplayName: String
7505
- # @param Mobile: 用户手机号
7508
+ # @param Mobile: 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
7506
7509
  # @type Mobile: String
7507
- # @param Email: 用户邮箱
7510
+ # @param Email: 用户邮箱。
7508
7511
  # 注意:此字段可能返回 null,表示取不到有效值。
7509
7512
  # @type Email: String
7510
- # @param OpenId: 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
7513
+ # @param OpenId: 用户在第三方平台ID。
7514
+ # 注:`如需在此接口提醒员工实名,该参数不传。`
7511
7515
  # 注意:此字段可能返回 null,表示取不到有效值。
7512
7516
  # @type OpenId: String
7513
- # @param Roles: 员工角色
7514
- # 注:创建和更新场景无需填写
7517
+ # @param Roles: 员工角色信息。
7518
+ # 注:`创建和更新场景无需填写。`
7515
7519
  # 注意:此字段可能返回 null,表示取不到有效值。
7516
7520
  # @type Roles: Array
7517
- # @param Department: 员工部门
7521
+ # @param Department: 员工部门信息。
7518
7522
  # 注意:此字段可能返回 null,表示取不到有效值。
7519
7523
  # @type Department: :class:`Tencentcloud::Ess.v20201111.models.Department`
7520
- # @param Verified: 员工是否实名
7521
- # 注:创建和更新场景无需填写
7524
+ # @param Verified: 员工是否实名。
7525
+ # 注:`创建和更新场景无需填写。`
7522
7526
  # @type Verified: Boolean
7523
- # @param CreatedOn: 员工创建时间戳,单位秒
7524
- # 注:创建和更新场景无需填写
7527
+ # @param CreatedOn: 员工创建时间戳,单位秒。
7528
+ # 注:`创建和更新场景无需填写。`
7525
7529
  # @type CreatedOn: Integer
7526
- # @param VerifiedOn: 员工实名时间戳,单位秒
7527
- # 注:创建和更新场景无需填写
7530
+ # @param VerifiedOn: 员工实名时间戳,单位秒。
7531
+ # 注:`创建和更新场景无需填写。`
7528
7532
  # 注意:此字段可能返回 null,表示取不到有效值。
7529
7533
  # @type VerifiedOn: Integer
7530
- # @param QuiteJob: 员工是否离职:0-未离职,1-离职
7531
- # 注:创建和更新场景无需填写
7534
+ # @param QuiteJob: 员工是否离职:
7535
+ # <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
7536
+ # 注:`创建和更新场景无需填写。`
7532
7537
  # 注意:此字段可能返回 null,表示取不到有效值。
7533
7538
  # @type QuiteJob: Integer
7534
- # @param ReceiveUserId: 员工离职交接人用户id
7535
- # 注:创建和更新场景无需填写
7539
+ # @param ReceiveUserId: 员工离职交接人用户ID。
7540
+ # 注:`创建和更新场景无需填写。`
7536
7541
  # @type ReceiveUserId: String
7537
- # @param ReceiveOpenId: 员工离职交接人用户OpenId
7538
- # 注:创建和更新场景无需填写
7542
+ # @param ReceiveOpenId: 员工离职交接人用户OpenId
7543
+ # 注:`创建和更新场景无需填写。`
7539
7544
  # @type ReceiveOpenId: String
7540
- # @param WeworkOpenId: 企业微信用户账号ID
7541
- # 注:仅企微类型的企业创建员工接口支持该字段
7545
+ # @param WeworkOpenId: 企业微信用户账号ID
7546
+ # 注:`仅企微类型的企业创建员工接口支持该字段。`
7542
7547
  # 注意:此字段可能返回 null,表示取不到有效值。
7543
7548
  # @type WeworkOpenId: String
7544
7549
 
@@ -7589,12 +7594,12 @@ module TencentCloud
7589
7594
  end
7590
7595
  end
7591
7596
 
7592
- # 集成版企业角色信息
7597
+ # 集成版企业角色信息。
7593
7598
  class StaffRole < TencentCloud::Common::AbstractModel
7594
- # @param RoleId: 角色id
7599
+ # @param RoleId: 角色ID。
7595
7600
  # 注意:此字段可能返回 null,表示取不到有效值。
7596
7601
  # @type RoleId: String
7597
- # @param RoleName: 角色名称
7602
+ # @param RoleName: 角色名称。
7598
7603
  # 注意:此字段可能返回 null,表示取不到有效值。
7599
7604
  # @type RoleName: String
7600
7605
 
@@ -7741,9 +7746,10 @@ module TencentCloud
7741
7746
  class SuccessUpdateStaffData < TencentCloud::Common::AbstractModel
7742
7747
  # @param DisplayName: 传入的用户名称
7743
7748
  # @type DisplayName: String
7744
- # @param Mobile: 传入的手机号
7749
+ # @param Mobile: 传入的手机号,没有打码
7745
7750
  # @type Mobile: String
7746
- # @param UserId: 用户Id
7751
+ # @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
7752
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
7747
7753
  # @type UserId: String
7748
7754
 
7749
7755
  attr_accessor :DisplayName, :Mobile, :UserId
@@ -7936,13 +7942,17 @@ module TencentCloud
7936
7942
 
7937
7943
  # UnbindEmployeeUserIdWithClientOpenId请求参数结构体
7938
7944
  class UnbindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
7939
- # @param Operator: 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定(参数用法参考示例)
7945
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId
7946
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
7940
7947
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
7941
- # @param UserId: 电子签系统员工UserId
7948
+ # @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
7949
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
7942
7950
  # @type UserId: String
7943
- # @param OpenId: 客户系统OpenId
7951
+ # @param OpenId: 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
7952
+ # 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
7944
7953
  # @type OpenId: String
7945
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
7954
+ # @param Agent: 代理企业和员工的信息。
7955
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
7946
7956
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
7947
7957
 
7948
7958
  attr_accessor :Operator, :UserId, :OpenId, :Agent
@@ -7970,7 +7980,9 @@ module TencentCloud
7970
7980
 
7971
7981
  # UnbindEmployeeUserIdWithClientOpenId返回参数结构体
7972
7982
  class UnbindEmployeeUserIdWithClientOpenIdResponse < TencentCloud::Common::AbstractModel
7973
- # @param Status: 解绑是否成功,1表示成功,0表示失败
7983
+ # @param Status: 解绑是否成功。
7984
+ # <ul><li> **0**:失败 </li>
7985
+ # <li> **1**:成功 </li></ul>
7974
7986
  # @type Status: Integer
7975
7987
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7976
7988
  # @type RequestId: String
@@ -7990,13 +8002,15 @@ module TencentCloud
7990
8002
 
7991
8003
  # UpdateIntegrationEmployees请求参数结构体
7992
8004
  class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
7993
- # @param Operator: 当前用户信息,UserId必填
8005
+ # @param Operator: 执行本接口操作的员工信息,UserId必填。
8006
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
7994
8007
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
7995
8008
  # @param Employees: 员工信息,不超过100个。
7996
8009
  # 根据UserId或OpenId更新员工,必填一个,优先UserId。
7997
8010
  # 可更新Mobile、DisplayName、Email和Department.DepartmentId字段,其他字段暂不支持
7998
8011
  # @type Employees: Array
7999
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
8012
+ # @param Agent: 代理企业和员工的信息。
8013
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8000
8014
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
8001
8015
 
8002
8016
  attr_accessor :Operator, :Employees, :Agent
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.661
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-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common