tencentcloud-sdk-nodejs 4.0.490 → 4.0.492

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 (86) hide show
  1. package/CHANGELOG.md +266 -0
  2. package/SERVICE_CHANGELOG.md +272 -222
  3. package/package.json +1 -1
  4. package/products.md +21 -21
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +4 -2
  7. package/src/services/asr/v20190614/asr_models.ts +2 -2
  8. package/src/services/batch/v20170312/batch_models.ts +2 -2
  9. package/src/services/cdb/v20170320/cdb_client.ts +2 -15
  10. package/src/services/cdb/v20170320/cdb_models.ts +73 -133
  11. package/src/services/cdn/v20180606/cdn_client.ts +1 -1
  12. package/src/services/cdn/v20180606/cdn_models.ts +8 -3
  13. package/src/services/cdwch/v20200915/cdwch_client.ts +16 -2
  14. package/src/services/cdwch/v20200915/cdwch_models.ts +150 -10
  15. package/src/services/cls/v20201016/cls_models.ts +1 -1
  16. package/src/services/cvm/v20170312/cvm_client.ts +2 -1
  17. package/src/services/cvm/v20170312/cvm_models.ts +38 -13
  18. package/src/services/dcdb/v20180411/dcdb_client.ts +22 -0
  19. package/src/services/dcdb/v20180411/dcdb_models.ts +155 -0
  20. package/src/services/dts/v20211206/dts_client.ts +2 -2
  21. package/src/services/dts/v20211206/dts_models.ts +6 -6
  22. package/src/services/emr/v20190103/emr_client.ts +5 -5
  23. package/src/services/emr/v20190103/emr_models.ts +13 -19
  24. package/src/services/es/v20180416/es_models.ts +24 -12
  25. package/src/services/essbasic/v20210526/essbasic_client.ts +16 -1
  26. package/src/services/essbasic/v20210526/essbasic_models.ts +178 -21
  27. package/src/services/faceid/v20180301/faceid_client.ts +1 -0
  28. package/src/services/faceid/v20180301/faceid_models.ts +15 -0
  29. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +7 -1
  30. package/src/services/lcic/v20220817/lcic_models.ts +14 -14
  31. package/src/services/lighthouse/v20200324/lighthouse_client.ts +42 -16
  32. package/src/services/lighthouse/v20200324/lighthouse_models.ts +173 -43
  33. package/src/services/postgres/v20170312/postgres_client.ts +2 -0
  34. package/src/services/postgres/v20170312/postgres_models.ts +119 -7
  35. package/src/services/tcm/v20210413/tcm_models.ts +28 -3
  36. package/src/services/teo/v20220901/teo_models.ts +7 -2
  37. package/src/services/tione/v20211111/tione_models.ts +5 -0
  38. package/src/services/tts/v20190823/tts_models.ts +1 -1
  39. package/tencentcloud/common/sdk_version.d.ts +1 -1
  40. package/tencentcloud/common/sdk_version.js +1 -1
  41. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +3 -1
  42. package/tencentcloud/services/asr/v20190614/asr_client.js +3 -1
  43. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +2 -2
  44. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  45. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +1 -5
  46. package/tencentcloud/services/cdb/v20170320/cdb_client.js +0 -6
  47. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +60 -110
  48. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +1 -1
  49. package/tencentcloud/services/cdn/v20180606/cdn_client.js +1 -1
  50. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +7 -3
  51. package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +5 -1
  52. package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +6 -0
  53. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +127 -10
  54. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  55. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -1
  56. package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -1
  57. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +34 -13
  58. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +10 -1
  59. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +11 -0
  60. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +132 -0
  61. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +2 -2
  62. package/tencentcloud/services/dts/v20211206/dts_client.js +2 -2
  63. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +6 -6
  64. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -5
  65. package/tencentcloud/services/emr/v20190103/emr_client.js +5 -5
  66. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +11 -17
  67. package/tencentcloud/services/es/v20180416/es_models.d.ts +14 -2
  68. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -2
  69. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +8 -1
  70. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +152 -20
  71. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +13 -0
  72. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +6 -1
  73. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +14 -14
  74. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +13 -5
  75. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +18 -6
  76. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +151 -39
  77. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +102 -7
  78. package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +23 -3
  79. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +6 -2
  80. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +4 -0
  81. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +1 -1
  82. package/test/cdb.v20170320.test.js +0 -10
  83. package/test/cdwch.v20200915.test.js +10 -0
  84. package/test/dcdb.v20180411.test.js +10 -0
  85. package/test/essbasic.v20210526.test.js +10 -0
  86. package/test/lighthouse.v20200324.test.js +24 -4
