tencentcloud-sdk-ess 3.0.658 → 3.0.660

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: d082f169231143a032c3fc356d0d7a645eb6f0a5
4
- data.tar.gz: 323b167fd95e76dde617be89ca4eaa6d075f675d
3
+ metadata.gz: 9eed30651867f40a38aa3196b66dabb8e2515a2b
4
+ data.tar.gz: 961e2478e0a7529f550a907ed111e5f2b7427354
5
5
  SHA512:
6
- metadata.gz: 7268ec91991184f29b9ffcaf9e4b072c32df22765ab3ee4eb390567a60b925946f736fb5e05d666471d28fb9cecc023988e728910c3aecf638c8429a16c32415
7
- data.tar.gz: 1c09c28a79a3d8e7913ec1d8571c58c4022a1262685c6f92fe570d1d1070b7278ae467780ebea33852068d1a43137bcb3f36d19d0550615bae6fd5fc89142fa7
6
+ metadata.gz: 0823a3c206f92087891e07317f92aeb3640e3adfe01012b76028820f66b9b27b8a7ee554b469a32a1badeae7d724e6052ff01812321a0f1dfb934700904248ac
7
+ data.tar.gz: 2813e4efbb3c840c2fd89654bf4f9791cd1193fc47b82a6cf086da6b0e4ca93a71a9df3fcde8bcce7a6ae3e7b0f763ded7929aae21affee8a719989e15e7745b
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.658
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`
@@ -327,9 +335,15 @@ module TencentCloud
327
335
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
328
336
  end
329
337
 
330
- # 创建出证报告并返回报告ID。
331
- # 使用此功能需搭配出证套餐。
332
- # 注意:出证过程需一定时间,建议在调用创建出证后的24小时之后,通过DescribeFlowEvidenceReport接口进行查询。
338
+ # 提交申请出证报告任务并返回报告ID。
339
+
340
+ # 注意:
341
+ # <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
342
+ # <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
343
+ # <li>合同流程必须所有参与方`已经签署完成`。</li>
344
+ # <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
345
+
346
+ # <svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
333
347
 
334
348
  # @param request: Request instance for CreateFlowEvidenceReport.
335
349
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowEvidenceReportRequest`
@@ -353,9 +367,11 @@ module TencentCloud
353
367
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
354
368
  end
355
369
 
356
- # 此接口(CreateFlowGroupByFiles)通过多文件创建合同组签署流程。<br/>
357
- # PDF资源Id 通过上传文件接口获取
358
- # 此接口合同组中的子合同必须都是文件发起的合同
370
+ # 此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。
371
+
372
+ # 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
373
+
374
+ # 注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
359
375
 
360
376
  # @param request: Request instance for CreateFlowGroupByFiles.
361
377
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesRequest`
@@ -379,8 +395,9 @@ module TencentCloud
379
395
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
380
396
  end
381
397
 
382
- # 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
383
- # 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
398
+ # 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
399
+
400
+ # 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
384
401
 
385
402
  # @param request: Request instance for CreateFlowGroupByTemplates.
386
403
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesRequest`
@@ -574,7 +591,7 @@ module TencentCloud
574
591
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
575
592
  end
576
593
 
577
- # 绑定员工与对应角色
594
+ # 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
578
595
 
579
596
  # @param request: Request instance for CreateIntegrationUserRoles.
580
597
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationUserRolesRequest`
@@ -635,7 +652,7 @@ module TencentCloud
635
652
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
636
653
  end
637
654
 
638
- # 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。</br>
655
+ # 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
639
656
  # 附注:
640
657
  # - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。
641
658
  # - 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
@@ -668,7 +685,11 @@ module TencentCloud
668
685
 
669
686
  # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
670
687
 
671
- # 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
688
+ # 注:
689
+ # <ul>
690
+ # <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
691
+ # <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
692
+ # </ul>
672
693
 
673
694
  # @param request: Request instance for CreatePersonAuthCertificateImage.
674
695
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
@@ -888,7 +909,8 @@ module TencentCloud
888
909
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
889
910
  end
890
911
 
891
- # 用来创建页面主题配置
912
+ # 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
913
+ # 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准
892
914
 
893
915
  # @param request: Request instance for CreateWebThemeConfig.
894
916
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest`
@@ -963,7 +985,7 @@ module TencentCloud
963
985
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
964
986
  end
