tencentcloud-sdk-python-essbasic 3.0.999__tar.gz → 3.0.1004__tar.gz

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.
Files changed (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20210526/essbasic_client.py +161 -6
  5. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20210526/models.py +316 -112
  6. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1004/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.999/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.999 → tencentcloud-sdk-python-essbasic-3.0.1004}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.999
3
+ Version: 3.0.1004
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.999"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1004"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.999'
17
+ __version__ = '3.0.1004'
@@ -291,7 +291,64 @@ class EssbasicClient(AbstractClient):
291
291
 
292
292
 
293
293
  def ChannelCreateFlowByFiles(self, request):
294
- """接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
294
+ """接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
295
+
296
+ 适用场景:适用非制式的合同文件签署,开发者有每个签署流程的PDF,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
297
+
298
+ **注**:
299
+ <ul>
300
+ <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
301
+ <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
302
+ </ul>
303
+
304
+ ![image](https://dyn.ess.tencent.cn/guide/capi/ChannelCreateFlowByFiles.png)
305
+
306
+ **可以作为发起方和签署方的角色列表**
307
+ <table>
308
+ <thead>
309
+ <tr>
310
+ <th>场景编号</th>
311
+ <th>可作为发起方类型</th>
312
+ <th>可作为签署方的类型</th>
313
+ </tr>
314
+ </thead>
315
+
316
+ <tbody>
317
+ <tr>
318
+ <td>场景一</td>
319
+ <td>第三方子企业A员工</td>
320
+ <td>第三方子企业A员工</td>
321
+ </tr>
322
+
323
+ <tr>
324
+ <td>场景二</td>
325
+ <td>第三方子企业A员工</td>
326
+ <td>第三方子企业B(不指定经办人)</td>
327
+ </tr>
328
+
329
+ <tr>
330
+ <td>场景三</td>
331
+ <td>第三方子企业A员工</td>
332
+ <td>第三方子企业B员工</td>
333
+ </tr>
334
+
335
+ <tr>
336
+ <td>场景四</td>
337
+ <td>第三方子企业A员工</td>
338
+ <td>个人/自然人</td>
339
+ </tr>
340
+
341
+ <tr>
342
+ <td>场景五</td>
343
+ <td>第三方子企业A员工</td>
344
+ <td>SaaS平台企业员工</td>
345
+ </tr>
346
+ </tbody>
347
+ </table>
348
+
349
+ **注**:
350
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
351
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
295
352
 
296
353
  :param request: Request instance for ChannelCreateFlowByFiles.
297
354
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesRequest`
@@ -1036,7 +1093,7 @@ class EssbasicClient(AbstractClient):
1036
1093
 
1037
1094
 
1038
1095
  def ChannelVerifyPdf(self, request):
1039
- """对流程的合同文件进行数字签名验证,判断文件是否被篡改。
1096
+ """对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
1040
1097
 
1041
1098
  :param request: Request instance for ChannelVerifyPdf.
1042
1099
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelVerifyPdfRequest`
@@ -1059,8 +1116,15 @@ class EssbasicClient(AbstractClient):
1059
1116
 
1060
1117
 
1061
1118
  def CreateChannelFlowEvidenceReport(self, request):
1062
- """创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
1063
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。
1119
+ """提交申请出证报告任务并返回报告ID。
1120
+
1121
+ 注意:
1122
+ <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
1123
+ <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
1124
+ <li>合同流程必须所有参与方`已经签署完成`。</li>
1125
+ <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
1126
+
1127
+ <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>
1064
1128
 
1065
1129
  :param request: Request instance for CreateChannelFlowEvidenceReport.
1066
1130
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelFlowEvidenceReportRequest`
@@ -1083,7 +1147,40 @@ class EssbasicClient(AbstractClient):
1083
1147
 
1084
1148
 
1085
1149
  def CreateChannelOrganizationInfoChangeUrl(self, request):
1086
- """此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
1150
+ """此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接(需要在移动端打开,会跳转到微信小程序),支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。
1151
+
1152
+
1153
+ <h3 id="1-企业超管变更">1. 企业超管变更</h3>
1154
+
1155
+ <p>换成企业的其他员工来当超管</p>
1156
+
1157
+ <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
1158
+
1159
+ <h4 id="可以变动">可以变动</h4>
1160
+
1161
+ <ul>
1162
+ <li>企业名称<br>
1163
+ </li>
1164
+ <li>法定代表人姓名(新法人有邀请链接)<br>
1165
+ </li>
1166
+ <li>企业地址和所在地</li>
1167
+ </ul>
1168
+
1169
+ <h4 id="不可变动">不可变动</h4>
1170
+
1171
+ <ul>
1172
+ <li>统一社会信用代码<br>
1173
+ </li>
1174
+ <li>企业主体类型</li>
1175
+ </ul>
1176
+
1177
+ <p>如果企业名称变动会引起下面的变动</p>
1178
+
1179
+ <ul>
1180
+ <li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
1181
+ <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
1182
+ <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1183
+ </ul>
1087
1184
 
1088
1185
  :param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
1089
1186
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlRequest`
@@ -1142,6 +1239,57 @@ class EssbasicClient(AbstractClient):
1142
1239
  如若在模板中配置了动态表格, 上传的附件必须为A4大小
1143
1240
  合同发起人必须在电子签已经进行实名。
1144
1241
 
1242
+ **整体的逻辑如下**
1243
+
1244
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreateFlowsByTemplates.png)
1245
+
1246
+ **可以作为发起方和签署方的角色列表**
1247
+ <table>
1248
+ <thead>
1249
+ <tr>
1250
+ <th>场景编号</th>
1251
+ <th>可作为发起方类型</th>
1252
+ <th>可作为签署方的类型</th>
1253
+ </tr>
1254
+ </thead>
1255
+
1256
+ <tbody>
1257
+ <tr>
1258
+ <td>场景一</td>
1259
+ <td>第三方子企业A员工</td>
1260
+ <td>第三方子企业A员工</td>
1261
+ </tr>
1262
+
1263
+ <tr>
1264
+ <td>场景二</td>
1265
+ <td>第三方子企业A员工</td>
1266
+ <td>第三方子企业B(不指定经办人)</td>
1267
+ </tr>
1268
+
1269
+ <tr>
1270
+ <td>场景三</td>
1271
+ <td>第三方子企业A员工</td>
1272
+ <td>第三方子企业B员工</td>
1273
+ </tr>
1274
+
1275
+ <tr>
1276
+ <td>场景四</td>
1277
+ <td>第三方子企业A员工</td>
1278
+ <td>个人/自然人</td>
1279
+ </tr>
1280
+
1281
+ <tr>
1282
+ <td>场景五</td>
1283
+ <td>第三方子企业A员工</td>
1284
+ <td>SaaS平台企业员工</td>
1285
+ </tr>
1286
+ </tbody>
1287
+ </table>
1288
+
1289
+ **注**:
1290
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
1291
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
1292
+
1145
1293
  :param request: Request instance for CreateFlowsByTemplates.
