tencentcloud-sdk-nodejs 4.0.412 → 4.0.415

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 (124) hide show
  1. package/CHANGELOG.md +813 -0
  2. package/SERVICE_CHANGELOG.md +1108 -212
  3. package/package.json +1 -1
  4. package/products.md +34 -34
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_client.ts +13 -13
  7. package/src/services/antiddos/v20200309/antiddos_models.ts +78 -43
  8. package/src/services/as/v20180419/as_models.ts +18 -0
  9. package/src/services/bm/v20180423/bm_models.ts +2 -2
  10. package/src/services/captcha/v20190722/captcha_models.ts +4 -1
  11. package/src/services/ccc/v20200210/ccc_client.ts +0 -14
  12. package/src/services/ccc/v20200210/ccc_models.ts +25 -40
  13. package/src/services/cfw/v20190904/cfw_models.ts +2 -2
  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 +25 -0
  18. package/src/services/ess/v20201111/ess_client.ts +1 -0
  19. package/src/services/ess/v20201111/ess_models.ts +56 -28
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +2 -2
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +51 -26
  22. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  23. package/src/services/gme/v20180711/gme_client.ts +185 -111
  24. package/src/services/gme/v20180711/gme_models.ts +312 -71
  25. package/src/services/iai/v20200303/iai_models.ts +1 -1
  26. package/src/services/lighthouse/v20200324/lighthouse_client.ts +1 -0
  27. package/src/services/lighthouse/v20200324/lighthouse_models.ts +79 -7
  28. package/src/services/live/v20180801/live_models.ts +6 -0
  29. package/src/services/mongodb/v20190725/mongodb_client.ts +0 -15
  30. package/src/services/mongodb/v20190725/mongodb_models.ts +0 -55
  31. package/src/services/monitor/v20180724/monitor_client.ts +1 -0
  32. package/src/services/monitor/v20180724/monitor_models.ts +25 -0
  33. package/src/services/organization/v20181225/organization_models.ts +1 -1
  34. package/src/services/postgres/v20170312/postgres_client.ts +1 -1
  35. package/src/services/redis/v20180412/redis_client.ts +12 -0
  36. package/src/services/redis/v20180412/redis_models.ts +25 -0
  37. package/src/services/sqlserver/v20180328/sqlserver_models.ts +40 -0
  38. package/src/services/taf/v20200210/taf_client.ts +20 -37
  39. package/src/services/taf/v20200210/taf_models.ts +154 -224
  40. package/src/services/tbaas/v20180416/tbaas_client.ts +77 -175
  41. package/src/services/tbaas/v20180416/tbaas_models.ts +978 -1343
  42. package/src/services/tcss/v20201101/tcss_models.ts +54 -0
  43. package/src/services/tem/v20210701/tem_client.ts +14 -1
  44. package/src/services/tem/v20210701/tem_models.ts +183 -87
  45. package/src/services/teo/v20220106/teo_client.ts +8 -7
  46. package/src/services/teo/v20220106/teo_models.ts +536 -355
  47. package/src/services/tione/v20211111/tione_models.ts +23 -1
  48. package/src/services/tke/v20180525/tke_models.ts +6 -0
  49. package/src/services/tse/v20201207/tse_client.ts +16 -2
  50. package/src/services/tse/v20201207/tse_models.ts +93 -17
  51. package/src/services/vod/v20180717/vod_client.ts +49 -33
  52. package/src/services/vod/v20180717/vod_models.ts +78 -21
  53. package/src/services/vpc/v20170312/vpc_models.ts +29 -0
  54. package/tencentcloud/common/sdk_version.d.ts +1 -1
  55. package/tencentcloud/common/sdk_version.js +1 -1
  56. package/tencentcloud/services/antiddos/v20200309/antiddos_client.d.ts +5 -5
  57. package/tencentcloud/services/antiddos/v20200309/antiddos_client.js +6 -6
  58. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +68 -40
  59. package/tencentcloud/services/as/v20180419/as_models.d.ts +15 -0
  60. package/tencentcloud/services/bm/v20180423/bm_models.d.ts +2 -2
  61. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +4 -1
  62. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -7
  63. package/tencentcloud/services/ccc/v20200210/ccc_client.js +0 -8
  64. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -34
  65. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +2 -2
  66. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +8 -0
  67. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +14 -1
  68. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +21 -0
  69. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +1 -0
  70. package/tencentcloud/services/ess/v20201111/ess_client.js +1 -0
  71. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +50 -24
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +2 -2
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +2 -2
  74. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +46 -23
  75. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  76. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +68 -44
  77. package/tencentcloud/services/gme/v20180711/gme_client.js +94 -58
  78. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +273 -66
  79. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +1 -1
  80. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +67 -5
  81. package/tencentcloud/services/live/v20180801/live_models.d.ts +5 -0
  82. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +1 -7
  83. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +0 -8
  84. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +0 -47
  85. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +21 -0
  86. package/tencentcloud/services/organization/v20181225/organization_models.d.ts +1 -1
  87. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
  88. package/tencentcloud/services/postgres/v20170312/postgres_client.js +1 -1
  89. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +5 -1
  90. package/tencentcloud/services/redis/v20180412/redis_client.js +6 -0
  91. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +22 -0
  92. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +32 -0
  93. package/tencentcloud/services/taf/v20200210/taf_client.d.ts +5 -11
  94. package/tencentcloud/services/taf/v20200210/taf_client.js +6 -14
  95. package/tencentcloud/services/taf/v20200210/taf_models.d.ts +136 -197
  96. package/tencentcloud/services/tbaas/v20180416/tbaas_client.d.ts +7 -49
  97. package/tencentcloud/services/tbaas/v20180416/tbaas_client.js +9 -65
  98. package/tencentcloud/services/tbaas/v20180416/tbaas_models.d.ts +905 -1211
  99. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +47 -0
  100. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +5 -1
  101. package/tencentcloud/services/tem/v20210701/tem_client.js +6 -0
  102. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +151 -70
  103. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +7 -7
  104. package/tencentcloud/services/teo/v20220106/teo_client.js +7 -7
  105. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +452 -288
  106. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +19 -1
  107. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -0
  108. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +5 -1
  109. package/tencentcloud/services/tse/v20201207/tse_client.js +6 -0
  110. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +81 -16
  111. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +23 -15
  112. package/tencentcloud/services/vod/v20180717/vod_client.js +28 -18
  113. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +67 -18
  114. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +24 -0
  115. package/test/antiddos.v20200309.test.js +10 -10
  116. package/test/ccc.v20200210.test.js +0 -10
  117. package/test/gme.v20180711.test.js +90 -30
  118. package/test/mongodb.v20190725.test.js +0 -10
  119. package/test/redis.v20180412.test.js +10 -0
  120. package/test/taf.v20200210.test.js +8 -18
  121. package/test/tbaas.v20180416.test.js +6 -76
  122. package/test/tem.v20210701.test.js +10 -0
  123. package/test/tse.v20201207.test.js +10 -0
  124. package/test/vod.v20180717.test.js +18 -8
