tencentcloud-sdk-nodejs 4.0.581 → 4.0.583

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 (100) hide show
  1. package/CHANGELOG.md +498 -0
  2. package/SERVICE_CHANGELOG.md +753 -32
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdb/v20170320/cdb_client.ts +24 -12
  7. package/src/services/cdn/v20180606/cdn_models.ts +8 -2
  8. package/src/services/ckafka/v20190819/ckafka_client.ts +12 -0
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +32 -0
  10. package/src/services/cls/v20201016/cls_client.ts +177 -162
  11. package/src/services/cls/v20201016/cls_models.ts +195 -21
  12. package/src/services/cwp/v20180228/cwp_client.ts +4 -2
  13. package/src/services/cwp/v20180228/cwp_models.ts +11 -2
  14. package/src/services/dlc/v20210125/dlc_models.ts +57 -7
  15. package/src/services/domain/v20180808/domain_client.ts +2 -3
  16. package/src/services/domain/v20180808/domain_models.ts +21 -3
  17. package/src/services/ess/v20201111/ess_client.ts +28 -3
  18. package/src/services/ess/v20201111/ess_models.ts +118 -38
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +1 -1
  20. package/src/services/lcic/v20220817/lcic_client.ts +69 -21
  21. package/src/services/lcic/v20220817/lcic_models.ts +205 -33
  22. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -1
  23. package/src/services/live/v20180801/live_models.ts +21 -0
  24. package/src/services/postgres/v20170312/postgres_client.ts +1 -0
  25. package/src/services/postgres/v20170312/postgres_models.ts +36 -1
  26. package/src/services/redis/v20180412/redis_client.ts +1 -1
  27. package/src/services/redis/v20180412/redis_models.ts +95 -63
  28. package/src/services/rum/v20210622/rum_client.ts +86 -38
  29. package/src/services/rum/v20210622/rum_models.ts +283 -13
  30. package/src/services/sqlserver/v20180328/sqlserver_client.ts +61 -23
  31. package/src/services/sqlserver/v20180328/sqlserver_models.ts +239 -34
  32. package/src/services/tcss/v20201101/tcss_models.ts +5 -4
  33. package/src/services/tke/v20180525/tke_client.ts +12 -0
  34. package/src/services/tke/v20180525/tke_models.ts +31 -0
  35. package/src/services/trp/v20210515/trp_client.ts +55 -17
  36. package/src/services/trp/v20210515/trp_models.ts +157 -26
  37. package/src/services/tsf/v20180326/tsf_client.ts +49 -25
  38. package/src/services/tsf/v20180326/tsf_models.ts +142 -5
  39. package/src/services/waf/v20180125/waf_client.ts +40 -15
  40. package/src/services/waf/v20180125/waf_models.ts +325 -29
  41. package/tencentcloud/common/sdk_version.d.ts +1 -1
  42. package/tencentcloud/common/sdk_version.js +1 -1
  43. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +18 -6
  44. package/tencentcloud/services/cdb/v20170320/cdb_client.js +18 -6
  45. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +7 -2
  46. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  47. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  48. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +28 -0
  49. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +161 -157
  50. package/tencentcloud/services/cls/v20201016/cls_client.js +163 -157
  51. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +176 -30
  52. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +3 -1
  53. package/tencentcloud/services/cwp/v20180228/cwp_client.js +3 -1
  54. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +10 -2
  55. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +48 -7
  56. package/tencentcloud/services/domain/v20180808/domain_client.d.ts +0 -1
  57. package/tencentcloud/services/domain/v20180808/domain_client.js +0 -1
  58. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +18 -3
  59. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +12 -3
  60. package/tencentcloud/services/ess/v20201111/ess_client.js +15 -2
  61. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +105 -37
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  63. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +23 -7
  64. package/tencentcloud/services/lcic/v20220817/lcic_client.js +33 -9
  65. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +176 -29
  66. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +22 -1
  67. package/tencentcloud/services/live/v20180801/live_models.d.ts +18 -0
  68. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +30 -1
  69. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  70. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  71. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +80 -48
  72. package/tencentcloud/services/rum/v20210622/rum_client.d.ts +29 -13
  73. package/tencentcloud/services/rum/v20210622/rum_client.js +42 -18
  74. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +236 -12
  75. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +21 -9
  76. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +30 -12
  77. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +202 -30
  78. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +4 -3
  79. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +5 -1
  80. package/tencentcloud/services/tke/v20180525/tke_client.js +6 -0
  81. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +27 -0
  82. package/tencentcloud/services/trp/v20210515/trp_client.d.ts +17 -5
  83. package/tencentcloud/services/trp/v20210515/trp_client.js +24 -6
  84. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +140 -26
  85. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +17 -9
  86. package/tencentcloud/services/tsf/v20180326/tsf_client.js +24 -12
  87. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +118 -4
  88. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +14 -6
  89. package/tencentcloud/services/waf/v20180125/waf_client.js +19 -7
  90. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +276 -27
  91. package/test/ckafka.v20190819.test.js +10 -0
  92. package/test/cls.v20201016.test.js +12 -2
  93. package/test/ess.v20201111.test.js +20 -0
  94. package/test/lcic.v20220817.test.js +46 -6
  95. package/test/rum.v20210622.test.js +52 -12
  96. package/test/sqlserver.v20180328.test.js +44 -14
  97. package/test/tke.v20180525.test.js +10 -0
  98. package/test/trp.v20210515.test.js +34 -4
  99. package/test/tsf.v20180326.test.js +28 -8
  100. package/test/waf.v20180125.test.js +24 -4