965
987
 
966
- # 解绑员工与对应角色关系
988
+ # 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
967
989
 
968
990
  # @param request: Request instance for DeleteIntegrationRoleUsers.
969
991
  # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationRoleUsersRequest`
@@ -1116,7 +1138,15 @@ module TencentCloud
1116
1138
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1117
1139
  end
1118
1140
 
1119
- # 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
1141
+ # 获取出证报告任务执行结果,返回报告 URL
1142
+
1143
+
1144
+
1145
+ # 注意:
1146
+ # <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
1147
+ # <li>需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。</li></ul>
1148
+
1149
+ # <svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
1120
1150
 
1121
1151
  # @param request: Request instance for DescribeFlowEvidenceReport.
1122
1152
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`
@@ -1249,33 +1279,9 @@ module TencentCloud
1249
1279
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1250
1280
  end
1251
1281
 
1252
- # 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
1253
-
1254
- # 通过子企业影子账号查询主企业员工账号
1255
-
1256
- # @param request: Request instance for DescribeIntegrationMainOrganizationUser.
1257
- # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserRequest`
1258
- # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserResponse`
1259
- def DescribeIntegrationMainOrganizationUser(request)
1260
- body = send_request('DescribeIntegrationMainOrganizationUser', request.serialize)
1261
- response = JSON.parse(body)
1262
- if response['Response'].key?('Error') == false
1263
- model = DescribeIntegrationMainOrganizationUserResponse.new
1264
- model.deserialize(response['Response'])
1265
- model
1266
- else
1267
- code = response['Response']['Error']['Code']
1268
- message = response['Response']['Error']['Message']
1269
- reqid = response['Response']['RequestId']
1270
- raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1271
- end
1272
- rescue TencentCloud::Common::TencentCloudSDKException => e
1273
- raise e
1274
- rescue StandardError => e
1275
- raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1276
- end
1282
+ # 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
1277
1283
 
1278
- # 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
1284
+ # 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
1279
1285
 
1280
1286
  # @param request: Request instance for DescribeIntegrationRoles.