@@ -992,12 +992,12 @@ export interface ModifyBlockIgnoreListRequest {
992
992
  IocAction: string
993
993
 
994
994
  /**
995
- * 时间格式:yyyy-MM-dd HH:mm:ss
995
+ * 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填
996
996
  */
997
997
  StartTime?: string
998
998
 
999
999
  /**
1000
- * 时间格式:yyyy-MM-dd HH:mm:ss
1000
+ * 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填
1001
1001
  */
1002
1002
  EndTime?: string
1003
1003
  }
@@ -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
  */
@@ -11449,6 +11464,11 @@ __test__:测试环境
11449
11464
  缺省默认为生产环境
11450
11465
  */
11451
11466
  Environment?: string
11467
+
11468
+ /**
11469
+ * 支付结果通知回调地址
11470
+ */
11471
+ NotifyUrl?: string
11452
11472
  }
11453
11473
 
11454
11474
  /**
@@ -21796,6 +21816,11 @@ ORDER_RECEIVE_MODE_V_COMBINE - 虚拟合单支付
21796
21816
  若不传入该字段,则会根据是否传入子单来判断是 普通支付 还是 合单支付
21797
21817
  */
21798
21818
  OrderReceiveMode?: string
21819
+
21820
+ /**
21821
+ * 渠道方用户信息列表
21822
+ */
21823
+ ExternalUserInfoList?: Array<CloudExternalUserInfo>
21799
21824
  }
