tencentcloud-sdk-nodejs 4.0.413 → 4.0.416

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 (125) hide show
  1. package/CHANGELOG.md +623 -0
  2. package/SERVICE_CHANGELOG.md +814 -288
  3. package/package.json +1 -1
  4. package/products.md +32 -32
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_models.ts +18 -0
  7. package/src/services/bm/v20180423/bm_models.ts +2 -2
  8. package/src/services/captcha/v20190722/captcha_models.ts +4 -1
  9. package/src/services/ccc/v20200210/ccc_client.ts +0 -14
  10. package/src/services/ccc/v20200210/ccc_models.ts +25 -40
  11. package/src/services/cfw/v20190904/cfw_models.ts +2 -2
  12. package/src/services/ckafka/v20190819/ckafka_models.ts +10 -0
  13. package/src/services/cls/v20201016/cls_models.ts +17 -1
  14. package/src/services/cpdp/v20190820/cpdp_client.ts +1 -0
  15. package/src/services/cpdp/v20190820/cpdp_models.ts +25 -0
  16. package/src/services/ess/v20201111/ess_client.ts +33 -16
  17. package/src/services/ess/v20201111/ess_models.ts +105 -34
  18. package/src/services/essbasic/v20210526/essbasic_client.ts +33 -18
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +119 -56
  20. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  21. package/src/services/gme/v20180711/gme_client.ts +185 -111
  22. package/src/services/gme/v20180711/gme_models.ts +312 -71
  23. package/src/services/iai/v20200303/iai_models.ts +1 -1
  24. package/src/services/lighthouse/v20200324/lighthouse_client.ts +1 -0
  25. package/src/services/lighthouse/v20200324/lighthouse_models.ts +79 -7
  26. package/src/services/live/v20180801/live_models.ts +6 -0
  27. package/src/services/mongodb/v20190725/mongodb_client.ts +0 -15
  28. package/src/services/mongodb/v20190725/mongodb_models.ts +0 -55
  29. package/src/services/monitor/v20180724/monitor_client.ts +1 -0
  30. package/src/services/monitor/v20180724/monitor_models.ts +25 -0
  31. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  32. package/src/services/ocr/v20181119/ocr_models.ts +5 -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 +41 -4
  44. package/src/services/tem/v20210701/tem_models.ts +409 -225
  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/as/v20180419/as_models.d.ts +15 -0
  57. package/tencentcloud/services/bm/v20180423/bm_models.d.ts +2 -2
  58. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +4 -1
  59. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -7
  60. package/tencentcloud/services/ccc/v20200210/ccc_client.js +0 -8
  61. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -34
  62. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +2 -2
  63. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +8 -0
  64. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +14 -1
  65. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +21 -0
  66. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +17 -8
  67. package/tencentcloud/services/ess/v20201111/ess_client.js +20 -9
  68. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +93 -30
  69. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +16 -9
  70. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +19 -10
  71. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +107 -51
  72. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  73. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +68 -44
  74. package/tencentcloud/services/gme/v20180711/gme_client.js +94 -58
  75. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +273 -66
  76. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +1 -1
  77. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +67 -5
  78. package/tencentcloud/services/live/v20180801/live_models.d.ts +5 -0
  79. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +1 -7
  80. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +0 -8
  81. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +0 -47
  82. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +21 -0
  83. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  84. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  85. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -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 +13 -1
  101. package/tencentcloud/services/tem/v20210701/tem_client.js +18 -0
  102. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +316 -160
  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/ccc.v20200210.test.js +0 -10
  116. package/test/ess.v20201111.test.js +14 -4
  117. package/test/essbasic.v20210526.test.js +14 -4
  118. package/test/gme.v20180711.test.js +90 -30
  119. package/test/mongodb.v20190725.test.js +0 -10
  120. package/test/redis.v20180412.test.js +10 -0
  121. package/test/taf.v20200210.test.js +8 -18
  122. package/test/tbaas.v20180416.test.js +6 -76
  123. package/test/tem.v20210701.test.js +30 -0
  124. package/test/tse.v20201207.test.js +10 -0
  125. package/test/vod.v20180717.test.js +18 -8
