tencentcloud-sdk-nodejs 4.0.682 → 4.0.683

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 (91) hide show
  1. package/CHANGELOG.md +141 -0
  2. package/SERVICE_CHANGELOG.md +155 -169
  3. package/package.json +1 -1
  4. package/products.md +10 -10
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/bma/index.ts +2 -2
  8. package/src/services/btoe/index.ts +2 -2
  9. package/src/services/cbs/v20170312/cbs_client.ts +2 -2
  10. package/src/services/ccc/v20200210/ccc_client.ts +2 -1
  11. package/src/services/ccc/v20200210/ccc_models.ts +21 -2
  12. package/src/services/cii/index.ts +2 -2
  13. package/src/services/cloudstudio/index.ts +2 -2
  14. package/src/services/dts/index.ts +2 -2
  15. package/src/services/ess/v20201111/ess_client.ts +26 -16
  16. package/src/services/ess/v20201111/ess_models.ts +85 -42
  17. package/src/services/essbasic/index.ts +2 -2
  18. package/src/services/iai/index.ts +2 -2
  19. package/src/services/iai/v20180301/iai_models.ts +8 -12
  20. package/src/services/iai/v20200303/iai_models.ts +8 -12
  21. package/src/services/ims/index.ts +2 -2
  22. package/src/services/iotcloud/index.ts +2 -2
  23. package/src/services/iotvideo/index.ts +4 -4
  24. package/src/services/mgobe/index.ts +2 -2
  25. package/src/services/mrs/v20200910/mrs_models.ts +48 -25
  26. package/src/services/tem/index.ts +2 -2
  27. package/src/services/thpc/index.ts +4 -4
  28. package/src/services/thpc/v20230321/thpc_models.ts +17 -0
  29. package/src/services/tione/index.ts +2 -2
  30. package/src/services/tms/index.ts +2 -2
  31. package/src/services/tsw/index.ts +2 -2
  32. package/src/services/vm/index.ts +2 -2
  33. package/src/services/waf/v20180125/waf_client.ts +12 -0
  34. package/src/services/waf/v20180125/waf_models.ts +28 -0
  35. package/src/services/yunsou/index.ts +2 -2
  36. package/tencentcloud/common/sdk_version.d.ts +1 -1
  37. package/tencentcloud/common/sdk_version.js +1 -1
  38. package/tencentcloud/services/ams/index.d.ts +4 -4
  39. package/tencentcloud/services/ams/index.js +2 -2
  40. package/tencentcloud/services/bma/index.d.ts +4 -4
  41. package/tencentcloud/services/bma/index.js +2 -2
  42. package/tencentcloud/services/btoe/index.d.ts +4 -4
  43. package/tencentcloud/services/btoe/index.js +2 -2
  44. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +2 -2
  45. package/tencentcloud/services/cbs/v20170312/cbs_client.js +2 -2
  46. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  47. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  48. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -2
  49. package/tencentcloud/services/cii/index.d.ts +4 -4
  50. package/tencentcloud/services/cii/index.js +2 -2
  51. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  52. package/tencentcloud/services/cloudstudio/index.js +2 -2
  53. package/tencentcloud/services/dts/index.d.ts +4 -4
  54. package/tencentcloud/services/dts/index.js +2 -2
  55. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -11
  56. package/tencentcloud/services/ess/v20201111/ess_client.js +21 -11
  57. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +85 -42
  58. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  59. package/tencentcloud/services/essbasic/index.js +2 -2
  60. package/tencentcloud/services/iai/index.d.ts +4 -4
  61. package/tencentcloud/services/iai/index.js +2 -2
  62. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +8 -12
  63. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +8 -12
  64. package/tencentcloud/services/ims/index.d.ts +4 -4
  65. package/tencentcloud/services/ims/index.js +2 -2
  66. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  67. package/tencentcloud/services/iotcloud/index.js +2 -2
  68. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  69. package/tencentcloud/services/iotvideo/index.js +4 -4
  70. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  71. package/tencentcloud/services/mgobe/index.js +2 -2
  72. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +48 -25
  73. package/tencentcloud/services/tem/index.d.ts +4 -4
  74. package/tencentcloud/services/tem/index.js +2 -2
  75. package/tencentcloud/services/thpc/index.d.ts +6 -6
  76. package/tencentcloud/services/thpc/index.js +4 -4
  77. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +17 -0
  78. package/tencentcloud/services/tione/index.d.ts +4 -4
  79. package/tencentcloud/services/tione/index.js +2 -2
  80. package/tencentcloud/services/tms/index.d.ts +4 -4
  81. package/tencentcloud/services/tms/index.js +2 -2
  82. package/tencentcloud/services/tsw/index.d.ts +4 -4
  83. package/tencentcloud/services/tsw/index.js +2 -2
  84. package/tencentcloud/services/vm/index.d.ts +4 -4
  85. package/tencentcloud/services/vm/index.js +2 -2
  86. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
  87. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
  88. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +26 -0
  89. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  90. package/tencentcloud/services/yunsou/index.js +2 -2
  91. package/test/waf.v20180125.test.js +10 -0
