tencentcloud-sdk-nodejs-ess 4.0.684 → 4.0.686

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.
@@ -186,14 +186,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
186
186
  */
187
187
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
188
188
  /**
189
- * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
189
+ * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
190
+ 解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
190
191
 
191
- `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
192
- `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
193
- `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
194
- `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
195
- `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
196
- `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
192
+ 注意:
193
+ <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
194
+ <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
195
+ <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
196
+ <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
197
+ <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
198
+ <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
197
199
  */
198
200
  CreateReleaseFlow(req: CreateReleaseFlowRequest, cb?: (error: string, rep: CreateReleaseFlowResponse) => void): Promise<CreateReleaseFlowResponse>;
199
201
  /**
@@ -277,15 +279,23 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
277
279
  /**
278
280
  * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
279
281
 
280
- 注:
281
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
282
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
283
- `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
282
+ `注意:`<br/>
283
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
284
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
285
+ `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
286
+ `4. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
287
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
284
288
  */
285
289
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
286
290
  /**
287
- * 本接口(CreatePersonAuthCertificateImage)用于创建个人用户证书证明图片
288
- */
291
+ * 获取个人用户认证证书图片下载URL
292
+
293
+ 个人用户认证证书图片样式如下图
294
+
295
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
296
+
297
+ 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
298
+ */
289
299
  CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
290
300
  /**
291
301
  * 此接口(CreateConvertTaskApi)用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
@@ -294,14 +304,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
294
304
  适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
295
305
  转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
296
306
  注:
297
- 1. `支持的文件类型有doc\docx\xls\xlsx\jpg\jpeg\png\bmp\txt`
307
+ 1. `支持的文件类型有docdocxxlsxlsxjpgjpegpngbmptxt`
298
308
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
299
309
  */
300
310
  CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
301
311
  /**
302
312
  * 查询流程基础信息
303
313
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
304
- 每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误
314
+
315
+ 注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
305
316
  */
306
317
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
307
318
  /**
@@ -351,8 +362,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
351
362
  */
352
363
  DescribeIntegrationMainOrganizationUser(req: DescribeIntegrationMainOrganizationUserRequest, cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void): Promise<DescribeIntegrationMainOrganizationUserResponse>;
353
364
  /**
354
- * 通过AuthCode查询用户是否实名
355
- */
365
+ * 通过AuthCode查询个人用户是否实名
366
+
367
+
368
+ 注意:
369
+ <ul>
370
+ <li>此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。</li>
371
+ <li>`AuthCode 只能使用一次`,查询一次再次查询会返回错误</li>
372
+ </ul>
373
+ */
356
374
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
357
375
  /**
358
376
  * 用来创建页面主题配置
@@ -259,14 +259,16 @@ class Client extends TencentCloudCommon.AbstractClient {
259
259
  return this.request("CreateFlow", req, cb);
260
260
  }
261
261
  /**
262
- * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
262
+ * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
263
+ 解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
263
264
 
264
- `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
265
- `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
266
- `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
267
- `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
268
- `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
269
- `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
265
+ 注意:
266
+ <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
267
+ <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
268
+ <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
269
+ <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
270
+ <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
271
+ <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
270
272
  */
