tencentcloud-sdk-nodejs-ess 4.0.679 → 4.0.680

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.679",
3
+ "version": "4.0.680",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -45,9 +45,9 @@
45
45
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-08-17 01:37:50 |
46
46
  | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-08-21 01:07:44 |
47
47
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2023-08-17 01:43:06 |
48
- | cdwch | [云数据仓库 ClickHouse](https://cloud.tencent.com/document/product/1299) | 2023-08-31 01:09:05 |
48
+ | cdwch | [云数据仓库 ClickHouse](https://cloud.tencent.com/document/product/1299) | 2023-09-01 01:09:03 |
49
49
  | cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2023-08-23 01:12:18 |
50
- | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2023-08-28 01:20:23 |
50
+ | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2023-09-01 01:09:12 |
51
51
  | cfw | [云防火墙](https://cloud.tencent.com/document/product/1132) | 2023-08-31 01:09:25 |
52
52
  | chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2023-08-17 01:47:49 |
53
53
  | ciam | [账号风控平台](https://cloud.tencent.com/document/product/1441) | 2023-07-06 01:13:25 |
@@ -65,7 +65,7 @@
65
65
  | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-08-24 01:10:10 |
66
66
  | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-08-17 02:03:56 |
67
67
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
68
- | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-08-31 01:11:48 |
68
+ | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-09-01 01:11:09 |
69
69
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
70
70
  | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-08-31 01:12:23 |
71
71
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-08-31 01:12:44 |
@@ -74,28 +74,28 @@
74
74
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2023-08-17 02:45:26 |
75
75
  | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 |
76
76
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 |
77
- | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2023-08-31 01:13:53 |
77
+ | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2023-09-01 01:12:36 |
78
78
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
79
79
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-08-17 02:50:46 |
80
80
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-08-29 01:12:46 |
81
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-08-22 01:11:51 |
81
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-09-01 01:13:07 |
82
82
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-08-30 01:13:12 |
83
83
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-08-17 02:58:55 |
84
84
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-08-17 02:59:36 |
85
85
  | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 |
86
86
  | dsgc | [数据安全中心](https://cloud.tencent.com/document/product/1087) | 2023-08-31 01:14:45 |
87
87
  | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 |
88
- | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2023-08-18 16:50:40 |
88
+ | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2023-09-01 01:13:57 |
89
89
  | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-08-22 01:12:28 |
90
90
  | ecc | [英文作文批改](https://cloud.tencent.com/document/product/1076) | 2023-08-17 03:03:01 |
91
91
  | ecdn | [全站加速网络](https://cloud.tencent.com/document/product/570) | 2023-08-17 03:03:04 |
92
- | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-08-18 01:11:07 |
92
+ | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-09-01 01:14:14 |
93
93
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
94
94
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
95
95
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-08-17 03:08:06 |
96
96
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-08-29 01:14:45 |
97
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-08-31 01:16:24 |
98
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-08-31 01:16:36 |
97
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-09-01 01:14:51 |
98
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-09-01 01:15:02 |
99
99
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-07-27 01:13:31 |
100
100
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-08-31 01:16:46 |
101
101
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
@@ -115,7 +115,7 @@
115
115
  | ie | [智能编辑](https://cloud.tencent.com/document/product/1186) | 2023-08-17 03:20:18 |
116
116
  | iecp | [物联网边缘计算平台](https://cloud.tencent.com/document/product/1118) | 2023-05-18 01:30:55 |
117
117
  | iir | [智能识图](https://cloud.tencent.com/document/product/1217) | 2022-04-04 06:48:05 |
118
- | ims | [图片内容安全](https://cloud.tencent.com/document/product/1125) | 2023-05-18 01:31:36 |
118
+ | ims | [图片内容安全](https://cloud.tencent.com/document/product/1125) | 2023-09-01 01:16:08 |
119
119
  | iot | [加速物联网套件](https://cloud.tencent.com/document/product/568) | 2023-07-17 01:22:28 |
120
120
  | iotcloud | [物联网通信](https://cloud.tencent.com/document/product/634) | 2023-08-09 01:29:39 |
121
121
  | iotexplorer | [物联网开发平台](https://cloud.tencent.com/document/product/1081) | 2023-08-22 01:14:25 |
@@ -141,7 +141,7 @@
141
141
  | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-08-30 01:19:09 |
142
142
  | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-08-25 01:55:53 |
143
143
  | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-08-17 04:10:02 |
144
- | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-08-22 01:16:40 |
144
+ | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-09-01 01:18:55 |
145
145
  | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-05-18 01:42:01 |
146
146
  | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-08-30 01:19:55 |
147
147
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-08-17 04:18:22 |
@@ -206,9 +206,9 @@
206
206
  | ticm | [智能鉴黄](https://cloud.tencent.com/document/product/864) | 2021-01-07 08:08:15 |
207
207
  | tics | [威胁情报云查服务](https://cloud.tencent.com/document/product/1013) | 2023-08-17 05:26:12 |
208
208
  | tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
209
- | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-08-17 05:26:15 |
210
- | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-08-28 02:39:57 |
211
- | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-08-17 05:29:47 |
209
+ | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-09-01 01:23:47 |
210
+ | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-09-01 01:23:56 |
211
+ | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-09-01 01:24:40 |
212
212
  | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-08-17 05:31:16 |
213
213
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
214
214
  | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2023-05-18 02:01:07 |
@@ -219,15 +219,15 @@
219
219
  | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2023-08-15 01:44:16 |
220
220
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2023-07-18 01:53:24 |
221
221
  | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2023-08-31 01:26:49 |
222
- | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-08-29 01:25:23 |
222
+ | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-09-01 01:25:13 |
223
223
  | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2023-08-31 01:27:03 |
224
224
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2023-05-18 02:04:00 |
225
225
  | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-08-22 01:22:20 |
226
226
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2023-08-17 05:50:27 |
227
227
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 |
228
228
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
229
- | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-08-31 01:27:41 |
230
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-08-31 11:01:10 |
229
+ | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-09-01 01:25:57 |
230
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-09-01 01:26:26 |
231
231
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
232
232
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-08-31 10:55:43 |
233
233
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
@@ -512,8 +512,9 @@ callbackinfo包含: 回调地址和签名key
512
512
  }
513
513
 
514
514
  /**
515
- * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
516
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
515
+ * 创建出证报告并返回报告ID
516
+ 使用此功能需搭配出证套餐。
517
+ 注意:出证过程需一定时间,建议在调用创建出证后的24小时之后,通过DescribeFlowEvidenceReport接口进行查询。
517
518
  */
518
519
  async CreateFlowEvidenceReport(
519
520
  req: CreateFlowEvidenceReportRequest,
@@ -791,11 +792,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
791
792
  }
792
793
 
793
794
  /**
794
- * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
795
- 注意:
796
- 该接口不可直接调用,请联系客户经理申请使用
797
- 仅能催办当前状态为“待签署”的签署人,且只能催办一次
798
- 发起合同时,签署人的NotifyType需设置为sms,否则无法催办
795
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
796
+
797
+ 1. 发起合同时,签署人的NotifyType需设置为sms
798
+ 2. 合同中当前状态为“待签署”的签署人是催办的对象
799
+ 3. 每个合同只能催办一次
800
+
801
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
799
802
  */
800
803
  async CreateFlowReminds(
801
804
  req: CreateFlowRemindsRequest,
@@ -621,16 +621,18 @@ Key:"IsReturnPermissionGroup",Values:["0"]:表示接口不返回角色对应
621
621
  */
622
622
  export interface CreateFlowEvidenceReportRequest {
623
623
  /**
624
- * 调用方用户信息,userId 必填
624
+ * 执行本接口操作的员工信息。
625
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
625
626
  */
626
627
  Operator: UserInfo
627
628
  /**
628
- * 签署流程编号
629
+ * 合同流程ID,为32位字符串。
630
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
629
631
  */
630
632
  FlowId: string
631
633
  /**
632
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
633
-
634
+ * 代理企业和员工的信息。
635
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
634
636
  */
635
637
  Agent?: Agent
636
638
  }
@@ -794,7 +796,7 @@ export interface DeleteIntegrationEmployeesResponse {
794
796
  */
795
797
  export interface CreateFlowRemindsResponse {
796
798
  /**
797
- * 催办合同详情列表
799
+ * 合同催办结果的详细信息列表。
798
800
  */
799
801
  RemindFlowRecords?: Array<RemindFlowRecords>
800
802
  /**
@@ -1258,6 +1260,10 @@ export interface CreateFlowRequest {
1258
1260
  注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
1259
1261
  */
1260
1262
  Approvers: Array<FlowCreateApprover>
1263
+ /**
1264
+ * 签署流程描述,最大长度1000个字符
1265
+ */
1266
+ FlowDescription?: string
1261
1267
  /**
1262
1268
  * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1263
1269
  */
@@ -1268,6 +1274,7 @@ export interface CreateFlowRequest {
1268
1274
  ClientToken?: string
1269
1275
  /**
1270
1276
  * 签署流程的签署截止时间。
1277
+
1271
1278
  值为unix时间戳,精确到秒,不传默认为当前时间一年后
1272
1279
  */
1273
1280
  DeadLine?: number
@@ -1279,10 +1286,6 @@ export interface CreateFlowRequest {
1279
1286
  * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1280
1287
  */
1281
1288
  UserData?: string
1282
- /**
1283
- * 签署流程描述,最大长度1000个字符
1284
- */
1285
- FlowDescription?: string
1286
1289
  /**
1287
1290
  * 发送类型:
1288
1291
  true:无序签
@@ -2938,19 +2941,23 @@ export interface RecipientComponentInfo {
2938
2941
  */
2939
2942
  export interface CreateFlowEvidenceReportResponse {
2940
2943
  /**
2941
- * 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
2944
+ * 出证报告 ID,可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
2942
2945
  注意:此字段可能返回 null,表示取不到有效值。
2943
2946
  */
2944
2947
  ReportId?: string
2945
2948
  /**
2946
- * 执行中:EvidenceStatusExecuting
2947
- 成功:EvidenceStatusSuccess
2948
- 失败:EvidenceStatusFailed
2949
+ * 出证任务执行的状态, 可能会有以下状态:
2950
+
2951
+ <ul><li>EvidenceStatusExecuting: 出证任务在执行中</li>
2952
+ <li>EvidenceStatusSuccess: 出证任务执行成功</li>
2953
+ <li>EvidenceStatusFailed : 出征任务执行失败</li></ul>
2949
2954
  */
2950
2955
  Status?: string
2951
2956
  /**
2952
- * 废除,字段无效
2957
+ * 此字段已经废除,不再使用.
2958
+ 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
2953
2959
  注意:此字段可能返回 null,表示取不到有效值。
2960
+ * @deprecated
2954
2961
  */
2955
2962
  ReportUrl?: string
2956
2963
  /**
@@ -4236,21 +4243,23 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
4236
4243
  }
4237
4244
 
4238
4245
  /**
4239
- * 催办接口返回详细信息
4246
+ * 催办接口返回的详细信息。
4240
4247
  */
4241
4248
  export interface RemindFlowRecords {
4242
4249
  /**
4243
- * 是否能够催办,true-是,false-否
4250
+ * 合同流程是否可以催办:
4251
+ true - 可以,false - 不可以。
4252
+ 若无法催办,将返回RemindMessage以解释原因。
4244
4253
  */
4245
- CanRemind: boolean
4254
+ CanRemind?: boolean
4246
4255
  /**
4247
- * 合同id
4256
+ * 合同流程ID,为32位字符串。
4248
4257
  */
4249
- FlowId: string
4258
+ FlowId?: string
4250
4259
  /**
4251
- * 催办详情信息
4260
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
4252
4261
  */
4253
- RemindMessage: string
4262
+ RemindMessage?: string
4254
4263
  }
4255
4264
 
4256
4265
  /**
@@ -5256,15 +5265,17 @@ export interface DescribeIntegrationRolesResponse {
5256
5265
  */
5257
5266
  export interface CreateFlowRemindsRequest {
5258
5267
  /**
5259
- * 调用方用户信息,userId 必填
5268
+ * 执行本接口操作的员工信息。
5269
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5260
5270
  */
5261
5271
  Operator: UserInfo
5262
5272
  /**
5263
- * 需要执行催办的签署流程id数组,最多100
5273
+ * 需执行催办的签署流程ID数组,最多包含100个。
5264
5274
  */
5265
5275
  FlowIds: Array<string>
5266
5276
  /**
5267
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5277
+ * 代理企业和员工的信息。
5278
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5268
5279
  */
5269
5280
  Agent?: Agent
5270
5281
  }
@@ -5735,7 +5746,11 @@ export interface CancelMultiFlowSignQRCodeResponse {
5735
5746
  */
5736
5747
  export interface CreateFlowResponse {
5737
5748
  /**
5738
- * 签署流程编号
5749
+ * 签署流程编号,
5750
+
5751
+ 返回的流程编号,需要在CreateDocument,StartFlow中使用,
5752
+
5753
+ 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
5739
5754
  */
5740
5755
  FlowId?: string
5741
5756
  /**
@@ -158,8 +158,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
158
158
  */
159
159
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
160
160
  /**
161
- * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
162
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
161
+ * 创建出证报告并返回报告ID
162
+ 使用此功能需搭配出证套餐。
163
+ 注意:出证过程需一定时间,建议在调用创建出证后的24小时之后,通过DescribeFlowEvidenceReport接口进行查询。
163
164
  */
164
165
  CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
165
166
  /**
@@ -293,11 +294,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
293
294
  */
294
295
  CreateOrganizationBatchSignUrl(req: CreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: CreateOrganizationBatchSignUrlResponse) => void): Promise<CreateOrganizationBatchSignUrlResponse>;
295
296
  /**
296
- * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
297
- 注意:
298
- 该接口不可直接调用,请联系客户经理申请使用
299
- 仅能催办当前状态为“待签署”的签署人,且只能催办一次
300
- 发起合同时,签署人的NotifyType需设置为sms,否则无法催办
297
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
298
+
299
+ 1. 发起合同时,签署人的NotifyType需设置为sms
300
+ 2. 合同中当前状态为“待签署”的签署人是催办的对象
301
+ 3. 每个合同只能催办一次
302
+
303
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
301
304
  */
302
305
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
303
306
  /**
@@ -227,8 +227,9 @@ class Client extends TencentCloudCommon.AbstractClient {
227
227
  return this.request("CreateMultiFlowSignQRCode", req, cb);
228
228
  }
229
229
  /**
230
- * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
231
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
230
+ * 创建出证报告并返回报告ID
231
+ 使用此功能需搭配出证套餐。
232
+ 注意:出证过程需一定时间,建议在调用创建出证后的24小时之后,通过DescribeFlowEvidenceReport接口进行查询。
232
233
  */
233
234
  async CreateFlowEvidenceReport(req, cb) {
234
235
  return this.request("CreateFlowEvidenceReport", req, cb);
@@ -410,11 +411,13 @@ class Client extends TencentCloudCommon.AbstractClient {
410
411
  return this.request("CreateOrganizationBatchSignUrl", req, cb);
411
412
  }
412
413
  /**
413
- * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
414
- 注意:
415
- 该接口不可直接调用,请联系客户经理申请使用
416
- 仅能催办当前状态为“待签署”的签署人,且只能催办一次
417
- 发起合同时,签署人的NotifyType需设置为sms,否则无法催办
414
+ * 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
415
+
416
+ 1. 发起合同时,签署人的NotifyType需设置为sms
417
+ 2. 合同中当前状态为“待签署”的签署人是催办的对象
418
+ 3. 每个合同只能催办一次
419
+
420
+ 注意:该接口无法直接调用,请联系客户经理申请使用。
418
421
  */
419
422
  async CreateFlowReminds(req, cb) {
420
423
  return this.request("CreateFlowReminds", req, cb);
@@ -580,16 +580,18 @@ export interface DescribeIntegrationRolesRequest {
580
580
  */
581
581
  export interface CreateFlowEvidenceReportRequest {
582
582
  /**
583
- * 调用方用户信息,userId 必填
583
+ * 执行本接口操作的员工信息。
584
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
584
585
  */
585
586
  Operator: UserInfo;
586
587
  /**
587
- * 签署流程编号
588
+ * 合同流程ID,为32位字符串。
589
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
588
590
  */
589
591
  FlowId: string;
590
592
  /**
591
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
592
-
593
+ * 代理企业和员工的信息。
594
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
593
595
  */
594
596
  Agent?: Agent;
595
597
  }
@@ -745,7 +747,7 @@ export interface DeleteIntegrationEmployeesResponse {
745
747
  */
746
748
  export interface CreateFlowRemindsResponse {
747
749
  /**
748
- * 催办合同详情列表
750
+ * 合同催办结果的详细信息列表。
749
751
  */
750
752
  RemindFlowRecords?: Array<RemindFlowRecords>;
751
753
  /**
@@ -1195,6 +1197,10 @@ export interface CreateFlowRequest {
1195
1197
  注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
1196
1198
  */
1197
1199
  Approvers: Array<FlowCreateApprover>;
1200
+ /**
1201
+ * 签署流程描述,最大长度1000个字符
1202
+ */
1203
+ FlowDescription?: string;
1198
1204
  /**
1199
1205
  * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1200
1206
  */
@@ -1205,6 +1211,7 @@ export interface CreateFlowRequest {
1205
1211
  ClientToken?: string;
1206
1212
  /**
1207
1213
  * 签署流程的签署截止时间。
1214
+
1208
1215
  值为unix时间戳,精确到秒,不传默认为当前时间一年后
1209
1216
  */
1210
1217
  DeadLine?: number;
@@ -1216,10 +1223,6 @@ export interface CreateFlowRequest {
1216
1223
  * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1217
1224
  */
1218
1225
  UserData?: string;
1219
- /**
1220
- * 签署流程描述,最大长度1000个字符
1221
- */
1222
- FlowDescription?: string;
1223
1226
  /**
1224
1227
  * 发送类型:
1225
1228
  true:无序签
@@ -2830,19 +2833,23 @@ export interface RecipientComponentInfo {
2830
2833
  */
2831
2834
  export interface CreateFlowEvidenceReportResponse {
2832
2835
  /**
2833
- * 出证报告 ID,用于查询出证报告DescribeFlowEvidenceReport接口时用到
2836
+ * 出证报告 ID,可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
2834
2837
  注意:此字段可能返回 null,表示取不到有效值。
2835
2838
  */
2836
2839
  ReportId?: string;
2837
2840
  /**
2838
- * 执行中:EvidenceStatusExecuting
2839
- 成功:EvidenceStatusSuccess
2840
- 失败:EvidenceStatusFailed
2841
+ * 出证任务执行的状态, 可能会有以下状态:
2842
+
2843
+ <ul><li>EvidenceStatusExecuting: 出证任务在执行中</li>
2844
+ <li>EvidenceStatusSuccess: 出证任务执行成功</li>
2845
+ <li>EvidenceStatusFailed : 出征任务执行失败</li></ul>
2841
2846
  */
2842
2847
  Status?: string;
2843
2848
  /**
2844
- * 废除,字段无效
2849
+ * 此字段已经废除,不再使用.
2850
+ 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
2845
2851
  注意:此字段可能返回 null,表示取不到有效值。
2852
+ * @deprecated
2846
2853
  */
2847
2854
  ReportUrl?: string;
2848
2855
  /**
@@ -4088,21 +4095,23 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
4088
4095
  RequestId?: string;
4089
4096
  }
4090
4097
  /**
4091
- * 催办接口返回详细信息
4098
+ * 催办接口返回的详细信息。
4092
4099
  */
4093
4100
  export interface RemindFlowRecords {
4094
4101
  /**
4095
- * 是否能够催办,true-是,false-否
4102
+ * 合同流程是否可以催办:
4103
+ true - 可以,false - 不可以。
4104
+ 若无法催办,将返回RemindMessage以解释原因。
4096
4105
  */
4097
- CanRemind: boolean;
4106
+ CanRemind?: boolean;
4098
4107
  /**
4099
- * 合同id
4108
+ * 合同流程ID,为32位字符串。
4100
4109
  */
4101
- FlowId: string;
4110
+ FlowId?: string;
4102
4111
  /**
4103
- * 催办详情信息
4112
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
4104
4113
  */
4105
- RemindMessage: string;
4114
+ RemindMessage?: string;
4106
4115
  }
4107
4116
  /**
4108
4117
  * CancelUserAutoSignEnableUrl请求参数结构体
@@ -5079,15 +5088,17 @@ export interface DescribeIntegrationRolesResponse {
5079
5088
  */
5080
5089
  export interface CreateFlowRemindsRequest {
5081
5090
  /**
5082
- * 调用方用户信息,userId 必填
5091
+ * 执行本接口操作的员工信息。
5092
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5083
5093
  */
5084
5094
  Operator: UserInfo;
5085
5095
  /**
5086
- * 需要执行催办的签署流程id数组,最多100
5096
+ * 需执行催办的签署流程ID数组,最多包含100个。
5087
5097
  */
5088
5098
  FlowIds: Array<string>;
5089
5099
  /**
5090
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5100
+ * 代理企业和员工的信息。
5101
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5091
5102
  */
5092
5103
  Agent?: Agent;
5093
5104
  }
@@ -5538,7 +5549,11 @@ export interface CancelMultiFlowSignQRCodeResponse {
5538
5549
  */
5539
5550
  export interface CreateFlowResponse {
5540
5551
  /**
5541
- * 签署流程编号
5552
+ * 签署流程编号,
5553
+
5554
+ 返回的流程编号,需要在CreateDocument,StartFlow中使用,
5555
+
5556
+ 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
5542
5557
  */
5543
5558
  FlowId?: string;
5544
5559
  /**