1146
1294
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
1147
1295
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesResponse`
@@ -1261,7 +1409,14 @@ class EssbasicClient(AbstractClient):
1261
1409
 
1262
1410
 
1263
1411
  def DescribeExtendedServiceAuthInfo(self, request):
1264
- """查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人
1412
+ """查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
1413
+ 1. 企业自动签
1414
+ 2. 企业与港澳台居民签署合同
1415
+ 3. 使用手机号验证签署方身份
1416
+ 4. 骑缝章
1417
+ 5. 拓宽签署方年龄限制
1418
+
1419
+ 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
1265
1420
 
1266
1421
  :param request: Request instance for DescribeExtendedServiceAuthInfo.
1267
1422
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeExtendedServiceAuthInfoRequest`
@@ -166,9 +166,13 @@ class ApproverItem(AbstractModel):
166
166
  def __init__(self):
167
167
  r"""
168
168
  :param _SignId: 签署方唯一编号
169
+
170
+ 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
169
171
  注意:此字段可能返回 null,表示取不到有效值。
170
172
  :type SignId: str
171
173
  :param _RecipientId: 签署方角色编号
174
+
175
+ 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
172
176
  注意:此字段可能返回 null,表示取不到有效值。
173
177
  :type RecipientId: str
174
178
  :param _ApproverRoleName: 签署方角色名称
@@ -232,9 +236,19 @@ class ApproverOption(AbstractModel):
232
236
  <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)</li>
233
237
  </ul>
234
238
  :type FillType: int
239
+ :param _FlowReadLimit: 签署人阅读合同限制参数
240
+ <br/>取值:
241
+ <ul>
242
+ <li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li>
243
+ <li> LimitReadTime,阅读合同仅限制阅读时长</li>
244
+ <li> LimitBottom,阅读合同仅限制必须阅读到底</li>
245
+ <li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>
246
+ </ul>
247
+ :type FlowReadLimit: str
235
248
  """
236
249
  self._HideOneKeySign = None
237
250
  self._FillType = None