@@ -108,6 +108,11 @@ InstanceType 指定单一实例类型,通过设置 InstanceTypes可以指定
108
108
  * CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
109
109
  */
110
110
  CamRoleName?: string;
111
+ /**
112
+ * 高性能计算集群ID。<br>
113
+ 注意:此字段默认为空。
114
+ */
115
+ HpcClusterId?: string;
111
116
  }
112
117
  /**
113
118
  * DisableAutoScalingGroup请求参数结构体
@@ -468,6 +473,11 @@ export interface LaunchConfiguration {
468
473
  <br><li>AUTOMATIC:自动选择当前可用区下可用的云盘类型
469
474
  */
470
475
  DiskTypePolicy: string;
476
+ /**
477
+ * 高性能计算集群ID。<br>
478
+ 注意:此字段默认为空。
479
+ */
480
+ HpcClusterId: string;
471
481
  }
472
482
  /**
473
483
  * DescribeAccountLimits返回参数结构体
@@ -1130,6 +1140,11 @@ export interface CreateLaunchConfigurationRequest {
1130
1140
  <br><li>AUTOMATIC:自动选择当前可用的云盘类型
1131
1141
  */
1132
1142
  DiskTypePolicy?: string;
1143
+ /**
1144
+ * 高性能计算集群ID。<br>
1145
+ 注意:此字段默认为空。
1146
+ */
1147
+ HpcClusterId?: string;
1133
1148
  }
1134
1149
  /**
1135
1150
  * 伸缩组
@@ -1960,11 +1960,11 @@ export interface DescribeTaskInfoResponse {
1960
1960
  /**
1961
1961
  * 返回任务总数量
1962
1962
  */
1963
- TotalCount?: number;
1963
+ TotalCount: number;
1964
1964
  /**
1965
1965
  * 任务信息列表
1966
1966
  */
1967
- TaskInfoSet?: Array<TaskInfo>;
1967
+ TaskInfoSet: Array<TaskInfo>;
1968
1968
  /**
1969
1969
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1970
1970
  */
