tencentcloud-sdk-nodejs 4.0.414 → 4.0.417

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 (140) hide show
  1. package/CHANGELOG.md +881 -0
  2. package/SERVICE_CHANGELOG.md +1035 -17
  3. package/package.json +1 -1
  4. package/products.md +36 -36
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +13 -11
  7. package/src/services/ams/v20201229/ams_models.ts +69 -15
  8. package/src/services/as/v20180419/as_models.ts +18 -0
  9. package/src/services/billing/v20180709/billing_models.ts +49 -0
  10. package/src/services/cat/v20180409/cat_models.ts +4 -4
  11. package/src/services/cbs/v20170312/cbs_models.ts +5 -5
  12. package/src/services/ccc/v20200210/ccc_client.ts +0 -14
  13. package/src/services/ccc/v20200210/ccc_models.ts +25 -40
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +10 -0
  15. package/src/services/cls/v20201016/cls_models.ts +17 -1
  16. package/src/services/cpdp/v20190820/cpdp_client.ts +1 -0
  17. package/src/services/cpdp/v20190820/cpdp_models.ts +20 -0
  18. package/src/services/ess/v20201111/ess_client.ts +32 -16
  19. package/src/services/ess/v20201111/ess_models.ts +67 -8
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +31 -16
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +83 -32
  22. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  23. package/src/services/gme/v20180711/gme_client.ts +179 -118
  24. package/src/services/gme/v20180711/gme_models.ts +264 -78
  25. package/src/services/irp/index.ts +2 -0
  26. package/src/services/irp/v20220805/index.ts +6 -0
  27. package/src/services/irp/v20220805/irp_client.ts +85 -0
  28. package/src/services/irp/v20220805/irp_models.ts +549 -0
  29. package/src/services/lighthouse/v20200324/lighthouse_models.ts +26 -4
  30. package/src/services/live/v20180801/live_models.ts +6 -0
  31. package/src/services/mongodb/v20190725/mongodb_client.ts +12 -15
  32. package/src/services/mongodb/v20190725/mongodb_models.ts +14 -49
  33. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  34. package/src/services/ocr/v20181119/ocr_models.ts +5 -0
  35. package/src/services/postgres/v20170312/postgres_client.ts +1 -1
  36. package/src/services/privatedns/v20201028/privatedns_models.ts +16 -1
  37. package/src/services/pts/v20210728/pts_models.ts +5 -0
  38. package/src/services/redis/v20180412/redis_client.ts +12 -0
  39. package/src/services/redis/v20180412/redis_models.ts +25 -0
  40. package/src/services/sqlserver/v20180328/sqlserver_models.ts +40 -0
  41. package/src/services/taf/v20200210/taf_client.ts +20 -37
  42. package/src/services/taf/v20200210/taf_models.ts +154 -224
  43. package/src/services/tbaas/v20180416/tbaas_client.ts +77 -175
  44. package/src/services/tbaas/v20180416/tbaas_models.ts +978 -1343
  45. package/src/services/tcbr/v20220217/tcbr_models.ts +5 -0
  46. package/src/services/tcr/v20190924/tcr_client.ts +1 -0
  47. package/src/services/tcr/v20190924/tcr_models.ts +44 -1
  48. package/src/services/tcss/v20201101/tcss_models.ts +64 -0
  49. package/src/services/tem/v20210701/tem_client.ts +41 -4
  50. package/src/services/tem/v20210701/tem_models.ts +409 -225
  51. package/src/services/teo/v20220106/teo_client.ts +9 -7
  52. package/src/services/teo/v20220106/teo_models.ts +944 -658
  53. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  54. package/src/services/tts/v20190823/tts_client.ts +1 -0
  55. package/src/services/tts/v20190823/tts_models.ts +40 -0
  56. package/src/services/vod/v20180717/vod_client.ts +45 -29
  57. package/src/services/vod/v20180717/vod_models.ts +52 -8
  58. package/src/services/wedata/v20210820/wedata_client.ts +105 -68
  59. package/tencentcloud/common/sdk_version.d.ts +1 -1
  60. package/tencentcloud/common/sdk_version.js +1 -1
  61. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +11 -10
  62. package/tencentcloud/services/ams/v20201229/ams_client.js +11 -10
  63. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +58 -12
  64. package/tencentcloud/services/as/v20180419/as_models.d.ts +15 -0
  65. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +40 -0
  66. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +4 -4
  67. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -4
  68. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -7
  69. package/tencentcloud/services/ccc/v20200210/ccc_client.js +0 -8
  70. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -34
  71. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +8 -0
  72. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +14 -1
  73. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +17 -0
  74. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +16 -8
  75. package/tencentcloud/services/ess/v20201111/ess_client.js +19 -9
  76. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +59 -8
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -7
  78. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -8
  79. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +74 -30
  80. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  81. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +66 -46
  82. package/tencentcloud/services/gme/v20180711/gme_client.js +91 -61
  83. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +232 -72
  84. package/tencentcloud/services/irp/index.d.ts +4 -0
  85. package/tencentcloud/services/irp/index.js +2 -0
  86. package/tencentcloud/services/irp/v20220805/index.d.ts +6 -0
  87. package/tencentcloud/services/irp/v20220805/index.js +9 -0
  88. package/tencentcloud/services/irp/v20220805/irp_client.d.ts +26 -0
  89. package/tencentcloud/services/irp/v20220805/irp_client.js +55 -0
  90. package/tencentcloud/services/irp/v20220805/irp_models.d.ts +442 -0
  91. package/tencentcloud/services/irp/v20220805/irp_models.js +18 -0
  92. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -3
  93. package/tencentcloud/services/live/v20180801/live_models.d.ts +5 -0
  94. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -7
  95. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -8
  96. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +13 -42
  97. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  98. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  99. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
  100. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
  101. package/tencentcloud/services/postgres/v20170312/postgres_client.js +1 -1
  102. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +13 -1
  103. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +4 -0
  104. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +5 -1
  105. package/tencentcloud/services/redis/v20180412/redis_client.js +6 -0
  106. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +22 -0
  107. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +32 -0
  108. package/tencentcloud/services/taf/v20200210/taf_client.d.ts +5 -11
  109. package/tencentcloud/services/taf/v20200210/taf_client.js +6 -14
  110. package/tencentcloud/services/taf/v20200210/taf_models.d.ts +136 -197
  111. package/tencentcloud/services/tbaas/v20180416/tbaas_client.d.ts +7 -49
  112. package/tencentcloud/services/tbaas/v20180416/tbaas_client.js +9 -65
  113. package/tencentcloud/services/tbaas/v20180416/tbaas_models.d.ts +905 -1211
  114. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +4 -0
  115. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +37 -1
  116. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +55 -0
  117. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +13 -1
  118. package/tencentcloud/services/tem/v20210701/tem_client.js +18 -0
  119. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +316 -160
  120. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +7 -7
  121. package/tencentcloud/services/teo/v20220106/teo_client.js +7 -7
  122. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +805 -547
  123. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  124. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +33 -0
  125. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +19 -11
  126. package/tencentcloud/services/vod/v20180717/vod_client.js +24 -14
  127. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +45 -7
  128. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +72 -35
  129. package/tencentcloud/services/wedata/v20210820/wedata_client.js +72 -35
  130. package/test/ccc.v20200210.test.js +0 -10
  131. package/test/ess.v20201111.test.js +14 -4
  132. package/test/essbasic.v20210526.test.js +14 -4
  133. package/test/gme.v20180711.test.js +82 -32
  134. package/test/irp.v20220805.test.js +61 -0
  135. package/test/mongodb.v20190725.test.js +10 -10
  136. package/test/redis.v20180412.test.js +10 -0
  137. package/test/taf.v20200210.test.js +8 -18
  138. package/test/tbaas.v20180416.test.js +6 -76
  139. package/test/tem.v20210701.test.js +30 -0
  140. package/test/vod.v20180717.test.js +18 -8