251
+ self._FlowReadLimit = None
238
252
 
239
253
  @property
240
254
  def HideOneKeySign(self):
@@ -252,10 +266,19 @@ class ApproverOption(AbstractModel):
252
266
  def FillType(self, FillType):
253
267
  self._FillType = FillType
254
268
 
269
+ @property
270
+ def FlowReadLimit(self):
271
+ return self._FlowReadLimit
272
+
273
+ @FlowReadLimit.setter
274
+ def FlowReadLimit(self, FlowReadLimit):
275
+ self._FlowReadLimit = FlowReadLimit
276
+
255
277
 
256
278
  def _deserialize(self, params):
257
279
  self._HideOneKeySign = params.get("HideOneKeySign")
258
280
  self._FillType = params.get("FillType")
281
+ self._FlowReadLimit = params.get("FlowReadLimit")
259
282
  memeber_set = set(params.keys())
260
283
  for name, value in vars(self).items():
261
284
  property_name = name[1:]
@@ -1985,8 +2008,7 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
1985
2008
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
1986
2009
  :param _FillApproverType: 签署人信息补充方式
1987
2010
 
1988
- <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
1989
- <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
2011
+ <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
1990
2012
  :type FillApproverType: int
1991
2013
  """
1992
2014
  self._Agent = None
@@ -2112,56 +2134,99 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
2112
2134
 
2113
2135
  def __init__(self):
2114
2136
  r"""
2115
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
2137
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2138
+
2139
+ 此接口下面信息必填。
2140
+ <ul>
2141
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2142
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2143
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2144
+ </ul>
2116
2145
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2117
- :param _FlowName: 签署流程名称,长度不超过200个字符
2146
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
2118
2147
  :type FlowName: str
2119
- :param _FlowDescription: 签署流程的描述,长度不超过1000个字符
2148
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
2120
2149
  :type FlowDescription: str
2121
- :param _FlowApprovers: 签署流程签约方列表,最多不超过50个参与方
2150
+ :param _FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo" target="_blank">FlowApproverInfo结构体</a>。
2151
+
2152
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
2122
2153
  :type FlowApprovers: list of FlowApproverInfo
2123
- :param _FileIds: 签署文件资源Id列表,目前仅支持单个文件
2154
+ :param _FileIds: 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
2155
+
2156
+ 注: `目前,此接口仅支持单个文件发起。`
2124
2157
  :type FileIds: list of str
2125
- :param _Components: 签署文件中的发起方的填写控件,需要在发起的时候进行填充
2158
+ :param _Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2159
+ <ul><li>单行文本控件</li>
2160
+ <li>多行文本控件</li>
2161
+ <li>勾选框控件</li>
2162
+ <li>数字控件</li>
2163
+ <li>图片控件</li>
2164
+ <li>数据表格等填写控件</li></ul>
2126
2165
  :type Components: list of Component
2127
- :param _Deadline: 签署流程的签署截止时间。
2128
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
2129
- 不能早于当前时间
2166
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
2167
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
2130
2168
  :type Deadline: int
2131
- :param _CallbackUrl: 签署流程回调地址,长度不超过255个字符
2132
- 如果不传递回调地址, 则默认是配置应用号时候使用的回调地址
2169
+ :param _CallbackUrl: 执行结果的回调URL,长度不超过255个字符,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
2170
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
2171
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块。
2172
+
2173
+ 注:
2174
+ `如果不传递回调地址, 则默认是配置应用号时候使用的回调地址`
2133
2175
  :type CallbackUrl: str
2134
- :param _Unordered: 合同签署顺序类型
2135
- true - 无序签,
2136
- false - 顺序签,
2137
- 默认为false,即有序签署。
2138
- 有序签署时以传入FlowApprovers数组的顺序作为签署顺序
2176
+ :param _Unordered: 合同流程的签署顺序类型:
2177
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2178
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2179
+ **注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
2139
2180
  :type Unordered: bool
2140
- :param _FlowType: 签署流程的类型,长度不超过255个字符
2181
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。
2141
2182
  :type FlowType: str
2142
- :param _CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2183
+ :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2184
+ <ul><li>{合同名称} </li>
2185
+ <li>{发起方企业} </li>
2186
+ <li>{发起方姓名} </li>
2187
+ <li>{签署方N企业}</li>
2188
+ <li>{签署方N姓名}</li></ul>
2189
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
2190
+
2191
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
2192
+
2193
+ 合同名称:租房合同
2194
+ 发起方:腾讯公司(张三)
2195
+ 签署方:李四
2196
+
2197
+
2143
2198
  :type CustomShowMap: str