@@ -717,7 +717,10 @@ export interface DescribeCaptchaResultResponse {
717
717
  */
718
718
  CaptchaMsg: string;
719
719
  /**
720
- * [0,100],恶意等级
720
+ * 无感验证模式下,该参数返回验证结果:
721
+
722
+ EvilLevel=0 请求无恶意
723
+ EvilLevel=100 请求有恶意
721
724
  注意:此字段可能返回 null,表示取不到有效值。
722
725
  */
723
726
  EvilLevel: number;
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { StopAutoCalloutTaskRequest, BindStaffSkillGroupListRequest, DescribePSTNActiveSessionListRequest, UnbindStaffSkillGroupListRequest, CreateAutoCalloutTaskRequest, CreateSDKLoginTokenResponse, DescribeCallInMetricsResponse, DescribeStaffInfoListResponse, CreateAutoCalloutTaskResponse, CreateUserSigRequest, CreateCCCSkillGroupRequest, DescribeIMCdrsRequest, DescribeAutoCalloutTaskResponse, DescribeStaffStatusMetricsRequest, DescribeAutoCalloutTaskRequest, CreateUserSigResponse, ModifyStaffRequest, DeleteStaffRequest, CreateCCCSkillGroupResponse, DescribeTelSessionRequest, DescribeCCCBuyInfoListRequest, DeleteStaffResponse, DescribeSkillGroupInfoListRequest, CreateStaffRequest, DescribeChatMessagesResponse, DescribePSTNActiveSessionListResponse, CreateCallOutSessionResponse, DescribeProtectedTelCdrResponse, DescribeAutoCalloutTasksRequest, DescribeChatMessagesRequest, DescribeTelSessionResponse, DescribeStaffInfoListRequest, ModifyStaffResponse, DescribeTelCdrResponse, DescribeStaffStatusMetricsResponse, DescribeTelCallInfoResponse, StopAutoCalloutTaskResponse, DescribeSeatUserListResponse, DescribeSeatUserListRequest, CreateCallOutSessionRequest, BindStaffSkillGroupListResponse, DescribeAutoCalloutTasksResponse, DescribeTelCdrRequest, DescribeProtectedTelCdrRequest, CreateSDKLoginTokenRequest, DescribeTelCallInfoRequest, DescribeCCCBuyInfoListResponse, UnbindStaffSkillGroupListResponse, DescribeCallInMetricsRequest, CreateStaffResponse, DescribeSkillGroupInfoListResponse, DescribeIMCdrsResponse } from "./ccc_models";
3
+ import { StopAutoCalloutTaskRequest, BindStaffSkillGroupListRequest, DescribePSTNActiveSessionListRequest, UnbindStaffSkillGroupListRequest, CreateAutoCalloutTaskRequest, CreateSDKLoginTokenResponse, DescribeCallInMetricsResponse, DescribeStaffInfoListResponse, CreateAutoCalloutTaskResponse, CreateUserSigRequest, CreateCCCSkillGroupRequest, DescribeIMCdrsRequest, DescribeAutoCalloutTaskResponse, DescribeStaffStatusMetricsRequest, DescribeAutoCalloutTaskRequest, CreateUserSigResponse, ModifyStaffRequest, DeleteStaffRequest, CreateCCCSkillGroupResponse, DescribeTelSessionRequest, DescribeCCCBuyInfoListRequest, DeleteStaffResponse, DescribeSkillGroupInfoListRequest, CreateStaffRequest, DescribeChatMessagesResponse, DescribePSTNActiveSessionListResponse, CreateCallOutSessionResponse, DescribeProtectedTelCdrResponse, DescribeAutoCalloutTasksRequest, DescribeChatMessagesRequest, DescribeTelSessionResponse, DescribeStaffInfoListRequest, ModifyStaffResponse, DescribeTelCdrResponse, DescribeStaffStatusMetricsResponse, DescribeTelCallInfoResponse, StopAutoCalloutTaskResponse, CreateCallOutSessionRequest, BindStaffSkillGroupListResponse, DescribeAutoCalloutTasksResponse, DescribeTelCdrRequest, DescribeProtectedTelCdrRequest, CreateSDKLoginTokenRequest, DescribeTelCallInfoRequest, DescribeCCCBuyInfoListResponse, UnbindStaffSkillGroupListResponse, DescribeCallInMetricsRequest, CreateStaffResponse, DescribeSkillGroupInfoListResponse, DescribeIMCdrsResponse } from "./ccc_models";
4
4
  /**
5
5
  * ccc client
6
6
  * @class
@@ -107,10 +107,4 @@ export declare class Client extends AbstractClient {
107
107
  * 创建 SDK 登录 Token。
108
108
  */
109
109
  CreateSDKLoginToken(req: CreateSDKLoginTokenRequest, cb?: (error: string, rep: CreateSDKLoginTokenResponse) => void): Promise<CreateSDKLoginTokenResponse>;
110
- /**
111
- * 废弃接口下架
112
-
113
- 获取坐席用户列表(废弃)
114
- */
115
- DescribeSeatUserList(req: DescribeSeatUserListRequest, cb?: (error: string, rep: DescribeSeatUserListResponse) => void): Promise<DescribeSeatUserListResponse>;
116
110
  }
@@ -177,13 +177,5 @@ class Client extends abstract_client_1.AbstractClient {
177
177
  async CreateSDKLoginToken(req, cb) {
178
178
  return this.request("CreateSDKLoginToken", req, cb);
179
179
  }
180
- /**
181
- * 废弃接口下架
182
-
183
- 获取坐席用户列表(废弃)
184
- */
185
- async DescribeSeatUserList(req, cb) {
186
- return this.request("DescribeSeatUserList", req, cb);
187
- }
188
180
  }