1281
1287
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest`
@@ -343,7 +343,7 @@ module TencentCloud
343
343
  # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
344
344
 
345
345
  # <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
346
- # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
346
+ # </ul>
347
347
  # @type LicenseType: Integer
348
348
 
349
349
  attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
@@ -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
@@ -1631,14 +1638,14 @@ module TencentCloud
1631
1638
 
1632
1639
  # CreateFlowEvidenceReport返回参数结构体
1633
1640
  class CreateFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
1634
- # @param ReportId: 出证报告 ID,可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
1641
+ # @param ReportId: 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
1635
1642
  # 注意:此字段可能返回 null,表示取不到有效值。
1636
1643
  # @type ReportId: String
1637
- # @param Status: 出证任务执行的状态, 可能会有以下状态:
1644
+ # @param Status: 出证任务执行的状态, 状态含义如下:
1638
1645
 
1639
- # <ul><li>EvidenceStatusExecuting 出证任务在执行中</li>
1640
- # <li>EvidenceStatusSuccess 出证任务执行成功</li>
1641
- # <li>EvidenceStatusFailed : 出征任务执行失败</li></ul>
1646
+ # <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
1647
+ # <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
1648
+ # <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
1642
1649
  # @type Status: String
1643
1650
  # @param ReportUrl: 此字段已经废除,不再使用.
1644
1651
  # 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
@@ -1669,15 +1676,22 @@ module TencentCloud
1669
1676
 
1670
1677
  # CreateFlowGroupByFiles请求参数结构体
1671
1678
  class CreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
1672
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1679
+ # @param Operator: 执行本接口操作的员工信息。
1680
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1673
1681
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1674
- # @param FlowGroupName: 合同(流程)组名称,最大长度200个字符
1682
+ # @param FlowGroupName: 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1675
1683
  # @type FlowGroupName: String
1676
1684
  # @param FlowGroupInfos: 合同(流程)组的子合同信息,支持2-50个子合同
1677
1685
  # @type FlowGroupInfos: Array
1678
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1686
+ # @param Agent: 代理企业和员工的信息。
1687
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1679
1688
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1680
- # @param FlowGroupOptions: 合同(流程)组的配置项信息。包括是否通知本企业签署方,是否通知其他签署方
1689
+ # @param FlowGroupOptions: 合同(流程)组的配置项信息。
1690
+ # 其中包括:
1691
+ # <ul>
1692
+ # <li>是否通知本企业签署方</li>
1693
+ # <li>是否通知其他签署方</li>
1694
+ # </ul>
1681
1695
  # @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
1682
1696
 
1683
1697
  attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
@@ -1743,15 +1757,22 @@ module TencentCloud
1743
1757
 
1744
1758
  # CreateFlowGroupByTemplates请求参数结构体
1745
1759
  class CreateFlowGroupByTemplatesRequest < TencentCloud::Common::AbstractModel
1746
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1760
+ # @param Operator: 执行本接口操作的员工信息。
1761
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1747
1762
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1748
- # @param FlowGroupName: 合同组名称,最大长度200个字符
1763
+ # @param FlowGroupName: 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1749
1764
  # @type FlowGroupName: String
1750
- # @param FlowGroupInfos: 合同组的子合同信息,支持2-50个子合同
1765
+ # @param FlowGroupInfos: 合同(流程)组的子合同信息,支持2-50个子合同
1751
1766
  # @type FlowGroupInfos: Array
1752
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1767
+ # @param Agent: 代理企业和员工的信息。
1768
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1753
1769
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1754
- # @param FlowGroupOptions: 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
1770
+ # @param FlowGroupOptions: 合同(流程)组的配置项信息。
1771
+ # 其中包括:
1772
+ # <ul>
1773
+ # <li>是否通知本企业签署方</li>
1774
+ # <li>是否通知其他签署方</li>
1775
+ # </ul>
1755
1776
  # @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
1756
1777
 
1757
1778
  attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
@@ -2486,13 +2507,13 @@ module TencentCloud
2486
2507
 
2487
2508
  # CreateIntegrationUserRoles请求参数结构体
2488
2509
  class CreateIntegrationUserRolesRequest < TencentCloud::Common::AbstractModel
2489
- # @param Operator: 操作人信息,UserId必填
2510
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
2490
2511
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2491
2512
  # @param UserIds: 绑定角色的用户id列表,不能重复,不能大于 100 个
2492
2513
  # @type UserIds: Array
2493
- # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
2514
+ # @param RoleIds: 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
2494
2515
  # @type RoleIds: Array
2495
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2516
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2496
2517
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2497
2518
 
2498
2519
  attr_accessor :Operator, :UserIds, :RoleIds, :Agent
@@ -2672,22 +2693,24 @@ module TencentCloud
2672
2693
 
2673
2694
  # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2674
2695
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2675
- # @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。</br>
2676
- # 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。</br>
2696
+ # @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100
2697
+ # 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。
2677
2698
  # 用户将利用链接对这些合同实施批量操作。
2678
2699
  # @type FlowIds: Array
2679
2700
  # @param Agent: 代理企业和员工的信息。
2680
2701
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2681
2702
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2682
- # @param UserId: 员工在腾讯电子签平台的独特身份标识,为32位字符串。</br>
2683
- # 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。</br>
2703
+ # @param UserId: 员工在腾讯电子签平台的独特身份标识,为32位字符串。
2704
+ # 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
2684
2705
  # UserId必须是传入合同(FlowId)中的签署人。
2685
2706
  # - 1. 若UserId为空,Name和Mobile 必须提供。
2686
2707
  # - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
2687
2708
  # @type UserId: String
2688
- # @param Name: 员工姓名,必须与手机号码一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
2709
+ # @param Name: 员工姓名,必须与手机号码一起使用。
2710
+ # 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
2689
2711
  # @type Name: String
2690
- # @param Mobile: 员工手机号,必须与姓名一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
2712
+ # @param Mobile: 员工手机号,必须与姓名一起使用。
2713
+ # 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
2691
2714
  # @type Mobile: String
2692
2715
 
2693
2716
  attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile
@@ -3582,7 +3605,7 @@ module TencentCloud
3582
3605
 
3583
3606
  # CreateUserAutoSignEnableUrl返回参数结构体
3584
3607
  class CreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
3585
- # @param Url: 个人用户自动签的开通链接, 短链形式
3608
+ # @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
3586
3609
  # @type Url: String
3587
3610
  # @param AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3588
3611
 
@@ -3632,15 +3655,16 @@ module TencentCloud
3632
3655
 
3633
3656
  # CreateWebThemeConfig请求参数结构体
3634
3657
  class CreateWebThemeConfigRequest < TencentCloud::Common::AbstractModel
3635
- # @param Operator: 操作人信息
3658
+ # @param Operator: 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3636
3659
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3637
- # @param ThemeType: 主题类型
3638
- # <br/>EMBED_WEB_THEME:嵌入式主题
3639
- # <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
3660
+ # @param ThemeType: 主题类型,取值如下:
3661
+ # <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
3662
+ # </ul>
3640
3663
  # @type ThemeType: String
3641
3664
  # @param WebThemeConfig: 主题配置
3642
3665
  # @type WebThemeConfig: :class:`Tencentcloud::Ess.v20201111.models.WebThemeConfig`
3643
- # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3666
+ # @param Agent: 代理企业和员工的信息。
3667
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3644
3668
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3645
3669
 
3646
3670
  attr_accessor :Operator, :ThemeType, :WebThemeConfig, :Agent
@@ -3799,13 +3823,13 @@ module TencentCloud
3799
3823
 
3800
3824
  # DeleteIntegrationRoleUsers请求参数结构体
3801
3825
  class DeleteIntegrationRoleUsersRequest < TencentCloud::Common::AbstractModel
3802
- # @param Operator: 操作人信息,userId必填
3826
+ # @param Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3803
3827
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3804
- # @param RoleId: 角色id
3828
+ # @param RoleId: 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3805
3829
  # @type RoleId: String
3806
3830
  # @param Users: 用户信息,最多 200 个用户,并且 UserId 和 OpenId 二选一,其他字段不需要传
3807
3831
  # @type Users: Array
3808
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3832
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3809
3833
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3810
3834
 
3811
3835
  attr_accessor :Operator, :RoleId, :Users, :Agent
@@ -4265,7 +4289,7 @@ module TencentCloud
4265
4289
  # @param Operator: 执行本接口操作的员工信息。
4266
4290
  # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4267
4291
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4268
- # @param ReportId: 签署报告编号
4292
+ # @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4269
4293
  # @type ReportId: String
4270
4294
  # @param Agent: 代理企业和员工的信息。
4271
4295
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -4294,15 +4318,14 @@ module TencentCloud
4294
4318
 
4295
4319
  # DescribeFlowEvidenceReport返回参数结构体
4296
4320
  class DescribeFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
4297
- # @param ReportUrl: 出证报告PDF的下载 URL
4321
+ # @param ReportUrl: 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
4298
4322
  # 注意:此字段可能返回 null,表示取不到有效值。
4299
4323
  # @type ReportUrl: String
4300
- # @param Status: 签署报告出证任务的状态
4301
- # <ul>
4302
- # <li>EvidenceStatusExecuting : 出证任务在执行中</li>
4303
- # <li>EvidenceStatusSuccess : 出证任务执行成功</li>
4304
- # <li>EvidenceStatusFailed : 出证任务执行失败</li>
4305
- # </ul>
4324
+ # @param Status: 出证任务执行的状态, 状态含义如下:
4325
+
4326
+ # <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
4327
+ # <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
4328
+ # <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
4306
4329
  # @type Status: String
4307
4330
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4308
4331
  # @type RequestId: String
@@ -4666,64 +4689,30 @@ module TencentCloud
4666
4689
  end
4667
4690
  end
4668
4691
 
4669
- # DescribeIntegrationMainOrganizationUser请求参数结构体
4670
- class DescribeIntegrationMainOrganizationUserRequest < TencentCloud::Common::AbstractModel
4671
- # @param Operator: 操作人信息,userId必填
4672
- # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4673
-
4674
- attr_accessor :Operator
4675
-
4676
- def initialize(operator=nil)
4677
- @Operator = operator
4678
- end
4679
-
4680
- def deserialize(params)
4681
- unless params['Operator'].nil?
4682
- @Operator = UserInfo.new
4683
- @Operator.deserialize(params['Operator'])
4684
- end
4685
- end
4686
- end
4687
-
4688
- # DescribeIntegrationMainOrganizationUser返回参数结构体
4689
- class DescribeIntegrationMainOrganizationUserResponse < TencentCloud::Common::AbstractModel
4690
- # @param IntegrationMainOrganizationUser: 主企业员工账号信息
4691
- # 注意:此字段可能返回 null,表示取不到有效值。
4692
- # @type IntegrationMainOrganizationUser: :class:`Tencentcloud::Ess.v20201111.models.IntegrationMainOrganizationUser`
4693
- # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4694
- # @type RequestId: String
4695
-
4696
- attr_accessor :IntegrationMainOrganizationUser, :RequestId
4697
-
4698
- def initialize(integrationmainorganizationuser=nil, requestid=nil)
4699
- @IntegrationMainOrganizationUser = integrationmainorganizationuser
4700
- @RequestId = requestid
4701
- end
4702
-
4703
- def deserialize(params)
4704
- unless params['IntegrationMainOrganizationUser'].nil?
4705
- @IntegrationMainOrganizationUser = IntegrationMainOrganizationUser.new
4706
- @IntegrationMainOrganizationUser.deserialize(params['IntegrationMainOrganizationUser'])
4707
- end
4708
- @RequestId = params['RequestId']
4709
- end
4710
- end
4711
-
4712
4692
  # DescribeIntegrationRoles请求参数结构体
4713
4693
  class DescribeIntegrationRolesRequest < TencentCloud::Common::AbstractModel
4714
- # @param Operator: 操作人信息,UserId必填
4694
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写UserId
4695
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4715
4696
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4716
- # @param Limit: 指定每页多少条数据,单页最大200
4697
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4717
4698
  # @type Limit: Integer
4718
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4699
+ # @param Agent: 代理企业和员工的信息。
4700
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4719
4701
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4720
- # @param Filters: 查询的关键字段:
4721
- # Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
4722
- # Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
4723
- # Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
4724
- # 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>
4725
4714
  # @type Filters: Array
4726
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4715
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
4727
4716
  # @type Offset: Integer
4728
4717
 
4729
4718
  attr_accessor :Operator, :Limit, :Agent, :Filters, :Offset
@@ -4760,13 +4749,13 @@ module TencentCloud
4760
4749
 
4761
4750
  # DescribeIntegrationRoles返回参数结构体
4762
4751
  class DescribeIntegrationRolesResponse < TencentCloud::Common::AbstractModel
4763
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4752
+ # @param Offset: 指定分页返回的页码。页码从0开始,最大为2000
4764
4753
  # @type Offset: Integer
4765
- # @param Limit: 指定每页多少条数据,单页最大200
4754
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 200
4766
4755
  # @type Limit: Integer
4767
- # @param TotalCount: 符合查询条件的总的角色数
4756
+ # @param TotalCount: 符合查询条件的总角色数。
4768
4757
  # @type TotalCount: Integer
4769
- # @param IntegrateRoles: 企业角色信息列表
4758
+ # @param IntegrateRoles: 企业角色信息列表。
4770
4759
  # @type IntegrateRoles: Array
4771
4760
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4772
4761
  # @type RequestId: String
@@ -5103,8 +5092,7 @@ module TencentCloud
5103
5092
  # @type LicenseTo: Integer
5104
5093
  # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
5105
5094
 
5106
- # <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
5107
- # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
5095
+ # <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
5108
5096
  # @type LicenseType: Integer
5109
5097
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5110
5098
  # @type RequestId: String
@@ -5422,21 +5410,24 @@ module TencentCloud
5422
5410
 
5423
5411
  # 补充签署人信息
5424
5412
  # - RecipientId 必须指定
5425
- # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5413
+ # - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
5426
5414
  # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
5427
5415
  class FillApproverInfo < TencentCloud::Common::AbstractModel
5428
- # @param RecipientId: 对应模板中的参与方ID
5416
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5417
+ # 模板发起合同时,该参数为必填项。
5418
+ # 文件发起合同是,该参数无需传值。
5419
+ # 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5429
5420
  # @type RecipientId: String
5430
5421
  # @param ApproverSource: 签署人来源
5431
5422
  # WEWORKAPP: 企业微信
5432
5423
  # <br/>仅【企微或签】时指定WEWORKAPP
5433
5424
  # @type ApproverSource: String
5434
- # @param CustomUserId: 企业自定义账号ID
5435
- # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
5425
+ # @param CustomUserId: 企业微信UserId
5426
+ # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
5436
5427
  # @type CustomUserId: String
5437
- # @param ApproverName: 补充签署人姓名
5428
+ # @param ApproverName: 补充企业签署人员工姓名
5438
5429
  # @type ApproverName: String
5439
- # @param ApproverMobile: 补充签署人手机号
5430
+ # @param ApproverMobile: 补充企业签署人员工手机号
5440
5431
  # @type ApproverMobile: String
5441
5432
 
5442
5433
  attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile
@@ -5754,9 +5745,10 @@ module TencentCloud
5754
5745
  # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5755
5746
  # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5756
5747
  # @type ApproverIdCardNumber: String
5757
- # @param RecipientId: 签署方经办人在模板中的参与方ID
5758
- # <br/>模板发起合同时,该参数为必填项
5759
- # <br/>文件发起合同是,该参数无序传值
5748
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
5749
+ # 模板发起合同时,该参数为必填项。
5750
+ # 文件发起合同是,该参数无需传值。
5751
+ # 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
5760
5752
  # @type RecipientId: String
5761
5753
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
5762
5754
 
@@ -6021,34 +6013,63 @@ module TencentCloud
6021
6013
 
6022
6014
  # 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
6023
6015
  class FlowGroupInfo < TencentCloud::Common::AbstractModel
6024
- # @param FlowName: 合同(流程)的名称
6016
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
6017
+ # 该名称还将用于合同签署完成后的下载文件名。
6025
6018
  # @type FlowName: String
6026
- # @param Approvers: 合同(流程)的签署方信息
6019
+ # @param Approvers: 签署流程参与者信息,最大限制50方
6020
+ # 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
6027
6021
  # @type Approvers: Array
6028
- # @param FileIds: 发起合同(流程)的资源Id,此资源必须是PDF文件,来自UploadFiles,使用文件发起合同(流程)组时必传
6022
+ # @param FileIds: 文件资源ID,通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得,为32位字符串。
6023
+ # 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
6029
6024
  # @type FileIds: Array
6030
- # @param TemplateId: 发起合同(流程)的模板Id,用模板发起合同(流程)组时必填
6025
+ # @param TemplateId: 合同模板ID,为32位字符串。
6026
+ # 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
6027
+ # 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
6031
6028
  # @type TemplateId: String
6032
- # @param FlowType: 合同(流程)的类型
6029
+ # @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
6030
+ # 示例值:劳务合同
6033
6031
  # @type FlowType: String
6034
- # @param FlowDescription: 合同(流程)的描述
6032
+ # @param FlowDescription: 签署流程描述,最大长度1000个字符
6035
6033
  # @type FlowDescription: String
6036
- # @param Deadline: 合同(流程)的截止时间戳,单位秒。默认是一年
6034
+ # @param Deadline: 签署流程的签署截止时间。
6035
+
6036
+ # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
6037
+ # 示例值:1604912664
6037
6038
  # @type Deadline: Integer
6038
6039
  # @param CallbackUrl: 合同(流程)的回调地址
6039
6040
  # @type CallbackUrl: String
6040
- # @param UserData: 第三方平台传递过来的信息, 限制1024字符 格式必须是base64的
6041
+ # @param UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
6042
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
6043
+ # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
6041
6044
  # @type UserData: String
6042
- # @param Unordered: 合同(流程)的签署是否是无序签, true - 无序。 false - 有序, 默认
6045
+ # @param Unordered: 发送类型:
6046
+ # true:无序签
6047
+ # false:有序签
6048
+ # 注:默认为false(有序签),请和模板中的配置保持一致
6049
+ # 示例值:true
6043
6050
  # @type Unordered: Boolean
6044
- # @param Components: 合同(流程)发起方的填写控件, 由发起方进行在发起时进行填充
6051
+ # @param Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
6052
+ # <ul><li>单行文本控件</li>
6053
+ # <li>多行文本控件</li>
6054
+ # <li>勾选框控件</li>
6055
+ # <li>数字控件</li>
6056
+ # <li>图片控件</li>
6057
+ # <li>动态表格等填写控件</li></ul>
6045
6058
  # @type Components: Array
6046
- # @param NeedSignReview: 本企业(发起方)是否需要签署审批,若需要审批则只允许查看不允许签署,需要您调用接口CreateFlowSignReview提交审批结果。
6059
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
6060
+ # 若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
6061
+
6062
+ # 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
6063
+ # 示例值:true
6047
6064
  # @type NeedSignReview: Boolean
6048
- # @param AutoSignScene: 本企业(发起方)自动签署,需要您在发起合同时给印章控件指定自动签的印章。
6065
+ # @param AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
6066
+ # 示例值:E_PRESCRIPTION_AUTO_SIGN
6049
6067
  # @type AutoSignScene: String
6050
6068
 
6051
6069
  attr_accessor :FlowName, :Approvers, :FileIds, :TemplateId, :FlowType, :FlowDescription, :Deadline, :CallbackUrl, :UserData, :Unordered, :Components, :NeedSignReview, :AutoSignScene
6070
+ extend Gem::Deprecate
6071
+ deprecate :CallbackUrl, :none, 2023, 9
6072
+ deprecate :CallbackUrl=, :none, 2023, 9
6052
6073
 
6053
6074
  def initialize(flowname=nil, approvers=nil, fileids=nil, templateid=nil, flowtype=nil, flowdescription=nil, deadline=nil, callbackurl=nil, userdata=nil, unordered=nil, components=nil, needsignreview=nil, autosignscene=nil)
6054
6075
  @FlowName = flowname
@@ -6099,16 +6120,18 @@ module TencentCloud
6099
6120
 
6100
6121
  # 此结构体(FlowGroupOptions)描述的是合同组的个性化配置,支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证(仅在合同组文件发起配置时生效)
6101
6122
  class FlowGroupOptions < TencentCloud::Common::AbstractModel
6102
- # @param ApproverVerifyType: 发起合同(流程)组的合同(流程)签署人校验方式
6103
- # VerifyCheck: 人脸识别(默认)
6104
- # MobileCheck:手机号验证
6123
+ # @param ApproverVerifyType: 签署人校验方式,支持以下类型
6124
+ # <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
6125
+ # <li>MobileCheck : 手机号验证</li></ul>
6105
6126
  # 参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
6106
6127
  # @type ApproverVerifyType: String
6107
6128
  # @param SelfOrganizationApproverNotifyType: 发起合同(流程)组本方企业经办人通知方式
6108
- # 签署通知类型:sms--短信,none--不通知
6129
+ # 签署通知类型,支持以下类型
6130
+ # <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
6109
6131
  # @type SelfOrganizationApproverNotifyType: String
6110
6132
  # @param OtherApproverNotifyType: 发起合同(流程)组他方经办人通知方式
6111
- # 签署通知类型:sms--短信,none--不通知
6133
+ # 签署通知类型,支持以下类型
6134
+ # <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
6112
6135
  # @type OtherApproverNotifyType: String
6113
6136
 
6114
6137
  attr_accessor :ApproverVerifyType, :SelfOrganizationApproverNotifyType, :OtherApproverNotifyType
@@ -6599,33 +6622,6 @@ module TencentCloud
6599
6622
  end
6600
6623
  end
6601
6624
 
6602
- # 主企业员工账号信息
6603
- class IntegrationMainOrganizationUser < TencentCloud::Common::AbstractModel
6604
- # @param MainOrganizationId: 主企业id
6605
- # 注意:此字段可能返回 null,表示取不到有效值。
6606
- # @type MainOrganizationId: String
6607
- # @param MainUserId: 主企业员工UserId
6608
- # 注意:此字段可能返回 null,表示取不到有效值。
6609
- # @type MainUserId: String
6610
- # @param UserName: 主企业员工名
6611
- # 注意:此字段可能返回 null,表示取不到有效值。
6612
- # @type UserName: String
6613
-
6614
- attr_accessor :MainOrganizationId, :MainUserId, :UserName
6615
-
6616
- def initialize(mainorganizationid=nil, mainuserid=nil, username=nil)
6617
- @MainOrganizationId = mainorganizationid
6618
- @MainUserId = mainuserid
6619
- @UserName = username
6620
- end
6621
-
6622
- def deserialize(params)
6623
- @MainOrganizationId = params['MainOrganizationId']
6624
- @MainUserId = params['MainUserId']
6625
- @UserName = params['UserName']
6626
- end
6627
- end
6628
-
6629
6625
  # ModifyApplicationCallbackInfo请求参数结构体
6630
6626
  class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
6631
6627
  # @param Operator: 执行本接口操作的员工信息。
@@ -8262,13 +8258,12 @@ module TencentCloud
8262
8258
  # 页面主题配置
8263
8259
  class WebThemeConfig < TencentCloud::Common::AbstractModel
8264
8260
  # @param DisplaySignBrandLogo: 是否显示页面底部电子签logo,取值如下:
8265
- # <ul>
8266
- # <li> **true**:页面底部显示电子签logo</li>
8267
- # <li> **false**:页面底部不显示电子签logo(默认)</li>
8268
- # </ul>
8261
+ # <ul><li> **true**:页面底部显示电子签logo</li>
8262
+ # <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
8269
8263
  # @type DisplaySignBrandLogo: Boolean
8270
- # @param WebEmbedThemeColor: 主题颜色
8271
- # <br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
8264
+ # @param WebEmbedThemeColor: 主题颜色:
8265
+ # 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
8266
+ # <br/>
8272
8267
  # @type WebEmbedThemeColor: String
8273
8268
 
8274
8269
  attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor
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.658
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-13 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