2144
- :param _CustomerData: 业务信息,最大长度1000个字符。
2199
+ :param _CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1000长度。
2200
+
2201
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
2145
2202
  :type CustomerData: str
2146
- :param _NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2203
+ :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2204
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2205
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2206
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2207
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2208
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2209
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2147
2210
  :type NeedSignReview: bool
2148
2211
  :param _ApproverVerifyType: 签署人校验方式
2149
2212
  VerifyCheck: 人脸识别(默认)
2150
2213
  MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
2151
2214
  参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
2152
2215
  :type ApproverVerifyType: str
2153
- :param _SignBeanTag: 标识是否允许发起后添加控件。
2154
- 0为不允许
2155
- 1为允许。
2156
- 如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
2216
+ :param _SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
2217
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2218
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2219
+ **注**: `发起后添加控件功能不支持添加签批控件`
2157
2220
  :type SignBeanTag: int
2158
- :param _CcInfos: 被抄送人信息列表
2221
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
2159
2222
  :type CcInfos: list of CcInfo
2160
- :param _CcNotifyType: 给关注人发送短信通知的类型,
2161
- 0-合同发起时通知
2162
- 1-签署完成后通知
2223
+ :param _CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
2224
+ <ul><li> **0**:合同发起时通知(默认值)</li>
2225
+ <li> **1**:签署完成后通知</li></ul>
2163
2226
  :type CcNotifyType: int
2164
- :param _AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2227
+ :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
2228
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
2229
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
2165
2230
  :type AutoSignScene: str
2166
2231
  :param _Operator: 操作者的信息,不用传
2167
2232
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -2399,7 +2464,8 @@ class ChannelCreateFlowByFilesResponse(AbstractModel):
2399
2464
 
2400
2465
  def __init__(self):
2401
2466
  r"""
2402
- :param _FlowId: 合同签署流程ID
2467
+ :param _FlowId: 合同流程ID,为32位字符串。
2468
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2403
2469
  注意:此字段可能返回 null,表示取不到有效值。
2404
2470
  :type FlowId: str
2405
2471
  :param _Approvers: 签署方信息,如角色ID、角色名称等
@@ -6695,9 +6761,11 @@ class ChannelVerifyPdfRequest(AbstractModel):
6695
6761
 
6696
6762
  def __init__(self):
6697
6763
  r"""
6698
- :param _FlowId: 流程ID
6764
+ :param _FlowId: 合同流程ID,为32位字符串。
6765
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6699
6766
  :type FlowId: str
6700
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6767
+ :param _Agent: 代理企业和员工的信息。
6768
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6701
6769
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6702
6770
  :param _Operator: 暂未开放
6703
6771
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -6760,15 +6828,32 @@ class ChannelVerifyPdfResponse(AbstractModel):
6760
6828
 
6761
6829
  def __init__(self):
6762
6830
  r"""
6763
- :param _VerifyResult: 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
6831
+ :param _VerifyResult: 验签结果代码,代码的含义如下:
6832
+
6833
+ <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
6834
+ <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
6835
+ <li>**3**:文件被篡改。</li>
6836
+ <li>**4**:异常:文件内没有签名域。</li>
6837
+ <li>**5**:异常:文件签名格式错误。</li></ul>
6764
6838
  :type VerifyResult: int
6765
- :param _PdfVerifyResults: 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
6839
+ :param _PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
6840
+ <ul><li> **1** :验签成功,在电子签签署</li>
6841
+ <li> **2** :验签成功,在其他平台签署</li>
6842
+ <li> **3** :验签失败</li>
6843
+ <li> **4** :pdf文件没有签名域</li>
6844
+ <li> **5** :文件签名格式错误</li></ul>
6766
6845
  :type PdfVerifyResults: list of PdfVerifyResult
6846
+ :param _VerifySerialNo: 验签序列号, 为11为数组组成的字符串
6847
+ :type VerifySerialNo: str
6848
+ :param _PdfResourceMd5: 合同文件MD5哈希值
6849
+ :type PdfResourceMd5: str
6767
6850
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6768
6851
  :type RequestId: str
6769
6852
  """
6770
6853
  self._VerifyResult = None
6771
6854
  self._PdfVerifyResults = None
6855
+ self._VerifySerialNo = None
6856
+ self._PdfResourceMd5 = None
6772
6857
  self._RequestId = None
6773
6858
 
6774
6859
  @property
@@ -6787,6 +6872,22 @@ class ChannelVerifyPdfResponse(AbstractModel):
6787
6872
  def PdfVerifyResults(self, PdfVerifyResults):
