tencentcloud-sdk-essbasic 3.0.686 → 3.0.688

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: 251d3f753ebc7815cf3177eefd16a83296b2d570
4
- data.tar.gz: 3b837f0f9345ffadbde849a16f4faeade720dfab
3
+ metadata.gz: e9034e10361d2d7499e49ae40f635c00ae096d1b
4
+ data.tar.gz: 092c64090f84480a7038f8ee2111bbd8912efd90
5
5
  SHA512:
6
- metadata.gz: 1236a771f7c0a380d362b7d4a1d241c390e611c92c6de96bebf754107a883c32a31e7f396244de08f5ec1e8509f46d73f48a2c5c4346e1f43dbd445e6ddf1d18
7
- data.tar.gz: 1b162a653c13b6f1332cc667851ffa366f7f54892980f4da78f02d2393776e79456b377f972e439ca7fc8b3e04f3eca617623f2c3deb6f4a9dec0afee93b5ea1
6
+ metadata.gz: d1dd687cb98ba736b92bebdd5bf0aa05389853935f012ce33596e1848401bc36df106bc588b0fe35b05250b47c3923a03d4f3a28c82506a79402bc915a3dfcbb
7
+ data.tar.gz: beef8ac476ecf0f8f885a6fcb9a28839cec5f6e313374cf5c4bf4731fe7dba64787f86a101a93056059aa5e0f611087cb84b0d4d4822e86b59fd5b9ecb6aa418
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.686
1
+ 3.0.688
@@ -29,18 +29,22 @@ module TencentCloud
29
29
  end
30
30
 
31
31
 
32
- # 指定需要批量撤销的签署流程Id,批量撤销合同
33
- # 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
34
-
35
- # 可以撤回:未全部签署完成
36
- # 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
37
-
38
- # **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
39
-
40
- # **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
41
-
42
- # **注意:
43
- # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
32
+ # 用于批量撤销合同流程<br/>
33
+ # 适用场景:
34
+ # 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
35
+ # 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
36
+ # - 已全部签署完成
37
+ # - 已拒签
38
+ # - 已过期
39
+ # - 已撤回
40
+ # - 拒绝填写
41
+ # - 已解除
42
+
43
+ # <br/>
44
+ # 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
45
+ # <br/><br/>
46
+ # 注:
47
+ # `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
44
48
 
45
49
  # @param request: Request instance for ChannelBatchCancelFlows.
46
50
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
@@ -64,9 +68,14 @@ module TencentCloud
64
68
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
65
69
  end
66
70
 
67
- # 撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
68
- # 注意:
69
- # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
71
+ # 撤销签署流程接口
72
+
73
+ # 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
74
+ # <ul><li> `可撤回合同状态` :未全部签署完成</li>
75
+ # <li> `不撤回合同状态` :已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
76
+ # 注:
77
+ # <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人` </li>
78
+ # <li>签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
70
79
 
71
80
  # @param request: Request instance for ChannelCancelFlow.
72
81
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowRequest`
@@ -610,7 +619,6 @@ module TencentCloud
610
619
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
611
620
  end
612
621
 
613
- # 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
614
622
  # 该接口用于发起合同后,生成C端签署人的签署链接<br/>
615
623
  # 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
616
624
  # 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
@@ -1135,7 +1143,9 @@ module TencentCloud
1135
1143
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1136
1144
  end
1137
1145
 
1138
- # 企业方可以通过此接口查询个人用户自动签开启状态
1146
+ # 通过此接口获取个人用户自动签的开通状态。
1147
+
1148
+ # 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
1139
1149
 
1140
1150
  # @param request: Request instance for ChannelDescribeUserAutoSignStatus.
1141
1151
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeUserAutoSignStatusRequest`
@@ -1159,7 +1169,13 @@ module TencentCloud
1159
1169
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1160
1170
  end
1161
1171
 
1162
- # 企业方可以通过此接口关闭个人的自动签功能
1172
+ # 通过此接口可以关闭个人用户自动签功能。
1173
+ # 无需对应的用户刷脸等方式同意即可关闭。
1174
+
1175
+ # 注意:
1176
+
1177
+ # <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
1178
+ # <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
1163
1179
 
1164
1180
  # @param request: Request instance for ChannelDisableUserAutoSign.