@@ -2633,6 +2633,7 @@ export interface DescribeFileTamperEventsRequest {
2633
2633
  <li>ModifyTime - String - 是否必填:否 - 最近发生时间</li>
2634
2634
  <li>Uuid- String - 是否必填:否 - 主机uuid查询</li>
2635
2635
  <li>RuleCategory- string - 是否必填:否 - 规则类别 0 系统规则 1 自定义规则</li>
2636
+ <li>FileAction- string - 是否必填:否 - 威胁行为 read 读取文件 write 写文件</li>
2636
2637
  */
2637
2638
  Filters?: Array<Filters>
2638
2639
 
@@ -4274,12 +4275,12 @@ export interface DescribeFileTamperEventsResponse {
4274
4275
  * 核心文件事件列表
4275
4276
  注意:此字段可能返回 null,表示取不到有效值。
4276
4277
  */
4277
- List: Array<FileTamperEvent>
4278
+ List?: Array<FileTamperEvent>
4278
4279
 
4279
4280
  /**
4280
4281
  * 数据总条数
4281
4282
  */
4282
- TotalCount: number
4283
+ TotalCount?: number
4283
4284
 
4284
4285
  /**
4285
4286
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -10050,6 +10051,14 @@ export interface FileTamperEvent {
10050
10051
  注意:此字段可能返回 null,表示取不到有效值。
10051
10052
  */
10052
10053
  MachineExtraInfo?: MachineExtraInfo
10054
+
10055
+ /**
10056
+ * 文件威胁行为
10057
+ <li>read 读取文件</li>
10058
+ <li>write 修改文件</li>
10059
+ 注意:此字段可能返回 null,表示取不到有效值。
10060
+ */
10061
+ FileAction?: string
10053
10062
  }
10054
10063
 
10055
10064
  /**
@@ -89,6 +89,11 @@ export interface DescribeNotebookSessionStatementRequest {
89
89
  * Session Statement唯一标识
90
90
  */
91
91
  StatementId: string
92
+
93
+ /**
94
+ * 任务唯一标识
95
+ */
96
+ TaskId?: string
92
97
  }
93
98
 
94
99
  /**
@@ -303,19 +308,25 @@ export interface ListTaskJobLogDetailResponse {
303
308
  * 下一次分页参数
304
309
  注意:此字段可能返回 null,表示取不到有效值。
305
310
  */
306
- Context: string
311
+ Context?: string
307
312
 
308
313
  /**
309
314
  * 是否获取完结
310
315
  注意:此字段可能返回 null,表示取不到有效值。
311
316
  */
312
- ListOver: boolean
317
+ ListOver?: boolean
313
318
 
314
319
  /**
315
320
  * 日志详情
316
321
  注意:此字段可能返回 null,表示取不到有效值。
317
322
  */
318
- Results: Array<JobLogResult>
323
+ Results?: Array<JobLogResult>
324
+
325
+ /**
326
+ * 日志url
327
+ 注意:此字段可能返回 null,表示取不到有效值。
328
+ */
329
+ LogUrl?: string
319
330
 