21800
21825
 
21801
21826
  /**
@@ -236,6 +236,7 @@ export class Client extends AbstractClient {
236
236
  /**
237
237
  * 查询流程摘要
238
238
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
239
+ 日调用量默认10W
239
240
  */
240
241
  async DescribeFlowBriefs(
241
242
  req: DescribeFlowBriefsRequest,
@@ -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
  */
@@ -425,24 +433,24 @@ export interface SignQrCode {
425
433
  */
426
434
  export interface GetTaskResultApiRequest {
427
435
  /**
428
- * 任务Id
436
+ * 任务Id,通过CreateConvertTaskApi得到
429
437
  */
430
438
  TaskId: string
431
439
 
432
- /**
433
- * 企业信息
434
- */
435
- Organization?: OrganizationInfo
436
-
437
440
  /**
438
441
  * 操作人信息
439
442
  */
440
443
  Operator?: UserInfo
441
444
 
442
445
  /**
443
- * 渠道信息
446
+ * 应用号信息
444
447
  */
445
448
  Agent?: Agent
449
+
450
+ /**
451
+ * 暂未开放
452
+ */
453
+ Organization?: OrganizationInfo
446
454
  }
447
455
 
448
456
  /**
@@ -451,8 +459,8 @@ export interface GetTaskResultApiRequest {
451
459
  export interface UploadFilesRequest {
452
460
  /**
453
461
  * 文件对应业务类型,用于区分文件存储路径:
454
- 1. TEMPLATE - 模板; 文件类型:.pdf/.html
455
- 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
462
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
463
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
456
464
  3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
457
465
  */
458
466
  BusinessType: string
@@ -849,7 +857,7 @@ export interface DescribeFlowBriefsRequest {
849
857
  Operator: UserInfo
850
858
 
851
859
  /**
852
- * 需要查询的流程ID列表
860
+ * 需要查询的流程ID列表,限制最大20个
853
861
  */
854
862
  FlowIds: Array<string>
855
863
 
@@ -1323,35 +1331,35 @@ export interface Filter {
1323
1331
  * CreateConvertTaskApi请求参数结构体
1324
1332
  */
1325
1333
  export interface CreateConvertTaskApiRequest {
1326
- /**
1327
- * 资源Id
1328
- */
1329
- ResourceId: string
1330
-
1331
1334
  /**
1332
1335
  * 资源类型 取值范围doc,docx,html之一
1333
1336
  */
1334
1337
  ResourceType: string
1335
1338
 
1336
1339
  /**
1337
- * 资源名称
1340
+ * 资源名称,长度限制为256字符
1338
1341
  */
1339
1342
  ResourceName: string
1340
1343
 
1341
1344
  /**
1342
- *
1345
+ * 资源Id,通过UploadFiles获取
1343
1346
  */
1344
- Organization?: OrganizationInfo
1347
+ ResourceId: string
1345
1348
 
1346
1349
  /**
1347
- *
1350
+ * 操作者信息
1348
1351
  */
1349
1352
  Operator?: UserInfo
1350
1353
 
1351
1354
  /**
1352
- *
1355
+ * 应用号信息
1353
1356
  */
1354
1357
  Agent?: Agent
1358
+
1359
+ /**
1360
+ * 暂未开放
1361
+ */
1362
+ Organization?: OrganizationInfo
1355
1363
  }
1356
1364
 
1357
1365
  /**
@@ -1384,7 +1392,7 @@ export interface CreateFlowByFilesRequest {
1384
1392
  FlowName: string
1385
1393
 
1386
1394
  /**
1387
- * 签署参与者信息
1395
+ * 签署参与者信息,最大限制50方
1388
1396
  */
1389
1397
  Approvers: Array<ApproverInfo>
1390
1398
 
@@ -1439,6 +1447,14 @@ false:有序签
1439
1447
  */
1440
1448
  CustomShowMap?: string
1441
1449
 
1450
+ /**
1451
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1452
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1453
+
1454
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1455
+ */
1456
+ NeedSignReview?: boolean
1457
+
1442
1458
  /**
1443
1459
  * 应用号信息
1444
1460
  */
@@ -1541,7 +1557,7 @@ export interface DescribeFlowTemplatesRequest {
1541
1557
  Filters?: Array<Filter>
1542
1558
 
1543
1559
  /**
1544
- * 查询个数,默认20,最大100
1560
+ * 查询个数,默认20,最大200
1545
1561
  */
1546
1562
  Limit?: number
1547
1563
 
@@ -1576,17 +1592,29 @@ export interface GetTaskResultApiResponse {
1576
1592
  TaskId: string
1577
1593
 
1578
1594
  /**
1579
- * 任务状态
1580
- */
1595
+ * 任务状态,需要关注的状态
1596
+ 0 :NeedTranform - 任务已提交
1597
+ 4 :Processing - 文档转换中
1598
+ 8 :TaskEnd - 任务处理完成
1599
+ -2 :DownloadFailed - 下载失败
1600
+ -6 :ProcessFailed - 转换失败
1601
+ -13:ProcessTimeout - 转换文件超时
1602
+ */
1581
1603
  TaskStatus: number
1582
1604
 
1583
1605
  /**
1584
- * 状态描述
1585
- */
1606
+ * 状态描述,需要关注的状态
1607
+ NeedTranform - 任务已提交
1608
+ Processing - 文档转换中
1609
+ TaskEnd - 任务处理完成
1610
+ DownloadFailed - 下载失败
1611
+ ProcessFailed - 转换失败
1612
+ ProcessTimeout - 转换文件超时
1613
+ */
1586
1614
  TaskMessage: string
1587
1615
 
1588
1616
  /**
1589
- * 资源Id
1617
+ * 资源Id,也是FileId,用于文件发起使用
1590
1618
  */
1591
1619
  ResourceId: string
1592
1620
 
@@ -235,8 +235,8 @@ export class Client extends AbstractClient {
235
235
  }
236
236
 
237
237
  /**
238
- * 指定需要批量撤回的签署流程Id,获取批量撤销链接
239
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
238
+ * 指定需要批量撤销的签署流程Id,获取批量撤销链接
239
+ 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销
240
240
  */
241
241
  async ChannelCreateBatchCancelFlowUrl(
242
242
  req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -617,17 +617,29 @@ export interface ChannelGetTaskResultApiResponse {
617
617
  TaskId: string
618
618
 
619
619
  /**
620
- * 任务状态
621
- */
620
+ * 任务状态,需要关注的状态
621
+ 0 :NeedTranform - 任务已提交
622
+ 4 :Processing - 文档转换中
623
+ 8 :TaskEnd - 任务处理完成
624
+ -2 :DownloadFailed - 下载失败
625
+ -6 :ProcessFailed - 转换失败
626
+ -13:ProcessTimeout - 转换文件超时
627
+ */
622
628
  TaskStatus: number
623
629
 
624
630
  /**
625
- * 状态描述
626
- */
631
+ * 状态描述,需要关注的状态
632
+ NeedTranform - 任务已提交
633
+ Processing - 文档转换中
634
+ TaskEnd - 任务处理完成
635
+ DownloadFailed - 下载失败
636
+ ProcessFailed - 转换失败
637
+ ProcessTimeout - 转换文件超时
638
+ */
627
639
  TaskMessage: string
628
640
 
629
641
  /**
630
- * 资源Id
642
+ * 资源Id,也是FileId,用于文件发起使用
631
643
  */
632
644
  ResourceId: string
633
645
 
@@ -648,7 +660,7 @@ export interface UploadFilesRequest {
648
660
 
649
661
  /**
650
662
  * 文件对应业务类型,用于区分文件存储路径:
651
- 1. TEMPLATE - 模板; 文件类型:.pdf
663
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
652
664
  2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
653
665
  */
654
666
  BusinessType: string
@@ -669,24 +681,24 @@ export interface UploadFilesRequest {
669
681
  */
670
682
  export interface ChannelGetTaskResultApiRequest {
671
683
  /**
672
- * 渠道信息
684
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
673
685
  */
674
686
  Agent: Agent
675
687
 
676
688
  /**
677
- * 任务Id
689
+ * 任务Id,通过ChannelCreateConvertTaskApi接口获得
678
690
  */
679
691
  TaskId: string
680
692
 
681
693
  /**
682
- * 企业信息
694
+ * 操作者的信息
683
695
  */
684
- Organization?: OrganizationInfo
696
+ Operator?: UserInfo
685
697
 
686
698
  /**
687
- * 操作人信息
699
+ * 暂未开放
688
700
  */
689
- Operator?: UserInfo
701
+ Organization?: OrganizationInfo
690
702
  }
691
703
 
692
704
  /**
@@ -1393,17 +1405,17 @@ export interface UsageDetail {
1393
1405
  */
1394
1406
  export interface ChannelCreateBatchCancelFlowUrlResponse {
1395
1407
  /**
1396
- * 批量撤回url
1408
+ * 批量撤销url
1397
1409
  */
1398
1410
  BatchCancelFlowUrl: string
1399
1411
 
1400
1412
  /**
1401
- * 签署流程批量撤回失败原因
1413
+ * 签署流程批量撤销失败原因
1402
1414
  */
1403
1415
  FailMessages: Array<string>
1404
1416
 
1405
1417
  /**
1406
- * 签署撤回url过期时间-年月日-时分秒
1418
+ * 签署撤销url过期时间-年月日-时分秒
1407
1419
  */
1408
1420
  UrlExpireOn: string
1409
1421
 
@@ -1594,7 +1606,7 @@ export interface ApproverRestriction {
1594
1606
  */
1595
1607
  export interface ChannelCreateFlowByFilesRequest {
1596
1608
  /**
1597
- * 渠道应用相关信息
1609
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1598
1610
  */
1599
1611
  Agent?: Agent
1600
1612
 
@@ -1653,6 +1665,11 @@ export interface ChannelCreateFlowByFilesRequest {
1653
1665
  */
1654
1666
  CustomerData?: string
1655
1667
 
1668
+ /**
1669
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1670
+ */
1671
+ NeedSignReview?: boolean
1672
+
1656
1673
  /**
1657
1674
  * 操作者的信息
1658
1675
  */
@@ -1794,34 +1811,34 @@ export interface UserInfo {
1794
1811
  */
1795
1812
  export interface ChannelCreateConvertTaskApiRequest {
1796
1813
  /**
1797
- *
1814
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1798
1815
  */
1799
1816
  Agent: Agent
1800
1817
 
1801
- /**
1802
- * 资源Id
1803
- */
1804
- ResourceId: string
1805
-
1806
1818
  /**
1807
1819
  * 资源类型 取值范围doc,docx,html之一
1808
1820
  */
1809
1821
  ResourceType: string
1810
1822
 
1811
1823
  /**
1812
- * 资源名称
1824
+ * 资源名称,长度限制为256字符
1813
1825
  */
1814
1826
  ResourceName: string
1815
1827
 
1816
1828
  /**
1817
- *
1829
+ * 资源Id,通过UploadFiles获取
1818
1830
  */
1819
- Organization?: OrganizationInfo
1831
+ ResourceId: string
1820
1832
 
1821
1833
  /**
1822
- *
1834
+ * 操作者信息
1823
1835
  */
1824
1836
  Operator?: UserInfo
1837
+
1838
+ /**
1839
+ * 暂未开放
1840
+ */
1841
+ Organization?: OrganizationInfo
1825
1842
  }
1826
1843
 
1827
1844
  /**
@@ -2007,6 +2024,14 @@ export interface FlowInfo {
2007
2024
  * 被抄送人的信息列表,抄送功能暂不开放
2008
2025
  */
2009
2026
  CcInfos?: Array<CcInfo>
2027
+
2028
+ /**
2029
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
2030
+ 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2031
+
2032
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2033
+ */
2034
+ NeedSignReview?: boolean
2010
2035
  }
2011
2036
 
2012
2037
  /**
@@ -732,7 +732,7 @@ export interface GetEidTokenRequest {
732
732
  export interface IntentionQuestionResult {
733
733
  /**
734
734
  * 意愿核身最终结果:
735
- 0:通过,-1:未通过
735
+ 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验
736
736
  注意:此字段可能返回 null,表示取不到有效值。
737
737
  */
738
738
  FinalResultCode: string