1165
1181
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDisableUserAutoSignRequest`
@@ -1373,16 +1389,39 @@ module TencentCloud
1373
1389
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1374
1390
  end
1375
1391
 
1376
- # 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
1377
- # 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下:
1378
- # 1. 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。
1379
- # 2. 若子客企业已激活,员工未激活,则会进入经办人激活流程。
1380
- # 3. 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
1392
+ # 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
1381
1393
 
1394
+ # Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:
1395
+ # <table>
1396
+ # <thead>
1397
+ # <tr>
1398
+ # <th>子客企业状态</th>
1399
+ # <th>子客企业员工状态</th>
1400
+ # <th>点击链接进入的流程</th>
1401
+ # </tr>
1402
+ # </thead>
1403
+ # <tbody>
1404
+ # <tr>
1405
+ # <td>企业未激活</td>
1406
+ # <td>员工未认证</td>
1407
+ # <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
1408
+ # </tr>
1409
+ # <tr>
1410
+ # <td>企业已激活</td>
1411
+ # <td>员工未认证</td>
1412
+ # <td>进入员认证并加入企业流程</td>
1413
+ # </tr>
1414
+ # <tr>
1415
+ # <td>企业已激活</td>
1416
+ # <td>员工已认证</td>
1417
+ # <td>进入子客企业Web控制台</td>
1418
+ # </tr>
1419
+ # </tbody>
1420
+ # </table>
1382
1421
  # 如果是企业激活流程,需要注意如下情况:
1383
1422
 
1384
- # 1. 若在激活过程中,更换用户OpenID重新生成链接,之前的认证会被清理。因此不要在认证过程中多人同时操作,导致认证过程互相影响。
1385
- # 2. 若您认证中发现信息有误需要重新认证,可以通过更换OpenID重新生成链接的方式,来清理掉已有的流程。
1423
+ # 1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
1424
+ # 2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
1386
1425
 
1387
1426
  # @param request: Request instance for CreateConsoleLoginUrl.
1388
1427
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
@@ -1511,37 +1550,25 @@ module TencentCloud
1511
1550
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1512
1551
  end
1513
1552
 
1514
- # 创建跳转小程序查看或签署的链接。
1515
-
1516
- # 跳转小程序的几种方式:主要是设置不同的EndPoint
1517
- # 1. 通过链接Url直接跳转到小程序,不需要返回
1518
- # 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
1519
-
1520
- # 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
1521
- # 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
1522
-
1523
- # 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
1524
- # 跳转到小程序的实现,参考官方文档
1525
- # https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
1526
- # 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
1527
- # 使用CreateSignUrls,设置EndPoint为APP,得到path。
1553
+ # 创建跳转小程序查看或签署的链接
1528
1554
 
1529
- # 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
1530
- # 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
1531
- # 全屏方式:
1532
- # (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html )
1533
- # 半屏方式:
1534
- # (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html )
1535
- # 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
1536
- # 使用CreateSignUrls,设置EndPoint为APP,得到path。
1537
-
1538
- # 其中小程序的原始Id如下,或者查看小程序信息自助获取。
1555
+ # **腾讯电子签小程序的的AppID 和 原始Id如下:**
1539
1556
 
1540
1557
  # | 小程序 | AppID | 原始ID |
1541
1558
  # | ------------ | ------------ | ------------ |
1542
1559
  # | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
1543
1560
  # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1544
1561
 
1562
+ # **主要使用场景可以更加EndPoint分类如下**
1563
+
1564
+ # |EndPoint| 场景| 说明和示例|
1565
+ # | ---- | ---- | --- |
1566
+ # | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
1567
+ # | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
1568
+ # | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
1569
+ # |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
1570
+ # |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
1571
+
1545
1572
  # @param request: Request instance for CreateSignUrls.
1546
1573
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsRequest`
1547
1574
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsResponse`
@@ -1644,8 +1671,18 @@ module TencentCloud
1644
1671
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1645
1672
  end
1646
1673
 
1647
- # 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
1648
- # 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
1674
+ # 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
1675
+
1676
+ # **注意**:
1677
+ # 有两种开通权限的途径
1678
+
1679
+ # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1680
+ # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1681
+
1682
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
1683
+
1684
+ # **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1685
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
1649
1686
 
1650
1687
  # @param request: Request instance for DescribeResourceUrlsByFlows.
1651
1688
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeResourceUrlsByFlowsRequest`
@@ -1728,9 +1765,14 @@ module TencentCloud
1728
1765
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1729
1766
  end
1730
1767
 
1731
- # 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
1732
- # 当前接口限制最多合同(流程)50个.
1733
- # 返回的链接只能使用一次
1768
+ # 此接口(GetDownloadFlowUrl)用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
1769
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png)
1770
+
1771
+ # 注:
1772
+ # <ul>
1773
+ # <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
1774
+ # <li> **链接仅可使用一次**,不可重复使用</li>
1775
+ # </ul>
1734
1776
 
1735
1777
  # @param request: Request instance for GetDownloadFlowUrl.
1736
1778
  # @type request: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlRequest`
@@ -1921,12 +1963,19 @@ module TencentCloud
1921
1963
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1922
1964
  end
1923
1965
 
1924
- # 此接口(UploadFiles)用于文件上传。
1925
- # 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
1926
- # 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
1927
- # 代码示例:
1966
+ # 此接口(UploadFiles)文件上传。<br/>
1967
+
1968
+ # 适用场景:用于合同,印章的文件上传。文件上传以后,
1969
+ # 如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
1970
+ # 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
1971
+
1972
+ # 注:
1973
+ # 1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
1974
+ # 2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn,正式环境需要设置为file.ess.tencent.cn,代码示例`
1975
+ # ```
1928
1976
  # HttpProfile httpProfile = new HttpProfile();
1929
1977
  # httpProfile.setEndpoint("file.test.ess.tencent.cn");