320
331
  /**
321
332
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -910,6 +921,12 @@ export interface SparkJobInfo {
910
921
  注意:此字段可能返回 null,表示取不到有效值。
911
922
  */
912
923
  SparkImageVersion?: string
924
+
925
+ /**
926
+ * 查询脚本关联id
927
+ 注意:此字段可能返回 null,表示取不到有效值。
928
+ */
929
+ SessionId?: string
913
930
  }
914
931
 
915
932
  /**
@@ -1570,6 +1587,11 @@ export interface ModifySparkAppRequest {
1570
1587
  * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于AppExecutorNums
1571
1588
  */
1572
1589
  AppExecutorMaxNumbers?: number
1590
+
1591
+ /**
1592
+ * 关联dlc查询脚本
1593
+ */
1594
+ SessionId?: string
1573
1595
  }
1574
1596
 
1575
1597
  /**
@@ -2046,6 +2068,11 @@ export interface ListTaskJobLogDetailRequest {
2046
2068
  * 预览日志的通用过滤条件
2047
2069
  */
2048
2070
  Filters?: Array<Filter>
2071
+
2072
+ /**
2073
+ * SparkSQL任务唯一ID
2074
+ */
2075
+ BatchId?: string
2049
2076
  }
2050
2077
 
2051
2078
  /**
@@ -2442,22 +2469,22 @@ export interface DescribeSparkAppJobsRequest {
2442
2469
  Filters?: Array<Filter>
2443
2470
 
2444
2471
  /**
2445
- * 更新时间起始点
2472
+ * 更新时间起始点,支持格式:yyyy-MM-dd HH:mm:ss
2446
2473
  */
2447
2474
  StartTime?: string
2448
2475
 
2449
2476
  /**
2450
- * 更新时间截止点
2477
+ * 更新时间截止点,支持格式:yyyy-MM-dd HH:mm:ss
2451
2478
  */
2452
2479
  EndTime?: string
2453
2480
 
2454
2481
  /**
2455
- * 查询列表偏移量
2482
+ * 查询列表偏移量, 默认值0
2456
2483
  */
2457
2484
  Offset?: number
2458
2485
 
2459
2486
  /**
2460
- * 查询列表限制数量
2487
+ * 查询列表限制数量, 默认值100
2461
2488
  */
2462
2489
  Limit?: number
2463
2490
  }
@@ -5203,6 +5230,12 @@ export interface JobLogResult {
5203
5230
  注意:此字段可能返回 null,表示取不到有效值。
5204
5231
  */
5205
5232
  LogJson: string
5233
+
5234
+ /**
5235
+ * 日志ID
5236
+ 注意:此字段可能返回 null,表示取不到有效值。
5237
+ */
5238
+ PkgLogId?: string
5206
5239
  }
5207
5240
 
5208
5241
  /**
@@ -5892,6 +5925,11 @@ export interface CreateSparkAppRequest {
5892
5925
  * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于AppExecutorNums
5893
5926
  */
5894
5927
  AppExecutorMaxNumbers?: number
5928
+
5929
+ /**
5930
+ * 关联dlc查询脚本id
5931
+ */
5932
+ SessionId?: string
5895
5933
  }
5896
5934
 
5897
5935
  /**
@@ -6237,6 +6275,18 @@ export interface DataEngineInfo {
6237
6275
  注意:此字段可能返回 null,表示取不到有效值。
6238
6276
  */
6239
6277
  StartStandbyCluster?: boolean
6278
+
6279
+ /**
6280
+ * spark jar 包年包月集群是否开启弹性
6281
+ 注意:此字段可能返回 null,表示取不到有效值。
6282
+ */
6283
+ ElasticSwitch?: boolean
6284
+
6285
+ /**
6286
+ * spark jar 包年包月集群弹性上限
6287
+ 注意:此字段可能返回 null,表示取不到有效值。
6288
+ */
6289
+ ElasticLimit?: number
6240
6290
  }
6241
6291
 
