tencentcloud-sdk-nodejs 4.0.781 → 4.0.783

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 (59) hide show
  1. package/CHANGELOG.md +345 -0
  2. package/SERVICE_CHANGELOG.md +473 -6
  3. package/package.json +1 -1
  4. package/products.md +20 -20
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdn/v20180606/cdn_client.ts +1 -1
  7. package/src/services/cdn/v20180606/cdn_models.ts +1 -1
  8. package/src/services/dasb/v20191018/dasb_models.ts +4 -0
  9. package/src/services/dbbrain/v20210527/dbbrain_models.ts +15 -2
  10. package/src/services/eb/v20210416/eb_client.ts +2 -2
  11. package/src/services/eb/v20210416/eb_models.ts +4 -4
  12. package/src/services/ess/v20201111/ess_client.ts +65 -10
  13. package/src/services/ess/v20201111/ess_models.ts +68 -12
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +5 -6
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +53 -9
  16. package/src/services/monitor/v20180724/monitor_models.ts +22 -3
  17. package/src/services/ocr/v20181119/ocr_client.ts +21 -9
  18. package/src/services/ocr/v20181119/ocr_models.ts +71 -0
  19. package/src/services/organization/v20210331/organization_client.ts +216 -77
  20. package/src/services/organization/v20210331/organization_models.ts +1351 -830
  21. package/src/services/sqlserver/v20180328/sqlserver_models.ts +3 -3
  22. package/src/services/sts/v20180813/sts_models.ts +3 -4
  23. package/src/services/vpc/v20170312/vpc_models.ts +4 -0
  24. package/src/services/wedata/v20210820/wedata_client.ts +0 -14
  25. package/src/services/wedata/v20210820/wedata_models.ts +74 -35
  26. package/src/services/weilingwith/v20230427/weilingwith_models.ts +4 -0
  27. package/tencentcloud/common/sdk_version.d.ts +1 -1
  28. package/tencentcloud/common/sdk_version.js +1 -1
  29. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +1 -1
  30. package/tencentcloud/services/cdn/v20180606/cdn_client.js +1 -1
  31. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +1 -1
  32. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +4 -0
  33. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +15 -2
  34. package/tencentcloud/services/eb/v20210416/eb_client.d.ts +2 -2
  35. package/tencentcloud/services/eb/v20210416/eb_client.js +2 -2
  36. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +4 -4
  37. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +64 -9
  38. package/tencentcloud/services/ess/v20201111/ess_client.js +64 -9
  39. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +68 -12
  40. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -6
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +5 -6
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +53 -9
  43. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +22 -3
  44. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +9 -5
  45. package/tencentcloud/services/ocr/v20181119/ocr_client.js +11 -5
  46. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +69 -0
  47. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +51 -7
  48. package/tencentcloud/services/organization/v20210331/organization_client.js +75 -9
  49. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +1326 -834
  50. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +3 -3
  51. package/tencentcloud/services/sts/v20180813/sts_models.d.ts +3 -4
  52. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +4 -0
  53. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -7
  54. package/tencentcloud/services/wedata/v20210820/wedata_client.js +0 -8
  55. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +74 -33
  56. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +4 -0
  57. package/test/ocr.v20181119.test.js +12 -2
  58. package/test/organization.v20210331.test.js +116 -6
  59. package/test/wedata.v20210820.test.js +0 -10