1978
+ # ```
1930
1979
 
1931
1980
  # @param request: Request instance for UploadFiles.
1932
1981
  # @type request: :class:`Tencentcloud::essbasic::V20210526::UploadFilesRequest`
@@ -385,12 +385,19 @@ module TencentCloud
385
385
  # @type FlowIds: Array
386
386
  # @param CancelMessage: 撤销理由,不超过200个字符
387
387
  # @type CancelMessage: String
388
- # @param CancelMessageFormat: 撤销理由自定义格式;选项:
389
-
390
- # - 0 默认格式
391
- # - 1 只保留身份信息:展示为【发起方】
392
- # - 2 保留身份信息+企业名称:展示为【发起方xxx公司】
393
- # - 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
388
+ # @param CancelMessageFormat: 撤销理由自定义格式,支持以下格式
389
+ # <ul><li>0 : 默认值</li>
390
+ # <li>1 : 只保留身份信息</li>
391
+ # <li>2 : 保留身份信息+企业名称</li>
392
+ # <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
393
+ # 例如,假设合同的发起方是典子谦示例企业的经办人张三,撤销理由是"合同内容错误,需要修正",合同撤销后,各签署方看到的撤销理由是会是
394
+
395
+ # 0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
396
+ # 1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
397
+ # 2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
398
+ # 3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
399
+
400
+ # 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
394
401
  # @type CancelMessageFormat: Integer
395
402
  # @param Operator: 暂未开放
396
403
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -445,17 +452,30 @@ module TencentCloud
445
452
 
446
453
  # ChannelCancelFlow请求参数结构体
447
454
  class ChannelCancelFlowRequest < TencentCloud::Common::AbstractModel
448
- # @param FlowId: 签署流程编号
455
+ # @param FlowId: 要撤销的合同流程ID
449
456
  # @type FlowId: String
450
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
457
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
458
+
459
+ # 此接口下面信息必填。
460
+ # <ul>
461
+ # <li>渠道应用标识: Agent.AppId</li>
462
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
463
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
464
+ # </ul>
465
+ # 第三方平台子客企业和员工必须已经经过实名认证
451
466
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
452
- # @param CancelMessage: 撤回原因,最大不超过200字符
467
+ # @param CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
453
468
  # @type CancelMessage: String
454
- # @param CancelMessageFormat: 撤销理由自定义格式;选项:
455
- # 0 默认格式
456
- # 1 只保留身份信息:展示为【发起方】
457
- # 2 保留身份信息+企业名称:展示为【发起方xxx公司】
458
- # 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
469
+ # @param CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
470
+
471
+ # **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
472
+ # **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
473
+ # **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
474
+ # **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
475
+
476
+ # 注: `CancelMessage为撤销当前合同的理由`
477
+
478
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
459
479
  # @type CancelMessageFormat: Integer
460
480
  # @param Operator: 暂未开放
461
481
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1291,11 +1311,11 @@ module TencentCloud
1291
1311
 
1292
1312
  # 此接口下面信息必填。
1293
1313
  # <ul>
1294
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1295
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1296
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1314
+ # <li>渠道应用标识: Agent.AppId</li>
1315
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1316
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
1297
1317
  # </ul>
1298
- # 子客企业和子客企业中的员工比较走完创建和实名过程
1318
+ # 第三方平台子客企业和员工必须已经经过实名认证
1299
1319
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1300
1320
  # @param ApproverVerifyType: 合同组中签署人校验和认证的方式:
1301
1321
  # <ul><li>**VerifyCheck**:人脸识别(默认)</li>
@@ -1358,7 +1378,7 @@ module TencentCloud
1358
1378
  # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。
1359
1379
 
1360
1380
  # 注:
1361
- # `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
1381
+ # `此数组的顺序和入参中的FlowGroupInfos顺序一致`
1362
1382
  # 注意:此字段可能返回 null,表示取不到有效值。
1363
1383
  # @type FlowIds: Array
1364
1384
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1385,11 +1405,11 @@ module TencentCloud
1385
1405
 
1386
1406
  # 此接口下面信息必填。
1387
1407
  # <ul>
1388
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1389
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1390
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1408
+ # <li>渠道应用标识: Agent.AppId</li>
1409
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1410
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
1391
1411
  # </ul>
1392
- # 子客企业和子客企业中的员工比较走完创建和实名过程
1412
+ # 第三方平台子客企业和员工必须已经经过实名认证
1393
1413
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1394
1414
  # @param FlowInfos: 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。
1395
1415
  # @type FlowInfos: Array
@@ -1429,7 +1449,7 @@ module TencentCloud
1429
1449
  # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。
1430
1450
 
1431
1451
  # 注:
1432
- # `此数组的顺序和入参中的FlowInfos顺序回不一致`
1452
+ # `此数组的顺序和入参中的FlowInfos顺序一致`
1433
1453
  # @type FlowIds: Array
1434
1454
  # @param TaskInfos: 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1435
1455
  # 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
@@ -3061,14 +3081,17 @@ module TencentCloud
3061
3081
 