189
181
  exports.Client = Client;
@@ -636,6 +636,14 @@ export interface ModifyStaffRequest {
636
636
  * 绑定技能组ID列表
637
637
  */
638
638
  SkillGroupIds?: Array<number>;
639
+ /**
640
+ * 是否开启手机外呼开关
641
+ */
642
+ UseMobileCallOut?: boolean;
643
+ /**
644
+ * 手机接听模式 0 - 关闭 | 1 - 仅离线 | 2 - 始终
645
+ */
646
+ UseMobileAccept?: number;
639
647
  }
640
648
  /**
641
649
  * DeleteStaff请求参数结构体
@@ -802,6 +810,10 @@ export interface DescribeSkillGroupInfoListRequest {
802
810
  * 查询修改时间大于等于ModifiedTime的技能组时使用
803
811
  */
804
812
  ModifiedTime?: number;
813
+ /**
814
+ * 技能组名称
815
+ */
816
+ SkillGroupName?: string;
805
817
  }
806
818
  /**
807
819
  * CreateStaff请求参数结构体
@@ -1496,40 +1508,6 @@ export interface StopAutoCalloutTaskResponse {
1496
1508
  */
1497
1509
  RequestId?: string;
1498
1510
  }
1499
- /**
1500
- * DescribeSeatUserList返回参数结构体
1501
- */
1502
- export interface DescribeSeatUserListResponse {
1503
- /**
1504
- * 此实例的坐席用户总数
1505
- */
1506
- TotalCount: number;
1507
- /**
1508
- * 坐席用户信息列表
1509
- */
1510
- SeatUsers: Array<SeatUserInfo>;
1511
- /**
1512
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1513
- */
1514
- RequestId?: string;
1515
- }
1516
- /**
1517
- * DescribeSeatUserList请求参数结构体
1518
- */
1519
- export interface DescribeSeatUserListRequest {
1520
- /**
1521
- * 实例ID
1522
- */
1523
- InstanceId: number;
1524
- /**
1525
- * 偏移量
1526
- */
1527
- Offset: number;
1528
- /**
1529
- * 返回数量
1530
- */
1531
- Limit: number;
1532
- }
1533
1511
  /**
1534
1512
  * CreateCallOutSession请求参数结构体
1535
1513
  */
@@ -1611,6 +1589,14 @@ export interface StaffStatusMetrics {
1611
1589
  * 是否预约示忙
1612
1590
  */
1613
1591
  ReserveNotReady: boolean;
1592
+ /**
1593
+ * 手机接听模式: 0 - 关闭 | 1 - 仅离线 | 2- 始终
1594
+ */
1595
+ UseMobileAccept: number;
1596
+ /**
1597
+ * 手机外呼开关
1598
+ */
1599
+ UseMobileCallOut: boolean;
1614
1600
  }
1615
1601
  /**
1616
1602
  * BindStaffSkillGroupList返回参数结构体
@@ -833,11 +833,11 @@ export interface ModifyBlockIgnoreListRequest {
833
833
  */
834
834
  IocAction: string;
835
835
  /**
836
- * 时间格式:yyyy-MM-dd HH:mm:ss
836
+ * 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填
837
837
  */
838
838
  StartTime?: string;
839
839
  /**
840
- * 时间格式:yyyy-MM-dd HH:mm:ss
840
+ * 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填
841
841
  */
842
842
  EndTime?: string;
843
843
  }
@@ -6040,6 +6040,14 @@ export interface MySQLParam {
6040
6040
  * 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键
6041
6041
  */
6042
6042
  KeyColumns?: string;
6043
+ /**
6044
+ * Mysql 是否抛弃解析失败的消息,默认为true
6045
+ */
6046
+ DropInvalidMessage?: boolean;
6047
+ /**
6048
+ * 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
6049
+ */
6050
+ DropCls?: DropCls;
6043
6051
  }