@@ -2675,11 +2675,11 @@ export interface DescribeProductConfigResponse {
2675
2675
  /**
2676
2676
  * 规格信息数组
2677
2677
  */
2678
- SpecInfoList: Array<SpecInfo>
2678
+ SpecInfoList?: Array<SpecInfo>
2679
2679
  /**
2680
2680
  * 返回总共多少条数据
2681
2681
  */
2682
- TotalCount: number
2682
+ TotalCount?: number
2683
2683
  /**
2684
2684
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2685
2685
  */
@@ -4547,7 +4547,7 @@ export interface DescribeProductConfigRequest {
4547
4547
  */
4548
4548
  Zone: string
4549
4549
  /**
4550
- * 购买实例的类型 HA-高可用型(包括双机高可用,alwaysOn集群),RO-只读副本型,SI-基础版本型
4550
+ * 购买实例的类型 HA-本地盘高可用(包括双机高可用,alwaysOn集群),RO-本地盘只读副本,SI-云盘版单节点,BI-商业智能服务,cvmHA-云盘版高可用,cvmRO-云盘版只读副本
4551
4551
  */
4552
4552
  InstanceType?: string
4553
4553
  }
@@ -181,11 +181,10 @@ export interface GetFederationTokenRequest {
181
181
  */
182
182
  Name: string
183
183
  /**
184
- * 授予该临时访问凭证权限的CAM策略
185
- 注意:
184
+ * 注意:
186
185
  1、策略语法参照[ CAM 策略语法](https://cloud.tencent.com/document/product/598/10603)。
187
186
  2、策略中不能包含 principal 元素。
188
- 3、该参数需要做urlencode
187
+ 3、该参数需要做urlencode,服务端会对该字段做urldecode, 并按处理后Policy授予临时访问凭证权限,请按规范传入参数。
189
188
  */
190
189
  Policy: string
191
190
  /**
@@ -285,7 +284,7 @@ qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920、qcs::c
285
284
  /**
286
285
  * 策略描述
287
286
  注意:
288
- 1、policy 需要做 urlencode(如果通过 GET 方法请求云 API,发送请求前,所有参数都需要按照[云 API 规范](https://cloud.tencent.com/document/api/598/33159#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2)再 urlencode 一次)。
287
+ 1、该参数需要做urlencode,服务端会对该字段做urldecode, 并按处理后Policy授予临时访问凭证权限,请按规范传入参数。(如果通过 GET 方法请求云 API,发送请求前,所有参数都需要按照[云 API 规范](https://cloud.tencent.com/document/api/598/33159#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2)再 urlencode 一次)。
289
288
  2、策略语法参照[ CAM 策略语法](https://cloud.tencent.com/document/product/598/10603)。
290
289
  3、策略中不能包含 principal 元素。
291
290
  */
@@ -10024,6 +10024,10 @@ export interface DescribeUsedIpAddressRequest {
10024
10024
  * 查询是否占用的ip列表,ip需要在vpc或子网内。最多允许一次查询100个IP。
10025
10025
  */
10026
10026
  IpAddresses?: Array<string>
10027
+ /**
10028
+ * 过滤条件,不支持同时指定IpAddresses和Filters参数。 支持的过滤条件如下: <li>ip-addresses:IP地址。</li> <li>resource-id:资源ID。</li>
10029
+ */
10030
+ Filters?: Array<Filter>
10027
10031
  /**
10028
10032
  * 偏移量,默认为0。
10029
10033
  */
@@ -131,7 +131,6 @@ import {
131
131
  CreateInLongAgentResponse,
132
132
  RuleGroupTable,
133
133
  DescribeInstanceLogRequest,
134
- DescribeKafkaTopicInfoRequest,
135
134
  DescribeRuleGroupSubscriptionResponse,
136
135
  DescribeIntegrationStatisticsTaskStatusTrendResponse,
137
136
  DeleteResourceFileRequest,
@@ -232,7 +231,6 @@ import {
232
231
  DescribeColumnsMetaRequest,
233
232
  DescribeOrganizationalFunctionsRequest,
234
233
  DescribeRuleTemplateResponse,
235
- DescribeKafkaTopicInfoResponse,
236
234
  OpsTaskCanvasInfoList,
237
235
  DescribeDependTaskListsRequest,
238
236
  DatabaseMeta,
@@ -4013,18 +4011,6 @@ export class Client extends AbstractClient {
4013
4011
  return this.request("DescribeTableMeta", req, cb)
4014
4012
  }
4015
4013
 
4016
- /**
4017
- * 没用到
4018
-
4019
- 获取kafka的topic信息
4020
- */
4021
- async DescribeKafkaTopicInfo(
4022
- req: DescribeKafkaTopicInfoRequest,
4023
- cb?: (error: string, rep: DescribeKafkaTopicInfoResponse) => void
4024
- ): Promise<DescribeKafkaTopicInfoResponse> {
4025
- return this.request("DescribeKafkaTopicInfo", req, cb)
4026
- }
4027
-
4028
4014
  /**
4029
4015
  * 提取数据集成节点字段Schema
4030
4016
  */
@@ -665,6 +665,10 @@ export interface CreateDataSourceRequest {
665
665
  * cos region
666
666
  */
667
667
  COSRegion?: string
668
+ /**
669
+ * 连接测试结果
670
+ */
671
+ ConnectResult?: string
668
672
  }
669
673
 
670
674
  /**
@@ -1685,11 +1689,6 @@ export interface ColumnLineageInfo {
1685
1689
  注意:此字段可能返回 null,表示取不到有效值。
1686
1690
  */
1687
1691
  Id: string
1688
- /**
1689
- * 由中心节点出发的路径信息
1690
- 注意:此字段可能返回 null,表示取不到有效值。
1691
- */
1692
- PrefixPath: string
1693
1692
  /**
1694
1693
  * 数据源ID
1695
1694
  注意:此字段可能返回 null,表示取不到有效值。
@@ -1765,6 +1764,11 @@ export interface ColumnLineageInfo {
1765
1764
  注意:此字段可能返回 null,表示取不到有效值。
1766
1765
  */
1767
1766
  Description?: string
1767
+ /**
1768
+ * 由中心节点出发的路径信息
1769
+ 注意:此字段可能返回 null,表示取不到有效值。
1770
+ */
1771
+ PrefixPath?: string
1768
1772
  /**
1769
1773
  * 创建时间
1770
1774
  注意:此字段可能返回 null,表示取不到有效值。
@@ -3962,20 +3966,6 @@ export interface DescribeInstanceLogRequest {
3962
3966
  OriginFileName: string
3963
3967
  }
3964
3968
 
3965
- /**
3966
- * DescribeKafkaTopicInfo请求参数结构体
3967
- */
3968
- export interface DescribeKafkaTopicInfoRequest {
3969
- /**
3970
- * 数据源id
3971
- */
3972
- DatasourceId: string
3973
- /**
3974
- * 数据源类型
3975
- */
3976
- Type: string
3977
- }
3978
-
3979
3969
  /**
3980
3970
  * DescribeRuleGroupSubscription返回参数结构体
3981
3971
  */
@@ -4795,11 +4785,6 @@ export interface TableLineageInfo {
4795
4785
  注意:此字段可能返回 null,表示取不到有效值。
4796
4786
  */
4797
4787
  MetastoreType: string
4798
- /**
4799
- * 由中心节点到该节点的路径
4800
- 注意:此字段可能返回 null,表示取不到有效值。
4801
- */
4802
- PrefixPath: string
4803
4788
  /**
4804
4789
  * 空间id
4805
4790
  注意:此字段可能返回 null,表示取不到有效值。
@@ -4870,6 +4855,11 @@ export interface TableLineageInfo {
4870
4855
  注意:此字段可能返回 null,表示取不到有效值。
4871
4856
  */
4872
4857
  Description?: string
4858
+ /**
4859
+ * 由中心节点到该节点的路径
4860
+ 注意:此字段可能返回 null,表示取不到有效值。
4861
+ */
4862
+ PrefixPath?: string
4873
4863
  /**
4874
4864
  * 血缘创建时间
4875
4865
  注意:此字段可能返回 null,表示取不到有效值。
@@ -4885,6 +4875,11 @@ export interface TableLineageInfo {
4885
4875
  注意:此字段可能返回 null,表示取不到有效值。
4886
4876
  */
4887
4877
  Tasks?: Array<string>
4878
+ /**
4879
+ * 模块/应用类型
4880
+ 注意:此字段可能返回 null,表示取不到有效值。
4881
+ */
4882
+ ChannelType?: string
4888
4883
  }
4889
4884
 
4890
4885
  /**
@@ -6596,6 +6591,10 @@ export interface DescribeBaselineInstanceDagRequest {
6596
6591
  * 向上展开层级
6597
6592
  */
6598
6593
  Level?: number
6594
+ /**
6595
+ * 保障任务id
6596
+ */
6597
+ PromiseTaskId?: string
6599
6598
  }
6600
6599
 
6601
6600
  /**
@@ -7200,16 +7199,6 @@ export interface DescribeRuleTemplateResponse {
7200
7199
  RequestId?: string
7201
7200
  }
7202
7201
 
7203
- /**
7204
- * DescribeKafkaTopicInfo返回参数结构体
7205
- */
7206
- export interface DescribeKafkaTopicInfoResponse {
7207
- /**
7208
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7209
- */
7210
- RequestId?: string
7211
- }
7212
-
7213
7202
  /**
7214
7203
  * 画布所需的信息
7215
7204
  */
@@ -9128,6 +9117,10 @@ export interface DescribeBaselineAllTaskDagRequest {
9128
9117
  * 1
9129
9118
  */
9130
9119
  ProjectId: string
9120
+ /**
9121
+ * 1
9122
+ */
9123
+ BaselineTaskId?: string
9131
9124
  }
9132
9125
 
9133
9126
  /**
@@ -17874,6 +17867,10 @@ export interface DescribeTaskByStatusReportRequest {
17874
17867
  * 无
17875
17868
  */
17876
17869
  InCharge?: string
17870
+ /**
17871
+ * 工作流ID
17872
+ */
17873
+ WorkflowId?: string
17877
17874
  }
17878
17875
 
17879
17876
  /**
@@ -18353,6 +18350,10 @@ export interface DescribeSchedulerTaskCntByStatusRequest {
18353
18350
  * 1
18354
18351
  */
18355
18352
  InCharge?: string
18353
+ /**
18354
+ * 工作流ID
18355
+ */
18356
+ WorkflowId?: string
18356
18357
  }
18357
18358
 
18358
18359
  /**
@@ -20777,6 +20778,11 @@ WAITINT_TO_RUN:等待运行 / RUNNING: 正在运行 / COMPLETED: 执行成功 /
20777
20778
  注意:此字段可能返回 null,表示取不到有效值。
20778
20779
  */
20779
20780
  AppId?: string
20781
+ /**
20782
+ * 关键路径依赖
20783
+ 注意:此字段可能返回 null,表示取不到有效值。
20784
+ */
20785
+ CriticalDependency?: string
20780
20786
  }
20781
20787
 
20782
20788
  /**
@@ -21153,6 +21159,11 @@ export interface RuntimeInstanceCntTop {
21153
21159
  注意:此字段可能返回 null,表示取不到有效值。
21154
21160
  */
21155
21161
  CurRunTime?: string
21162
+ /**
21163
+ * 等待调度耗时
21164
+ 注意:此字段可能返回 null,表示取不到有效值。
21165
+ */
21166
+ WaitScheduleTime?: number
21156
21167
  }