6242
6292
  /**
@@ -236,9 +236,8 @@ export class Client extends AbstractClient {
236
236
  }
237
237
 
238
238
  /**
239
- * 本接口 (DescribeTemplateList) 用于获取信息模板列表。
240
-
241
- */
239
+ * 本接口 (DescribeTemplateList) 用于获取信息模板列表。
240
+ */
242
241
  async DescribeTemplateList(
243
242
  req: DescribeTemplateListRequest,
244
243
  cb?: (error: string, rep: DescribeTemplateListResponse) => void
@@ -760,12 +760,12 @@ export interface DescribeTemplateListResponse {
760
760
  /**
761
761
  * 模板数量。
762
762
  */
763
- TotalCount: number
763
+ TotalCount?: number
764
764
 
765
765
  /**
766
766
  * 模板详细信息列表。
767
767
  */
768
- TemplateSet: Array<TemplateInfo>
768
+ TemplateSet?: Array<TemplateInfo>
769
769
 
770
770
  /**
771
771
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -963,7 +963,7 @@ export interface CreateTemplateResponse {
963
963
  /**
964
964
  * 模板信息
965
965
  */
966
- Template: TemplateInfo
966
+ Template?: TemplateInfo
967
967
 
968
968
  /**
969
969
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1017,6 +1017,24 @@ GZJGZY: 公证机构执业证。
1017
1017
  * 证件照片地址。
1018
1018
  */
1019
1019
  ImgUrl: string
1020
+
1021
+ /**
1022
+ * 联系人证件号码。
1023
+ 注意:此字段可能返回 null,表示取不到有效值。
1024
+ */
1025
+ RegistrantCertificateCode?: string
1026
+
1027
+ /**
1028
+ * 联系人证件类型。
1029
+ 注意:此字段可能返回 null,表示取不到有效值。
1030
+ */
1031
+ RegistrantCertificateType?: string
1032
+
1033
+ /**
1034
+ * 联系人证件照片地址。
1035
+ 注意:此字段可能返回 null,表示取不到有效值。
1036
+ */
1037
+ RegistrantImgUrl?: string
1020
1038
  }
1021
1039
 
1022
1040
  /**
@@ -31,6 +31,7 @@ import {
31
31
  FlowCreateApprover,
32
32
  DescribeThirdPartyAuthCodeResponse,
33
33
  DisableUserAutoSignResponse,
34
+ BindEmployeeUserIdWithClientOpenIdResponse,
34
35
  CreateIntegrationEmployeesRequest,
35
36
  CreateConvertTaskApiRequest,
36
37
  CreateFlowEvidenceReportRequest,
@@ -54,8 +55,9 @@ import {
54
55
  CreateSchemeUrlRequest,
55
56
  AutoSignConfig,
56
57
  DescribeThirdPartyAuthCodeRequest,
58
+ UnbindEmployeeUserIdWithClientOpenIdResponse,
57
59
  CreateReleaseFlowResponse,
58
- DescribeFlowInfoRequest,
60
+ BindEmployeeUserIdWithClientOpenIdRequest,
59
61
  DeleteSealPoliciesResponse,
60
62
  OrganizationInfo,
61
63
  DescribeUserAutoSignStatusResponse,
@@ -72,6 +74,7 @@ import {
72
74
  SuccessDeleteStaffData,
73
75
  CreateConvertTaskApiResponse,
74
76
  CreateFlowSignReviewRequest,
77
+ UnbindEmployeeUserIdWithClientOpenIdRequest,
75
78
  CreateSchemeUrlResponse,
76
79
  CreateUserAutoSignEnableUrlResponse,
77
80
  CreateFlowSignUrlResponse,
@@ -146,6 +149,7 @@ import {
146
149
  RelieveInfo,
147
150
  CreateBatchCancelFlowUrlRequest,
148
151
  CreateMultiFlowSignQRCodeRequest,
152
+ DescribeFlowInfoRequest,
149
153
  DescribeFlowInfoResponse,
150
154
  CcInfo,
151
155
  CreateFlowResponse,
@@ -274,8 +278,19 @@ callbackinfo包含: 回调地址和签名key
274
278
  }
275
279
 
276
280
  /**
277
- * 指定需要批量撤回的签署流程Id,获取批量撤销链接
278
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
281
+ * 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
282
+ */
283
+ async UnbindEmployeeUserIdWithClientOpenId(
284
+ req: UnbindEmployeeUserIdWithClientOpenIdRequest,
285
+ cb?: (error: string, rep: UnbindEmployeeUserIdWithClientOpenIdResponse) => void
286
+ ): Promise<UnbindEmployeeUserIdWithClientOpenIdResponse> {
287
+ return this.request("UnbindEmployeeUserIdWithClientOpenId", req, cb)
288
+ }
289
+
290
+ /**
291
+ * 注:此接口建会废弃,请使用撤销单个签署流程(CancelFlow)接口。
292
+ 指定需要批量撤回的签署流程Id,获取批量撤销链接。
293
+ 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。
279
294
  */
280
295
  async CreateBatchCancelFlowUrl(
281
296
  req: CreateBatchCancelFlowUrlRequest,
@@ -284,6 +299,16 @@ callbackinfo包含: 回调地址和签名key
284
299
  return this.request("CreateBatchCancelFlowUrl", req, cb)
285
300
  }
286
301
 
302
+ /**
303
+ * 将电子签系统员工userId与客户系统员工openId进行绑定
304
+ */
305
+ async BindEmployeeUserIdWithClientOpenId(
306
+ req: BindEmployeeUserIdWithClientOpenIdRequest,
307
+ cb?: (error: string, rep: BindEmployeeUserIdWithClientOpenIdResponse) => void
308
+ ): Promise<BindEmployeeUserIdWithClientOpenIdResponse> {
309
+ return this.request("BindEmployeeUserIdWithClientOpenId", req, cb)
310
+ }
311
+
287
312
  /**
288
313
  * 本接口(CreatePreparedPersonalEsign)用于创建导入个人印章。
289
314
  */
@@ -321,6 +321,21 @@ export interface DisableUserAutoSignResponse {
321
321
  RequestId?: string
322
322
  }
323
323
 
324
+ /**
325
+ * BindEmployeeUserIdWithClientOpenId返回参数结构体
326
+ */
327
+ export interface BindEmployeeUserIdWithClientOpenIdResponse {
328
+ /**
329
+ * 绑定是否成功,1表示成功,0表示失败
330
+ */
331
+ Status?: number
332
+
333
+ /**
334
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
335
+ */
336
+ RequestId?: string
337
+ }
338
+
324
339
  /**
325
340
  * CreateIntegrationEmployees请求参数结构体
326
341
  */
@@ -540,7 +555,7 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
540
555
  Status?: number
541
556
 
542
557
  /**
543
- * 是否到处当前成员企业数据
558
+ * 是否导出当前成员企业数据
544
559
  */
545
560
  Export?: boolean
546
561
 
@@ -671,11 +686,6 @@ export interface DescribeFlowTemplatesRequest {
671
686
  */
672
687
  Operator: UserInfo
673
688
 
674
- /**
675
- * 企业组织相关信息,一般不用填
676
- */
677
- Organization?: OrganizationInfo
678
-
679
689
  /**
680
690
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
681
691
  */
@@ -710,15 +720,20 @@ ApplicationId为空,查询所有应用下的模板列表
710
720
  */
711
721
  IsChannel?: boolean
712
722
 
723
+ /**
724
+ * 查询内容:0-模板列表及详情(默认),1-仅模板列表
725
+ */
726
+ ContentType?: number
727
+
713
728
  /**
714
729
  * 暂未开放
715
730
  */
716
- GenerateSource?: number
731
+ Organization?: OrganizationInfo
717
732
 
718
733
  /**
719
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
734
+ * 暂未开放
720
735
  */
721
- ContentType?: number
736
+ GenerateSource?: number
722
737
  }
723
738
 
724
739
  /**
@@ -834,7 +849,7 @@ export interface TemplateInfo {
834
849
  Promoter?: Recipient
835
850
 
836
851
  /**
837
- * 模板可用状态,取值:0未知,但默认会被转成启用;1启用(默认),2停用
852
+ * 模板可用状态,取值:1启用(默认),2停用
838
853
  */
839
854
  Available?: number
840
855
 
@@ -1110,6 +1125,21 @@ export interface DescribeThirdPartyAuthCodeRequest {
1110
1125
  AuthCode: string
1111
1126
  }
1112
1127
 
1128
+ /**
1129
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1130
+ */
1131
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1132
+ /**
1133
+ * 解绑是否成功,1表示成功,0表示失败
1134
+ */
1135
+ Status?: number
1136
+
1137
+ /**
1138
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1139
+ */
1140
+ RequestId?: string
1141
+ }
1142
+
1113
1143
  /**
1114
1144
  * CreateReleaseFlow返回参数结构体
1115
1145
  */