6044
6052
  /**
6045
6053
  * DescribeTopicSyncReplica请求参数结构体
@@ -967,6 +967,10 @@ export interface ModifyConsumerRequest {
967
967
  * CKafka的描述
968
968
  */
969
969
  Ckafka?: Ckafka;
970
+ /**
971
+ * 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
972
+ */
973
+ Compression?: number;
970
974
  }
971
975
  /**
972
976
  * CreateIndex返回参数结构体
@@ -1893,6 +1897,11 @@ export interface DescribeConsumerResponse {
1893
1897
  * CKafka的描述
1894
1898
  */
1895
1899
  Ckafka: Ckafka;
1900
+ /**
1901
+ * 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
1902
+ 注意:此字段可能返回 null,表示取不到有效值。
1903
+ */
1904
+ Compression: number;
1896
1905
  /**
1897
1906
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1898
1907
  */
@@ -2783,6 +2792,10 @@ export interface CreateConsumerRequest {
2783
2792
  * CKafka的描述
2784
2793
  */
2785
2794
  Ckafka?: Ckafka;
2795
+ /**
2796
+ * 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4]
2797
+ */
2798
+ Compression?: number;
2786
2799
  }
2787
2800
  /**
2788
2801
  * 告警通知模板类型
@@ -3734,7 +3747,7 @@ export interface ConsumerContent {
3734
3747
  */
3735
3748
  EnableTag: boolean;
3736
3749
  /**
3737
- * 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_和\_\_TIMESTAMP\_\_
3750
+ * 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_,\_\_TIMESTAMP\_\_,\_\_HOSTNAME\_\_和\_\_PKGID\_\_
3738
3751
  注意:此字段可能返回 null,表示取不到有效值。
3739
3752
  */
3740
3753
  MetaFields: Array<string>;
@@ -1320,6 +1320,19 @@ export interface AddMerchantResult {
1320
1320
  */
1321
1321
  MerchantNo: string;
1322
1322
  }
1323
+ /**
1324
+ * 渠道方用户信息
1325
+ */
1326
+ export interface CloudExternalUserInfo {
1327
+ /**
1328
+ * 渠道方用户类型
1329
+ */
1330
+ ExternalUserType?: string;
1331
+ /**
1332
+ * 渠道方用户ID
1333
+ */
1334
+ ExternalUserId?: string;
1335
+ }
1323
1336
  /**
1324
1337
  * QueryOpenBankExternalSubMerchantRegistration请求参数结构体
1325
1338
  */
@@ -9618,6 +9631,10 @@ __test__:测试环境
9618
9631
  缺省默认为生产环境
9619
9632
  */
9620
9633
  Environment?: string;
9634
+ /**
9635
+ * 支付结果通知回调地址
9636
+ */
9637
+ NotifyUrl?: string;
9621
9638
  }
9622
9639
  /**
9623
9640
  * 第三方渠道数据信息
@@ -18347,6 +18364,10 @@ ORDER_RECEIVE_MODE_V_COMBINE - 虚拟合单支付
18347
18364
  若不传入该字段,则会根据是否传入子单来判断是 普通支付 还是 合单支付
18348
18365
  */
18349
18366
  OrderReceiveMode?: string;
18367
+ /**
18368
+ * 渠道方用户信息列表
18369
+ */
18370
+ ExternalUserInfoList?: Array<CloudExternalUserInfo>;
18350
18371
  }
18351
18372
  /**
18352
18373
  * UploadOpenBankSubMerchantCredential请求参数结构体
@@ -1,12 +1,17 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
3
+ import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
7
7
  */
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
+ /**
11
+ * 查询文件下载URL
12
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
13
+ */
14
+ DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
10
15
  /**
11
16
  * 此接口用于发起流程
12
17
  适用场景:见创建签署流程接口。
@@ -14,11 +19,13 @@ export declare class Client extends AbstractClient {
14
19
  */