21157
21168
 
21158
21169
  /**
@@ -23322,6 +23333,10 @@ export interface DescribeStatisticInstanceStatusTrendOpsRequest {
23322
23333
  * 1
23323
23334
  */
23324
23335
  AverageWindowSize?: number
23336
+ /**
23337
+ * 工作流ID
23338
+ */
23339
+ WorkflowId?: string
23325
23340
  }
23326
23341
 
23327
23342
  /**
@@ -23622,7 +23637,7 @@ export interface CreateDataSourceResponse {
23622
23637
  * 主键ID
23623
23638
  注意:此字段可能返回 null,表示取不到有效值。
23624
23639
  */
23625
- Data: number
23640
+ Data?: number
23626
23641
  /**
23627
23642
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23628
23643
  */
@@ -24375,6 +24390,10 @@ export interface DescribeSchedulerInstanceStatusRequest {
24375
24390
  * 责任人
24376
24391
  */
24377
24392
  InCharge?: string
24393
+ /**
24394
+ * 工作流ID
24395
+ */
24396
+ WorkflowId?: string
24378
24397
  }
24379
24398
 
24380
24399
  /**
@@ -24594,6 +24613,18 @@ export interface DescribeSchedulerRunTimeInstanceCntByStatusRequest {
24594
24613
  * 1
24595
24614
  */