271
273
  async CreateReleaseFlow(req, cb) {
272
274
  return this.request("CreateReleaseFlow", req, cb);
@@ -378,17 +380,25 @@ class Client extends TencentCloudCommon.AbstractClient {
378
380
  /**
379
381
  * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
380
382
 
381
- 注:
382
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
383
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
384
- `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
383
+ `注意:`<br/>
384
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
385
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
386
+ `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
387
+ `4. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
388
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
385
389
  */
386
390
  async CreateFlowSignUrl(req, cb) {
387
391
  return this.request("CreateFlowSignUrl", req, cb);
388
392
  }
389
393
  /**
390
- * 本接口(CreatePersonAuthCertificateImage)用于创建个人用户证书证明图片
391
- */
394
+ * 获取个人用户认证证书图片下载URL
395
+
396
+ 个人用户认证证书图片样式如下图
397
+
398
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
399
+
400
+ 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
401
+ */
392
402
  async CreatePersonAuthCertificateImage(req, cb) {
393
403
  return this.request("CreatePersonAuthCertificateImage", req, cb);
394
404
  }
@@ -399,7 +409,7 @@ class Client extends TencentCloudCommon.AbstractClient {
399
409
  适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
400
410
  转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
401
411
  注:
402
- 1. `支持的文件类型有doc\docx\xls\xlsx\jpg\jpeg\png\bmp\txt`
412
+ 1. `支持的文件类型有docdocxxlsxlsxjpgjpegpngbmptxt`
403
413
  2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
404
414
  */
405
415
  async CreateConvertTaskApi(req, cb) {
@@ -408,7 +418,8 @@ class Client extends TencentCloudCommon.AbstractClient {
408
418
  /**
409
419
  * 查询流程基础信息
410
420
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
411
- 每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误
421
+
422
+ 注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
412
423
  */
413
424
  async DescribeFlowBriefs(req, cb) {
414
425
  return this.request("DescribeFlowBriefs", req, cb);
@@ -474,8 +485,15 @@ class Client extends TencentCloudCommon.AbstractClient {
474
485
  return this.request("DescribeIntegrationMainOrganizationUser", req, cb);
475
486
  }
476
487
  /**
477
- * 通过AuthCode查询用户是否实名
478
- */
488
+ * 通过AuthCode查询个人用户是否实名
489
+
490
+
491
+ 注意:
492
+ <ul>
493
+ <li>此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。</li>
494
+ <li>`AuthCode 只能使用一次`,查询一次再次查询会返回错误</li>
495
+ </ul>
496
+ */
479
497
  async DescribeThirdPartyAuthCode(req, cb) {
480
498
  return this.request("DescribeThirdPartyAuthCode", req, cb);
481
499
  }
@@ -374,7 +374,10 @@ export interface ReviewerInfo {
374
374
  */
375
375
  export interface DescribeThirdPartyAuthCodeResponse {
376
376
  /**
377
- * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
377
+ * AuthCode 中对应个人用户是否实名
378
+ <ul>
379
+ <li> **VERIFIED** : 此个人已实名</li>
380
+ <li> **UNVERIFIED**: 此个人未实名</li></ul>
378
381
  */
379
382
  VerifyStatus?: string;
380
383
  /**
@@ -548,7 +551,10 @@ export interface ReleasedApprover {
548
551
  */
549
552
  ApproverSignComponentType?: string;
550
553
  /**
551
- * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
554
+ * 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
555
+
556
+ 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
557
+
552
558
  */
553
559
  ApproverSignRole?: string;
554
560
  }
@@ -1175,7 +1181,9 @@ export interface DescribeIntegrationEmployeesRequest {
1175
1181
  */
1176
1182
  Agent?: Agent;
1177
1183
  /**
1178
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
1184
+ * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1185
+ 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1186
+ 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1179
1187
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1180
1188
  */
1181
1189
  Filters?: Array<Filter>;
@@ -1445,7 +1453,7 @@ export interface AutoSignConfig {
1445
1453
  <li>**TELECOM** : 运营商三要素验证</li></ul>
1446
1454
  注:
1447
1455
  <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
1448
- <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li>
1456
+ <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1449
1457
  */
1450
1458
  VerifyChannels?: Array<string>;
1451
1459
  /**
@@ -1462,15 +1470,17 @@ export interface AutoSignConfig {
1462
1470
  */
1463
1471
  export interface DescribeThirdPartyAuthCodeRequest {
1464
1472
  /**
1465
- * 电子签小程序跳转客户小程序时携带的授权查看码
1473
+ * 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
1466
1474
  */
1467
1475
  AuthCode: string;
1468
1476
  /**
1469
- * 操作人信息
1477
+ * 执行本接口操作的员工信息。
1478
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1470
1479
  */
1471
1480
  Operator?: UserInfo;
1472
1481
  /**
1473
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1482
+ * 代理企业和员工的信息。
1483
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1474
1484
  */
1475
1485
  Agent?: Agent;
1476
1486
  }
@@ -1615,6 +1625,34 @@ export interface Permission {
1615
1625
  */
1616
1626
  Children?: Array<Permission>;
1617
1627
  }
1628
+ /**
1629
+ * 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
1630
+ */
1631
+ export interface ComponentLimit {
1632
+ /**
1633
+ * 控件类型,支持以下类型
1634
+ <ul><li>SIGN_SEAL : 印章控件</li>
1635
+ <li>SIGN_PAGING_SEAL : 骑缝章控件</li>
1636
+ <li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
1637
+ <li>SIGN_SIGNATURE : 用户签名控件</li></ul>
1638
+ */
1639
+ ComponentType: string;
1640
+ /**
1641
+ * 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
1642
+
1643
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
1644
+
1645
+ 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
1646
+
1647
+ <ul><li>HANDWRITE : 手写签名</li>
1648
+ <li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
1649
+ <li>ESIGN : 个人印章</li>
1650
+ <li>SYSTEM_ESIGN : 系统印章</li></ul>
1651
+
1652
+ 3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
1653
+ */
1654
+ ComponentValue?: Array<string>;
1655
+ }
1618
1656
  /**
1619
1657
  * CreateIntegrationDepartment返回参数结构体
1620
1658
  */
@@ -1845,26 +1883,33 @@ export interface OccupiedSeal {
1845
1883
  */
1846
1884
  export interface CreatePersonAuthCertificateImageResponse {
1847
1885
  /**
1848
- * 个人用户证明证书的下载链接
1886
+ * 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
1849
1887
  */
1850
1888
  AuthCertUrl?: string;
1851
1889
  /**
1852
- * 证书图片上的证书编号,20位数字
1890
+ * 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
1891
+ 该编号会合成到个人用户证书证明图片。
1892
+
1893
+ 注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
1853
1894
  注意:此字段可能返回 null,表示取不到有效值。
1854
1895
  */
1855
1896
  ImageCertId?: string;
1856
1897
  /**
1857
- * 图片证明对应的CA证书序列号
1898
+ * CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。
1899
+
1900
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`
1858
1901
  注意:此字段可能返回 null,表示取不到有效值。
1859
1902
  */
1860
1903
  SerialNumber?: string;
1861
1904
  /**
1862
- * CA证书颁发时间戳
1905
+ * CA证书颁发时间,格式为Unix标准时间戳(秒)
1906
+ 该时间格式化后会合成到个人用户证书证明图片
1863
1907
  注意:此字段可能返回 null,表示取不到有效值。
1864
1908
  */
1865
1909
  ValidFrom?: number;
1866
1910
  /**
1867
- * CA证书有效截止时间戳
1911
+ * CA证书有效截止时间,格式为Unix标准时间戳(秒)
1912
+ 该时间格式化后会合成到个人用户证书证明图片
1868
1913
  注意:此字段可能返回 null,表示取不到有效值。
1869
1914
  */
1870
1915
  ValidTo?: number;
@@ -3687,7 +3732,7 @@ export interface CreateReleaseFlowRequest {
3687
3732
  */
3688
3733
  NeedRelievedFlowId: string;
3689
3734
  /**
3690
- * 解除协议内容。
3735
+ * 解除协议内容, 包括解除理由等信息。
3691
3736
  */
3692
3737
  ReliveInfo: RelieveInfo;
3693
3738
  /**
@@ -3695,12 +3740,12 @@ export interface CreateReleaseFlowRequest {
3695
3740
  */
3696
3741
  Agent?: Agent;
3697
3742
  /**
3698
- * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3699
- 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3700
- 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3743
+ * 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
3744
+ 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3701
3745
 
3702
- `注意:只能更换同企业的签署人。`<br/>
3703
- `注意:不支持更换个人类型的签署人。`<br/>
3746
+ 注意:
3747
+ `只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
3748
+ `可以不指定替换签署人, 使用原流程的签署人 `
3704
3749
  */
3705
3750
  ReleasedApprovers?: Array<ReleasedApprover>;
3706
3751
  /**
@@ -3777,7 +3822,8 @@ export interface SuccessUpdateStaffData {
3777
3822
  */
3778
3823
  export interface CreatePersonAuthCertificateImageRequest {
3779
3824
  /**
3780
- * 操作人信息
3825
+ * 执行本接口操作的员工信息。
3826
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3781
3827
  */
3782
3828
  Operator: UserInfo;
3783
3829
  /**
@@ -3785,20 +3831,24 @@ export interface CreatePersonAuthCertificateImageRequest {
3785
3831
  */
3786
3832
  UserName: string;
3787
3833
  /**
3788
- * 身份证件类型取值:
3789
- ID_CARD 身居民身份证
3790
- PASSPORT 护照
3791
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
3792
- FOREIGN_ID_CARD 外国人永久居留身份证
3793
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3834
+ * 证件类型,支持以下类型
3835
+ <ul><li> ID_CARD : 居民身份证 (默认值)</li>
3836
+ <li> PASSPORT : 护照</li>
3837
+ <li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
3838
+ <li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3839
+ <li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
3794
3840
  */
3795
3841
  IdCardType: string;
3796
3842
  /**
3797
- * 身份证件号码
3843
+ * 证件号码,应符合以下规则
3844
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3845
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3846
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3798
3847
  */
3799
3848
  IdCardNumber: string;
3800
3849
  /**
3801
- * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3850
+ * 代理企业和员工的信息。
3851
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3802
3852
  */
3803
3853
  Agent?: Agent;
3804
3854
  }
@@ -4102,6 +4152,12 @@ export interface ApproverInfo {
4102
4152
  注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4103
4153
  */
4104
4154
  ApproverNeedSignReview?: boolean;
4155
+ /**
4156
+ * [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
4157
+
4158
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
4159
+ */
4160
+ AddSignComponentsLimits?: Array<ComponentLimit>;
4105
4161
  }
4106
4162
  /**
4107
4163
  * CreateFlowSignReview返回参数结构体
@@ -4198,7 +4254,7 @@ export interface CreateUserAutoSignEnableUrlRequest {
4198
4254
  /**
4199
4255
  * 生成的链接类型:
4200
4256
  <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
4201
- <li> **H5SIGN** : 生成H5端开通链接</li><ul>
4257
+ <li> **H5SIGN** : 生成H5端开通链接</li></ul>
4202
4258
  */
4203
4259
  UrlType?: string;
4204
4260
  /**
@@ -5308,15 +5364,20 @@ export interface UpdateIntegrationEmployeesRequest {
5308
5364
  */
5309
5365
  export interface DescribeFlowBriefsRequest {
5310
5366
  /**
5311
- * 调用方用户信息,userId 必填
5367
+ * 执行本接口操作的员工信息。
5368
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5312
5369
  */
5313
5370
  Operator: UserInfo;
5314
5371
  /**
5315
- * 需要查询的流程ID列表,限制最大100
5372
+ * 查询的合同流程ID列表最多支持100个流程ID。
5373
+ 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
5374
+
5375
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5316
5376
  */
5317
5377
  FlowIds: Array<string>;
5318
5378
  /**
5319
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5379
+ * 代理企业和员工的信息。
5380
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5320
5381
  */
5321
5382
  Agent?: Agent;
5322
5383
  }
@@ -5406,7 +5467,8 @@ export interface DeleteStaffsResult {
5406
5467
  */
5407
5468
  export interface DescribeFlowBriefsResponse {
5408
5469
  /**
5409
- * 流程列表
5470
+ * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
5471
+ 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
5410
5472
  */
5411
5473
  FlowBriefs?: Array<FlowBrief>;
5412
5474
  /**
@@ -5554,27 +5616,24 @@ export interface ExtendAuthInfo {
5554
5616
  */
5555
5617
  export interface RelieveInfo {
5556
5618
  /**
5557
- * 解除理由,最大支持200个字
5619
+ * 解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5558
5620
  */
5559
5621
  Reason: string;
5560
5622
  /**
5561
- * 解除后仍然有效的条款,保留条款,最大支持200个字
5623
+ * 解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5562
5624
 
5563
5625
  */
5564
5626
  RemainInForceItem?: string;
5565
5627
  /**
5566
- * 原合同事项处理-费用结算,最大支持200个字
5567
-
5628
+ * 原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5568
5629
  */
5569
5630
  OriginalExpenseSettlement?: string;
5570
5631
  /**
5571
- * 原合同事项处理-其他事项,最大支持200个字
5572
-
5632
+ * 原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5573
5633
  */
5574
5634
  OriginalOtherSettlement?: string;
5575
5635
  /**
5576
- * 其他约定,最大支持200个字
5577
-
5636
+ * 其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5578
5637
  */
5579
5638
  OtherDeals?: string;
5580
5639
  }