tencentcloud-sdk-nodejs-ess 4.0.781 → 4.0.782

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.0.781",
3
+ "version": "4.0.782",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -76,7 +76,7 @@
76
76
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2024-01-05 01:13:10 |
77
77
  | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 |
78
78
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 |
79
- | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2023-10-09 01:12:39 |
79
+ | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2024-01-16 01:12:56 |
80
80
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
81
81
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2024-01-11 01:12:33 |
82
82
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 |
@@ -96,8 +96,8 @@
96
96
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
97
97
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-12-25 00:10:01 |
98
98
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-01-03 01:15:03 |
99
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-01-10 01:15:05 |
100
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-01-11 01:14:56 |
99
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-01-16 01:14:53 |
100
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-01-16 01:15:09 |
101
101
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-12-15 19:41:44 |
102
102
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-01-12 01:15:37 |
103
103
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-12-25 00:11:01 |
@@ -154,9 +154,9 @@
154
154
  | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 |
155
155
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
156
156
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-01-05 01:21:32 |
157
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-01-15 01:19:04 |
157
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-01-16 01:19:57 |
158
158
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-01-05 01:21:57 |
159
- | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-12-25 00:15:53 |
159
+ | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-01-16 01:20:17 |
160
160
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-08-17 04:23:46 |
161
161
  | pds | [私域安全](https://cloud.tencent.com/document/product/1473) | 2023-05-18 01:44:14 |
162
162
  | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2023-11-14 01:22:46 |
@@ -212,7 +212,7 @@
212
212
  | tics | [威胁情报云查服务](https://cloud.tencent.com/document/product/1013) | 2023-08-17 05:26:12 |
213
213
  | tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
214
214
  | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-09-01 01:23:47 |
215
- | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2024-01-09 01:26:40 |
215
+ | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2024-01-16 01:24:12 |
216
216
  | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-12-29 01:26:38 |
217
217
  | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-12-26 01:27:04 |
218
218
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
@@ -236,7 +236,7 @@
236
236
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-27 00:23:42 |
237
237
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-12-26 02:05:35 |
238
238
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-11-15 02:42:49 |
239
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-12-28 01:29:55 |
239
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-01-16 01:27:38 |
240
240
  | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2023-12-14 02:56:46 |
241
241
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
242
242
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2023-12-26 02:06:57 |
@@ -999,15 +999,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
999
999
  }
1000
1000
 
1001
1001
  /**
1002
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
1002
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
1003
1003
 
1004
1004
  **注意**
1005
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
1006
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
1007
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1008
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1005
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
1006
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
1007
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1009
1008
  跳转到小程序的实现,参考微信官方文档(分为<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>。
1010
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1009
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1011
1010
  */
1012
1011
  async CreateFlowSignUrl(
1013
1012
  req: CreateFlowSignUrlRequest,
@@ -1383,8 +1382,37 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1383
1382
  }
1384
1383
 
1385
1384
  /**
1386
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
1387
- */
1385
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
1386
+ 支持以下场景
1387
+ <table style="border-collapse: collapse; width: 100%;" border="1">
1388
+ <tbody>
1389
+ <tr>
1390
+ <td style="width: 25%;">生成端</td>
1391
+ <td style="width: 25%;">入参</td>
1392
+ <td style="width: 25%;">提醒方式</td>
1393
+ </tr>
1394
+ <tr>
1395
+ <td style="width: 25%;">普通saas员工</td>
1396
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
1397
+ <td style="width: 25%;">短信</td>
1398
+ </tr>
1399
+ <tr>
1400
+ <td style="width: 25%;">企微员工</td>
1401
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
1402
+ <td style="width: 25%;">企微内部实名消息</td>
1403
+ </tr>
1404
+ <tr>
1405
+ <td style="width: 25%;">H5端 saas员工</td>
1406
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
1407
+ <td style="width: 25%;">生成H5链接</td>
1408
+ </tr>
1409
+ </tbody>
1410
+ </table>
1411
+ 注意:
1412
+
1413
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
1414
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
1415
+ */
1388
1416
  async CreateIntegrationEmployees(
1389
1417
  req: CreateIntegrationEmployeesRequest,
1390
1418
  cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void
@@ -1393,8 +1421,35 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1393
1421
  }
1394
1422
 
1395
1423
  /**
1396
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
1397
- 可进行批量操作,Employees中的userID与openID二选一必填
1424
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
1425
+ 修改手机号的时候,支持以下场景进行提醒通知
1426
+ <table style="border-collapse: collapse; width: 100%;" border="1">
1427
+ <tbody>
1428
+ <tr>
1429
+ <td style="width: 25%;">生成端</td>
1430
+ <td style="width: 25%;">入参</td>
1431
+ <td style="width: 25%;">提醒方式</td>
1432
+ </tr>
1433
+ <tr>
1434
+ <td style="width: 25%;">普通saas员工</td>
1435
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
1436
+ <td style="width: 25%;">短信</td>
1437
+ </tr>
1438
+ <tr>
1439
+ <td style="width: 25%;">企微员工</td>
1440
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
1441
+ <td style="width: 25%;">企微内部实名消息</td>
1442
+ </tr>
1443
+ <tr>
1444
+ <td style="width: 25%;">H5端 saas员工</td>
1445
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
1446
+ <td style="width: 25%;">生成H5链接</td>
1447
+ </tr>
1448
+ </tbody>
1449
+ </table>
1450
+ 注意:
1451
+
1452
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
1398
1453
  */
1399
1454
  async UpdateIntegrationEmployees(
1400
1455
  req: UpdateIntegrationEmployeesRequest,
@@ -799,6 +799,19 @@ export interface CreateIntegrationEmployeesRequest {
799
799
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
800
800
  */
801
801
  Agent?: Agent
802
+ /**
803
+ * 员工邀请方式
804
+ 如果是来自H5的,参数需要传递H5
805
+ 短信或者企微 请传递SMS,或者不传递
806
+ */
807
+ InvitationNotifyType?: string
808
+ /**
809
+ * 回跳地址,
810
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
811
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置
812
+
813
+ */
814
+ JumpUrl?: string
802
815
  }
803
816
 
804
817
  /**
@@ -4691,14 +4704,6 @@ export interface CreateFlowSignUrlRequest {
4691
4704
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4692
4705
  */
4693
4706
  FlowId: string
4694
- /**
4695
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
4696
-
4697
- 注:
4698
- `1. ApproverType目前只支持个人类型的签署人。`
4699
- `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4700
- */
4701
- FlowApproverInfos: Array<FlowCreateApprover>
4702
4707
  /**
4703
4708
  * 执行本接口操作的员工信息。
4704
4709
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -4709,6 +4714,14 @@ export interface CreateFlowSignUrlRequest {
4709
4714
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4710
4715
  */
4711
4716
  Agent?: Agent
4717
+ /**
4718
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
4719
+
4720
+ 注:
4721
+ `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4722
+ `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
4723
+ */
4724
+ FlowApproverInfos?: Array<FlowCreateApprover>
4712
4725
  /**
4713
4726
  * 机构信息,暂未开放
4714
4727
  * @deprecated
@@ -4718,6 +4731,15 @@ export interface CreateFlowSignUrlRequest {
4718
4731
  * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4719
4732
  */
4720
4733
  JumpUrl?: string
4734
+ /**
4735
+ * 链接类型,支持指定以下类型
4736
+ <ul><li>0 : 签署链接 (默认值)</li>
4737
+ <li>1 : 预览链接</li></ul>
4738
+ 注:
4739
+ `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
4740
+ `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
4741
+ */
4742
+ UrlType?: number
4721
4743
  }
4722
4744
 
4723
4745
  /**
@@ -4839,7 +4861,9 @@ export interface FlowDetailInfo {
4839
4861
  }
4840
4862
 
4841
4863
  /**
4842
- * 更新员工信息成功返回的数据信息
4864
+ * 更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
4865
+ 会通过短信、企微消息或者H5Url 链接
4866
+ 如果是通过H5邀请加入的方式,会返回H5 链接
4843
4867
  */
4844
4868
  export interface SuccessUpdateStaffData {
4845
4869
  /**
@@ -4855,6 +4879,12 @@ export interface SuccessUpdateStaffData {
4855
4879
  可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4856
4880
  */
4857
4881
  UserId?: string
4882
+ /**
4883
+ * H5端员工实名链接
4884
+
4885
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
4886
+ */
4887
+ Url?: string
4858
4888
  }
4859
4889
 
4860
4890
  /**
@@ -4948,7 +4978,8 @@ export interface UploadFilesResponse {
4948
4978
  }
4949
4979
 
4950
4980
  /**
4951
- * 创建员工的成功数据
4981
+ * 创建员工成功返回的信息
4982
+ 支持saas/企微/H5端进行加入。
4952
4983
  */
4953
4984
  export interface SuccessCreateStaffData {
4954
4985
  /**
@@ -4972,6 +5003,12 @@ export interface SuccessCreateStaffData {
4972
5003
  * 传入的企微账号id
4973
5004
  */
4974
5005
  WeworkOpenId?: string
5006
+ /**
5007
+ * H5端员工加入\实名链接
5008
+
5009
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
5010
+ */
5011
+ Url?: string
4975
5012
  }
4976
5013
 
4977
5014
  /**
@@ -6192,8 +6229,9 @@ export interface Component {
6192
6229
  <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6193
6230
  <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
6194
6231
 
6195
- **如果是SignComponent签署控件类型,则可选的字段为**
6196
-
6232
+ **如果是SignComponent签署控件类型,
6233
+ 需要根据签署人的类型可选的字段为**
6234
+ * 企业方
6197
6235
  <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6198
6236
  <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6199
6237
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
@@ -6201,6 +6239,12 @@ export interface Component {
6201
6239
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6202
6240
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6203
6241
  <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6242
+
6243
+ * 个人方
6244
+ <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6245
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6246
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
6247
+
6204
6248
  注:` 表单域的控件不能作为印章和签名控件`
6205
6249
  */
6206
6250
  ComponentType: string
@@ -6633,6 +6677,18 @@ export interface UpdateIntegrationEmployeesRequest {
6633
6677
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6634
6678
  */
6635
6679
  Agent?: Agent
6680
+ /**
6681
+ * 员工邀请方式
6682
+ 如果是来自H5的,参数需要传递H5
6683
+ 短信或者企微 请传递SMS,或者不传递
6684
+ */
6685
+ InvitationNotifyType?: string
6686
+ /**
6687
+ * 回跳地址,
6688
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
6689
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置。
6690
+ */
6691
+ JumpUrl?: string
6636
6692
  }
6637
6693
 
6638
6694
  /**
@@ -500,15 +500,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
500
500
  */
501
501
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
502
502
  /**
503
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
503
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
504
504
 
505
505
  **注意**
506
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
507
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
508
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
509
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
506
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
507
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
508
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
510
509
  跳转到小程序的实现,参考微信官方文档(分为<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>。
511
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
510
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
512
511
  */
513
512
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
514
513
  /**
@@ -734,12 +733,68 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
734
733
  */
735
734
  DeleteExtendedServiceAuthInfos(req: DeleteExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DeleteExtendedServiceAuthInfosResponse) => void): Promise<DeleteExtendedServiceAuthInfosResponse>;