24596
24615
  InCharge?: string
24616
+ /**
24617
+ * 工作流ID
24618
+ */
24619
+ WorkflowId?: string
24620
+ /**
24621
+ * 排序字段
24622
+ */
24623
+ SortItem?: string
24624
+ /**
24625
+ * 升序降序
24626
+ */
24627
+ SortType?: string
24597
24628
  }
24598
24629
 
24599
24630
  /**
@@ -25339,6 +25370,10 @@ export interface DescribeTaskByCycleRequest {
25339
25370
  * 1
25340
25371
  */
25341
25372
  InCharge?: string
25373
+ /**
25374
+ * 工作流ID
25375
+ */
25376
+ WorkflowId?: string
25342
25377
  }
25343
25378
 
25344
25379
  /**
@@ -26893,6 +26928,10 @@ export interface DescribeBaselineInstanceGanttRequest {
26893
26928
  * 项目id
26894
26929
  */
26895
26930
  ProjectId: string
26931
+ /**
26932
+ * 保障任务id
26933
+ */
26934
+ PromiseTaskId?: string
26896
26935
  }
26897
26936
 
26898
26937
  /**
@@ -3149,6 +3149,10 @@ export interface ControlDeviceRequest {
3149
3149
  * 应用token
3150
3150
  */
3151
3151
  ApplicationToken: string