15
20
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
16
21
  /**
17
- * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
18
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
19
- 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
22
+ * 提交企业签署流程审批结果
23
+ 适用场景:
24
+ 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
25
+ 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
26
+
20
27
  */
21
- CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
28
+ CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
22
29
  /**
23
30
  * 用于撤销签署流程
24
31
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
@@ -32,10 +39,11 @@ export declare class Client extends AbstractClient {
32
39
  */
33
40
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
34
41
  /**
35
- * 查询文件下载URL
36
- 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
42
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
43
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
44
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
37
45
  */
38
- DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
46
+ CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
39
47
  /**
40
48
  * 通过AuthCode查询用户是否实名
41
49
  */
@@ -85,6 +93,7 @@ export declare class Client extends AbstractClient {
85
93
  /**
86
94
  * 查询流程摘要
87
95
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
96
+ 日调用量默认10W
88
97
  */
89
98
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
90
99
  /**
@@ -27,6 +27,13 @@ class Client extends abstract_client_1.AbstractClient {
27
27
  constructor(clientConfig) {
28
28
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
29
29
  }
30
+ /**
31
+ * 查询文件下载URL
32
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
33
+ */
34
+ async DescribeFileUrls(req, cb) {
35
+ return this.request("DescribeFileUrls", req, cb);
36
+ }
30
37
  /**
31
38
  * 此接口用于发起流程
32
39
  适用场景:见创建签署流程接口。
@@ -36,12 +43,14 @@ class Client extends abstract_client_1.AbstractClient {
36
43
  return this.request("StartFlow", req, cb);
37
44
  }
38
45
  /**
39
- * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
40
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
41
- 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
46
+ * 提交企业签署流程审批结果
47
+ 适用场景:
48
+ 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
49
+ 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
50
+
42
51
  */
43
- async CreateMultiFlowSignQRCode(req, cb) {
44
- return this.request("CreateMultiFlowSignQRCode", req, cb);
52
+ async CreateFlowSignReview(req, cb) {
53
+ return this.request("CreateFlowSignReview", req, cb);
45
54
  }
46
55
  /**
47
56
  * 用于撤销签署流程
@@ -60,11 +69,12 @@ class Client extends abstract_client_1.AbstractClient {
60
69
  return this.request("CreateDocument", req, cb);
61
70
  }
62
71
  /**
63
- * 查询文件下载URL
64
- 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
72
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
73
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
74
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
65
75
  */
66
- async DescribeFileUrls(req, cb) {
67
- return this.request("DescribeFileUrls", req, cb);
76
+ async CreateMultiFlowSignQRCode(req, cb) {
77
+ return this.request("CreateMultiFlowSignQRCode", req, cb);
68
78
  }
69
79
  /**
70
80
  * 通过AuthCode查询用户是否实名
@@ -131,6 +141,7 @@ class Client extends abstract_client_1.AbstractClient {
131
141
  /**
132
142
  * 查询流程摘要
133
143
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
144
+ 日调用量默认10W
134
145
  */
135
146
  async DescribeFlowBriefs(req, cb) {
136
147
  return this.request("DescribeFlowBriefs", req, cb);
@@ -205,7 +205,7 @@ export interface CreateFlowRequest {
205
205
  */
206
206
  FlowName: string;
207
207
  /**
208
- * 签署流程参与者信息
208
+ * 签署流程参与者信息,最大限制50方
209
209
  */
210
210
  Approvers: Array<FlowCreateApprover>;
211
211
  /**
@@ -244,6 +244,13 @@ false:有序签
244
244
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
245
245
  */
246
246
  CustomShowMap?: string;
247
+ /**
248
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
249
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
250
+
251
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
252
+ */
253
+ NeedSignReview?: boolean;
247
254
  /**
248
255
  * 暂未开放
249
256
  */
@@ -320,6 +327,19 @@ export interface DescribeThirdPartyAuthCodeRequest {
320
327
  */
321
328
  AuthCode: string;
322
329
  }
330
+ /**
331
+ * 查询过滤条件
332
+ */
333
+ export interface Filter {
334
+ /**
335
+ * 查询过滤条件的Key
336
+ */
337
+ Key: string;
338
+ /**
339
+ * 查询过滤条件的Value列表
340
+ */
341
+ Values: Array<string>;
342
+ }
323
343
  /**
324
344
  * 一码多扫签署二维码对象
325
345
  */
@@ -342,21 +362,21 @@ export interface SignQrCode {
342
362
  */
343
363
  export interface GetTaskResultApiRequest {
344
364
  /**
345
- * 任务Id
365
+ * 任务Id,通过CreateConvertTaskApi得到
346
366
  */
347
367
  TaskId: string;
348
- /**
349
- * 企业信息
350
- */
351
- Organization?: OrganizationInfo;
352
368
  /**
353
369
  * 操作人信息
354
370
  */
355
371
  Operator?: UserInfo;
356
372
  /**
357
- * 渠道信息
373
+ * 应用号信息
358
374
  */
359
375
  Agent?: Agent;
376
+ /**
377
+ * 暂未开放
378
+ */
379
+ Organization?: OrganizationInfo;
360
380
  }
361
381
  /**
362
382
  * UploadFiles请求参数结构体
@@ -364,8 +384,8 @@ export interface GetTaskResultApiRequest {
364
384
  export interface UploadFilesRequest {
365
385
  /**
366
386
  * 文件对应业务类型,用于区分文件存储路径:
367
- 1. TEMPLATE - 模板; 文件类型:.pdf/.html
368
- 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
387
+ 1. TEMPLATE - 模板; 文件类型:.pdf .doc .docx .html
388
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
369
389
  3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
370
390
  */
371
391
  BusinessType: string;
@@ -701,7 +721,7 @@ export interface DescribeFlowBriefsRequest {
701
721
  */
702
722
  Operator: UserInfo;
703
723
  /**
704
- * 需要查询的流程ID列表
724
+ * 需要查询的流程ID列表,限制最大20个
705
725
  */
706
726
  FlowIds: Array<string>;
707
727
  /**
@@ -918,6 +938,15 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
918
938
  */
919
939
  PreReadTime?: number;
920
940
  }
941
+ /**
942
+ * CreateFlowSignReview返回参数结构体
943
+ */
944
+ export interface CreateFlowSignReviewResponse {
945
+ /**
946
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
947
+ */
948
+ RequestId?: string;
949
+ }
921
950
  /**
922
951
  * 此结构体 (Caller) 用于描述调用方属性。
923
952
  */
@@ -1082,46 +1111,61 @@ export interface CreateConvertTaskApiResponse {
1082
1111
  RequestId?: string;
1083
1112
  }
1084
1113
  /**
1085
- * 查询过滤条件
1114
+ * CreateFlowSignReview请求参数结构体
1086
1115
  */
1087
- export interface Filter {
1116
+ export interface CreateFlowSignReviewRequest {
1088
1117
  /**
1089
- * 查询过滤条件的Key
1118
+ * 调用方用户信息,userId 必填
1090
1119
  */
1091
- Key: string;
1120
+ Operator: UserInfo;
1092
1121
  /**
1093
- * 查询过滤条件的Value列表
1122
+ * 签署流程编号
1094
1123
  */
1095
- Values: Array<string>;
1124
+ FlowId: string;
1125
+ /**
1126
+ * 企业内部审核结果
1127
+ PASS: 通过
1128
+ REJECT: 拒绝
1129
+ */
1130
+ ReviewType: string;
1131
+ /**
1132
+ * 审核原因
1133
+ 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
1134
+ */
1135
+ ReviewMessage?: string;
1136
+ /**
1137
+ * 应用相关信息
1138
+ */
1139
+ Agent?: Agent;
1096
1140
  }
1097
1141
  /**
1098
1142
  * CreateConvertTaskApi请求参数结构体
1099
1143
  */
1100
1144
  export interface CreateConvertTaskApiRequest {
1101
- /**
1102
- * 资源Id
1103
- */
1104
- ResourceId: string;
1105
1145
  /**
1106
1146
  * 资源类型 取值范围doc,docx,html之一
1107
1147
  */
1108
1148
  ResourceType: string;
1109
1149
  /**
1110
- * 资源名称
1150
+ * 资源名称,长度限制为256字符
1111
1151
  */
1112
1152
  ResourceName: string;
1113
1153
  /**
1114
- *
1154
+ * 资源Id,通过UploadFiles获取
1115
1155
  */
1116
- Organization?: OrganizationInfo;
1156
+ ResourceId: string;
1117
1157
  /**
1118
- *
1158
+ * 操作者信息
1119
1159
  */
1120
1160
  Operator?: UserInfo;
1121
1161
  /**
1122
- *
1162
+ * 应用号信息
1123
1163
  */
1124
1164
  Agent?: Agent;
1165
+ /**
1166
+ * 暂未开放
1167
+ */
1168
+ Organization?: OrganizationInfo;
1125
1169
  }
1126
1170
  /**
1127
1171
  * CreateSchemeUrl返回参数结构体
@@ -1149,7 +1193,7 @@ export interface CreateFlowByFilesRequest {
1149
1193
  */
1150
1194
  FlowName: string;
1151
1195
  /**
1152
- * 签署参与者信息
1196
+ * 签署参与者信息,最大限制50方
1153
1197
  */
1154
1198
  Approvers: Array<ApproverInfo>;
1155
1199
  /**
@@ -1194,6 +1238,13 @@ false:有序签
1194
1238
  * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1195
1239
  */
1196
1240
  CustomShowMap?: string;
1241
+ /**
1242
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。
1243
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1244
+
1245
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1246
+ */
1247
+ NeedSignReview?: boolean;
1197
1248
  /**
1198
1249
  * 应用号信息
1199
1250
  */
@@ -1282,7 +1333,7 @@ export interface DescribeFlowTemplatesRequest {
1282
1333
  */
1283
1334
  Filters?: Array<Filter>;
1284
1335
  /**
1285
- * 查询个数,默认20,最大100
1336
+ * 查询个数,默认20,最大200
1286
1337
  */
1287
1338
  Limit?: number;
1288
1339
  /**
@@ -1311,15 +1362,27 @@ export interface GetTaskResultApiResponse {
1311
1362
  */
1312
1363
  TaskId: string;
1313
1364
  /**
1314
- * 任务状态
1365
+ * 任务状态,需要关注的状态
1366
+ 0 :NeedTranform - 任务已提交
1367
+ 4 :Processing - 文档转换中
1368
+ 8 :TaskEnd - 任务处理完成
1369
+ -2 :DownloadFailed - 下载失败
1370
+ -6 :ProcessFailed - 转换失败
1371
+ -13:ProcessTimeout - 转换文件超时
1315
1372
  */
1316
1373
  TaskStatus: number;
1317
1374
  /**
1318
- * 状态描述
1375
+ * 状态描述,需要关注的状态
1376
+ NeedTranform - 任务已提交
1377
+ Processing - 文档转换中
1378
+ TaskEnd - 任务处理完成
1379
+ DownloadFailed - 下载失败
1380
+ ProcessFailed - 转换失败
1381
+ ProcessTimeout - 转换文件超时
1319
1382
  */
1320
1383
  TaskMessage: string;
1321
1384
  /**
1322
- * 资源Id
1385
+ * 资源Id,也是FileId,用于文件发起使用
1323
1386
  */
1324
1387
  ResourceId: string;
1325
1388
  /**