@@ -767,6 +767,16 @@ export interface ModifyStaffRequest {
767
767
  * 绑定技能组ID列表
768
768
  */
769
769
  SkillGroupIds?: Array<number>
770
+
771
+ /**
772
+ * 是否开启手机外呼开关
773
+ */
774
+ UseMobileCallOut?: boolean
775
+
776
+ /**
777
+ * 手机接听模式 0 - 关闭 | 1 - 仅离线 | 2 - 始终
778
+ */
779
+ UseMobileAccept?: number
770
780
  }
771
781
 
772
782
  /**
@@ -963,6 +973,11 @@ export interface DescribeSkillGroupInfoListRequest {
963
973
  * 查询修改时间大于等于ModifiedTime的技能组时使用
964
974
  */
965
975
  ModifiedTime?: number
976
+
977
+ /**
978
+ * 技能组名称
979
+ */
980
+ SkillGroupName?: string
966
981
  }
967
982
 
968
983
  /**
@@ -1789,46 +1804,6 @@ export interface StopAutoCalloutTaskResponse {
1789
1804
  RequestId?: string
1790
1805
  }
1791
1806
 
1792
- /**
1793
- * DescribeSeatUserList返回参数结构体
1794
- */
1795
- export interface DescribeSeatUserListResponse {
1796
- /**
1797
- * 此实例的坐席用户总数
1798
- */
1799
- TotalCount: number
1800
-
1801
- /**
1802
- * 坐席用户信息列表
1803
- */
1804
- SeatUsers: Array<SeatUserInfo>
1805
-
1806
- /**
1807
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1808
- */
1809
- RequestId?: string
1810
- }
1811
-
1812
- /**
1813
- * DescribeSeatUserList请求参数结构体
1814
- */
1815
- export interface DescribeSeatUserListRequest {
1816
- /**
1817
- * 实例ID
1818
- */
1819
- InstanceId: number
1820
-
1821
- /**
1822
- * 偏移量
1823
- */
1824
- Offset: number
1825
-
1826
- /**
1827
- * 返回数量
1828
- */
1829
- Limit: number
1830
- }
1831
-
1832
1807
  /**
1833
1808
  * CreateCallOutSession请求参数结构体
1834
1809
  */