3062
3082
  # ChannelDescribeUserAutoSignStatus请求参数结构体
3063
3083
  class ChannelDescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
3064
- # @param Agent: 渠道应用相关信息
3084
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3065
3085
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3066
- # @param SceneKey: 自动签场景:
3067
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
3086
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
3087
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3088
+
3089
+ # 注: `现在仅支持电子处方场景`
3068
3090
  # @type SceneKey: String
3069
- # @param UserInfo: 查询开启状态的用户信息
3091
+ # @param UserInfo: 要查询状态的用户信息, 包括名字,身份证等
3070
3092
  # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
3071
- # @param Operator: 操作人信息
3093
+ # @param Operator: 执行本接口操作的员工信息。
3094
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3072
3095
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3073
3096
 
3074
3097
  attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -3099,13 +3122,19 @@ module TencentCloud
3099
3122
 
3100
3123
  # ChannelDescribeUserAutoSignStatus返回参数结构体
3101
3124
  class ChannelDescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
3102
- # @param IsOpen: 是否开通
3125
+ # @param IsOpen: 查询用户是否已开通自动签
3103
3126
  # @type IsOpen: Boolean
3104
- # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
3127
+ # @param LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
3128
+
3129
+ # 值为unix时间戳,单位为秒。
3105
3130
  # @type LicenseFrom: Integer
3106
- # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
3131
+ # @param LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
3132
+
3133
+ # 值为unix时间戳,单位为秒。
3107
3134
  # @type LicenseTo: Integer
3108
- # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
3135
+ # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
3136
+
3137
+ # <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
3109
3138
  # @type LicenseType: Integer
3110
3139
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3111
3140
  # @type RequestId: String
@@ -3131,14 +3160,15 @@ module TencentCloud
3131
3160
 
3132
3161
  # ChannelDisableUserAutoSign请求参数结构体
3133
3162
  class ChannelDisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
3134
- # @param Agent: 渠道应用相关信息
3163
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3135
3164
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3136
- # @param SceneKey: 自动签场景:
3137
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
3165
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
3166
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
3138
3167
  # @type SceneKey: String
3139
- # @param UserInfo: 关闭自动签的个人的三要素
3168
+ # @param UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
3140
3169
  # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
3141
- # @param Operator: 操作人信息
3170
+ # @param Operator: 执行本接口操作的员工信息。
3171
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3142
3172
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3143
3173
 
3144
3174
  attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -4088,64 +4118,70 @@ module TencentCloud
4088
4118
 
4089
4119
  # CreateConsoleLoginUrl请求参数结构体
4090
4120
  class CreateConsoleLoginUrlRequest < TencentCloud::Common::AbstractModel
4091
- # @param Agent: 应用信息
4092
- # 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
4121
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
4122
+ # 此接口下面信息必填。
4123
+ # <ul>
4124
+ # <li>渠道应用标识: Agent.AppId</li>
4125
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4126
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
4127
+ # </ul>注:
4128
+ # `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识, 建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
4129
+ # `2. 员工认证时, 此时的Agent.ProxyOrganizationOpenId将会是员工认证加入企业后的唯一标识, 建议开发者保存此员工的penId, 后续各项接口调用皆需要此参数。 `
4130
+ # `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一, 员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)`
4093
4131
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4094
- # @param ProxyOrganizationName: 子客企业名称,最大长度64个字符
4095
- # 注意:
4096
- # 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
4097
- # 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
4132
+ # @param ProxyOrganizationName: 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
4133
+
4134
+ # 注:
4135
+ # `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
4136
+ # `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。 `
4098
4137
  # @type ProxyOrganizationName: String
4099
4138
  # @param UniformSocialCreditCode: 子客企业统一社会信用代码,最大长度200个字符
4100
- # 注意:
4101
- # 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
4139
+ # 注意:`如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效`。
4102
4140
  # @type UniformSocialCreditCode: String
4103
- # @param ProxyOperatorName: 子客企业经办人的姓名,最大长度50个字符
4104
- # 注意:
4105
- # 1、若经办人已经实名,这里修改经办人名字传入将不会生效。
4106
- # 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
4141
+ # @param ProxyOperatorName: 子客企业员工的姓名,最大长度50个字符, 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
4142
+
4143
+ # 注:`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人名字传入将不会生效`
4107
4144
  # @type ProxyOperatorName: String
4108
- # @param Module: PC控制台登录后进入该参数指定的模块,如果不传递,将默认进入控制台首页。支持的模块包括:
4109
- # 1、DOCUMENT:合同管理模块,
4110
- # 2、TEMPLATE:企业模板管理模块,
4111
- # 3、SEAL:印章管理模块,
4112
- # 4、OPERATOR:组织管理模块,
4113
- # 默认将进入企业中心模块
4145
+ # @param Module: Web控制台登录后进入的功能模块, 支持的模块包括:
4146
+ # <ul>
4147
+ # <li> **空值** :(默认)企业中心模块</li>
4148
+ # <li> **DOCUMENT** :合同管理模块</li>
4149
+ # <li> **TEMPLATE** :企业模板管理模块</li>
4150
+ # <li> **SEAL** :印章管理模块</li>
4151
+ # <li> **OPERATOR** :组织管理模块</li></ul>
4114
4152
  # 注意:
4115
4153
  # 1、如果EndPoint选择"CHANNEL"或"APP",该参数仅支持传递"SEAL",进入印章管理模块
4116
- # 2、该参数仅在企业和员工激活完成,登录控制台场景才生效。
4154
+ # 2、该参数**仅在企业和员工激活已经完成,登录控制台场景才生效**。
4117
4155
  # @type Module: String
4118
4156
  # @param ModuleId: 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
4119
- # 根据Module参数的不同所代表的含义不同。当前支持:
4120
- # 1、如果Module="SEAL",ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
4121
- # 2、如果Module="TEMPLATE",ModuleId代表模版Id,登录链接将直接查看指定模版的详情。
4122
- # 3、如果Module="1、DOCUMENT",ModuleId代表合同Id,登录链接将直接查看指定合同的详情。
4123
- # 注意:
4124
- # 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
4125
- # 2、ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到。
4157
+
4158
+ # 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到)。当前支持:
4159
+ # <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模版的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
4160
+ # 注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
4126
4161
  # @type ModuleId: String
4127
4162
  # @param MenuStatus: 是否展示左侧菜单栏
4128
- # "ENABLE": 是,展示
4129
- # DISABLE”: 否,不展示
4130
- # 默认值为ENABLE
4131
- # 注意:
4132
- # 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
4163
+ # <ul><li> **ENABLE** : (默认)进入web控制台展示左侧菜单栏</li>
4164
+ # <li> **DISABLE** : 进入web控制台不展示左侧菜单栏</li></ul>
4165
+ # 注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
4133
4166
  # @type MenuStatus: String
4134
4167
  # @param Endpoint: 生成链接的类型:
4135
- # "PC":PC控制台链接
4136
- # "CHANNEL":H5跳转到电子签小程序链接
4137
- # "APP":第三方APP或小程序跳转电子签小程序链接
4138
- # 默认将生成PC控制台链接
4168
+ # 生成链接的类型
4169
+ # <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
4170
+ # <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
4171
+ # <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
4139
4172
  # @type Endpoint: String
4140
4173
  # @param AutoJumpBackEvent: 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
4141
- # "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
4174
+ # <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
4142
4175
  # @type AutoJumpBackEvent: String
4143
- # @param AuthorizationTypes: 可选的企业授权方式:
4144
- # 1:上传授权书
4145
- # 2:转法定代表人授权
4146
- # 4:企业实名认证(信任第三方认证源)(此项仅支持单选)
4147
- # 未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不生效;选择信任第三方认证源时,请先通过“同步企业信息”接口同步信息。
4148
- # 该参数仅在企业激活场景生效
4176
+ # @param AuthorizationTypes: 可选的此企业允许的授权方式, 可以设置的方式有:
4177
+ # <ul><li>1:上传授权书</li>
4178
+ # <li>2:转法定代表人授权</li>
4179
+ # <li>4:企业实名认证(信任第三方认证源)(此项有排他性, 选择后不能增添其他的方式)</li></ul>
4180
+ # 注:<ul>
4181
+ # <li>未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不对此法人生效`</li>
4182
+ # <li>选择信任第三方认证源时,请先通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization" target="_blank">同步企业信息</a>接口同步信息。</li>
4183
+ # <li>该参数仅在企业未激活时生效</li>
4184
+ # </ul>
4149
4185
  # @type AuthorizationTypes: Array
4150
4186
  # @param Operator: 暂未开放
4151
4187
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -4192,20 +4228,22 @@ module TencentCloud
4192
4228
 
4193
4229
  # CreateConsoleLoginUrl返回参数结构体
4194
4230
  class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
4195
- # @param ConsoleUrl: 子客企业Web控制台url注意事项:
4196
- # 1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
4197
- # 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接在5分钟之内有效,且只能访问一次
4198
- # 3. 若企业认证完成且员工认证完成后,重新获取CHANNEL/APP的链接只要在有效期内(一年)都可以访问
4199
- # 4. 此链接仅单次有效,每次登录需要需要重新创建新的链接,尽量不要做链接存储,多次使用。
4200
- # 5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
4231
+ # @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
4232
+ # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
4233
+ # 注:
4234
+ # `1.链接仅单次有效,每次登录需要需要重新创建新的链接`
4235
+ # `2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
4201
4236
  # @type ConsoleUrl: String
4202
- # @param IsActivated: 子客企业是否已开通腾讯电子签,true-是,false-否
4203
- # 注意:
4204
- # 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码
4237
+ # @param IsActivated: 子客企业是否已开通腾讯电子签,
4238
+ # <ul><li> **true** :已经开通腾讯电子签</li>
4239
+ # <li> **false** :还未开通腾讯电子签</li></ul>
4240
+
4241
+ # 注:`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码`
4205
4242
  # @type IsActivated: Boolean