736
735
  /**
737
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
738
- */
736
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
737
+ 支持以下场景
738
+ <table style="border-collapse: collapse; width: 100%;" border="1">
739
+ <tbody>
740
+ <tr>
741
+ <td style="width: 25%;">生成端</td>
742
+ <td style="width: 25%;">入参</td>
743
+ <td style="width: 25%;">提醒方式</td>
744
+ </tr>
745
+ <tr>
746
+ <td style="width: 25%;">普通saas员工</td>
747
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
748
+ <td style="width: 25%;">短信</td>
749
+ </tr>
750
+ <tr>
751
+ <td style="width: 25%;">企微员工</td>
752
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
753
+ <td style="width: 25%;">企微内部实名消息</td>
754
+ </tr>
755
+ <tr>
756
+ <td style="width: 25%;">H5端 saas员工</td>
757
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
758
+ <td style="width: 25%;">生成H5链接</td>
759
+ </tr>
760
+ </tbody>
761
+ </table>
762
+ 注意:
763
+
764
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
765
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
766
+ */
739
767
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
740
768
  /**
741
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
742
- 可进行批量操作,Employees中的userID与openID二选一必填
769
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
770
+ 修改手机号的时候,支持以下场景进行提醒通知
771
+ <table style="border-collapse: collapse; width: 100%;" border="1">
772
+ <tbody>
773
+ <tr>
774
+ <td style="width: 25%;">生成端</td>
775
+ <td style="width: 25%;">入参</td>
776
+ <td style="width: 25%;">提醒方式</td>
777
+ </tr>
778
+ <tr>
779
+ <td style="width: 25%;">普通saas员工</td>
780
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
781
+ <td style="width: 25%;">短信</td>
782
+ </tr>
783
+ <tr>
784
+ <td style="width: 25%;">企微员工</td>
785
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
786
+ <td style="width: 25%;">企微内部实名消息</td>
787
+ </tr>
788
+ <tr>
789
+ <td style="width: 25%;">H5端 saas员工</td>
790
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
791
+ <td style="width: 25%;">生成H5链接</td>
792
+ </tr>
793
+ </tbody>
794
+ </table>
795
+ 注意:
796
+
797
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
743
798
  */