3152
+ /**
3153
+ * 是否同步返回设备下控ack结果
3154
+ */
3155
+ IsSynchronized?: boolean
3152
3156
  }
3153
3157
 
3154
3158
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.781";
1
+ export declare const sdkVersion = "4.0.783";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.781";
4
+ exports.sdkVersion = "4.0.783";
@@ -297,7 +297,7 @@ ListDiagnoseReport 用于获取用户诊断URL访问后各个子任务的简要
297
297
  CreateClsLogTopic(req: CreateClsLogTopicRequest, cb?: (error: string, rep: CreateClsLogTopicResponse) => void): Promise<CreateClsLogTopicResponse>;
298
298
  /**
299
299
  * PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点,支持指定加速区域预热。
300
- 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点,所产生的边缘层流量会计入计费流量。
300
+ 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条 URL,每次提交的数量会消耗配额总数。如:1次提交500条URL全球预热,此时境内、境外预热 URL 各剩余 500条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点。
301
301
  */
302
302
  PushUrlsCache(req: PushUrlsCacheRequest, cb?: (error: string, rep: PushUrlsCacheResponse) => void): Promise<PushUrlsCacheResponse>;
303
303
  /**
@@ -433,7 +433,7 @@ ListDiagnoseReport 用于获取用户诊断URL访问后各个子任务的简要
433
433
  }
434
434
  /**
435
435
  * PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点,支持指定加速区域预热。
436
- 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点,所产生的边缘层流量会计入计费流量。
436
+ 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条 URL,每次提交的数量会消耗配额总数。如:1次提交500条URL全球预热,此时境内、境外预热 URL 各剩余 500条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点。
437
437
  */