4206
- # @param ProxyOperatorIsVerified: 当前经办人是否已认证,true-是,false-否
4207
- # 注意:
4208
- # 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名
4243
+ # @param ProxyOperatorIsVerified: 当前经办人是否已认证并加入功能
4244
+ # <ul><li> **true** : 已经认证加入公司</li>
4245
+ # <li> **false** : 还未认证加入公司</li></ul>
4246
+ # 注意:**员工是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名**
4209
4247
  # @type ProxyOperatorIsVerified: Boolean
4210
4248
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4211
4249
  # @type RequestId: String
@@ -4392,9 +4430,9 @@ module TencentCloud
4392
4430
 
4393
4431
  # 此接口下面信息必填。
4394
4432
  # <ul>
4395
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4396
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4397
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4433
+ # <li>渠道应用标识: Agent.AppId</li>
4434
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4435
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
4398
4436
  # </ul>
4399
4437
  # 第三方平台子客企业和员工必须已经经过实名认证
4400
4438
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
@@ -4417,7 +4455,7 @@ module TencentCloud
4417
4455
  # @param SealType: 电子印章类型 , 可选类型如下:
4418
4456
  # <ul><li>**OFFICIAL**: (默认)公章</li>
4419
4457
  # <li>**CONTRACT**: 合同专用章;</li>
4420
- # <li>**FINANCE**: 合财务专用章;</li>
4458
+ # <li>**FINANCE**: 财务专用章;</li>
4421
4459
  # <li>**PERSONNEL**: 人事专用章</li>
4422
4460
  # </ul>
4423
4461
  # 注: `同企业下只能有一个公章, 重复创建会报错`
@@ -4503,39 +4541,54 @@ module TencentCloud
4503
4541
 
4504
4542
  # CreateSignUrls请求参数结构体
4505
4543
  class CreateSignUrlsRequest < TencentCloud::Common::AbstractModel
4506
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4544
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4545
+
4546
+ # 此接口下面信息必填。
4547
+ # <ul>
4548
+ # <li>渠道应用标识: Agent.AppId</li>
4549
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4550
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4551
+ # </ul>
4552
+ # 第三方平台子客企业和员工必须已经经过实名认证
4507
4553
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4508
- # @param FlowIds: 流程(合同)的编号列表,最多支持100个。(备注:该参数和合同组编号必须二选一)
4554
+ # @param FlowIds: 合同流程ID数组,最多支持100个。
4555
+ # 注: `该参数和合同组编号必须二选一`
4509
4556
  # @type FlowIds: Array
4510
- # @param FlowGroupId: 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
4557
+ # @param FlowGroupId: 合同组编号
4558
+ # 注:`该参数和合同流程ID数组必须二选一`
4511
4559
  # @type FlowGroupId: String
4512
4560
  # @param Endpoint: 签署链接类型,可以设置的参数如下
4561
+ # <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
4562
+ # <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
4563
+ # <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
4564
+ # <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
4513
4565
 
4514
- # - WEIXINAPP:短链直接跳小程序 (默认类型)
4515
- # - CHANNEL:跳转H5页面
4516
- # - APP:第三方APP或小程序跳转电子签小程序
4517
- # - LONGURL2WEIXINAPP:长链接跳转小程序
4566
+ # 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
4518
4567
  # @type Endpoint: String
4519
4568
  # @param GenerateType: 签署链接生成类型,可以选择的类型如下
4520
4569
 
4521
- # - ALL:全部签署方签署链接,此时不会给自动签署的签署方创建签署链接(默认类型)
4522
- # - CHANNEL:第三方平台子客企业企业
4523
- # - NOT_CHANNEL:非第三方平台子客企业企业
4524
- # - PERSON:个人
4525
- # - FOLLOWER:关注方,目前是合同抄送方
4526
- # - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
4570
+ # <ul><li>**ALL**:(默认)全部签署方签署链接,此时不会给自动签署(静默签署)的签署方创建签署链接</li>
4571
+ # <li>**CHANNEL**:第三方子企业员工签署方</li>
4572
+ # <li>**NOT_CHANNEL**:SaaS平台企业员工签署方</li>
4573
+ # <li>**PERSON**:个人/自然人签署方</li>
4574
+ # <li>**FOLLOWER**:关注方,目前是合同抄送方</li>
4575
+ # <li>**RECIPIENT**:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接</li></ul>
4527
4576
  # @type GenerateType: String
4528
- # @param OrganizationName: 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
4577
+ # @param OrganizationName: SaaS平台企业员工签署方的企业名称
4578
+ # 如果名称中包含英文括号(),请使用中文括号()代替。
4579
+
4580
+ # 注: `GenerateType为"NOT_CHANNEL"时必填`
4529
4581
  # @type OrganizationName: String
4530
- # @param Name: 参与人姓名
4531
- # GenerateType为"PERSON"(即个人签署方)时必填
4582
+ # @param Name: 合同流程里边参与方的姓名。
4583
+ # 注: `GenerateType为"PERSON"(即个人签署方)时必填`
4532
4584
  # @type Name: String