744
799
  UpdateIntegrationEmployees(req: UpdateIntegrationEmployeesRequest, cb?: (error: string, rep: UpdateIntegrationEmployeesResponse) => void): Promise<UpdateIntegrationEmployeesResponse>;
745
800
  }
@@ -609,15 +609,14 @@ class Client extends TencentCloudCommon.AbstractClient {
609
609
  return this.request("DescribeIntegrationEmployees", req, cb);
610
610
  }
611
611
  /**
612
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
612
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
613
613
 
614
614
  **注意**
615
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
616
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
617
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
618
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
615
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
616
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
617
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
619
618
  跳转到小程序的实现,参考微信官方文档(分为<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>。
620
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
619
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
621
620
  */
622
621
  async CreateFlowSignUrl(req, cb) {
623
622
  return this.request("CreateFlowSignUrl", req, cb);
@@ -893,14 +892,70 @@ class Client extends TencentCloudCommon.AbstractClient {
893
892
  return this.request("DeleteExtendedServiceAuthInfos", req, cb);
894
893
  }
895
894
  /**
896
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
897
- */
895
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
896
+ 支持以下场景
897
+ <table style="border-collapse: collapse; width: 100%;" border="1">
898
+ <tbody>
899
+ <tr>
900
+ <td style="width: 25%;">生成端</td>
901
+ <td style="width: 25%;">入参</td>
902
+ <td style="width: 25%;">提醒方式</td>
903
+ </tr>
904
+ <tr>
905
+ <td style="width: 25%;">普通saas员工</td>
906
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
907
+ <td style="width: 25%;">短信</td>
908
+ </tr>
909
+ <tr>
910
+ <td style="width: 25%;">企微员工</td>
911
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
912
+ <td style="width: 25%;">企微内部实名消息</td>
913
+ </tr>
914
+ <tr>
915
+ <td style="width: 25%;">H5端 saas员工</td>
916
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
917
+ <td style="width: 25%;">生成H5链接</td>
918
+ </tr>
919
+ </tbody>
920
+ </table>
921
+ 注意:
922
+
923
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
924
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
925
+ */
898
926
  async CreateIntegrationEmployees(req, cb) {
899
927
  return this.request("CreateIntegrationEmployees", req, cb);
900
928
  }
901
929
  /**
902
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
903
- 可进行批量操作,Employees中的userID与openID二选一必填
930
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
931
+ 修改手机号的时候,支持以下场景进行提醒通知
932
+ <table style="border-collapse: collapse; width: 100%;" border="1">
933
+ <tbody>
934
+ <tr>
935
+ <td style="width: 25%;">生成端</td>
936
+ <td style="width: 25%;">入参</td>
937
+ <td style="width: 25%;">提醒方式</td>
938
+ </tr>
939
+ <tr>
940
+ <td style="width: 25%;">普通saas员工</td>
941
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
942
+ <td style="width: 25%;">短信</td>
943
+ </tr>
944
+ <tr>
945
+ <td style="width: 25%;">企微员工</td>
946
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
947
+ <td style="width: 25%;">企微内部实名消息</td>
948
+ </tr>
949
+ <tr>
950
+ <td style="width: 25%;">H5端 saas员工</td>
951
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
952
+ <td style="width: 25%;">生成H5链接</td>
953
+ </tr>
954
+ </tbody>
955
+ </table>
956
+ 注意:
957
+
958
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
904
959
  */
905
960
  async UpdateIntegrationEmployees(req, cb) {
906
961
  return this.request("UpdateIntegrationEmployees", req, cb);
@@ -755,6 +755,19 @@ export interface CreateIntegrationEmployeesRequest {
755
755
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
756
756
  */
757
757
  Agent?: Agent;
758
+ /**
759
+ * 员工邀请方式
760
+ 如果是来自H5的,参数需要传递H5
761
+ 短信或者企微 请传递SMS,或者不传递
762
+ */
763
+ InvitationNotifyType?: string;
764
+ /**
765
+ * 回跳地址,
766
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
767
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置
768
+
769
+ */
770
+ JumpUrl?: string;
758
771
  }
759
772
  /**
760
773
  * 创建合同个性化参数
@@ -4545,14 +4558,6 @@ export interface CreateFlowSignUrlRequest {
4545
4558
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4546
4559
  */
4547
4560
  FlowId: string;
4548
- /**
4549
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
4550
-
4551
- 注:
4552
- `1. ApproverType目前只支持个人类型的签署人。`
4553
- `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4554
- */
4555
- FlowApproverInfos: Array<FlowCreateApprover>;
4556
4561
  /**
4557
4562
  * 执行本接口操作的员工信息。
4558
4563
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -4563,6 +4568,14 @@ export interface CreateFlowSignUrlRequest {
4563
4568
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4564
4569
  */
4565
4570
  Agent?: Agent;
4571
+ /**
4572
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
4573
+
4574
+ 注:
4575
+ `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4576
+ `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
4577
+ */
4578
+ FlowApproverInfos?: Array<FlowCreateApprover>;
4566
4579
  /**
4567
4580
  * 机构信息,暂未开放
4568
4581
  * @deprecated
@@ -4572,6 +4585,15 @@ export interface CreateFlowSignUrlRequest {
4572
4585
  * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4573
4586
  */
4574
4587
  JumpUrl?: string;
4588
+ /**
4589
+ * 链接类型,支持指定以下类型
4590
+ <ul><li>0 : 签署链接 (默认值)</li>
4591
+ <li>1 : 预览链接</li></ul>
4592
+ 注:
4593
+ `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
4594
+ `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
4595
+ */
4596
+ UrlType?: number;
4575
4597
  }
4576
4598
  /**
4577
4599
  * CreateReleaseFlow请求参数结构体
@@ -4689,7 +4711,9 @@ export interface FlowDetailInfo {
4689
4711
  Creator?: string;
4690
4712
  }
4691
4713
  /**
4692
- * 更新员工信息成功返回的数据信息
4714
+ * 更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
4715
+ 会通过短信、企微消息或者H5Url 链接
4716
+ 如果是通过H5邀请加入的方式,会返回H5 链接
4693
4717
  */
4694
4718
  export interface SuccessUpdateStaffData {
4695
4719
  /**
@@ -4705,6 +4729,12 @@ export interface SuccessUpdateStaffData {
4705
4729
  可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4706
4730
  */
4707
4731
  UserId?: string;
4732
+ /**
4733
+ * H5端员工实名链接
4734
+
4735
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
4736
+ */
4737
+ Url?: string;
4708
4738
  }
4709
4739
  /**
4710
4740
  * CreatePersonAuthCertificateImage请求参数结构体
@@ -4794,7 +4824,8 @@ export interface UploadFilesResponse {
4794
4824
  RequestId?: string;
4795
4825
  }
4796
4826
  /**
4797
- * 创建员工的成功数据
4827
+ * 创建员工成功返回的信息
4828
+ 支持saas/企微/H5端进行加入。
4798
4829
  */
4799
4830
  export interface SuccessCreateStaffData {
4800
4831
  /**
@@ -4818,6 +4849,12 @@ export interface SuccessCreateStaffData {
4818
4849
  * 传入的企微账号id
4819
4850
  */
4820
4851
  WeworkOpenId?: string;
4852
+ /**
4853
+ * H5端员工加入\实名链接
4854
+
4855
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
4856
+ */
4857
+ Url?: string;
4821
4858
  }
4822
4859
  /**
4823
4860
  * 流程中参与方的信息结构
@@ -6001,8 +6038,9 @@ export interface Component {
6001
6038
  <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6002
6039
  <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
6003
6040
 
6004
- **如果是SignComponent签署控件类型,则可选的字段为**
6005
-
6041
+ **如果是SignComponent签署控件类型,
6042
+ 需要根据签署人的类型可选的字段为**
6043
+ * 企业方
6006
6044
  <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6007
6045
  <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6008
6046
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
@@ -6010,6 +6048,12 @@ export interface Component {
6010
6048
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6011
6049
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6012
6050
  <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6051
+
6052
+ * 个人方
6053
+ <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6054
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6055
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
6056
+
6013
6057
  注:` 表单域的控件不能作为印章和签名控件`
6014
6058
  */
6015
6059
  ComponentType: string;
@@ -6436,6 +6480,18 @@ export interface UpdateIntegrationEmployeesRequest {
6436
6480
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6437
6481
  */
6438
6482
  Agent?: Agent;
6483
+ /**
6484
+ * 员工邀请方式
6485
+ 如果是来自H5的,参数需要传递H5
6486
+ 短信或者企微 请传递SMS,或者不传递
6487
+ */
6488
+ InvitationNotifyType?: string;
6489
+ /**
6490
+ * 回跳地址,
6491
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
6492
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置。
6493
+ */
6494
+ JumpUrl?: string;
6439
6495
  }
6440
6496
  /**
6441
6497
  * DescribeFlowBriefs请求参数结构体