package/products.md CHANGED
@@ -4,8 +4,8 @@
4
4
  | aai | [](https://cloud.tencent.com/document/product) | 2019-08-08 23:15:13 |
5
5
  | acp | [应用合规平台](https://cloud.tencent.com/document/product/1553) | 2023-05-18 01:01:15 |
6
6
  | advisor | [云顾问](https://cloud.tencent.com/document/product/1264) | 2023-05-18 01:01:20 |
7
- | af | [借贷反欺诈](https://cloud.tencent.com/document/product/668) | 2023-08-17 01:06:02 |
8
- | afc | [定制建模](https://cloud.tencent.com/document/product/1029) | 2023-08-17 01:06:05 |
7
+ | af | [借贷反欺诈](https://cloud.tencent.com/document/product/668) | 2023-09-07 01:06:15 |
8
+ | afc | [定制建模](https://cloud.tencent.com/document/product/1029) | 2023-09-07 01:06:21 |
9
9
  | aiart | [AI 绘画](https://cloud.tencent.com/document/product/1668) | 2023-07-25 10:37:02 |
10
10
  | ame | [正版曲库直通车](https://cloud.tencent.com/document/product/1155) | 2023-08-17 01:06:14 |
11
11
  | ams | [音频内容安全](https://cloud.tencent.com/document/product/1219) | 2023-05-18 01:01:48 |
@@ -14,7 +14,7 @@
14
14
  | apcas | [汽车精准获客服务](https://cloud.tencent.com/document/product/1244) | 2022-04-04 06:05:36 |
15
15
  | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 |
16
16
  | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2023-01-05 01:02:52 |
17
- | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-09-04 01:07:54 |
17
+ | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-09-07 01:07:50 |
18
18
  | apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2023-07-18 01:07:24 |
19
19
  | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2023-08-28 01:09:11 |
20
20
  | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-09-04 01:14:46 |
@@ -39,8 +39,8 @@
39
39
  | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2023-08-23 01:10:00 |
40
40
  | casb | [云访问安全代理](https://cloud.tencent.com/document/product/1303) | 2022-12-26 10:53:16 |
41
41
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-05-18 01:07:39 |
42
- | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-09-04 01:20:21 |
43
- | ccc | [云呼叫中心](https://cloud.tencent.com/document/product/679) | 2023-09-05 01:41:59 |
42
+ | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-09-07 01:15:22 |
43
+ | ccc | [云呼叫中心](https://cloud.tencent.com/document/product/679) | 2023-09-07 01:15:54 |
44
44
  | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-08-29 01:07:58 |
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 |
@@ -94,7 +94,7 @@
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-09-05 04:23:35 |
97
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-09-05 17:35:52 |
97
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-09-07 01:48:58 |
98
98
  | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-09-05 17:36:50 |
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-09-06 01:49:13 |
@@ -109,7 +109,7 @@
109
109
  | habo | [](https://cloud.tencent.com/document/product) | 2019-05-09 19:37:22 |
110
110
  | hasim | [高可用物联网卡](https://cloud.tencent.com/document/product/1482) | 2023-05-18 01:29:47 |
111
111
  | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2023-08-17 03:18:40 |
112
- | iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2023-08-17 03:19:26 |
112
+ | iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2023-09-07 01:54:18 |
113
113
  | ic | [图片瘦身](https://cloud.tencent.com/document/product/636) | 2023-03-02 01:23:21 |
114
114
  | icr | [对话机器人](https://cloud.tencent.com/document/product/1268) | 2023-05-18 01:30:40 |
115
115
  | ie | [智能编辑](https://cloud.tencent.com/document/product/1186) | 2023-08-17 03:20:18 |
@@ -142,7 +142,7 @@
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-09-06 02:06:16 |
144
144
  | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-09-04 02:12:09 |
145
- | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-05-18 01:42:01 |
145
+ | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-09-07 02:12:57 |
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 |
148
148
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
@@ -200,7 +200,7 @@
200
200
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 |
201
201
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-08-30 01:25:15 |
202
202
  | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-09-05 07:43:47 |
203
- | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-09-06 02:32:29 |
203
+ | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-09-07 02:37:25 |
204
204
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
205
205
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
206
206
  | ticm | [智能鉴黄](https://cloud.tencent.com/document/product/864) | 2021-01-07 08:08:15 |
@@ -229,7 +229,7 @@
229
229
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-09-04 02:45:38 |
230
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
- | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-08-31 10:55:43 |
232
+ | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-09-07 02:51:23 |
233
233
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
234
234
  | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-08-31 01:29:16 |
235
235
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
@@ -1 +1 @@
1
- export const sdkVersion = "4.0.682"
1
+ export const sdkVersion = "4.0.683"
@@ -1,7 +1,7 @@
1
- import { v20200608 } from "./v20200608"
2
1
  import { v20201229 } from "./v20201229"
2
+ import { v20200608 } from "./v20200608"
3
3
 
4
4
  export const ams = {
5
- v20200608: v20200608,
6
5
  v20201229: v20201229,
6
+ v20200608: v20200608,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20210624 } from "./v20210624"
2
1
  import { v20221115 } from "./v20221115"
2
+ import { v20210624 } from "./v20210624"
3
3
 
4
4
  export const bma = {
5
- v20210624: v20210624,
6
5
  v20221115: v20221115,
6
+ v20210624: v20210624,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20210514 } from "./v20210514"
2
1
  import { v20210303 } from "./v20210303"
2
+ import { v20210514 } from "./v20210514"
3
3
 
4
4
  export const btoe = {
5
- v20210514: v20210514,
6
5
  v20210303: v20210303,
6
+ v20210514: v20210514,
7
7
  }
@@ -401,8 +401,8 @@ export class Client extends AbstractClient {
401
401
  /**
402
402
  * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
403
403
 
404
- * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
405
- * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
404
+ * 本接口支持修改快照名称及到期时间,以及将非永久快照修改为永久快照。
405
+ * “快照名称”仅为方便用户管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
406
406
  */
407
407
  async ModifySnapshotAttribute(
408
408
  req: ModifySnapshotAttributeRequest,
@@ -87,6 +87,7 @@ import {
87
87
  Variable,
88
88
  CallInNumberMetrics,
89
89
  CreateExtensionRequest,
90
+ StaffSkillGroupList,
90
91
  CreateAutoCalloutTaskRequest,
91
92
  Filter,
92
93
  UnbindStaffSkillGroupListRequest,
@@ -212,7 +213,7 @@ export class Client extends AbstractClient {
212
213
  }
213
214
 
214
215
  /**
215
- * 绑定坐席所属技能组
216
+ * 绑定座席所属技能组
216
217
  */
217
218
  async BindStaffSkillGroupList(
218
219
  req: BindStaffSkillGroupListRequest,
@@ -1936,6 +1936,20 @@ export interface CreateExtensionRequest {
1936
1936
  Relation?: string
1937
1937
  }
1938
1938
 
1939
+ /**
1940
+ * 座席绑定技能组列表
1941
+ */
1942
+ export interface StaffSkillGroupList {
1943
+ /**
1944
+ * 技能组ID
1945
+ */
1946
+ SkillGroupId: number
1947
+ /**
1948
+ * 座席在技能组中的优先级(1为最高,5最低,默认3)
1949
+ */
1950
+ Priority?: number
1951
+ }
1952
+
1939
1953
  /**
1940
1954
  * CreateAutoCalloutTask请求参数结构体
1941
1955
  */
@@ -2219,13 +2233,18 @@ export interface BindStaffSkillGroupListRequest {
2219
2233
  */
2220
2234
  SdkAppId: number
2221
2235
  /**
2222
- * 坐席邮箱
2236
+ * 座席邮箱
2223
2237
  */
2224
2238
  StaffEmail: string
2225
2239
  /**
2226
2240
  * 绑定技能组列表
2241
+ * @deprecated
2227
2242
  */
2228
- SkillGroupList: Array<number | bigint>
2243
+ SkillGroupList?: Array<number | bigint>
2244
+ /**
2245
+ * 绑定技能组列表(必填)
2246
+ */
2247
+ StaffSkillGroupList?: Array<StaffSkillGroupList>
2229
2248
  }
2230
2249
 
2231
2250
  /**
@@ -1,7 +1,7 @@
1
- import { v20201210 } from "./v20201210"
2
1
  import { v20210408 } from "./v20210408"
2
+ import { v20201210 } from "./v20201210"
3
3
 
4
4
  export const cii = {
5
- v20201210: v20201210,
6
5
  v20210408: v20210408,
6
+ v20201210: v20201210,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20210524 } from "./v20210524"
2
1
  import { v20230508 } from "./v20230508"
2
+ import { v20210524 } from "./v20210524"
3
3
 
4
4
  export const cloudstudio = {
5
- v20210524: v20210524,
6
5
  v20230508: v20230508,
6
+ v20210524: v20210524,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20180330 } from "./v20180330"
2
1
  import { v20211206 } from "./v20211206"
2
+ import { v20180330 } from "./v20180330"
3
3
 
4
4
  export const dts = {
5
- v20180330: v20180330,
6
5
  v20211206: v20211206,
6
+ v20180330: v20180330,
7
7
  }
@@ -254,9 +254,9 @@ export class Client extends AbstractClient {
254
254
  }
255
255
 
256
256
  /**
257
- * 用于撤销签署流程
258
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
259
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
257
+ * 用于撤销签署流程<br/>
258
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
259
+ `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
260
260
  */
261
261
  async CancelFlow(
262
262
  req: CancelFlowRequest,
@@ -540,8 +540,15 @@ export class Client extends AbstractClient {
540
540
  }
541
541
 
542
542
  /**
543
- * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
544
- */
543
+ * 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
544
+
545
+ `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
546
+ `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
547
+ `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
548
+ `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
549
+ `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
550
+ `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
551
+ */
545
552
  async CreateReleaseFlow(
546
553
  req: CreateReleaseFlowRequest,
547
554
  cb?: (error: string, rep: CreateReleaseFlowResponse) => void
@@ -618,7 +625,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
618
625
  }
619
626
 
620
627
  /**
621
- * 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
628
+ * 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
622
629
  */
623
630
  async DescribeFlowEvidenceReport(
624
631
  req: DescribeFlowEvidenceReportRequest,
@@ -682,8 +689,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
682
689
  }
683
690
 
684
691
  /**
685
- * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
686
- */
692
+ * 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
693
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
694
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
695
+ */
687
696
  async CancelMultiFlowSignQRCode(
688
697
  req: CancelMultiFlowSignQRCodeRequest,
689
698
  cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
@@ -702,13 +711,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
702
711
  }
703
712
 
704
713
  /**
705
- * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
714
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
706
715
 
707
- 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
708
-
709
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
710
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
711
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
716
+ 注:
717
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
718
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
719
+ `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>
712
720
  */
713
721
  async CreateFlowSignUrl(
714
722
  req: CreateFlowSignUrlRequest,
@@ -907,8 +915,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
907
915
  }
908
916
 
909
917
  /**
910
- * 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
911
- */
918
+ * 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
919
+
920
+ 注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
921
+ */
912
922
  async CancelUserAutoSignEnableUrl(
913
923
  req: CancelUserAutoSignEnableUrlRequest,
914
924
  cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void
@@ -131,16 +131,17 @@ export interface CancelFlowResponse {
131
131
  */
132
132
  export interface DescribeFlowEvidenceReportRequest {
133
133
  /**
134
- * 调用方用户信息,userId 必填
134
+ * 执行本接口操作的员工信息。
135
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
135
136
  */
136
137
  Operator: UserInfo
137
138
  /**
138
- * 出证报告编号
139
+ * 签署报告编号
139
140
  */
140
141
  ReportId: string
141
142
  /**
142
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
143
-
143
+ * 代理企业和员工的信息。
144
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
144
145
  */
145
146
  Agent?: Agent
146
147
  }
@@ -355,12 +356,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
355
356
  */
356
357
  export interface FlowApproverUrlInfo {
357
358
  /**
358
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
359
+ * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
360
+ 注: `注意该链接有效期为30分钟`
359
361
  注意:此字段可能返回 null,表示取不到有效值。
360
362
  */
361
363
  SignUrl?: string
362
364
  /**
363
- * 签署人类型 1-个人
365
+ * 签署参与人类型
366
+ <ul><li> **1** :个人参与方</li></ul>
367
+
368
+ 注: `现在仅支持个人参与方`
364
369
  注意:此字段可能返回 null,表示取不到有效值。
365
370
  */
366
371
  ApproverType?: number
@@ -375,7 +380,8 @@ export interface FlowApproverUrlInfo {
375
380
  */
376
381
  ApproverMobile?: string
377
382
  /**
378
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
383
+ * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
384
+ 注: `注意该链接有效期为30分钟`
379
385
  注意:此字段可能返回 null,表示取不到有效值。
380
386
  */
381
387
  LongUrl?: string
@@ -995,11 +1001,12 @@ export interface DescribeFlowEvidenceReportResponse {
995
1001
  */
996
1002
  ReportUrl?: string
997
1003
  /**
998
- * 出证任务执行的状态, 分布表示下面的含义
999
-
1000
- EvidenceStatusExecuting 出证任务在执行中
1001
- EvidenceStatusSuccess 出证任务执行成功
1002
- EvidenceStatusFailed 出证任务执行失败
1004
+ * 签署报告出证任务的状态
1005
+ <ul>
1006
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
1007
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
1008
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
1009
+ </ul>
1003
1010
  */
1004
1011
  Status?: string
1005
1012
  /**
@@ -1501,6 +1508,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
1501
1508
  export interface CreateReleaseFlowResponse {
1502
1509
  /**
1503
1510
  * 解除协议流程编号
1511
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
1504
1512
 
1505
1513
  */
1506
1514
  FlowId?: string
@@ -2002,18 +2010,22 @@ export interface CreateBatchCancelFlowUrlResponse {
2002
2010
  */
2003
2011
  export interface UserThreeFactor {
2004
2012
  /**
2005
- * 姓名
2013
+ * 签署方经办人的姓名。
2014
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2006
2015
  */
2007
2016
  Name: string
2008
2017
  /**
2009
- * 证件类型:
2010
- ID_CARD 身份证
2011
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2012
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2018
+ * 证件类型,支持以下类型
2019
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
2020
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2021
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
2013
2022
  */
2014
2023
  IdCardType: string
2015
2024
  /**
2016
- * 证件号,如果有 X 请大写
2025
+ * 证件号码,应符合以下规则
2026
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2027
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2028
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2017
2029
  */
2018
2030
  IdCardNumber: string
2019
2031
  }
@@ -3643,21 +3655,27 @@ export interface CreateFlowByFilesRequest {
3643
3655
  */
3644
3656
  export interface CreateFlowSignUrlRequest {
3645
3657
  /**
3646
- * 流程编号
3658
+ * 合同流程ID,为32位字符串。
3659
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3660
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3647
3661
  */
3648
3662
  FlowId: string
3649
3663
  /**
3650
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3664
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
3651
3665
 
3652
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3666
+ 注:
3667
+ `1. ApproverType目前只支持个人类型的签署人。`
3668
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3653
3669
  */
3654
3670
  FlowApproverInfos: Array<FlowCreateApprover>
3655
3671
  /**
3656
- * 用户信息,此结构体UserId必填
3672
+ * 执行本接口操作的员工信息。
3673
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3657
3674
  */
3658
3675
  Operator?: UserInfo
3659
3676
  /**
3660
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3677
+ * 代理企业和员工的信息。
3678
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3661
3679
  */
3662
3680
  Agent?: Agent
3663
3681
  /**
@@ -3666,7 +3684,7 @@ export interface CreateFlowSignUrlRequest {
3666
3684
  */
3667
3685
  Organization?: OrganizationInfo
3668
3686
  /**
3669
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
3687
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3670
3688
  */
3671
3689
  JumpUrl?: string
3672
3690
  }
@@ -3676,31 +3694,42 @@ export interface CreateFlowSignUrlRequest {
3676
3694
  */
3677
3695
  export interface CreateReleaseFlowRequest {
3678
3696
  /**
3679
- * 调用方用户信息,userId 必填
3697
+ * 执行本接口操作的员工信息。
3698
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3680
3699
  */
3681
3700
  Operator: UserInfo
3682
3701
  /**
3683
- * 待解除的签署流程编号(即原签署流程的编号)
3702
+ * 待解除的签署流程编号(即原签署流程的编号)。
3684
3703
  */
3685
3704
  NeedRelievedFlowId: string
3686
3705
  /**
3687
- * 解除协议内容
3706
+ * 解除协议内容。
3688
3707
  */
3689
3708
  ReliveInfo: RelieveInfo
3690
3709
  /**
3691
- * 非必须,解除协议的本企业签署人列表,
3692
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
3693
- 解除协议的签署人数量不能多于原流程的签署人数量
3710
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3711
+ */
3712
+ Agent?: Agent
3713
+ /**
3714
+ * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3715
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3716
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3717
+
3718
+ `注意:只能更换同企业的签署人。`<br/>
3719
+ `注意:不支持更换个人类型的签署人。`<br/>
3694
3720
  */
3695
3721
  ReleasedApprovers?: Array<ReleasedApprover>
3696
3722
  /**
3697
- * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
3723
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3724
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3698
3725
  */
3699
3726
  Deadline?: number
3700
3727
  /**
3701
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3728
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
3729
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3730
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3702
3731
  */
3703
- Agent?: Agent
3732
+ UserData?: string
3704
3733
  }
3705
3734
 
3706
3735
  /**
@@ -4278,11 +4307,15 @@ true - 可以,false - 不可以。
4278
4307
  */
4279
4308
  export interface CancelUserAutoSignEnableUrlRequest {
4280
4309
  /**
4281
- * 操作人信息,UseId必填
4310
+ * 执行本接口操作的员工信息。
4311
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4282
4312
  */
4283
4313
  Operator: UserInfo
4284
4314
  /**
4285
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
4315
+ * 企业开通用户自动签场景,例如电子处方。
4316
+ <ul>
4317
+ <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
4318
+ </ul>
4286
4319
  */
4287
4320
  SceneKey: string
4288
4321
  /**
@@ -4290,6 +4323,11 @@ export interface CancelUserAutoSignEnableUrlRequest {
4290
4323
 
4291
4324
  */
4292
4325
  UserInfo: UserThreeFactor
4326
+ /**
4327
+ * 代理企业和员工的信息。
4328
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4329
+ */
4330
+ Agent?: Agent
4293
4331
  }
4294
4332
 
4295
4333
  /**
@@ -4509,15 +4547,17 @@ ProcessTimeout - 转换文件超时
4509
4547
  */
4510
4548
  export interface CancelMultiFlowSignQRCodeRequest {
4511
4549
  /**
4512
- * 调用方用户信息,userId 必填
4550
+ * 执行本接口操作的员工信息。
4551
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4513
4552
  */
4514
4553
  Operator: UserInfo
4515
4554
  /**
4516
- * 二维码id
4555
+ * 二维码ID,为32位字符串。
4517
4556
  */
4518
4557
  QrCodeId: string
4519
4558
  /**
4520
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4559
+ * 代理企业和员工的信息。
4560
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4521
4561
  */
4522
4562
  Agent?: Agent
4523
4563
  }
@@ -4908,19 +4948,22 @@ export interface PermissionGroup {
4908
4948
  */
4909
4949
  export interface CancelFlowRequest {
4910
4950
  /**
4911
- * 调用方用户信息,userId 必填
4951
+ * 执行本接口操作的员工信息。
4952
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4912
4953
  */
4913
4954
  Operator: UserInfo
4914
4955
  /**
4915
- * 签署流程id
4956
+ * 合同流程ID, 为32位字符串。
4957
+ 建议开发者保存此流程ID方便后续其他操作。
4916
4958
  */
4917
4959
  FlowId: string
4918
4960
  /**
4919
- * 撤销原因,最长200个字符;
4961
+ * 撤销此合同(流程)的原因,最长200个字。
4920
4962
  */
4921
4963
  CancelMessage: string
4922
4964
  /**
4923
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4965
+ * 代理企业和员工的信息。
4966
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4924
4967
  */
4925
4968
  Agent?: Agent
4926
4969
  }
@@ -1,7 +1,7 @@
1
- import { v20210526 } from "./v20210526"
2
1
  import { v20201222 } from "./v20201222"
2
+ import { v20210526 } from "./v20210526"
3
3
 
4
4
  export const essbasic = {
5
- v20210526: v20210526,
6
5
  v20201222: v20201222,
6
+ v20210526: v20210526,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20200303 } from "./v20200303"
2
1
  import { v20180301 } from "./v20180301"
2
+ import { v20200303 } from "./v20200303"
3
3
 
4
4
  export const iai = {
5
- v20200303: v20200303,
6
5
  v20180301: v20180301,
6
+ v20200303: v20200303,
7
7
  }