@@ -1927,6 +1902,16 @@ export interface StaffStatusMetrics {
1927
1902
  * 是否预约示忙
1928
1903
  */
1929
1904
  ReserveNotReady: boolean
1905
+
1906
+ /**
1907
+ * 手机接听模式: 0 - 关闭 | 1 - 仅离线 | 2- 始终
1908
+ */
1909
+ UseMobileAccept: number
1910
+
1911
+ /**
1912
+ * 手机外呼开关
1913
+ */
1914
+ UseMobileCallOut: boolean
1930
1915
  }
1931
1916
 
1932
1917
  /**
@@ -7163,6 +7163,16 @@ export interface MySQLParam {
7163
7163
  * 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键
7164
7164
  */
7165
7165
  KeyColumns?: string
7166
+
7167
+ /**
7168
+ * Mysql 是否抛弃解析失败的消息,默认为true
7169
+ */
7170
+ DropInvalidMessage?: boolean
7171
+
7172
+ /**
7173
+ * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
7174
+ */
7175
+ DropCls?: DropCls
7166
7176
  }
7167
7177
 
7168
7178
  /**
@@ -1143,6 +1143,11 @@ export interface ModifyConsumerRequest {
1143
1143
  * CKafka的描述
1144
1144
  */
1145
1145
  Ckafka?: Ckafka
1146
+
1147
+ /**
1148
+ * 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
1149
+ */
1150
+ Compression?: number
1146
1151
  }
1147
1152
 
1148
1153
  /**
@@ -2234,6 +2239,12 @@ export interface DescribeConsumerResponse {
2234
2239
  */
2235
2240
  Ckafka: Ckafka
2236
2241
 