@@ -125,7 +125,7 @@ class Client extends abstract_client_1.AbstractClient {
125
125
  return this.request("StopMigrateJob", req, cb);
126
126
  }
127
127
  /**
128
- * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs,获取下线后任务列表,此操作成功后无法看到此任务表示下线成功。
128
+ * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态,此操作成功后无法看到此任务表示下线成功。
129
129
  */
130
130
  async DestroySyncJob(req, cb) {
131
131
  return this.request("DestroySyncJob", req, cb);
@@ -247,7 +247,7 @@ class Client extends abstract_client_1.AbstractClient {
247
247
  return this.request("ModifyMigrateName", req, cb);
248
248
  }
249
249
  /**
250
- * 销毁(隔离)同步任务,销毁后可通过查询同步任务信息接口DescribeSyncJobs,获取销毁后状态。在任务销毁后可进行解除隔离(RecoverSyncJob)操作或直接进行立即下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
250
+ * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
251
251
  */
252
252
  async IsolateSyncJob(req, cb) {
253
253
  return this.request("IsolateSyncJob", req, cb);
@@ -2766,7 +2766,7 @@ export interface StepDetailInfo {
2766
2766
  */
2767
2767
  export interface CreateSyncJobRequest {
2768
2768
  /**
2769
- * 支付类型,PrePay:包年包月 PostPay:按时按量
2769
+ * 付款类型, 如:PrePay(表示包年包月)、PostPay(表示按时按量)
2770
2770
  */
2771
2771
  PayMode: string;
2772
2772
  /**
@@ -2790,23 +2790,23 @@ export interface CreateSyncJobRequest {
2790
2790
  */
2791
2791
  Specification?: string;
2792
2792
  /**
2793
- *
2793
+ * 标签信息
2794
2794
  */
2795
2795
  Tags?: Array<TagItem>;
2796
2796
  /**
2797
- * 同步任务数量
2797
+ * 一次购买的同步任务数量,取值范围为[1, 10],默认为1
2798
2798
  */
2799
2799
  Count?: number;
2800
2800
  /**
2801
- * 自动续费标识
2801
+ * 自动续费标识,当PayMode值为PrePay则此项配置有意义,取值为:1(表示自动续费)、0(不自动续费,默认为此值)
2802
2802
  */
2803
2803
  AutoRenew?: number;
2804
2804
  /**
2805
- * 同步链路规格
2805
+ * 同步链路规格,如micro,small,medium,large,默认为medium
2806
2806
  */
2807
2807
  InstanceClass?: string;
2808
2808
  /**
2809
- * 同步链路名称
2809
+ * 同步任务名称
2810
2810
  */
2811
2811
  JobName?: string;
2812
2812
  /**
@@ -45,7 +45,7 @@ export declare class Client extends AbstractClient {
45
45
  */
46
46
  ScaleOutInstance(req: ScaleOutInstanceRequest, cb?: (error: string, rep: ScaleOutInstanceResponse) => void): Promise<ScaleOutInstanceResponse>;
47
47
  /**
48
- * 查询EMR实例
48
+ * 查询集群实例信息
49
49
  */
50
50
  DescribeInstances(req: DescribeInstancesRequest, cb?: (error: string, rep: DescribeInstancesResponse) => void): Promise<DescribeInstancesResponse>;
51
51
  /**
@@ -62,7 +62,7 @@ export declare class Client extends AbstractClient {
62
62
  */
63
63
  DescribeEmrApplicationStatics(req: DescribeEmrApplicationStaticsRequest, cb?: (error: string, rep: DescribeEmrApplicationStaticsResponse) => void): Promise<DescribeEmrApplicationStaticsResponse>;
64
64
  /**
65
- * 预付费集群隔离后续费资源查询
65
+ * 查询待续费节点信息
66
66
  */
67
67
  DescribeInstanceRenewNodes(req: DescribeInstanceRenewNodesRequest, cb?: (error: string, rep: DescribeInstanceRenewNodesResponse) => void): Promise<DescribeInstanceRenewNodesResponse>;
68
68
  /**
@@ -82,7 +82,7 @@ export declare class Client extends AbstractClient {
82
82
  */
83
83
  InquiryPriceCreateInstance(req: InquiryPriceCreateInstanceRequest, cb?: (error: string, rep: InquiryPriceCreateInstanceResponse) => void): Promise<InquiryPriceCreateInstanceResponse>;
84
84
  /**
85
- * 获取yarn资源调度页面的数据
85
+ * 查询YARN资源调度数据信息
86
86
  */
87
87
  DescribeResourceSchedule(req: DescribeResourceScheduleRequest, cb?: (error: string, rep: DescribeResourceScheduleResponse) => void): Promise<DescribeResourceScheduleResponse>;
88
88
  /**
@@ -98,11 +98,11 @@ export declare class Client extends AbstractClient {
98
98
  */
99
99
  DescribeClusterNodes(req: DescribeClusterNodesRequest, cb?: (error: string, rep: DescribeClusterNodesResponse) => void): Promise<DescribeClusterNodesResponse>;
100
100
  /**
101
- * EMR集群实例列表查询
101
+ * 查询集群列表
102
102
  */
103
103
  DescribeInstancesList(req: DescribeInstancesListRequest, cb?: (error: string, rep: DescribeInstancesListResponse) => void): Promise<DescribeInstancesListResponse>;
104
104
  /**
105
- * 刷新动态资源池
105
+ * 刷新YARN的动态资源池
106
106
  */
107
107
  ModifyResourcePools(req: ModifyResourcePoolsRequest, cb?: (error: string, rep: ModifyResourcePoolsResponse) => void): Promise<ModifyResourcePoolsResponse>;
108
108
  }
@@ -83,7 +83,7 @@ class Client extends abstract_client_1.AbstractClient {
83
83
  return this.request("ScaleOutInstance", req, cb);
84
84
  }
85
85
  /**
86
- * 查询EMR实例
86
+ * 查询集群实例信息
87
87
  */
88
88
  async DescribeInstances(req, cb) {
89
89
  return this.request("DescribeInstances", req, cb);
@@ -108,7 +108,7 @@ class Client extends abstract_client_1.AbstractClient {
108
108
  return this.request("DescribeEmrApplicationStatics", req, cb);
109
109
  }
110
110
  /**
111
- * 预付费集群隔离后续费资源查询
111
+ * 查询待续费节点信息
112
112
  */
113
113
  async DescribeInstanceRenewNodes(req, cb) {
114
114
  return this.request("DescribeInstanceRenewNodes", req, cb);
@@ -138,7 +138,7 @@ class Client extends abstract_client_1.AbstractClient {
138
138
  return this.request("InquiryPriceCreateInstance", req, cb);
139
139
  }
140
140
  /**
141
- * 获取yarn资源调度页面的数据
141
+ * 查询YARN资源调度数据信息
142
142
  */
143
143
  async DescribeResourceSchedule(req, cb) {
144
144
  return this.request("DescribeResourceSchedule", req, cb);
@@ -162,13 +162,13 @@ class Client extends abstract_client_1.AbstractClient {
162
162
  return this.request("DescribeClusterNodes", req, cb);
163
163
  }
164
164
  /**
165
- * EMR集群实例列表查询
165
+ * 查询集群列表
166
166
  */
167
167
  async DescribeInstancesList(req, cb) {
168
168
  return this.request("DescribeInstancesList", req, cb);
169
169
  }
170
170
  /**
171
- * 刷新动态资源池
171
+ * 刷新YARN的动态资源池
172
172
  */
173
173
  async ModifyResourcePools(req, cb) {
174
174
  return this.request("ModifyResourcePools", req, cb);
@@ -1690,11 +1690,11 @@ export interface ModifyResourceSchedulerRequest {
1690
1690
  */
1691
1691
  export interface LoginSettings {
1692
1692
  /**
1693
- * Password
1693
+ * 实例登录密码,8-16个字符,包含大写字母、小写字母、数字和特殊字符四种,特殊符号仅支持!@%^*,密码第一位不能为特殊字符
1694
1694
  */
1695
1695
  Password?: string;
1696
1696
  /**
1697
- * Public Key
1697
+ * 密钥ID。关联密钥后,就可以通过对应的私钥来访问实例;PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取
1698
1698
  */
1699
1699
  PublicKeyId?: string;
1700
1700
  }
@@ -1982,26 +1982,18 @@ export interface SyncPodStateRequest {
1982
1982
  export interface CreateInstanceRequest {
1983
1983
  /**
1984
1984
  * 产品ID,不同产品ID表示不同的EMR产品版本。取值范围:
1985
- <li>1:表示EMR-V1.3.1。</li>
1986
- <li>2:表示EMR-V2.0.1。</li>
1987
- <li>4:表示EMR-V2.1.0。</li>
1988
- <li>7:表示EMR-V3.0.0。</li>
1989
- <li>9:表示EMR-V2.2.0。</li>
1990
- <li>11:表示CLICKHOUSE-V1.0.0。</li>
1991
- <li>13:表示DRUID-V1.0.0。</li>
1992
- <li>15:表示EMR-V2.2.1。</li>
1993
1985
  <li>16:表示EMR-V2.3.0。</li>
1994
- <li>17:表示CLICKHOUSE-V1.1.0。</li>
1995
- <li>19:表示EMR-V2.4.0。</li>
1996
1986
  <li>20:表示EMR-V2.5.0。</li>
1997
- <li>22:表示CLICKHOUSE-V1.2.0。</li>
1998
- <li>24:表示EMR-TianQiong-V1.0.0。</li>
1999
1987
  <li>25:表示EMR-V3.1.0。</li>
2000
- <li>26:表示DORIS-V1.0.0。</li>
2001
1988
  <li>27:表示KAFKA-V1.0.0。</li>
2002
- <li>28:表示EMR-V3.2.0。</li>
2003
- <li>29:表示EMR-V2.5.1。</li>
2004
1989
  <li>30:表示EMR-V2.6.0。</li>
1990
+ <li>33 : 表示EMR-V3.2.1。</li>
1991
+ <li>34 : 表示EMR-V3.3.0。</li>
1992
+ <li>36 : 表示STARROCKS-V1.0.0。</li>
1993
+ <li>37 : 表示EMR-V3.4.0。</li>
1994
+ <li>38 : 表示EMR-V2.7.0。</li>
1995
+ <li>39 : 表示STARROCKS-V1.1.0。</li>
1996
+ <li>41 : 表示DRUID-V1.1.0。</li>
2005
1997
  */
2006
1998
  ProductId: number;
2007
1999
  /**
@@ -3655,6 +3647,8 @@ export interface InstanceChargePrepaid {
3655
3647
  Period: number;
3656
3648
  /**
3657
3649
  * 是否自动续费,默认为否。
3650
+ <li>true:是</li>
3651
+ <li>false:否</li>
3658
3652
  */
3659
3653
  RenewFlag: boolean;
3660
3654
  }
@@ -2839,7 +2839,9 @@ export interface UpdateInstanceRequest {
2839
2839
  */
2840
2840
  NodeInfoList?: Array<NodeInfo>;
2841
2841
  /**
2842
- * 公网访问状态
2842
+ * ES集群公网访问状态
2843
+ OPEN 开启
2844
+ CLOSE 关闭
2843
2845
  */
2844
2846
  PublicAccess?: string;
2845
2847
  /**
@@ -2848,10 +2850,14 @@ export interface UpdateInstanceRequest {
2848
2850
  EsPublicAcl?: EsPublicAcl;
2849
2851
  /**
2850
2852
  * Kibana公网访问状态
2853
+ OPEN 开启
2854
+ CLOSE 关闭
2851
2855
  */
2852
2856
  KibanaPublicAccess?: string;
2853
2857
  /**
2854
2858
  * Kibana内网访问状态
2859
+ OPEN 开启
2860
+ CLOSE 关闭
2855
2861
  */
2856
2862
  KibanaPrivateAccess?: string;
2857
2863
  /**
@@ -2892,10 +2898,14 @@ export interface UpdateInstanceRequest {
2892
2898
  EnableCerebro?: boolean;
2893
2899
  /**
2894
2900
  * Cerebro公网访问状态
2901
+ OPEN 开启
2902
+ CLOSE 关闭
2895
2903
  */
2896
2904
  CerebroPublicAccess?: string;
2897
2905
  /**
2898
2906
  * Cerebro内网访问状态
2907
+ OPEN 开启
2908
+ CLOSE 关闭
2899
2909
  */
2900
2910
  CerebroPrivateAccess?: string;
2901
2911
  /**
@@ -2907,7 +2917,9 @@ export interface UpdateInstanceRequest {
2907
2917
  */
2908
2918
  OperationDuration?: OperationDurationUpdated;
2909
2919
  /**
2910
- * 是否开启Altering 外网告警输出
2920
+ * 是否开启Alerting 外网告警输出:
2921
+ OPEN 开启
2922
+ CLOSE 关闭
2911
2923
  */
2912
2924
  KibanaAlteringPublicAccess?: string;
2913
2925
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, PrepareFlowsRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeUsageRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, DescribeChannelFlowEvidenceReportRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ChannelGetTaskResultApiResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, DescribeChannelFlowEvidenceReportResponse } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, PrepareFlowsRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeUsageRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, DescribeChannelFlowEvidenceReportRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ChannelGetTaskResultApiResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -82,7 +82,7 @@ export declare class Client extends AbstractClient {
82
82
  */
83
83
  CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
84
84
  /**
85
- * 此接口(CreateConsoleLoginUrl)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取
85
+ * 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。
86
86
  */
87
87
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
88
88
  /**
@@ -117,6 +117,11 @@ export declare class Client extends AbstractClient {
117
117
  客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
118
118
  */
119
119
  ChannelDescribeOrganizationSeals(req: ChannelDescribeOrganizationSealsRequest, cb?: (error: string, rep: ChannelDescribeOrganizationSealsResponse) => void): Promise<ChannelDescribeOrganizationSealsResponse>;
120
+ /**
121
+ * 渠道版发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
122
+ 合同发起人必须在电子签已经进行实名。
123
+ */
124
+ ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
120
125
  /**
121
126
  * 查询企业员工列表
122
127
  */
@@ -124,7 +124,7 @@ class Client extends abstract_client_1.AbstractClient {
124
124
  return this.request("CreateConsoleLoginUrl", req, cb);
125
125
  }
126
126
  /**
127
- * 此接口(CreateConsoleLoginUrl)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取
127
+ * 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。
128
128
  */
129
129
  async ChannelCreateBoundFlows(req, cb) {
130
130
  return this.request("ChannelCreateBoundFlows", req, cb);
@@ -173,6 +173,13 @@ class Client extends abstract_client_1.AbstractClient {
173
173
  async ChannelDescribeOrganizationSeals(req, cb) {
174
174
  return this.request("ChannelDescribeOrganizationSeals", req, cb);
175
175
  }
176
+ /**
177
+ * 渠道版发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
178
+ 合同发起人必须在电子签已经进行实名。
179
+ */
180
+ async ChannelCreateReleaseFlow(req, cb) {
181
+ return this.request("ChannelCreateReleaseFlow", req, cb);
182
+ }
176
183
  /**
177
184
  * 查询企业员工列表
178
185
  */
@@ -319,11 +319,11 @@ export interface CreateSealByImageRequest {
319
319
  */
320
320
  Agent: Agent;
321
321
  /**
322
- * 印章名称,最大长度不超过30字符
322
+ * 印章名称,最大长度不超过50字符
323
323
  */
324
324
  SealName: string;
325
325
  /**
326
- * 印章图片base64
326
+ * 印章图片base64,大小不超过10M(原始图片不超过7.6M)
327
327
  */
328
328
  SealImage: string;
329
329
  /**
@@ -480,23 +480,23 @@ MobileCheck:手机号验证
480
480
  */
481
481
  export interface Agent {
482
482
  /**
483
- * 腾讯电子签颁发给渠道的应用ID,32位字符串
483
+ * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
484
484
  */
485
485
  AppId: string;
486
486
  /**
487
- * 渠道/平台合作企业的企业ID,最大64位字符串
487
+ * 渠道平台自定义,对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要渠道平台保存),最大64位字符串
488
488
  */
489
489
  ProxyOrganizationOpenId?: string;
490
490
  /**
491
- * 渠道/平台合作企业经办人(操作员)
491
+ * 渠道子客企业中的员工/经办人,通过渠道平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
492
492
  */
493
493
  ProxyOperator?: UserInfo;
494
494
  /**
495
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
495
+ * 在子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
496
496
  */
497
497
  ProxyAppId?: string;
498
498
  /**
499
- * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
499
+ * 内部参数,暂未开放使用
500
500
  */
501
501
  ProxyOrganizationId?: string;
502
502
  }
@@ -554,6 +554,31 @@ export interface FlowApproverDetail {
554
554
  */
555
555
  ApproveType: string;
556
556
  }
557
+ /**
558
+ * 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
559
+ */
560
+ export interface RelieveInfo {
561
+ /**
562
+ * 解除理由,最大支持200个字
563
+ */
564
+ Reason: string;
565
+ /**
566
+ * 解除后仍然有效的条款,保留条款,最大支持200个字
567
+ */
568
+ RemainInForceItem?: string;
569
+ /**
570
+ * 原合同事项处理-费用结算,最大支持200个字
571
+ */
572
+ OriginalExpenseSettlement?: string;
573
+ /**
574
+ * 原合同事项处理-其他事项,最大支持200个字
575
+ */
576
+ OriginalOtherSettlement?: string;
577
+ /**
578
+ * 其他约定,最大支持200个字
579
+ */
580
+ OtherDeals?: string;
581
+ }
557
582
  /**
558
583
  * ChannelCreateFlowGroupByFiles请求参数结构体
559
584
  */
@@ -756,14 +781,14 @@ export interface TemplateInfo {
756
781
  * 模板控件信息结构
757
782
  */
758
783
  Components: Array<Component>;
759
- /**
760
- * 签署区模板信息结构
761
- */
762
- SignComponents: Array<Component>;
763
784
  /**
764
785
  * 模板中的流程参与人信息
765
786
  */
766
787
  Recipients: Array<Recipient>;
788
+ /**
789
+ * 签署区模板信息结构
790
+ */
791
+ SignComponents: Array<Component>;
767
792
  /**
768
793
  * 模板类型:1-静默签;3-普通模板
769
794
  */
@@ -787,9 +812,13 @@ export interface TemplateInfo {
787
812
  PreviewUrl: string;
788
813
  /**
789
814
  * 渠道模板ID
790
- 注意:此字段可能返回 null,表示取不到有效值。
791
815
  */
792
816
  ChannelTemplateId: string;
817
+ /**
818
+ * 渠道版-模板PDF文件链接
819
+ 注意:此字段可能返回 null,表示取不到有效值。
820
+ */
821
+ PdfUrl: string;
793
822
  }
794
823
  /**
795
824
  * GetDownloadFlowUrl返回参数结构体
@@ -1066,7 +1095,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
1066
1095
  */
1067
1096
  Offset?: number;
1068
1097
  /**
1069
- * 查询信息类型,为0时不返回授权用户,为1时返回
1098
+ * 查询信息类型,为1时返回授权用户,为其他值时不返回
1070
1099
  */
1071
1100
  InfoType?: number;
1072
1101
  /**
@@ -1079,7 +1108,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
1079
1108
  */
1080
1109
  export interface ProxyOrganizationOperator {
1081
1110
  /**
1082
- * 经办人ID(渠道颁发),最大长度64个字符
1111
+ * 对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(比如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
1083
1112
  */
1084
1113
  Id: string;
1085
1114
  /**
@@ -1304,23 +1333,23 @@ export interface FlowInfo {
1304
1333
  */
1305
1334
  export interface UserInfo {
1306
1335
  /**
1307
- * 用户在渠道的编号,最大64位字符串
1336
+ * 渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
1308
1337
  */
1309
1338
  OpenId?: string;
1310
1339
  /**
1311
- * 用户的来源渠道
1340
+ * 内部参数,暂未开放使用
1312
1341
  */
1313
1342
  Channel?: string;
1314
1343
  /**
1315
- * 自定义用户编号
1344
+ * 内部参数,暂未开放使用
1316
1345
  */
1317
1346
  CustomUserId?: string;
1318
1347
  /**
1319
- * 用户真实IP
1348
+ * 内部参数,暂未开放使用
1320
1349
  */
1321
1350
  ClientIp?: string;
1322
1351
  /**
1323
- * 用户代理IP
1352
+ * 内部参数,暂未开放使用
1324
1353
  */
1325
1354
  ProxyIp?: string;
1326
1355
  }
@@ -1420,7 +1449,7 @@ export interface ChannelCreateBoundFlowsRequest {
1420
1449
  */
1421
1450
  FlowIds?: Array<string>;
1422
1451
  /**
1423
- * 操作者的信息
1452
+ * 暂未开放
1424
1453
  */
1425
1454
  Operator?: UserInfo;
1426
1455
  }
@@ -1895,6 +1924,59 @@ export interface Filter {
1895
1924
  */
1896
1925
  Values: Array<string>;
1897
1926
  }
1927
+ /**
1928
+ * 解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
1929
+ 注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
1930
+
1931
+ 如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
1932
+ ApproverNumber, OrganizationName, ApproverType必传。
1933
+ 对于其他身份标识
1934
+ - 渠道子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
1935
+ - 非渠道合作企业:Name、Mobile必传。
1936
+ */
1937
+ export interface ReleasedApprover {
1938
+ /**
1939
+ * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符
1940
+ */
1941
+ OrganizationName: string;
1942
+ /**
1943
+ * 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
1944
+ */
1945
+ ApproverNumber: number;
1946
+ /**
1947
+ * 签署人类型,目前仅支持
1948
+ ORGANIZATION-企业
1949
+ */
1950
+ ApproverType: string;
1951
+ /**
1952
+ * 签署人姓名,最大长度50个字符
1953
+ */
1954
+ Name?: string;
1955
+ /**
1956
+ * 签署人身份证件类型
1957
+ 1.ID_CARD 居民身份证
1958
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
1959
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
1960
+ */
1961
+ IdCardType?: string;
1962
+ /**
1963
+ * 签署人证件号
1964
+ */
1965
+ IdCardNumber?: string;
1966
+ /**
1967
+ * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号
1968
+ */
1969
+ Mobile?: string;
1970
+ /**
1971
+ * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
1972
+ */
1973
+ OrganizationOpenId?: string;
1974
+ /**
1975
+ * 用户侧第三方id,最大长度64个字符
1976
+ 当签署方为同一渠道下的员工时,该字必传
1977
+ */
1978
+ OpenId?: string;
1979
+ }
1898
1980
  /**
1899
1981
  * DescribeUsage请求参数结构体
1900
1982
  */
@@ -2073,6 +2155,39 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
2073
2155
  */
2074
2156
  RequestId?: string;
2075
2157
  }
2158
+ /**
2159
+ * ChannelCreateReleaseFlow请求参数结构体
2160
+ */
2161
+ export interface ChannelCreateReleaseFlowRequest {
2162
+ /**
2163
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2164
+ */
2165
+ Agent: Agent;
2166
+ /**
2167
+ * 待解除的流程编号(即原流程的编号)
2168
+ */
2169
+ NeedRelievedFlowId: string;
2170
+ /**
2171
+ * 解除协议内容
2172
+ */
2173
+ ReliveInfo: RelieveInfo;
2174
+ /**
2175
+ * 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
2176
+ */
2177
+ ReleasedApprovers?: Array<ReleasedApprover>;
2178
+ /**
2179
+ * 签署完回调url,最大长度1000个字符
2180
+ */
2181
+ CallbackUrl?: string;
2182
+ /**
2183
+ * 机构信息
2184
+ */
2185
+ Organization?: OrganizationInfo;
2186
+ /**
2187
+ * 用户信息
2188
+ */
2189
+ Operator?: UserInfo;
2190
+ }
2076
2191
  /**
2077
2192
  * ChannelCreateFlowGroupByFiles返回参数结构体
2078
2193
  */
@@ -2472,6 +2587,10 @@ export interface DescribeTemplatesRequest {
2472
2587
  * 是否获取模板预览链接
2473
2588
  */
2474
2589
  WithPreviewUrl?: boolean;
2590
+ /**
2591
+ * 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
2592
+ */
2593
+ WithPdfUrl?: boolean;
2475
2594
  }
2476
2595
  /**
2477
2596
  * 持有的电子印章信息
@@ -2700,6 +2819,19 @@ export interface ChannelDescribeEmployeesResponse {
2700
2819
  */
2701
2820
  RequestId?: string;
2702
2821
  }
2822
+ /**
2823
+ * ChannelCreateReleaseFlow返回参数结构体
2824
+ */
2825
+ export interface ChannelCreateReleaseFlowResponse {
2826
+ /**
2827
+ * 解除协议流程编号
2828
+ */
2829
+ FlowId: string;
2830
+ /**
2831
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2832
+ */
2833
+ RequestId?: string;
2834
+ }
2703
2835
  /**
2704
2836
  * DescribeChannelFlowEvidenceReport返回参数结构体
2705
2837
  */
@@ -114,6 +114,15 @@ LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模
114
114
  */
115
115
  Optional?: string;
116
116
  }
117
+ /**
118
+ * RuleId相关配置
119
+ */
120
+ export interface RuleIdConfig {
121
+ /**
122
+ * 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认不开启。
123
+ */
124
+ IntentionRecognition?: boolean;
125
+ }
117
126
  /**
118
127
  * 敏感数据加密
119
128
  */
@@ -1541,6 +1550,10 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
1541
1550
  * 意愿核身(问答模式)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持一个播报文本+回答文本。
1542
1551
  */
1543
1552
  IntentionQuestions?: Array<IntentionQuestion>;
1553
+ /**
1554
+ * RuleId相关配置
1555
+ */
1556
+ Config?: RuleIdConfig;
1544
1557
  }
1545
1558
  /**
1546
1559
  * MinorsVerification返回参数结构体
@@ -1940,7 +1940,7 @@ export interface DescribeDeviceLocationSolveResponse {
1940
1940
  */
1941
1941
  Longitude: number;
1942
1942
  /**
1943
- * 维度
1943
+ * 纬度
1944
1944
  */
1945
1945
  Latitude: number;
1946
1946
  /**
@@ -4051,6 +4051,11 @@ export interface DeviceInfo {
4051
4051
  注意:此字段可能返回 null,表示取不到有效值。
4052
4052
  */
4053
4053
  DeviceType: string;
4054
+ /**
4055
+ * 是否是 lora 设备
4056
+ 注意:此字段可能返回 null,表示取不到有效值。
4057
+ */
4058
+ IsLora: boolean;
4054
4059
  }
4055
4060
  /**
4056
4061
  * ModifyLoRaFrequency返回参数结构体