4533
- # @param Mobile: 参与人手机号
4534
- # GenerateType为"PERSON"或"FOLLOWER"时必填
4585
+ # @param Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
4586
+ # 注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
4535
4587
  # @type Mobile: String
4536
- # @param OrganizationOpenId: 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
4588
+ # @param OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId
4589
+ # 注: `GenerateType为"CHANNEL"时必填`
4537
4590
  # @type OrganizationOpenId: String
4538
- # @param OpenId: 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
4591
+ # @param OpenId: 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
4539
4592
  # @type OpenId: String
4540
4593
  # @param AutoJumpBack: Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
4541
4594
  # @type AutoJumpBack: Boolean
@@ -4543,14 +4596,18 @@ module TencentCloud
4543
4596
  # @type JumpUrl: String
4544
4597
  # @param Operator: 暂未开放
4545
4598
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
4546
- # @param Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
4599
+ # @param Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
4600
+
4601
+ # <ul><li> **0** :合同签署页面更多操作按钮</li>
4602
+ # <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
4603
+ # <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
4604
+ # <li> **3** :签署成功页的查看详情按钮</li></ul>
4547
4605
 
4548
- # - 0:合同签署页面更多操作按钮
4549
- # - 1:合同签署页面更多操作的拒绝签署按钮
4550
- # - 2:合同签署页面更多操作的转他人处理按钮
4551
- # - 3:签署成功页的查看详情按钮
4606
+ # 注: `字段为数组, 可以传值隐藏多个按钮`
4552
4607
  # @type Hides: Array
4553
- # @param RecipientIds: 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
4608
+ # @param RecipientIds: 参与方角色ID,用于生成动态签署人链接完成领取。
4609
+
4610
+ # 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
4554
4611
  # @type RecipientIds: Array
4555
4612
 
4556
4613
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides, :RecipientIds
@@ -4857,10 +4914,17 @@ module TencentCloud
4857
4914
 
4858
4915
  # DescribeResourceUrlsByFlows请求参数结构体
4859
4916
  class DescribeResourceUrlsByFlowsRequest < TencentCloud::Common::AbstractModel
4860
- # @param Agent: 应用相关信息。
4861
- # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4917
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4918
+
4919
+ # 此接口下面信息必填。
4920
+ # <ul>
4921
+ # <li>渠道应用标识: Agent.AppId</li>
4922
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4923
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
4924
+ # </ul>
4925
+ # 第三方平台子客企业和员工必须已经经过实名认证
4862
4926
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4863
- # @param FlowIds: 查询资源所对应的签署流程Id,最多支持50个
4927
+ # @param FlowIds: 需要下载的合同流程的ID, 至少需要1个, 做多50个
4864
4928
  # @type FlowIds: Array
4865
4929
  # @param Operator: 操作者的信息,不用传
4866
4930
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -4891,10 +4955,10 @@ module TencentCloud
4891
4955
 
4892
4956
  # DescribeResourceUrlsByFlows返回参数结构体
4893
4957
  class DescribeResourceUrlsByFlowsResponse < TencentCloud::Common::AbstractModel
4894
- # @param FlowResourceUrlInfos: 签署流程资源对应链接信息
4958
+ # @param FlowResourceUrlInfos: 合同流程PDF下载链接
4895
4959
  # @type FlowResourceUrlInfos: Array
4896
- # @param ErrorMessages: 创建消息,对应多个合同ID,
4897
- # 成功为“”,创建失败则对应失败消息
4960
+ # @param ErrorMessages: 如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
4961
+ # 如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
4898
4962
  # @type ErrorMessages: Array
4899
4963
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4900
4964
  # @type RequestId: String
@@ -6089,10 +6153,10 @@ module TencentCloud
6089
6153
 
6090
6154
  # 流程对应资源链接信息
6091
6155
  class FlowResourceUrlInfo < TencentCloud::Common::AbstractModel
6092
- # @param FlowId: 流程对应Id
6156
+ # @param FlowId: 合同流程的ID
6093
6157
  # 注意:此字段可能返回 null,表示取不到有效值。
6094
6158
  # @type FlowId: String
6095
- # @param ResourceUrlInfos: 流程对应资源链接信息数组
6159
+ # @param ResourceUrlInfos: 对应的合同流程的PDF下载链接
6096
6160
  # 注意:此字段可能返回 null,表示取不到有效值。
6097
6161
  # @type ResourceUrlInfos: Array
6098
6162
 
@@ -6334,9 +6398,24 @@ module TencentCloud
6334
6398
 
6335
6399
  # GetDownloadFlowUrl请求参数结构体
6336
6400
  class GetDownloadFlowUrlRequest < TencentCloud::Common::AbstractModel
6337
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6401
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6402
+
6403
+ # 此接口下面信息必填。
6404
+ # <ul>
6405
+ # <li>渠道应用标识: Agent.AppId</li>
6406
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6407
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
6408
+ # </ul>
6409
+ # 第三方平台子客企业和员工必须已经经过实名认证
6338
6410
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
6339
- # @param DownLoadFlows: 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
6411
+ # @param DownLoadFlows: 流程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹对多20个合同, 所有文件夹最多50个合同
6412
+
6413
+ # 如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
6414
+
6415
+ # **2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
6416
+ # **2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
6417
+
6418
+ # ![image]( https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl_DownLoadFlows.png)
6340
6419
  # @type DownLoadFlows: Array