6788
6873
  self._PdfVerifyResults = PdfVerifyResults
6789
6874
 
6875
+ @property
6876
+ def VerifySerialNo(self):
6877
+ return self._VerifySerialNo
6878
+
6879
+ @VerifySerialNo.setter
6880
+ def VerifySerialNo(self, VerifySerialNo):
6881
+ self._VerifySerialNo = VerifySerialNo
6882
+
6883
+ @property
6884
+ def PdfResourceMd5(self):
6885
+ return self._PdfResourceMd5
6886
+
6887
+ @PdfResourceMd5.setter
6888
+ def PdfResourceMd5(self, PdfResourceMd5):
6889
+ self._PdfResourceMd5 = PdfResourceMd5
6890
+
6790
6891
  @property
6791
6892
  def RequestId(self):
6792
6893
  return self._RequestId
@@ -6804,6 +6905,8 @@ class ChannelVerifyPdfResponse(AbstractModel):
6804
6905
  obj = PdfVerifyResult()
6805
6906
  obj._deserialize(item)
6806
6907
  self._PdfVerifyResults.append(obj)
6908
+ self._VerifySerialNo = params.get("VerifySerialNo")
6909
+ self._PdfResourceMd5 = params.get("PdfResourceMd5")
6807
6910
  self._RequestId = params.get("RequestId")
6808
6911
 
6809
6912
 
@@ -7156,13 +7259,7 @@ ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
7156
7259
  2 FontSize: 范围12-72
7157
7260
  3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
7158
7261
  4 FontColor:字符串类型,格式为RGB颜色数字
7159
- 参数样例: "ComponentExtra": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}"
7160
-
7161
- TEXT/MULTI_LINE_TEXT控件可以指定
7162
- 1 Font:目前只支持黑体、宋体
7163
- 2 FontSize: 范围12-72
7164
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
7165
- 例如:{"FontSize":12}
7262
+ 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
7166
7263
 
7167
7264
  ComponentType为FILL_IMAGE时,支持以下参数:
7168
7265
  NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
@@ -7189,7 +7286,7 @@ ComponentType为SIGN_DATE时,支持以下参数:
7189
7286
 
7190
7287
  ComponentType为SIGN_SEAL类型时,支持以下参数:
7191
7288
  1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
7192
- 参数样例: "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
7289
+ 参数样例: "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"
7193
7290
  :type ComponentExtra: str
7194
7291
  :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
7195
7292
  TEXT - 文本内容
@@ -7663,9 +7760,17 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
7663
7760
 
7664
7761
  def __init__(self):
7665
7762
  r"""
7666
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
7763
+ :param _Agent: 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7764
+
7765
+ 此接口下面信息必填。
7766
+ <ul>
7767
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
7768
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
7769
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
7770
+ </ul>
7667
7771
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7668
- :param _FlowId: 签署流程编号
7772
+ :param _FlowId: 合同流程ID,为32位字符串。
7773
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
7669
7774
  :type FlowId: str
7670
7775
  :param _Operator: 暂未开放
7671
7776
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -7728,15 +7833,14 @@ class CreateChannelFlowEvidenceReportResponse(AbstractModel):
7728
7833
 
7729
7834
  def __init__(self):
7730
7835
  r"""
7731
- :param _ReportId: 出证报告 ID,可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
7732
-
7836
+ :param _ReportId: 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
7733
7837
  注意:此字段可能返回 null,表示取不到有效值。
7734
7838
  :type ReportId: str
7735
- :param _Status: 出征任务的执行状态,状态列表如下
7839
+ :param _Status: 出证任务执行的状态, 状态含义如下:
7736
7840
 
7737
- - EvidenceStatusExecuting : 出征任务正在执行中
7738
- - EvidenceStatusSuccess : 出征任务执行成功
7739
- - EvidenceStatusFailed : 出征任务执行失败
7841
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
7842
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
7843
+ <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
7740
7844
  :type Status: str
7741
7845
  :param _ReportUrl: 废除,字段无效
7742
7846
  注意:此字段可能返回 null,表示取不到有效值。
@@ -7796,10 +7900,18 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
7796
7900
 
7797
7901
  def __init__(self):
7798
7902
  r"""
7799
- :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7903
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7904
+
7905
+ 此接口下面信息必填。
7906
+ <ul>
7907
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
7908
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
7909
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
7910
+ </ul>
7800
7911
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7801
7912
  :param _ChangeType: 企业信息变更类型,可选类型如下:
7802
- <ul><li>**1**:企业超管变更</li><li>**2**:企业基础信息变更</li></ul>
7913
+ <ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
7914
+ <li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
7803
7915
  :type ChangeType: int
7804
7916
  """