2242
+ /**
2243
+ * 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
2244
+ 注意:此字段可能返回 null,表示取不到有效值。
2245
+ */
2246
+ Compression: number
2247
+
2237
2248
  /**
2238
2249
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2239
2250
  */
@@ -3285,6 +3296,11 @@ export interface CreateConsumerRequest {
3285
3296
  * CKafka的描述
3286
3297
  */
3287
3298
  Ckafka?: Ckafka
3299
+
3300
+ /**
3301
+ * 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
3302
+ */
3303
+ Compression?: number
3288
3304
  }
3289
3305
 
3290
3306
  /**
@@ -4399,7 +4415,7 @@ export interface ConsumerContent {
4399
4415
  EnableTag: boolean
4400
4416
 
4401
4417
  /**
4402
- * 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_和\_\_TIMESTAMP\_\_
4418
+ * 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_,\_\_TIMESTAMP\_\_,\_\_HOSTNAME\_\_和\_\_PKGID\_\_
4403
4419
  注意:此字段可能返回 null,表示取不到有效值。
4404
4420
  */
4405
4421
  MetaFields: Array<string>
@@ -62,6 +62,7 @@ import {
62
62
  UnbindOpenBankExternalSubMerchantBankAccountRequest,
63
63
  CreateRedInvoiceItem,
64
64
  AddMerchantResult,
65
+ CloudExternalUserInfo,
65
66
  QueryOpenBankExternalSubMerchantRegistrationRequest,
66
67
  QueryMerchantInfoForManagementResponse,
67
68
  CreateTransferBatchResponse,
@@ -1587,6 +1587,21 @@ export interface AddMerchantResult {
1587
1587
  MerchantNo: string
1588
1588
  }
1589
1589
 
1590
+ /**
1591
+ * 渠道方用户信息
1592
+ */
1593
+ export interface CloudExternalUserInfo {
1594
+ /**
1595
+ * 渠道方用户类型
1596
+ */
1597
+ ExternalUserType?: string
1598
+
1599
+ /**
1600
+ * 渠道方用户ID
1601
+ */
1602
+ ExternalUserId?: string
1603
+ }
1604
+
1590
1605
  /**
1591
1606
  * QueryOpenBankExternalSubMerchantRegistration请求参数结构体
1592
1607
  */
@@ -21801,6 +21816,11 @@ ORDER_RECEIVE_MODE_V_COMBINE - 虚拟合单支付
21801
21816
  若不传入该字段,则会根据是否传入子单来判断是 普通支付 还是 合单支付
21802
21817
  */
21803
21818
  OrderReceiveMode?: string
21819
+
21820
+ /**
21821
+ * 渠道方用户信息列表
21822
+ */
21823
+ ExternalUserInfoList?: Array<CloudExternalUserInfo>
21804
21824
  }
21805
21825
 
21806
21826
  /**
@@ -30,6 +30,7 @@ import {
30
30
  CreateSchemeUrlRequest,
31
31
  FileUrl,
32
32
  DescribeThirdPartyAuthCodeRequest,
33
+ Filter,
33
34
  SignQrCode,
34
35
  GetTaskResultApiRequest,
35
36
  UploadFilesRequest,
@@ -48,6 +49,7 @@ import {
48
49
  SignUrl,
49
50
  DescribeFileUrlsRequest,
50
51
  ApproverInfo,
52
+ CreateFlowSignReviewResponse,
51
53
  Caller,
52
54
  DescribeFlowTemplatesResponse,
53
55
  CreateBatchCancelFlowUrlResponse,
@@ -56,7 +58,7 @@ import {
56
58
  CreateBatchCancelFlowUrlRequest,
57
59
  CreateMultiFlowSignQRCodeRequest,
58
60
  CreateConvertTaskApiResponse,
59
- Filter,
61
+ CreateFlowSignReviewRequest,
60
62
  CreateConvertTaskApiRequest,
61
63
  CreateSchemeUrlResponse,
62
64
  CreateFlowByFilesRequest,
@@ -80,6 +82,17 @@ export class Client extends AbstractClient {
80
82
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig)
81
83
  }
82
84
 
85
+ /**
86
+ * 查询文件下载URL
87
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
88
+ */
89
+ async DescribeFileUrls(
90
+ req: DescribeFileUrlsRequest,
91
+ cb?: (error: string, rep: DescribeFileUrlsResponse) => void
92
+ ): Promise<DescribeFileUrlsResponse> {
93
+ return this.request("DescribeFileUrls", req, cb)
94
+ }
95
+
83
96
  /**
84
97
  * 此接口用于发起流程
85
98
  适用场景:见创建签署流程接口。
@@ -93,15 +106,17 @@ export class Client extends AbstractClient {
93
106
  }
94
107
 
95
108
  /**
96
- * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
97
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
98
- 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
109
+ * 提交企业签署流程审批结果
110
+ 适用场景:
111
+ 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
112
+ 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
113
+
99
114
  */