@@ -1127,23 +1157,23 @@ export interface CreateReleaseFlowResponse {
1127
1157
  }
1128
1158
 
1129
1159
  /**
1130
- * DescribeFlowInfo请求参数结构体
1160
+ * BindEmployeeUserIdWithClientOpenId请求参数结构体
1131
1161
  */
1132
- export interface DescribeFlowInfoRequest {
1162
+ export interface BindEmployeeUserIdWithClientOpenIdRequest {
1133
1163
  /**
1134
- * 需要查询的流程ID列表,限制最大100个
1164
+ * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
1135
1165
  */
1136
- FlowIds: Array<string>
1166
+ Operator: UserInfo
1137
1167
 
1138
1168
  /**
1139
- * 调用方用户信息
1169
+ * 电子签系统员工UserId
1140
1170
  */
1141
- Operator?: UserInfo
1171
+ UserId: string
1142
1172
 
1143
1173
  /**
1144
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1174
+ * 客户系统OpenId
1145
1175
  */
1146
- Agent?: Agent
1176
+ OpenId: string
1147
1177
  }
1148
1178
 
1149
1179
  /**
@@ -1161,27 +1191,27 @@ export interface DeleteSealPoliciesResponse {
1161
1191
  */
1162
1192
  export interface OrganizationInfo {
1163
1193
  /**
1164
- * 机构在平台的编号
1194
+ * 机构在平台的编号,内部字段,暂未开放
1165
1195
  */
1166
1196
  OrganizationId?: string
1167
1197
 
1168
1198
  /**
1169
- * 用户渠道
1199
+ * 用户渠道,内部字段,暂未开放
1170
1200
  */
1171
1201
  Channel?: string
1172
1202
 
1173
1203
  /**
1174
- * 用户在渠道的机构编号
1204
+ * 用户在渠道的机构编号,内部字段,暂未开放
1175
1205
  */
1176
1206
  OrganizationOpenId?: string
1177
1207
 
1178
1208
  /**
1179
- * 用户真实的IP
1209
+ * 用户真实的IP,内部字段,暂未开放
1180
1210
  */
1181
1211
  ClientIp?: string
1182
1212
 
1183
1213
  /**
1184
- * 机构的代理IP
1214
+ * 机构的代理IP,内部字段,暂未开放
1185
1215
  */
1186
1216
  ProxyIp?: string
1187
1217
  }
@@ -1312,12 +1342,12 @@ export interface FailedDeleteStaffData {
1312
1342
  */
1313
1343
  export interface PdfVerifyResult {
1314
1344
  /**
1315
- * 验签结果
1345
+ * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
1316
1346
  */
1317
1347
  VerifyResult: number
1318
1348
 
1319
1349
  /**
1320
- * 签署平台
1350
+ * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
1321
1351
  */
1322
1352
  SignPlatform: string
1323
1353
 
@@ -1581,6 +1611,26 @@ REJECT: 拒绝
1581
1611
  Agent?: Agent
1582
1612
  }
1583
1613
 
1614
+ /**
1615
+ * UnbindEmployeeUserIdWithClientOpenId请求参数结构体
1616
+ */
1617
+ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
1618
+ /**
1619
+ * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定
1620
+ */
1621
+ Operator: UserInfo
1622
+
1623
+ /**
1624
+ * 电子签系统员工UserId
1625
+ */
1626
+ UserId: string
1627
+
1628
+ /**
1629
+ * 客户系统OpenId
1630
+ */
1631
+ OpenId: string
1632
+ }
1633
+
1584
1634
  /**
1585
1635
  * CreateSchemeUrl返回参数结构体
1586
1636
  */
@@ -1862,22 +1912,22 @@ export interface UserInfo {
1862
1912
  UserId?: string
1863
1913
 
1864
1914
  /**
1865
- * 用户的来源渠道
1915
+ * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
1866
1916
  */
1867
1917
  Channel?: string
1868
1918
 
1869
1919
  /**
1870
- * 用户在渠道的编号
1920
+ * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
1871
1921
  */
1872
1922
  OpenId?: string
1873
1923
 
1874
1924
  /**
1875
- * 用户真实IP
1925
+ * 用户真实IP,内部字段,暂未开放
1876
1926
  */
1877
1927
  ClientIp?: string
1878
1928
 
1879
1929
  /**
1880
- * 用户代理IP
1930
+ * 用户代理IP,内部字段,暂未开放
1881
1931
  */
1882
1932
  ProxyIp?: string
1883
1933
  }
@@ -2061,7 +2111,7 @@ export interface GroupOrganization {
2061
2111
  UpdateTime?: number
2062
2112
 
2063
2113
  /**
2064
- * 成员企业状态
2114
+ * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
2065
2115
  注意:此字段可能返回 null,表示取不到有效值。
2066
2116
  */
2067
2117
  Status?: number
@@ -2144,7 +2194,7 @@ export interface CreateDocumentRequest {
2144
2194
  TemplateId: string
2145
2195
 
2146
2196
  /**
2147
- * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起
2197
+ * 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
2148
2198
  */
2149
2199
  FileNames: Array<string>
2150
2200
 
@@ -2245,7 +2295,7 @@ export interface DeleteIntegrationEmployeesRequest {
2245
2295
  Employees: Array<Staff>
2246
2296
 
2247
2297
  /**
2248
- * 代理信息
2298
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
2249
2299
  */
2250
2300
  Agent?: Agent
2251
2301
  }
@@ -2602,7 +2652,7 @@ export interface Recipient {
2602
2652
  RecipientId?: string
2603
2653
 
2604
2654
  /**
2605
- * 参与者类型(ENTERPRISE/INDIVIDUAL
2655
+ * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
2606
2656
  */
2607
2657
  RecipientType?: string
2608
2658
 
@@ -2652,7 +2702,7 @@ export interface Recipient {
2652
2702
  UserId?: string
2653
2703
 
2654
2704
  /**
2655
- * 发送方式(EMAIL/MOBILE
2705
+ * 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
2656
2706
  */
2657
2707
  DeliveryMethod?: string
2658
2708
 
@@ -2861,6 +2911,16 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
2861
2911
  * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
2862
2912
  */
2863
2913
  UrlType?: string
2914
+
2915
+ /**
2916
+ * 通知类型,默认不填为不通知开通方,填写 SMS 为短息通知。
2917
+ */
2918
+ NotifyType?: string
2919
+
2920
+ /**
2921
+ * 若上方填写为 SMS,则此处为手机号
2922
+ */
2923
+ NotifyAddress?: string
2864
2924
  }
2865
2925
 
2866
2926
  /**
@@ -3748,14 +3808,14 @@ export interface UpdateIntegrationEmployeesRequest {
3748
3808
  Operator: UserInfo
3749
3809
 
3750
3810
  /**
3751
- * 代理信息
3811
+ * 员工信息
3752
3812
  */
3753
- Agent: Agent
3813
+ Employees: Array<Staff>
3754
3814
 
3755
3815
  /**
3756
- * 员工信息
3816
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3757
3817
  */
3758
- Employees: Array<Staff>
3818
+ Agent?: Agent
3759
3819
  }
3760
3820
 
3761
3821
  /**
@@ -4090,6 +4150,26 @@ export interface CreateMultiFlowSignQRCodeRequest {
4090
4150
  ApproverRestrictions?: ApproverRestriction
4091
4151
  }
4092
4152
 
4153
+ /**
4154
+ * DescribeFlowInfo请求参数结构体
4155
+ */
4156
+ export interface DescribeFlowInfoRequest {
4157
+ /**
4158
+ * 需要查询的流程ID列表,限制最大100个
4159
+ */
4160
+ FlowIds: Array<string>
4161
+
4162
+ /**
4163
+ * 调用方用户信息
4164
+ */
4165
+ Operator?: UserInfo
4166
+
4167
+ /**
4168
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4169
+ */
4170
+ Agent?: Agent
4171
+ }
4172
+
4093
4173
  /**
4094
4174
  * DescribeFlowInfo返回参数结构体
4095
4175
  */
@@ -1257,7 +1257,7 @@ export interface Recipient {
1257
1257
  RecipientId?: string
1258
1258
 
1259
1259
  /**
1260
- * 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
1260
+ * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
1261
1261
  */
1262
1262
  RecipientType?: string
1263
1263