7805
7917
  self._Agent = None
@@ -7844,7 +7956,7 @@ class CreateChannelOrganizationInfoChangeUrlResponse(AbstractModel):
7844
7956
 
7845
7957
  def __init__(self):
7846
7958
  r"""
7847
- :param _Url: 创建的企业信息变更链接。
7959
+ :param _Url: 创建的企业信息变更链接。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。
7848
7960
  :type Url: str
7849
7961
  :param _ExpiredTime: 链接过期时间。链接7天有效。
7850
7962
  :type ExpiredTime: int
@@ -8256,15 +8368,31 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
8256
8368
 
8257
8369
  def __init__(self):
8258
8370
  r"""
8259
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
8371
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
8372
+
8373
+ 此接口下面信息必填。
8374
+ <ul>
8375
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
8376
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
8377
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
8378
+ </ul>
8260
8379
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
8261
8380
  :param _FlowInfos: 要创建的合同信息列表,最多支持一次创建20个合同
8262
8381
  :type FlowInfos: list of FlowInfo
8263
- :param _NeedPreview: 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
8264
- 预览链接有效期300秒;
8265
- 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
8382
+ :param _NeedPreview: 是否为预览模式,取值如下:
8383
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
8384
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
8385
+
8386
+ 注:
8387
+
8388
+ `如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
8389
+
8266
8390
  :type NeedPreview: bool
8267
- :param _PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
8391
+ :param _PreviewType: 预览模式下产生的预览链接类型
8392
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
8393
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
8394
+ 注: `此参数在NeedPreview 为true时有效`
8395
+
8268
8396
  :type PreviewType: int
8269
8397
  :param _Operator: 操作者的信息,不用传
8270
8398
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -8352,14 +8480,17 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
8352
8480
 
8353
8481
  def __init__(self):
8354
8482
  r"""
8355
- :param _FlowIds: 多个合同ID
8483
+ :param _FlowIds: 生成的合同流程ID数组,合同流程ID为32位字符串。
8484
+ 建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。
8356
8485
  :type FlowIds: list of str
8357
8486
  :param _CustomerData: 第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
8358
8487
  :type CustomerData: list of str
8359
8488
  :param _ErrorMessages: 创建消息,对应多个合同ID,
8360
8489
  成功为“”,创建失败则对应失败消息
8361
8490
  :type ErrorMessages: list of str
8362
- :param _PreviewUrls: 预览模式下返回的预览文件url数组
8491
+ :param _PreviewUrls: 合同预览链接URL数组。
8492
+
8493
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
8363
8494
  :type PreviewUrls: list of str
8364
8495
  :param _TaskInfos: 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
8365
8496
  如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
@@ -9113,10 +9244,14 @@ class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
9113
9244
 
9114
9245
  def __init__(self):
9115
9246
  r"""
9116
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
9117
-
9118
- 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
9247
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
9119
9248
 
9249
+ 此接口下面信息必填。
9250
+ <ul>
9251
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
9252
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
9253
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
9254
+ </ul>
9120
9255
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9121
9256
  """
9122
9257
  self._Agent = None
@@ -9151,7 +9286,7 @@ class DescribeExtendedServiceAuthInfoResponse(AbstractModel):
9151
9286
 
9152
9287
  def __init__(self):
9153
9288
  r"""
9154
- :param _AuthInfo: 企业扩展服务授权信息
9289
+ :param _AuthInfo: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
9155
9290
  注意:此字段可能返回 null,表示取不到有效值。
9156
9291
  :type AuthInfo: list of ExtentServiceAuthInfo
9157
9292
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -9946,7 +10081,7 @@ class DownloadFlowInfo(AbstractModel):
9946
10081
 
9947
10082
 
9948
10083
  class ExtentServiceAuthInfo(AbstractModel):
9949
- """企业扩展服务授权信息
10084
+ """扩展服务开通和授权的详细信息
9950
10085
 
9951
10086
  """
9952
10087
 
@@ -9954,7 +10089,7 @@ class ExtentServiceAuthInfo(AbstractModel):
9954
10089
  r"""
9955
10090
  :param _Type: 扩展服务类型
9956
10091
  <ul>
9957
- <li>AUTO_SIGN 企业静默签(自动签署)</li>
10092
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
9958
10093
  <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
9959
10094
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
9960
10095
  <li> PAGING_SEAL 骑缝章</li>
@@ -9964,14 +10099,12 @@ class ExtentServiceAuthInfo(AbstractModel):
9964
10099
  :type Type: str
9965
10100
  :param _Name: 扩展服务名称
9966
10101
  :type Name: str
9967
- :param _Status: 服务状态
9968
- ENABLE 开启
9969
- DISABLE 关闭
10102
+ :param _Status: 扩展服务的开通状态: ENABLE:开通 DISABLE:未开通
9970
10103
  :type Status: str
9971
- :param _OperatorOpenId: 最近操作人第三方应用平台的用户openid
10104
+ :param _OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
9972
10105
  注意:此字段可能返回 null,表示取不到有效值。
9973
10106
  :type OperatorOpenId: str
9974
- :param _OperateOn: 最近操作时间戳,单位秒
10107
+ :param _OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
9975
10108
  注意:此字段可能返回 null,表示取不到有效值。
9976
10109
  :type OperateOn: int
9977
10110
  """
@@ -10559,60 +10692,120 @@ class FlowApproverDetail(AbstractModel):
10559
10692
  class FlowApproverInfo(AbstractModel):
10560
10693
  """创建签署流程签署人入参。
10561
10694
 
10562
- 其中签署方FlowApproverInfo需要传递的参数
10563
- 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
10695
+ **各种场景传参说明**:
10696
+
10697
+ <table>
10698
+ <thead>
10699
+ <tr>
10700
+ <th>场景编号</th>
10701
+ <th>可作为发起方类型</th>
10702
+ <th>可作为签署方的类型</th>
10703
+ <th>签署方传参说明</th>
10704
+ </tr>
10705
+ </thead>
10706
+
10707
+ <tbody>
10708
+ <tr>
10709
+ <td>场景一</td>
10710
+ <td>第三方子企业A员工</td>
10711
+ <td>第三方子企业A员工</td>
10712
+ <td>OpenId、OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
10713
+ </tr>
10564
10714
 
10565
- 其他身份标识
10715
+ <tr>
10716
+ <td>场景二</td>
10717
+ <td>第三方子企业A员工</td>
10718
+ <td>第三方子企业B(不指定经办人)</td>
10719
+ <td>OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
10720
+ </tr>
10566
10721
 
10567
- <ul><li>1-个人:Name、Mobile必传</li>
10568
- <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
10569
- <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
10570
- <li>4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
10722
+ <tr>
10723
+ <td>场景三</td>
10724
+ <td>第三方子企业A员工</td>
10725
+ <td>第三方子企业B员工</td>
10726
+ <td>OpenId、OrgName、OrgOpenId必传, ApproverType设置为ORGANIZATION</td>
10727
+ </tr>
10571
10728
 
10572
- RecipientId参数:
10573
- 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
10729
+ <tr>
10730
+ <td>场景四</td>
10731
+ <td>第三方子企业A员工</td>
10732
+ <td>个人/自然人</td>
10733
+ <td>Name、Mobile必传, ApproverType设置为PERSON</td>
10734
+ </tr>
10735
+
10736
+ <tr>
10737
+ <td>场景五</td>
10738
+ <td>第三方子企业A员工</td>
10739
+ <td>SaaS平台企业员工</td>
10740
+ <td>Name、Mobile、OrgName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
10741
+ </tr>
10742
+ </tbody>
10743
+ </table>
10744
+
10745
+ **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
10746
+
10747
+ RecipientId参数获取:
10748
+ 从<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates" target="_blank">DescribeFlowTemplates接口</a>接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
10749
+
10750
+ **注2**: `如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`, 动态签署方可以参考<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">此文档</a>
10574
10751
 
10575
10752
  """
10576
10753
 
10577
10754
  def __init__(self):
10578
10755
  r"""
10579
- :param _Name: 签署人姓名,最大长度50个字符
10756
+ :param _Name: 签署方经办人的姓名。
10757
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
10580
10758
  :type Name: str
10581
- :param _IdCardType: 签署人的证件类型
10582
- 1.ID_CARD 居民身份证
10583
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
10584
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
10585
- 4.OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
10759
+ :param _IdCardType: 签署方经办人的证件类型,支持以下类型
10760
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
10761
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
10762
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
10763
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
10764
+
10765
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
10586
10766
  :type IdCardType: str
10587
- :param _IdCardNumber: 签署人证件号(长度不超过18位)
10767
+ :param _IdCardNumber: 签署方经办人的证件号码,应符合以下规则
10768
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
10769
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
10770
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
10588
10771
  :type IdCardNumber: str
10589
- :param _Mobile: 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
10772
+ :param _Mobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
10773
+ 请确认手机号所有方为此合同签署方。
10590
10774
  :type Mobile: str
10591
- :param _OrganizationName: 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
10775
+ :param _OrganizationName: 组织机构名称。
10776
+ 请确认该名称与企业营业执照中注册的名称一致。
10777
+ 如果名称中包含英文括号(),请使用中文括号()代替。
10592
10778
  :type OrganizationName: str
10593
- :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
10594
- 默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
10779
+ :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
10780
+ <ul>
10781
+ <li>false: 默认值,第三方平台子客企业下员工</li>
10782
+ <li>true: SaaS平台企业下的员工</li>
10783
+ </ul>
10784
+
10595
10785
  :type NotChannelOrganization: bool
10596
- :param _OpenId: 用户侧第三方id,最大长度64个字符
10786
+ :param _OpenId: 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成
10787
+
10597
10788
  当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
10598
10789
  :type OpenId: str
10599
- :param _OrganizationOpenId: 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
10790
+ :param _OrganizationOpenId: 同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
10600
10791
  :type OrganizationOpenId: str
10601
- :param _ApproverType: 签署人类型
10602
- PERSON-个人/自然人;
10603
- PERSON_AUTO_SIGN-个人自动签署,适用于个人自动签场景
10604
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
10605
- ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
10606
- ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的本方企业自动签)
10607
-
10608
- 若要实现他方企业(同一应用下)自动签,需要满足3个条件:
10609
- 条件1:ApproverType 设置为ENTERPRISESERVER
10610
- 条件2:子客之间完成授权
10611
- 条件3:联系对接的客户经理沟通
10792
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
10793
+ <ul><li> **PERSON** :个人/自然人</li>
10794
+ <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
10795
+ <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
10796
+ <li> **ENTERPRISESERVER** :企业/企业员自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
10797
+
10798
+ 注:
10799
+ `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
10800
+ `2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:`
10801
+ <ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li>
10802
+ <li>条件2:子客之间完成授权</li>
10803
+ <li>条件3:联系对接的客户经理沟通如何使用</li></ul>
10612
10804
  :type ApproverType: str