438
438
  async PushUrlsCache(req, cb) {
439
439
  return this.request("PushUrlsCache", req, cb);
@@ -9863,7 +9863,7 @@ export interface PushUrlsCacheResponse {
9863
9863
  /**
9864
9864
  * 此批提交的任务 ID
9865
9865
  */
9866
- TaskId: string;
9866
+ TaskId?: string;
9867
9867
  /**
9868
9868
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9869
9869
  */
@@ -1581,6 +1581,10 @@ export interface DeployResourceRequest {
1581
1581
  * 需要开通服务的子网名称
1582
1582
  */
1583
1583
  SubnetName?: string;
1584
+ /**
1585
+ * 需要开通实例所属的CDC集群ID
1586
+ */
1587
+ CdcClusterId?: string;
1584
1588
  }
1585
1589
  /**
1586
1590
  * SearchSession返回参数结构体
@@ -605,11 +605,11 @@ export interface DescribeRedisTopBigKeysResponse {
605
605
  /**
606
606
  * top key列表。
607
607
  */
608
- TopKeys: Array<RedisKeySpaceData>;
608
+ TopKeys?: Array<RedisKeySpaceData>;
609
609
  /**
610
610
  * 采集时间戳(秒)。
611
611
  */
612
- Timestamp: number;
612
+ Timestamp?: number;
613
613
  /**
614
614
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
615
615
  */
@@ -2074,6 +2074,11 @@ export interface InstanceConfs {
2074
2074
  注意:此字段可能返回 null,表示取不到有效值。
2075
2075
  */
2076
2076
  KeyDelimiters?: Array<string>;
2077
+ /**
2078
+ * 分片节点数量。
2079
+ 注意:此字段可能返回 null,表示取不到有效值。
2080
+ */
2081
+ ShardNum?: string;
2077
2082
  }
2078
2083
  /**
2079
2084
  * 接收组信息
@@ -3047,6 +3052,14 @@ export interface DescribeRedisTopBigKeysRequest {
3047
3052
  * 查询数目,默认为20,最大值为100。
3048
3053
  */
3049
3054
  Limit?: number;
3055
+ /**
3056
+ * 异步任务ID。当为空时,选择最近任务的ID。
3057
+ */
3058
+ AsyncRequestId?: number;
3059
+ /**
3060
+ * 分片节点序号列表。当列表为空时,选择所有分片节点。
3061
+ */
3062
+ ShardIds?: Array<number | bigint>;
3050
3063
  }
3051
3064
  /**
3052
3065
  * DescribeIndexRecommendInfo返回参数结构体
@@ -88,7 +88,7 @@ export declare class Client extends AbstractClient {
88
88
  */
89
89
  UpdateRule(req: UpdateRuleRequest, cb?: (error: string, rep: UpdateRuleResponse) => void): Promise<UpdateRuleResponse>;
90
90
  /**
91
- * 查询日志索引维度值
91
+ * 前置条件:需开启事件存储;事件查询维度值
92
92
  */
93
93
  DescribeLogTagValue(req: DescribeLogTagValueRequest, cb?: (error: string, rep: DescribeLogTagValueResponse) => void): Promise<DescribeLogTagValueResponse>;
94
94
  /**
@@ -104,7 +104,7 @@ export declare class Client extends AbstractClient {
104
104
  */
105
105
  GetRule(req: GetRuleRequest, cb?: (error: string, rep: GetRuleResponse) => void): Promise<GetRuleResponse>;
106
106
  /**
107
- * 日志检索
107
+ * 前置条件:开启事件存储;查询历史推送事件
108
108
  */
109
109
  SearchLog(req: SearchLogRequest, cb?: (error: string, rep: SearchLogResponse) => void): Promise<SearchLogResponse>;
110
110
  /**
@@ -148,7 +148,7 @@ class Client extends abstract_client_1.AbstractClient {
148
148
  return this.request("UpdateRule", req, cb);
149
149
  }
150
150
  /**
151
- * 查询日志索引维度值
151
+ * 前置条件:需开启事件存储;事件查询维度值
152
152
  */
153
153
  async DescribeLogTagValue(req, cb) {
154
154
  return this.request("DescribeLogTagValue", req, cb);
@@ -172,7 +172,7 @@ class Client extends abstract_client_1.AbstractClient {
172
172
  return this.request("GetRule", req, cb);
173
173
  }
174
174
  /**
175
- * 日志检索
175
+ * 前置条件:开启事件存储;查询历史推送事件
176
176
  */
177
177
  async SearchLog(req, cb) {
178
178
  return this.request("SearchLog", req, cb);
@@ -135,12 +135,12 @@ export interface CreateTransformationRequest {
135
135
  */
136
136
  export interface SearchLogResponse {
137
137
  /**
138
- * 日志总数
138
+ * 事件总数
139
139
  注意:此字段可能返回 null,表示取不到有效值。
140
140
  */
141
141
  Total?: number;
142
142
  /**
143
- * 每页日志条数
143
+ * 每页事件条数
144
144
  注意:此字段可能返回 null,表示取不到有效值。
145
145
  */
146
146
  Limit?: number;
@@ -150,7 +150,7 @@ export interface SearchLogResponse {
150
150
  */
151
151
  Page?: number;
152
152
  /**
153
- * 日志检索结果
153
+ * 事件查询结果
154
154
  注意:此字段可能返回 null,表示取不到有效值。
155
155
  */
156
156
  Results?: Array<SearchLogResult>;
@@ -1751,7 +1751,7 @@ export interface DeleteTargetRequest {
1751
1751
  */
1752
1752
  export interface DescribeLogTagValueResponse {
1753
1753
  /**
1754
- * 索引检索维度值
1754
+ * 事件查询维度值结果
1755
1755
  注意:此字段可能返回 null,表示取不到有效值。
1756
1756
  */
1757
1757
  Results?: Array<string>;
@@ -501,15 +501,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
501
501
  */
502
502
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
503
503
  /**
504
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
504
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
505
505
 
506
506
  **注意**
507
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
508
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
509
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
510
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
507
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
508
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
509
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
511
510
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
512
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
511
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
513
512
  */
514
513
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
515
514
  /**
@@ -735,12 +734,68 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
735
734
  */
736
735
  DeleteExtendedServiceAuthInfos(req: DeleteExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DeleteExtendedServiceAuthInfosResponse) => void): Promise<DeleteExtendedServiceAuthInfosResponse>;
737
736
  /**
738
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
737
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
738
+ 支持以下场景
739
+ <table>
740
+ <tbody>
741
+ <tr>
742
+ <td>生成端</td>
743
+ <td >入参</td>
744
+ <td>提醒方式</td>
745
+ </tr>
746
+ <tr>
747
+ <td>普通saas员工</td>
748
+ <td>不需要传递 InvitationNotifyType</td>
749
+ <td>短信</td>
750
+ </tr>
751
+ <tr>
752
+ <td>企微员工</td>
753
+ <td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
754
+ <td>企微内部实名消息</td>
755
+ </tr>
756
+ <tr>
757
+ <td>H5端 saas员工</td>
758
+ <td>传递 InvitationNotifyType = H5,不支持企微</td>
759
+ <td>生成H5链接</td>
760
+ </tr>
761
+ </tbody>
762
+ </table>
763
+ 注意:
764
+
765
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
766
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
739
767
  */
740
768
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
741
769
  /**
742
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
743
- 可进行批量操作,Employees中的userID与openID二选一必填
770
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
771
+ 修改手机号的时候,支持以下场景进行提醒通知
772
+ <table>
773
+ <tbody>
774
+ <tr>
775
+ <td>生成端</td>
776
+ <td>入参</td>
777
+ <td>提醒方式</td>
778
+ </tr>
779
+ <tr>
780
+ <td>普通saas员工</td>
781
+ <td>不需要传递 InvitationNotifyType</td>
782
+ <td>短信</td>
783
+ </tr>
784
+ <tr>
785
+ <td>企微员工</td>
786
+ <td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
787
+ <td>企微内部实名消息</td>
788
+ </tr>
789
+ <tr>
790
+ <td>H5端 saas员工</td>
791
+ <td>传递 InvitationNotifyType = H5,不支持企微</td>
792
+ <td>生成H5链接</td>
793
+ </tr>
794
+ </tbody>
795
+ </table>
796
+ 注意:
797
+
798
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
744
799
  */
745
800
  UpdateIntegrationEmployees(req: UpdateIntegrationEmployeesRequest, cb?: (error: string, rep: UpdateIntegrationEmployeesResponse) => void): Promise<UpdateIntegrationEmployeesResponse>;
746
801
  }