tencentcloud-sdk-nodejs 4.0.1009 → 4.0.1011

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 (97) hide show
  1. package/CHANGELOG.md +332 -0
  2. package/SERVICE_CHANGELOG.md +298 -431
  3. package/package.json +1 -1
  4. package/products.md +30 -30
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_client.ts +52 -19
  7. package/src/services/aiart/v20221229/aiart_models.ts +145 -32
  8. package/src/services/batch/v20170312/batch_models.ts +1 -1
  9. package/src/services/cdb/v20170320/cdb_models.ts +10 -0
  10. package/src/services/cmq/v20190304/cmq_client.ts +6 -208
  11. package/src/services/cmq/v20190304/cmq_models.ts +89 -710
  12. package/src/services/config/v20220802/config_client.ts +54 -29
  13. package/src/services/config/v20220802/config_models.ts +410 -218
  14. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  15. package/src/services/dc/v20180410/dc_client.ts +1 -1
  16. package/src/services/dc/v20180410/dc_models.ts +16 -25
  17. package/src/services/ecm/v20190719/ecm_models.ts +13 -22
  18. package/src/services/es/v20180416/es_models.ts +5 -0
  19. package/src/services/ess/v20201111/ess_client.ts +25 -4
  20. package/src/services/ess/v20201111/ess_models.ts +4 -24
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +4 -9
  22. package/src/services/hai/v20230812/hai_client.ts +17 -4
  23. package/src/services/hai/v20230812/hai_models.ts +136 -47
  24. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +70 -14
  25. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +286 -12
  26. package/src/services/iotvideo/v20211125/iotvideo_client.ts +13 -0
  27. package/src/services/iotvideo/v20211125/iotvideo_models.ts +41 -0
  28. package/src/services/lkeap/v20240522/lkeap_client.ts +1 -1
  29. package/src/services/lkeap/v20240522/lkeap_models.ts +27 -8
  30. package/src/services/mna/v20210119/mna_models.ts +0 -11
  31. package/src/services/redis/v20180412/redis_models.ts +97 -95
  32. package/src/services/sms/v20190711/sms_models.ts +23 -0
  33. package/src/services/sms/v20210111/sms_models.ts +23 -0
  34. package/src/services/tcb/v20180608/tcb_client.ts +2 -3
  35. package/src/services/tcb/v20180608/tcb_models.ts +3 -45
  36. package/src/services/tcr/v20190924/tcr_models.ts +3 -3
  37. package/src/services/tke/v20220501/tke_models.ts +1 -1
  38. package/src/services/trro/v20220325/trro_models.ts +4 -29
  39. package/src/services/trtc/v20190722/trtc_models.ts +54 -54
  40. package/src/services/tse/v20201207/tse_models.ts +8 -0
  41. package/src/services/vpc/v20170312/vpc_models.ts +3 -10
  42. package/src/services/wedata/v20210820/wedata_models.ts +35 -0
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +29 -12
  46. package/tencentcloud/services/aiart/v20221229/aiart_client.js +34 -13
  47. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +141 -32
  48. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +1 -1
  49. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +10 -0
  50. package/tencentcloud/services/cmq/v20190304/cmq_client.d.ts +1 -82
  51. package/tencentcloud/services/cmq/v20190304/cmq_client.js +0 -111
  52. package/tencentcloud/services/cmq/v20190304/cmq_models.d.ts +89 -679
  53. package/tencentcloud/services/config/v20220802/config_client.d.ts +15 -7
  54. package/tencentcloud/services/config/v20220802/config_client.js +21 -9
  55. package/tencentcloud/services/config/v20220802/config_models.d.ts +395 -208
  56. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  57. package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
  58. package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
  59. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +16 -25
  60. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +13 -22
  61. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
  62. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +25 -4
  63. package/tencentcloud/services/ess/v20201111/ess_client.js +25 -4
  64. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -24
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -9
  66. package/tencentcloud/services/hai/v20230812/hai_client.d.ts +5 -1
  67. package/tencentcloud/services/hai/v20230812/hai_client.js +6 -0
  68. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +133 -47
  69. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +21 -5
  70. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +30 -6
  71. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +270 -12
  72. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +5 -1
  73. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +6 -0
  74. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +38 -0
  75. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +1 -1
  76. package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +1 -1
  77. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +27 -8
  78. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +0 -11
  79. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +97 -95
  80. package/tencentcloud/services/sms/v20190711/sms_models.d.ts +23 -0
  81. package/tencentcloud/services/sms/v20210111/sms_models.d.ts +23 -0
  82. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +0 -1
  83. package/tencentcloud/services/tcb/v20180608/tcb_client.js +0 -1
  84. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +3 -45
  85. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +3 -3
  86. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +1 -1
  87. package/tencentcloud/services/trro/v20220325/trro_models.d.ts +4 -29
  88. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +54 -54
  89. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +8 -0
  90. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +1 -8
  91. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +35 -0
  92. package/test/aiart.v20221229.test.js +24 -4
  93. package/test/cmq.v20190304.test.js +0 -150
  94. package/test/config.v20220802.test.js +26 -6
  95. package/test/hai.v20230812.test.js +10 -0
  96. package/test/iotexplorer.v20190423.test.js +44 -4
  97. package/test/iotvideo.v20211125.test.js +10 -0