100
- async CreateMultiFlowSignQRCode(
101
- req: CreateMultiFlowSignQRCodeRequest,
102
- cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
103
- ): Promise<CreateMultiFlowSignQRCodeResponse> {
104
- return this.request("CreateMultiFlowSignQRCode", req, cb)
115
+ async CreateFlowSignReview(
116
+ req: CreateFlowSignReviewRequest,
117
+ cb?: (error: string, rep: CreateFlowSignReviewResponse) => void
118
+ ): Promise<CreateFlowSignReviewResponse> {
119
+ return this.request("CreateFlowSignReview", req, cb)
105
120
  }
106
121
 
107
122
  /**
@@ -129,14 +144,15 @@ export class Client extends AbstractClient {
129
144
  }
130
145
 
131
146
  /**
132
- * 查询文件下载URL
133
- 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
147
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
148
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
149
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
134
150
  */
135
- async DescribeFileUrls(
136
- req: DescribeFileUrlsRequest,
137
- cb?: (error: string, rep: DescribeFileUrlsResponse) => void
138
- ): Promise<DescribeFileUrlsResponse> {
139
- return this.request("DescribeFileUrls", req, cb)
151
+ async CreateMultiFlowSignQRCode(
152
+ req: CreateMultiFlowSignQRCodeRequest,
153
+ cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
154
+ ): Promise<CreateMultiFlowSignQRCodeResponse> {
155
+ return this.request("CreateMultiFlowSignQRCode", req, cb)
140
156
  }
141
157
 
142
158
  /**
@@ -262,7 +262,7 @@ export interface CreateFlowRequest {
262
262
  FlowName: string
263
263
 
264
264
  /**
265
- * 签署流程参与者信息
265
+ * 签署流程参与者信息,最大限制50方
266
266
  */
267
267
  Approvers: Array<FlowCreateApprover>
268
268
 
@@ -310,6 +310,14 @@ false:有序签
310
310
  */
311
311
  CustomShowMap?: string
312
312
 
313
+ /**
314
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
315
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
316
+
317
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
318
+ */
319
+ NeedSignReview?: boolean
320
+
313
321
  /**
314
322
  * 暂未开放
315
323
  */
@@ -400,6 +408,21 @@ export interface DescribeThirdPartyAuthCodeRequest {
400
408
  AuthCode: string
401
409
  }
402
410
 
411
+ /**
412
+ * 查询过滤条件
413
+ */
414
+ export interface Filter {
415
+ /**
416
+ * 查询过滤条件的Key
417
+ */
418
+ Key: string
419
+
420
+ /**
421
+ * 查询过滤条件的Value列表
422
+ */
423
+ Values: Array<string>
424
+ }
425
+
403
426
  /**
404
427
  * 一码多扫签署二维码对象
405
428
  */
@@ -1111,6 +1134,16 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1111
1134
  PreReadTime?: number
1112
1135
  }
1113
1136
 
1137
+ /**
1138
+ * CreateFlowSignReview返回参数结构体
1139
+ */
1140
+ export interface CreateFlowSignReviewResponse {
1141
+ /**
1142
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1143
+ */
1144
+ RequestId?: string
1145
+ }
1146
+
1114
1147
  /**
1115
1148
  * 此结构体 (Caller) 用于描述调用方属性。
1116
1149
  */
@@ -1305,18 +1338,36 @@ export interface CreateConvertTaskApiResponse {
1305
1338
  }
1306
1339
 
1307
1340
  /**
1308
- * 查询过滤条件
1341
+ * CreateFlowSignReview请求参数结构体
1309
1342
  */
1310
- export interface Filter {
1343
+ export interface CreateFlowSignReviewRequest {
1311
1344
  /**
1312
- * 查询过滤条件的Key
1345
+ * 调用方用户信息,userId 必填
1313
1346
  */
1314
- Key: string
1347
+ Operator: UserInfo
1315
1348
 
1316
1349
  /**
1317
- * 查询过滤条件的Value列表
1350
+ * 签署流程编号
1318
1351
  */
1319
- Values: Array<string>
1352
+ FlowId: string
1353
+
1354
+ /**
1355
+ * 企业内部审核结果
1356
+ PASS: 通过
1357
+ REJECT: 拒绝
1358
+ */
1359
+ ReviewType: string
1360
+
1361
+ /**
1362
+ * 审核原因
1363
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1364
+ */
1365
+ ReviewMessage?: string
1366
+
1367
+ /**
1368
+ * 应用相关信息
1369
+ */
1370
+ Agent?: Agent
1320
1371
  }
1321
1372
 
1322
1373
  /**
@@ -1384,7 +1435,7 @@ export interface CreateFlowByFilesRequest {
1384
1435
  FlowName: string
1385
1436
 
1386
1437
  /**
1387
- * 签署参与者信息
1438
+ * 签署参与者信息,最大限制50方
1388
1439
  */
1389
1440
  Approvers: Array<ApproverInfo>
1390
1441
 
@@ -1439,6 +1490,14 @@ false:有序签
1439
1490
  */
1440
1491
  CustomShowMap?: string
1441
1492
 
1493
+ /**
1494
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1495
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1496
+
1497
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1498
+ */
1499
+ NeedSignReview?: boolean
1500
+
1442
1501
  /**
1443
1502
  * 应用号信息
1444
1503
  */
@@ -24,6 +24,7 @@ import {
24
24
  ChannelCreateConvertTaskApiResponse,
25
25
  OperateChannelTemplateRequest,
26
26
  TemplateInfo,
27
+ UploadFilesRequest,
27
28
  GetDownloadFlowUrlResponse,
28
29
  DescribeResourceUrlsByFlowsResponse,
29
30
  ChannelCreateMultiFlowSignQRCodeResponse,
@@ -36,7 +37,7 @@ import {
36
37
  AuthFailMessage,
37
38
  DescribeFlowDetailInfoRequest,
38
39
  ChannelGetTaskResultApiResponse,
39
- UploadFilesRequest,
40
+ ProxyOrganizationOperator,
40
41
  ChannelGetTaskResultApiRequest,
41
42
  UploadFile,
42
43
  Component,
@@ -45,7 +46,7 @@ import {
45
46
  CreateConsoleLoginUrlRequest,
46
47
  OrganizationInfo,
47
48
  CreateFlowsByTemplatesResponse,
48
- ProxyOrganizationOperator,
49
+ ChannelCreateFlowSignReviewRequest,
49
50
  PrepareFlowsRequest,
50
51
  SyncProxyOrganizationOperatorsResponse,
51
52
  CreateSealByImageResponse,
@@ -72,6 +73,7 @@ import {
72
73
  ChannelCreateFlowByFilesRequest,
73
74
  ChannelCreateFlowByFilesResponse,
74
75
  UploadFilesResponse,
76
+ ChannelCreateFlowSignReviewResponse,
75
77
  Agent,
76
78
  FormField,
77
79
  UserInfo,
@@ -93,6 +95,17 @@ export class Client extends AbstractClient {
93
95
  super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig)
94
96
  }
95
97
 
98
+ /**
99
+ * 此接口(UploadFiles)用于文件上传。
100
+ 调用时需要设置Domain 为 file.ess.tencent.cn
101
+ */
102
+ async UploadFiles(
103
+ req: UploadFilesRequest,
104
+ cb?: (error: string, rep: UploadFilesResponse) => void
105
+ ): Promise<UploadFilesResponse> {
106
+ return this.request("UploadFiles", req, cb)
107
+ }
108
+
96
109
  /**
97
110
  * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
98
111
 
@@ -115,15 +128,16 @@ export class Client extends AbstractClient {
115
128
  }
116
129
 
117
130
  /**
118
- * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
119
- 当前接口限制最多合同(流程)50个.
131
+ * 提交企业签署流程审批结果
120
132
 
133
+ 在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
134
+ 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
121
135
  */
122
- async GetDownloadFlowUrl(
123
- req: GetDownloadFlowUrlRequest,
124
- cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void
125
- ): Promise<GetDownloadFlowUrlResponse> {
126
- return this.request("GetDownloadFlowUrl", req, cb)
136
+ async ChannelCreateFlowSignReview(
137
+ req: ChannelCreateFlowSignReviewRequest,
138
+ cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void
139
+ ): Promise<ChannelCreateFlowSignReviewResponse> {
140
+ return this.request("ChannelCreateFlowSignReview", req, cb)
127
141
  }
128
142
 
129
143
  /**
@@ -297,13 +311,14 @@ export class Client extends AbstractClient {
297
311
  }
298
312
 
299
313
  /**
300
- * 此接口(UploadFiles)用于文件上传。
301
- 调用时需要设置Domain 为 file.ess.tencent.cn
314
+ * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
315
+ 当前接口限制最多合同(流程)50个.
316
+
302
317
  */
303
- async UploadFiles(
304
- req: UploadFilesRequest,
305
- cb?: (error: string, rep: UploadFilesResponse) => void
306
- ): Promise<UploadFilesResponse> {
307
- return this.request("UploadFiles", req, cb)
318
+ async GetDownloadFlowUrl(
319
+ req: GetDownloadFlowUrlRequest,
320
+ cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void
321
+ ): Promise<GetDownloadFlowUrlResponse> {
322
+ return this.request("GetDownloadFlowUrl", req, cb)
308
323
  }
309
324
  }
@@ -246,6 +246,33 @@ export interface TemplateInfo {
246
246
  CreatedOn: number
247
247
  }
248
248
 
249
+ /**
250
+ * UploadFiles请求参数结构体
251
+ */
252
+ export interface UploadFilesRequest {
253
+ /**
254
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
255
+ */
256
+ Agent: Agent
257
+
258
+ /**
259
+ * 文件对应业务类型,用于区分文件存储路径:
260
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
261
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
262
+ */
263
+ BusinessType: string
264
+
265
+ /**
266
+ * 上传文件内容数组,最多支持20个文件
267
+ */
268
+ FileInfos?: Array<UploadFile>
269
+
270
+ /**
271
+ * 操作者的信息
272
+ */
273
+ Operator?: UserInfo
274
+ }
275
+
249
276
  /**
250
277
  * GetDownloadFlowUrl返回参数结构体
251
278
  */
@@ -650,30 +677,36 @@ ProcessTimeout - 转换文件超时
650
677
  }
651
678
 
652
679
  /**
653
- * UploadFiles请求参数结构体
680
+ * 合作企业经办人列表信息
654
681
  */
655
- export interface UploadFilesRequest {
682
+ export interface ProxyOrganizationOperator {
656
683
  /**
657
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
684
+ * 经办人ID(渠道颁发),最大长度64个字符
658
685
  */
659
- Agent: Agent
686
+ Id: string
660
687
 
661
688
  /**
662
- * 文件对应业务类型,用于区分文件存储路径:
663
- 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
664
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
689
+ * 经办人姓名,最大长度50个字符
690
+ */
691
+ Name?: string
692
+
693
+ /**
694
+ * 经办人身份证件类型
695
+ 1.ID_CARD 居民身份证
696
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
697
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
665
698
  */
666
- BusinessType: string
699
+ IdCardType?: string
667
700
 
668
701
  /**
669
- * 上传文件内容数组,最多支持20个文件
702
+ * 经办人证件号
670
703
  */
671
- FileInfos?: Array<UploadFile>
704
+ IdCardNumber?: string
672
705
 
673
706
  /**
674
- * 操作者的信息
707
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
675
708
  */
676
- Operator?: UserInfo
709
+ Mobile?: string
677
710
  }
678
711
 
679
712
  /**
@@ -1030,36 +1063,31 @@ export interface CreateFlowsByTemplatesResponse {
1030
1063
  }
1031
1064
 
1032
1065
  /**
1033
- * 合作企业经办人列表信息
1066
+ * ChannelCreateFlowSignReview请求参数结构体
1034
1067
  */
1035
- export interface ProxyOrganizationOperator {
1068
+ export interface ChannelCreateFlowSignReviewRequest {
1036
1069
  /**
1037
- * 经办人ID(渠道颁发),最大长度64个字符
1070
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1038
1071
  */
1039
- Id: string
1072
+ Agent: Agent
1040
1073
 
1041
1074
  /**
1042
- * 经办人姓名,最大长度50个字符
1075
+ * 签署流程编号
1043
1076
  */
1044
- Name?: string
1077
+ FlowId: string
1045
1078
 
1046
1079
  /**
1047
- * 经办人身份证件类型
1048
- 1.ID_CARD 居民身份证
1049
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
1050
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
1080
+ * 企业内部审核结果
1081
+ PASS: 通过
1082
+ REJECT: 拒绝
1051
1083
  */
1052
- IdCardType?: string
1053
-
1054
- /**
1055
- * 经办人证件号
1056
- */
1057
- IdCardNumber?: string
1084
+ ReviewType: string
1058
1085
 
1059
1086
  /**
1060
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
1061
- */
1062
- Mobile?: string
1087
+ * 审核原因
1088
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1089
+ */
1090
+ ReviewMessage?: string
1063
1091
  }
1064
1092
 
1065
1093
  /**
@@ -1606,7 +1634,7 @@ export interface ApproverRestriction {
1606
1634
  */
1607
1635
  export interface ChannelCreateFlowByFilesRequest {
1608
1636
  /**
1609
- * 渠道应用相关信息
1637
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1610
1638
  */
1611
1639
  Agent?: Agent
1612
1640
 
@@ -1665,6 +1693,11 @@ export interface ChannelCreateFlowByFilesRequest {
1665
1693
  */
1666
1694
  CustomerData?: string
1667
1695
 
1696
+ /**
1697
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1698
+ */
1699
+ NeedSignReview?: boolean
1700
+
1668
1701
  /**
1669
1702
  * 操作者的信息
1670
1703
  */
@@ -1712,6 +1745,16 @@ export interface UploadFilesResponse {
1712
1745
  RequestId?: string
1713
1746
  }
1714
1747
 
1748
+ /**
1749
+ * ChannelCreateFlowSignReview返回参数结构体
1750
+ */
1751
+ export interface ChannelCreateFlowSignReviewResponse {
1752
+ /**
1753
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1754
+ */
1755
+ RequestId?: string
1756
+ }
1757
+
1715
1758
  /**
1716
1759
  * 应用相关信息
1717
1760
  */
@@ -2019,6 +2062,14 @@ export interface FlowInfo {
2019
2062
  * 被抄送人的信息列表,抄送功能暂不开放
2020
2063
  */
2021
2064
  CcInfos?: Array<CcInfo>
2065
+
2066
+ /**
2067
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2068
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2069
+
2070
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2071
+ */
2072
+ NeedSignReview?: boolean
2022
2073
  }
2023
2074
 
2024
2075
  /**