6341
6420
  # @param Operator: 操作者的信息,不用传
6342
6421
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -6374,7 +6453,7 @@ module TencentCloud
6374
6453
 
6375
6454
  # GetDownloadFlowUrl返回参数结构体
6376
6455
  class GetDownloadFlowUrlResponse < TencentCloud::Common::AbstractModel
6377
- # @param DownLoadUrl: 合同(流程)下载地址
6456
+ # @param DownLoadUrl: 跳转控制台合同下载页面链接 , 5分钟之内有效,且只能访问一次
6378
6457
  # @type DownLoadUrl: String
6379
6458
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6380
6459
  # @type RequestId: String
@@ -7319,9 +7398,9 @@ module TencentCloud
7319
7398
  # @param OrganizationName: 签署参与者机构名字
7320
7399
  # 注意:此字段可能返回 null,表示取不到有效值。
7321
7400
  # @type OrganizationName: String
7322
- # @param ApproverType: 参与者类型:
7323
- # ORGANIZATION 企业经办人
7324
- # PERSON 自然人
7401
+ # @param ApproverType: 参与者类型, 类型如下:
7402
+ # **ORGANIZATION**:企业经办人
7403
+ # **PERSON**: 自然人
7325
7404
  # 注意:此字段可能返回 null,表示取不到有效值。
7326
7405
  # @type ApproverType: String
7327
7406
  # @param IdCardNumber: 经办人身份证号
@@ -7813,13 +7892,21 @@ module TencentCloud
7813
7892
 
7814
7893
  # UploadFiles请求参数结构体
7815
7894
  class UploadFilesRequest < TencentCloud::Common::AbstractModel
7816
- # @param Agent: 应用相关信息,若是第三方应用集成调用 若是第三方应用集成调用,Agent.AppId 和 Agent.ProxyOrganizationOpenId 必填
7895
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7896
+
7897
+ # 此接口下面信息必填。
7898
+ # <ul>
7899
+ # <li>渠道应用标识: Agent.AppId</li>
7900
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7901
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7902
+ # </ul>
7903
+ # 第三方平台子客企业和员工必须已经经过实名认证
7817
7904
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
7818
- # @param BusinessType: 文件对应业务类型
7819
- # 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
7820
- # 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
7905
+ # @param BusinessType: 文件对应业务类型,可以选择的类型如下
7906
+ # <ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
7907
+ # <li> **DOCUMENT** : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li></ul>
7821
7908
  # @type BusinessType: String
7822
- # @param FileInfos: 上传文件内容数组,最多支持20个文件
7909
+ # @param FileInfos: 上传文件内容数组,最多支持上传20个文件。
7823
7910
  # @type FileInfos: Array
7824
7911
  # @param Operator: 操作者的信息
7825
7912
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -7860,10 +7947,13 @@ module TencentCloud
7860
7947
  # UploadFiles返回参数结构体
7861
7948
  class UploadFilesResponse < TencentCloud::Common::AbstractModel
7862
7949
  # @param TotalCount: 上传成功文件数量
7950
+ # 注: `如果一个文件上传失败, 则全部文件皆上传失败`
7863
7951
  # @type TotalCount: Integer
7864
- # @param FileIds: 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
7952
+ # @param FileIds: 文件资源ID数组,每个文件资源ID为32位字符串。
7953
+ # 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
7954
+ # 注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
7865
7955
  # @type FileIds: Array
7866
- # @param FileUrls: 文件Url
7956
+ # @param FileUrls: 对应上传文件的下载链接,过期时间5分钟
7867
7957
  # @type FileUrls: Array
7868
7958
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7869
7959
  # @type RequestId: String
@@ -7968,14 +8058,18 @@ module TencentCloud
7968
8058
 
7969
8059
  # 用户的三要素:姓名,证件号,证件类型
7970
8060
  class UserThreeFactor < TencentCloud::Common::AbstractModel
7971
- # @param Name: 姓名
8061
+ # @param Name: 签署方经办人的姓名。
8062
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
7972
8063
  # @type Name: String
7973
- # @param IdCardType: 证件类型:
7974
- # ID_CARD 身份证
7975
- # HONGKONG_AND_MACAO 港澳居民来往内地通行证
7976
- # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
8064
+ # @param IdCardType: 证件类型,支持以下类型
8065
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
8066
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
8067
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
7977
8068
  # @type IdCardType: String
7978
- # @param IdCardNumber: 证件号,如果有 X 请大写
8069
+ # @param IdCardNumber: 证件号码,应符合以下规则
8070
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
8071
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
8072
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
7979
8073
  # @type IdCardNumber: String
7980
8074
 
7981
8075
  attr_accessor :Name, :IdCardType, :IdCardNumber
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.686
4
+ version: 3.0.688
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-10-27 00:00:00.000000000 Z
11
+ date: 2023-10-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common