@@ -91,7 +91,7 @@ class Client extends abstract_client_1.AbstractClient {
91
91
  return this.request("DisableInternetAddress", req, cb);
92
92
  }
93
93
  /**
94
- * 本接口(DescribePublicDirectConnectTunnelRoutes)用于查询互联网通道路由列表
94
+ * 查询互联网通道路由列表。
95
95
  */
96
96
  async DescribePublicDirectConnectTunnelRoutes(req, cb) {
97
97
  return this.request("DescribePublicDirectConnectTunnelRoutes", req, cb);
@@ -26,36 +26,35 @@ export interface DirectConnectTunnelRoute {
26
26
  /**
27
27
  * 专用通道路由ID
28
28
  */
29
- RouteId: string;
29
+ RouteId?: string;
30
30
  /**
31
31
  * 网段CIDR
32
32
  */
33
- DestinationCidrBlock: string;
33
+ DestinationCidrBlock?: string;
34
34
  /**
35
35
  * 路由类型:BGP/STATIC路由
36
36
  */
37
- RouteType: string;
37
+ RouteType?: string;
38
38
  /**
39
39
  * ENABLE:路由启用,DISABLE:路由禁用
40
40
  */
41
- Status: string;
41
+ Status?: string;
42
42
  /**
43
43
  * ASPath信息
44
44
  */
45
- ASPath: Array<string>;
45
+ ASPath?: Array<string>;
46
46
  /**
47
47
  * 路由下一跳IP
48
48
  */
49
- NextHop: string;
49
+ NextHop?: string;
50
50
  /**
51
51
  * 路由更新时间
52
- 注意:此字段可能返回 null,表示取不到有效值。
53
52
  */
54
- UpdateTime: string;
53
+ UpdateTime?: string;
55
54
  /**
56
55
  * 是否配置在通道上
57
56
  */
58
- ApplyOnTunnelEnable: boolean;
57
+ ApplyOnTunnelEnable?: boolean;
59
58
  }
60
59
  /**
61
60
  * RejectDirectConnectTunnel请求参数结构体
@@ -119,21 +118,21 @@ export interface DescribeDirectConnectTunnelExtraRequest {
119
118
  */
120
119
  export interface DescribePublicDirectConnectTunnelRoutesRequest {
121
120
  /**
122
- * 专用通道ID
121
+ * 专用通道ID
123
122
  */
124
123
  DirectConnectTunnelId: string;
125
124
  /**
126
125
  * 过滤条件:
127
- route-type:路由类型,取值:BGP/STATIC
128
- route-subnet:路由cidr,取值如:192.68.1.0/24
126
+ route-type:路由类型,取值:BGP/STATIC
127
+ route-subnet:路由cidr,取值如:192.68.1.0/24
129
128
  */
130
129
  Filters?: Array<Filter>;
131
130
  /**
132
- * 偏移量,默认为0
131
+ * 偏移量,默认为0
133
132
  */
134
133
  Offset?: number;
135
134
  /**
136
- * 返回数量,默认为20,最大值为100
135
+ * 返回数量,默认为20,最大值为100
137
136
  */
138
137
  Limit?: number;
139
138
  }
@@ -478,9 +477,8 @@ export interface AccessPoint {
478
477
  export interface ApplyInternetAddressResponse {
479
478
  /**
480
479
  * 互联网公网地址ID
481
- 注意:此字段可能返回 null,表示取不到有效值。
482
480
  */
483
- InstanceId: string;
481
+ InstanceId?: string;
484
482
  /**
485
483
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
486
484
  */
@@ -849,7 +847,6 @@ export interface DescribeDirectConnectsResponse {
849
847
  TotalCount?: number;
850
848
  /**
851
849
  * 用户名下物理专线是否都签署了用户协议。
852
- 注意:此字段可能返回 null,表示取不到有效值。
853
850
  */
854
851
  AllSignLaw?: boolean;
855
852
  /**
@@ -1470,7 +1467,6 @@ export interface DescribeInternetAddressStatisticsResponse {
1470
1467
  TotalCount?: number;
1471
1468
  /**
1472
1469
  * 互联网公网地址统计信息列表
1473
- 注意:此字段可能返回 null,表示取不到有效值。
1474
1470
  */
1475
1471
  InternetAddressStatistics?: Array<InternetAddressStatistics>;
1476
1472
  /**
@@ -1522,11 +1518,11 @@ export interface DescribeInternetAddressRequest {
1522
1518
  */
1523
1519
  export interface DescribePublicDirectConnectTunnelRoutesResponse {
1524
1520
  /**
1525
- * 互联网通道路由列表
1521
+ * 互联网通道路由列表。
1526
1522
  */
1527
1523
  Routes?: Array<DirectConnectTunnelRoute>;
1528
1524
  /**
1529
- * 记录总数
1525
+ * 路由总数量。
1530
1526
  */
1531
1527
  TotalCount?: number;
1532
1528
  /**
@@ -1540,27 +1536,22 @@ export interface DescribePublicDirectConnectTunnelRoutesResponse {
1540
1536
  export interface DescribeInternetAddressQuotaResponse {
1541
1537
  /**
1542
1538
  * IPv6互联网公网允许的最小前缀长度
1543
- 注意:此字段可能返回 null,表示取不到有效值。
1544
1539
  */
1545
1540
  Ipv6PrefixLen?: number;
1546
1541
  /**
1547
1542
  * BGP类型IPv4互联网地址配额
1548
- 注意:此字段可能返回 null,表示取不到有效值。
1549
1543
  */
1550
1544
  Ipv4BgpQuota?: number;
1551
1545
  /**
1552
1546
  * 非BGP类型IPv4互联网地址配额
1553
- 注意:此字段可能返回 null,表示取不到有效值。
1554
1547
  */
1555
1548
  Ipv4OtherQuota?: number;
1556
1549
  /**
1557
1550
  * BGP类型IPv4互联网地址已使用数量
1558
- 注意:此字段可能返回 null,表示取不到有效值。
1559
1551
  */
1560
1552
  Ipv4BgpNum?: number;
1561
1553
  /**
1562
1554
  * 非BGP类型互联网地址已使用数量
1563
- 注意:此字段可能返回 null,表示取不到有效值。
1564
1555
  */
1565
1556
  Ipv4OtherNum?: number;
1566
1557
  /**
@@ -737,12 +737,11 @@ export interface DescribeRouteTablesResponse {
737
737
  /**
738
738
  * 符合条件的实例数量
739
739
  */
740
- TotalCount: number;
740
+ TotalCount?: number;
741
741
  /**
742
742
  * 路由表列表
743
- 注意:此字段可能返回 null,表示取不到有效值。
744
743
  */
745
- RouteTableSet: Array<RouteTable>;
744
+ RouteTableSet?: Array<RouteTable>;
746
745
  /**
747
746
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
748
747
  */
@@ -1721,7 +1720,6 @@ export interface DescribeVpcsResponse {
1721
1720
  TotalCount?: number;
1722
1721
  /**
1723
1722
  * 私有网络对象。
1724
- 注意:此字段可能返回 null,表示取不到有效值。
1725
1723
  */
1726
1724
  VpcSet?: Array<VpcInfo>;
1727
1725
  /**
@@ -2206,7 +2204,6 @@ export interface SecurityGroupPolicy {
2206
2204
  PolicyDescription?: string;
2207
2205
  /**
2208
2206
  * 修改时间,例如 2020-07-22 19:27:23
2209
- 注意:此字段可能返回 null,表示取不到有效值。
2210
2207
  */
2211
2208
  ModifyTime?: string;
2212
2209
  /**
@@ -2678,12 +2675,10 @@ export interface ModifyLoadBalancerAttributesResponse {
2678
2675
  export interface Tag {
2679
2676
  /**
2680
2677
  * 标签健。
2681
- 注意:此字段可能返回 null,表示取不到有效值。
2682
2678
  */
2683
2679
  Key: string;
2684
2680
  /**
2685
2681
  * 标签值。
2686
- 注意:此字段可能返回 null,表示取不到有效值。
2687
2682
  */
2688
2683
  Value: string;
2689
2684
  }
@@ -3975,49 +3970,49 @@ export interface HaVip {
3975
3970
  /**
3976
3971
  * HAVIP的ID,是HAVIP的唯一标识。
3977
3972
  */
3978
- HaVipId: string;
3973
+ HaVipId?: string;
3979
3974
  /**
3980
3975
  * HAVIP名称。
3981
3976
  */
3982
- HaVipName: string;
3977
+ HaVipName?: string;
3983
3978
  /**
3984
3979
  * 虚拟IP地址。
3985
3980
  */
3986
- Vip: string;
3981
+ Vip?: string;
3987
3982
  /**
3988
3983
  * HAVIP所在私有网络ID。
3989
3984
  */
3990
- VpcId: string;
3985
+ VpcId?: string;
3991
3986
  /**
3992
3987
  * HAVIP所在子网ID。
3993
3988
  */
3994
- SubnetId: string;
3989
+ SubnetId?: string;
3995
3990
  /**
3996
3991
  * HAVIP关联弹性网卡ID。
3997
3992
  */
3998
- NetworkInterfaceId: string;
3993
+ NetworkInterfaceId?: string;
3999
3994
  /**
4000
3995
  * 被绑定的实例ID。
4001
3996
  */
4002
- InstanceId: string;
3997
+ InstanceId?: string;
4003
3998
  /**
4004
3999
  * 绑定EIP。
4005
4000
  */
4006
- AddressIp: string;
4001
+ AddressIp?: string;
4007
4002
  /**
4008
4003
  * 状态:
4009
4004
  AVAILABLE:运行中。
4010
4005
  UNBIND:未绑定。
4011
4006
  */
4012
- State: string;
4007
+ State?: string;
4013
4008
  /**
4014
4009
  * 创建时间。
4015
4010
  */
4016
- CreatedTime: string;
4011
+ CreatedTime?: string;
4017
4012
  /**
4018
4013
  * 使用havip的业务标识。
4019
4014
  */
4020
- Business: string;
4015
+ Business?: string;
4021
4016
  }
4022
4017
  /**
4023
4018
  * ModifyAddressesBandwidth返回参数结构体
@@ -4773,7 +4768,6 @@ export interface PrivateIpAddressSpecification {
4773
4768
  PrivateIpAddress: string;
4774
4769
  /**
4775
4770
  * 是否是主IP。
4776
- 注意:此字段可能返回 null,表示取不到有效值。
4777
4771
  */
4778
4772
  Primary?: boolean;
4779
4773
  /**
@@ -4790,7 +4784,6 @@ export interface PrivateIpAddressSpecification {
4790
4784
  Description?: string;
4791
4785
  /**
4792
4786
  * 公网IP是否被封堵。
4793
- 注意:此字段可能返回 null,表示取不到有效值。
4794
4787
  */
4795
4788
  IsWanIpBlocked?: boolean;
4796
4789
  /**
@@ -5891,7 +5884,6 @@ export interface DescribeSubnetsResponse {
5891
5884
  TotalCount?: number;
5892
5885
  /**
5893
5886
  * 子网对象。
5894
- 注意:此字段可能返回 null,表示取不到有效值。
5895
5887
  */
5896
5888
  SubnetSet?: Array<Subnet>;
5897
5889
  /**
@@ -7407,7 +7399,6 @@ export interface DescribeNetworkInterfacesResponse {
7407
7399
  TotalCount?: number;
7408
7400
  /**
7409
7401
  * 实例详细信息列表。
7410
- 注意:此字段可能返回 null,表示取不到有效值。
7411
7402
  */
7412
7403
  NetworkInterfaceSet?: Array<NetworkInterface>;
7413
7404
  /**
@@ -591,6 +591,11 @@ export interface IndexMetaField {
591
591
  注意:此字段可能返回 null,表示取不到有效值。
592
592
  */
593
593
  IndexSettingsField?: IndexSettingsField;
594
+ /**
595
+ * 索引别名字段
596
+ 注意:此字段可能返回 null,表示取不到有效值。
597
+ */
598
+ IndexAliasesField?: Array<string>;
594
599
  /**
595
600
  * 索引所属集群APP ID
596
601
  注意:此字段可能返回 null,表示取不到有效值。
@@ -144,7 +144,9 @@ export declare class Client extends AbstractClient {
144
144
 
145
145
 
146
146
  ### 填充模板中定义的填写控件
147
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
147
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
148
+
149
+ **<font color="red">填充填写控件需要进行Pdf合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
148
150
 
149
151
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
150
152
 
@@ -899,12 +901,31 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
899
901
  */
900
902
  CreateIntegrationSubOrganizationActiveRecord(req: CreateIntegrationSubOrganizationActiveRecordRequest, cb?: (error: string, rep: CreateIntegrationSubOrganizationActiveRecordResponse) => void): Promise<CreateIntegrationSubOrganizationActiveRecordResponse>;
901
903
  /**
902
- * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
903
-
904
+ * 您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
904
905
 
905
- 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
906
+ 无论是发起方还是签署方填写的控件,均包含在查询结果中。
906
907
 
907
908
  ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
909
+
910
+
911
+ ### 2. 那些控件会出现在结果里边?
912
+ **A.不返回的控件类型:**
913
+ - 动态表格
914
+ - 附件控件
915
+ - 水印控件
916
+
917
+ **B.返回的控件类型:**
918
+ - 单行文本
919
+ - 多行文本
920
+ - 勾选框控件
921
+ - 数字控件
922
+ - 日期控件
923
+ - 图片控件(图片下载地址)
924
+ - 邮箱控件
925
+ - 地址控件
926
+ - 学历控件
927
+ - 性别控件
928
+ - 省市区控件
908
929
  */
909
930
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
910
931
  /**
@@ -182,7 +182,9 @@ class Client extends abstract_client_1.AbstractClient {
182
182
 
183
183
 
184
184
  ### 填充模板中定义的填写控件
185
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
185
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
186
+
187
+ **<font color="red">填充填写控件需要进行Pdf合成工作,文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
186
188
 
187
189
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
188
190
 
@@ -1055,12 +1057,31 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1055
1057
  return this.request("CreateIntegrationSubOrganizationActiveRecord", req, cb);
1056
1058
  }
1057
1059
  /**
1058
- * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
1059
-
1060
+ * 您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
1060
1061
 
1061
- 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
1062
+ 无论是发起方还是签署方填写的控件,均包含在查询结果中。
1062
1063
 
1063
1064
  ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
1065
+
1066
+
1067
+ ### 2. 那些控件会出现在结果里边?
1068
+ **A.不返回的控件类型:**
1069
+ - 动态表格
1070
+ - 附件控件
1071
+ - 水印控件
1072
+
1073
+ **B.返回的控件类型:**
1074
+ - 单行文本
1075
+ - 多行文本
1076
+ - 勾选框控件
1077
+ - 数字控件
1078
+ - 日期控件
1079
+ - 图片控件(图片下载地址)
1080
+ - 邮箱控件
1081
+ - 地址控件
1082
+ - 学历控件
1083
+ - 性别控件
1084
+ - 省市区控件
1064
1085
  */
1065
1086
  async DescribeFlowComponents(req, cb) {
1066
1087
  return this.request("DescribeFlowComponents", req, cb);
@@ -518,7 +518,6 @@ export interface CreateFlowApproversResponse {
518
518
  * 批量补充签署人时,补充失败的报错说明
519
519
 
520
520
  注:`目前仅补充动态签署人时会返回补充失败的原因`
521
- 注意:此字段可能返回 null,表示取不到有效值。
522
521
  */
523
522
  FillError?: Array<FillError>;
524
523
  /**
@@ -2064,7 +2063,6 @@ export interface CreateFlowGroupByFilesRequest {
2064
2063
  export interface DescribeFlowComponentsResponse {
2065
2064
  /**
2066
2065
  * 合同流程关联的填写控件信息,包括填写控件的归属方以及是否填写等内容。
2067
- 注意:此字段可能返回 null,表示取不到有效值。
2068
2066
  */
2069
2067
  RecipientComponentInfos?: Array<RecipientComponentInfo>;
2070
2068
  /**
@@ -2078,7 +2076,6 @@ export interface DescribeFlowComponentsResponse {
2078
2076
  export interface DescribeFlowEvidenceReportResponse {
2079
2077
  /**
2080
2078
  * 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
2081
- 注意:此字段可能返回 null,表示取不到有效值。
2082
2079
  */
2083
2080
  ReportUrl?: string;
2084
2081
  /**
@@ -2166,12 +2163,10 @@ export interface CreateEmployeeQualificationSealQrCodeResponse {
2166
2163
  export interface CreateFlowGroupByTemplatesResponse {
2167
2164
  /**
2168
2165
  * 合同(流程)组的合同组Id
2169
- 注意:此字段可能返回 null,表示取不到有效值。
2170
2166
  */
2171
2167
  FlowGroupId?: string;
2172
2168
  /**
2173
2169
  * 合同(流程)组中子合同列表.
2174
- 注意:此字段可能返回 null,表示取不到有效值。
2175
2170
  */
2176
2171
  FlowIds?: Array<string>;
2177
2172
  /**
@@ -2453,13 +2448,11 @@ export interface CreateDocumentResponse {
2453
2448
  * 合同预览链接URL。
2454
2449
 
2455
2450
  注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
2456
- `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
2457
- 注意:此字段可能返回 null,表示取不到有效值。
2451
+ `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,完整的预览链接需通过[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取。
2458
2452
  */
2459
2453
  PreviewFileUrl?: string;
2460
2454
  /**
2461
2455
  * 签署方信息,如角色ID、角色名称等
2462
- 注意:此字段可能返回 null,表示取不到有效值。
2463
2456
  */
2464
2457
  Approvers?: Array<ApproverItem>;
2465
2458
  /**
@@ -2499,7 +2492,7 @@ export interface DescribeIntegrationEmployeesRequest {
2499
2492
  */
2500
2493
  Filters?: Array<Filter>;
2501
2494
  /**
2502
- * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
2495
+ * 偏移量,默认为0,最大20000。。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688" target="_blank">简介</a>中的相关小节。
2503
2496
  */
2504
2497
  Offset?: number;
2505
2498
  }
@@ -3685,24 +3678,20 @@ export interface CreatePersonAuthCertificateImageResponse {
3685
3678
  该编号会合成到个人用户证书证明图片。
3686
3679
 
3687
3680
  注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
3688
- 注意:此字段可能返回 null,表示取不到有效值。
3689
3681
  */
3690
3682
  ImageCertId?: string;
3691
3683
  /**
3692
3684
  * 在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。
3693
- 注意:此字段可能返回 null,表示取不到有效值。
3694
3685
  */
3695
3686
  SerialNumber?: string;
3696
3687
  /**
3697
3688
  * CA证书颁发时间,格式为Unix标准时间戳(秒)
3698
3689
  该时间格式化后会合成到个人用户证书证明图片
3699
- 注意:此字段可能返回 null,表示取不到有效值。
3700
3690
  */
3701
3691
  ValidFrom?: number;
3702
3692
  /**
3703
3693
  * CA证书有效截止时间,格式为Unix标准时间戳(秒)
3704
3694
  该时间格式化后会合成到个人用户证书证明图片
3705
- 注意:此字段可能返回 null,表示取不到有效值。
3706
3695
  */
3707
3696
  ValidTo?: number;
3708
3697
  /**
@@ -3980,12 +3969,10 @@ export interface DisableUserAutoSignRequest {
3980
3969
  export interface DescribeIntegrationEmployeesResponse {
3981
3970
  /**
3982
3971
  * 员工信息列表。
3983
- 注意:此字段可能返回 null,表示取不到有效值。
3984
3972
  */
3985
3973
  Employees?: Array<Staff>;
3986
3974
  /**
3987
- * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000。
3988
- 注意:此字段可能返回 null,表示取不到有效值。
3975
+ * 偏移量
3989
3976
  */
3990
3977
  Offset?: number;
3991
3978
  /**
@@ -5404,7 +5391,6 @@ export interface RecipientComponentInfo {
5404
5391
  export interface CreateFlowEvidenceReportResponse {
5405
5392
  /**
5406
5393
  * 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
5407
- 注意:此字段可能返回 null,表示取不到有效值。
5408
5394
  */
5409
5395
  ReportId?: string;
5410
5396
  /**
@@ -5961,8 +5947,7 @@ export interface FailedUpdateStaffData {
5961
5947
  */
5962
5948
  export interface GetTaskResultApiRequest {
5963
5949
  /**
5964
- * 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>或<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateMergeFileTask" target="_blank">创建多文件转换任务接口</a>
5965
- 得到的转换任务id
5950
+ * 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
5966
5951
  */
5967
5952
  TaskId: string;
5968
5953
  /**
@@ -6383,12 +6368,10 @@ export interface CreateFlowByFilesResponse {
6383
6368
  * 合同预览链接URL。
6384
6369
 
6385
6370
  注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
6386
- 注意:此字段可能返回 null,表示取不到有效值。
6387
6371
  */
6388
6372
  PreviewUrl?: string;
6389
6373
  /**
6390
6374
  * 签署方信息,如角色ID、角色名称等
6391
- 注意:此字段可能返回 null,表示取不到有效值。
6392
6375
  */
6393
6376
  Approvers?: Array<ApproverItem>;
6394
6377
  /**
@@ -6627,7 +6610,6 @@ export interface DescribeBillUsageResponse {
6627
6610
  Summary?: Array<OrgBillSummary>;
6628
6611
  /**
6629
6612
  * 集团子企业套餐使用情况
6630
- 注意:此字段可能返回 null,表示取不到有效值。
6631
6613
  */
6632
6614
  SubOrgSummary?: Array<SubOrgBillSummary>;
6633
6615
  /**
@@ -8844,12 +8826,10 @@ export interface CreateUserAutoSignEnableUrlResponse {
8844
8826
  export interface DescribeSignFaceVideoResponse {
8845
8827
  /**
8846
8828
  * 核身视频结果。
8847
- 注意:此字段可能返回 null,表示取不到有效值。
8848
8829
  */
8849
8830
  VideoData?: DetectInfoVideoData;
8850
8831
  /**
8851
8832
  * 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
8852
- 注意:此字段可能返回 null,表示取不到有效值。
8853
8833
  */
8854
8834
  IntentionQuestionResult?: IntentionQuestionResult;
8855
8835
  /**
@@ -4163,9 +4163,7 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
4163
4163
  */
4164
4164
  UrlType?: string;
4165
4165
  /**
4166
- * 是否通知开通方,通知类型:
4167
- <ul><li>默认不设置为不通知开通方</li>
4168
- <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
4166
+ * 是否通知开通方,通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
4169
4167
  */
4170
4168
  NotifyType?: string;
4171
4169
  /**
@@ -4987,7 +4985,6 @@ export interface ChannelCreateFlowApproversResponse {
4987
4985
  /**
4988
4986
  * 批量补充签署人时,补充失败的报错说明
4989
4987
  注:`目前仅补充动态签署人时会返回补充失败的原因`
4990
- 注意:此字段可能返回 null,表示取不到有效值。
4991
4988
  */
4992
4989
  FillError?: Array<FillError>;
4993
4990
  /**
@@ -5961,6 +5958,8 @@ export interface CreateFlowsByTemplatesResponse {
5961
5958
  * 合同预览链接URL数组。
5962
5959
 
5963
5960
  注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
5961
+ 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过[合同文档合成完成回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取或使用返回的TaskInfo中的TaskId通过[查询转换任务状态
5962
+ ](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi)接口查询得到
5964
5963
  */
5965
5964
  PreviewUrls?: Array<string>;
5966
5965
  /**
@@ -6567,7 +6566,7 @@ export interface ChannelOrganizationInfo {
6567
6566
  */
6568
6567
  ActiveStatus?: number;
6569
6568
  /**
6570
- * 账号过期时间,时间戳
6569
+ * 账号到期时间,时间戳
6571
6570
  */
6572
6571
  LicenseExpireTime?: number;
6573
6572
  }
@@ -6808,12 +6807,10 @@ export interface ChannelCreateFlowByFilesResponse {
6808
6807
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6809
6808
 
6810
6809
  [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
6811
- 注意:此字段可能返回 null,表示取不到有效值。
6812
6810
  */
6813
6811
  FlowId?: string;
6814
6812
  /**
6815
6813
  * 签署方信息,如角色ID、角色名称等
6816
- 注意:此字段可能返回 null,表示取不到有效值。
6817
6814
  */
6818
6815
  Approvers?: Array<ApproverItem>;
6819
6816
  /**
@@ -7126,7 +7123,6 @@ export interface ChannelCreateFlowGroupByFilesResponse {
7126
7123
  /**
7127
7124
  * 合同组ID,为32位字符串。
7128
7125
  建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
7129
- 注意:此字段可能返回 null,表示取不到有效值。
7130
7126
  */
7131
7127
  FlowGroupId?: string;
7132
7128
  /**
@@ -7134,7 +7130,6 @@ export interface ChannelCreateFlowGroupByFilesResponse {
7134
7130
 
7135
7131
  注:
7136
7132
  `此数组的顺序和入参中的FlowGroupInfos顺序一致`
7137
- 注意:此字段可能返回 null,表示取不到有效值。
7138
7133
  */
7139
7134
  FlowIds?: Array<string>;
7140
7135
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { InquirePriceRunInstancesResponse, StopInstanceRequest, DescribeServiceLoginSettingsResponse, DescribeInstanceNetworkStatusResponse, TerminateInstancesResponse, DescribeRegionsRequest, StartInstanceRequest, TerminateInstancesRequest, DescribeScenesResponse, DescribeApplicationsRequest, RunInstancesRequest, DescribeInstancesResponse, RunInstancesResponse, DescribeInstancesRequest, DescribeScenesRequest, DescribeRegionsResponse, InquirePriceRunInstancesRequest, StartInstanceResponse, CreateMuskPromptResponse, DescribeServiceLoginSettingsRequest, CreateMuskPromptRequest, DescribeApplicationsResponse, DescribeInstanceNetworkStatusRequest, StopInstanceResponse } from "./hai_models";
3
+ import { InquirePriceRunInstancesResponse, StopInstanceRequest, DescribeServiceLoginSettingsResponse, DescribeInstanceNetworkStatusResponse, TerminateInstancesResponse, DescribeApplicationsResponse, StartInstanceRequest, TerminateInstancesRequest, DescribeMuskPromptsRequest, DescribeScenesResponse, DescribeApplicationsRequest, RunInstancesRequest, DescribeInstancesResponse, RunInstancesResponse, DescribeInstancesRequest, DescribeScenesRequest, DescribeRegionsResponse, InquirePriceRunInstancesRequest, StartInstanceResponse, CreateMuskPromptResponse, DescribeServiceLoginSettingsRequest, CreateMuskPromptRequest, DescribeRegionsRequest, DescribeInstanceNetworkStatusRequest, StopInstanceResponse, DescribeMuskPromptsResponse } from "./hai_models";
4
4
  /**
5
5
  * hai client
6
6
  * @class
@@ -15,6 +15,10 @@ export declare class Client extends AbstractClient {
15
15
  * 查询应用
16
16
  */
17
17
  DescribeApplications(req: DescribeApplicationsRequest, cb?: (error: string, rep: DescribeApplicationsResponse) => void): Promise<DescribeApplicationsResponse>;
18
+ /**
19
+ * 获取prompt任务列表
20
+ */
21
+ DescribeMuskPrompts(req: DescribeMuskPromptsRequest, cb?: (error: string, rep: DescribeMuskPromptsResponse) => void): Promise<DescribeMuskPromptsResponse>;
18
22
  /**
19
23
  * 查询场景
20
24
  */
@@ -39,6 +39,12 @@ class Client extends abstract_client_1.AbstractClient {
39
39
  async DescribeApplications(req, cb) {
40
40
  return this.request("DescribeApplications", req, cb);
41
41
  }
42
+ /**
43
+ * 获取prompt任务列表
44
+ */
45
+ async DescribeMuskPrompts(req, cb) {
46
+ return this.request("DescribeMuskPrompts", req, cb);
47
+ }
42
48
  /**
43
49
  * 查询场景
44
50
  */