10613
10805
  :param _RecipientId: 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
10614
10806
  :type RecipientId: str
10615
- :param _Deadline: 签署截止时间戳,默认一年
10807
+ :param _Deadline: 本签署人在此合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
10808
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
10616
10809
  :type Deadline: int
10617
10810
  :param _CallbackUrl: 签署完回调url,最大长度1000个字符
10618
10811
  :type CallbackUrl: str
@@ -10624,11 +10817,19 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
10624
10817
  ESIGN -- 个人印章类型
10625
10818
  SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
10626
10819
  :type ComponentLimitType: list of str
10627
- :param _PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
10820
+ :param _PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
10821
+
10822
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
10823
+ <ul>
10824
+ <li>合同页数少于等于2页,阅读时间为3秒;</li>
10825
+ <li>合同页数为3到5页,阅读时间为5秒;</li>
10826
+ <li>合同页数大于等于6页,阅读时间为10秒。</li>
10827
+ </ul>
10628
10828
  :type PreReadTime: int
10629
10829
  :param _JumpUrl: 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
10630
10830
  :type JumpUrl: str
10631
- :param _ApproverOption: 签署人个性化能力值
10831
+ :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
10832
+ 详细操作可以参考开发者中心的ApproverOption结构体。
10632
10833
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
10633
10834
  :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
10634
10835
  :type ApproverNeedSignReview: bool
@@ -10643,14 +10844,17 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
10643
10844
  - 发起流程时系统自动补充
10644
10845
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
10645
10846
  :type SignId: str
10646
- :param _NotifyType: SMS: 短信(需确保“电子签短信通知签署方”功能是开启状态才能生效); NONE: 不发信息
10647
- 默认为SMS(签署方为子客时该字段不生效)
10847
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
10848
+ <ul><li> **SMS** :(默认)短信</li>
10849
+ <li> **NONE** : 不通知</li></ul>
10850
+
10851
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
10648
10852
  :type NotifyType: str
10649
10853
  :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
10650
10854
 
10651
10855
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
10652
10856
  :type AddSignComponentsLimits: list of ComponentLimit
10653
- :param _ApproverRoleName: 自定义签署方角色名称
10857
+ :param _ApproverRoleName: 自定义签署人角色名,如收款人、开具人、见证人等
10654
10858
  :type ApproverRoleName: str
10655
10859
  """
10656
10860
  self._Name = None
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.999
3
+ Version: 3.0.1004
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1004
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.999