tencentcloud-sdk-nodejs 4.0.727 → 4.0.729

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 (99) hide show
  1. package/CHANGELOG.md +363 -0
  2. package/SERVICE_CHANGELOG.md +331 -127
  3. package/package.json +1 -1
  4. package/products.md +25 -24
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +1 -1
  7. package/src/services/ams/v20201229/ams_models.ts +4 -1
  8. package/src/services/as/v20180419/as_client.ts +1 -0
  9. package/src/services/as/v20180419/as_models.ts +60 -31
  10. package/src/services/cfg/v20210820/cfg_models.ts +30 -7
  11. package/src/services/cfs/v20190719/cfs_client.ts +3 -2
  12. package/src/services/cfs/v20190719/cfs_models.ts +3 -2
  13. package/src/services/cls/v20201016/cls_models.ts +11 -8
  14. package/src/services/csip/v20221121/csip_models.ts +2 -2
  15. package/src/services/dlc/v20210125/dlc_client.ts +17 -4
  16. package/src/services/dlc/v20210125/dlc_models.ts +128 -54
  17. package/src/services/drm/v20181115/drm_client.ts +12 -0
  18. package/src/services/drm/v20181115/drm_models.ts +40 -0
  19. package/src/services/dts/v20211206/dts_models.ts +1 -1
  20. package/src/services/ess/v20201111/ess_client.ts +28 -24
  21. package/src/services/ess/v20201111/ess_models.ts +53 -58
  22. package/src/services/essbasic/v20210526/essbasic_client.ts +97 -45
  23. package/src/services/essbasic/v20210526/essbasic_models.ts +378 -149
  24. package/src/services/faceid/v20180301/faceid_models.ts +38 -38
  25. package/src/services/hai/index.ts +5 -0
  26. package/src/services/hai/v20230812/hai_client.ts +40 -0
  27. package/src/services/hai/v20230812/hai_models.ts +80 -0
  28. package/src/services/hai/v20230812/index.ts +6 -0
  29. package/src/services/index.ts +1 -0
  30. package/src/services/live/v20180801/live_models.ts +23 -23
  31. package/src/services/ocr/v20181119/ocr_client.ts +10 -7
  32. package/src/services/ocr/v20181119/ocr_models.ts +403 -129
  33. package/src/services/trocket/v20230308/trocket_client.ts +18 -2
  34. package/src/services/trocket/v20230308/trocket_models.ts +91 -15
  35. package/src/services/vm/v20201229/vm_models.ts +14 -14
  36. package/src/services/vm/v20210922/vm_client.ts +43 -9
  37. package/src/services/vm/v20210922/vm_models.ts +84 -37
  38. package/src/services/wedata/v20210820/wedata_client.ts +3 -3
  39. package/src/services/wedata/v20210820/wedata_models.ts +13 -13
  40. package/src/services/weilingwith/v20230427/weilingwith_client.ts +652 -24
  41. package/src/services/weilingwith/v20230427/weilingwith_models.ts +1031 -30
  42. package/tencentcloud/common/sdk_version.d.ts +1 -1
  43. package/tencentcloud/common/sdk_version.js +1 -1
  44. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +1 -1
  45. package/tencentcloud/services/ams/v20201229/ams_client.js +1 -1
  46. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +4 -1
  47. package/tencentcloud/services/as/v20180419/as_models.d.ts +59 -31
  48. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +30 -7
  49. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +1 -0
  50. package/tencentcloud/services/cfs/v20190719/cfs_client.js +1 -0
  51. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +3 -2
  52. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +11 -8
  53. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +2 -2
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  55. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  56. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +125 -54
  57. package/tencentcloud/services/drm/v20181115/drm_client.d.ts +5 -1
  58. package/tencentcloud/services/drm/v20181115/drm_client.js +6 -0
  59. package/tencentcloud/services/drm/v20181115/drm_models.d.ts +38 -0
  60. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  61. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +28 -24
  62. package/tencentcloud/services/ess/v20201111/ess_client.js +28 -24
  63. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +53 -58
  64. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +81 -38
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +82 -37
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +372 -146
  67. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +38 -38
  68. package/tencentcloud/services/hai/index.d.ts +6 -0
  69. package/tencentcloud/services/hai/index.js +7 -0
  70. package/tencentcloud/services/hai/v20230812/hai_client.d.ts +14 -0
  71. package/tencentcloud/services/hai/v20230812/hai_client.js +37 -0
  72. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +61 -0
  73. package/tencentcloud/services/hai/v20230812/hai_models.js +18 -0
  74. package/tencentcloud/services/hai/v20230812/index.d.ts +6 -0
  75. package/tencentcloud/services/hai/v20230812/index.js +9 -0
  76. package/tencentcloud/services/index.d.ts +1 -0
  77. package/tencentcloud/services/index.js +2 -0
  78. package/tencentcloud/services/live/v20180801/live_models.d.ts +23 -23
  79. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  80. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +399 -128
  81. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +8 -1
  82. package/tencentcloud/services/trocket/v20230308/trocket_client.js +9 -0
  83. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +88 -15
  84. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +14 -14
  85. package/tencentcloud/services/vm/v20210922/vm_client.d.ts +41 -8
  86. package/tencentcloud/services/vm/v20210922/vm_client.js +41 -8
  87. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +83 -37
  88. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +3 -3
  89. package/tencentcloud/services/wedata/v20210820/wedata_client.js +3 -3
  90. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +13 -13
  91. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +215 -7
  92. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +321 -9
  93. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +921 -28
  94. package/test/dlc.v20210125.test.js +10 -0
  95. package/test/drm.v20181115.test.js +10 -0
  96. package/test/essbasic.v20210526.test.js +10 -0
  97. package/test/hai.v20230812.test.js +31 -0
  98. package/test/trocket.v20230308.test.js +10 -0
  99. package/test/weilingwith.v20230427.test.js +526 -6
@@ -31,6 +31,7 @@ import {
31
31
  CancelNotebookSessionStatementRequest,
32
32
  DescribeNotebookSessionStatementSqlResultRequest,
33
33
  DescribeDatabasesRequest,
34
+ IpPortPair,
34
35
  WorkGroupMessage,
35
36
  DeleteUserRequest,
36
37
  DescribeUserDataEngineConfigResponse,
@@ -59,7 +60,7 @@ import {
59
60
  DescribeTablesResponse,
60
61
  SparkJobInfo,
61
62
  SwitchDataEngineRequest,
62
- IpPortPair,
63
+ DescribeDataEngineEventsResponse,
63
64
  DeleteSparkAppRequest,
64
65
  ModifyDataEngineDescriptionResponse,
65
66
  RestartDataEngineResponse,
@@ -129,7 +130,7 @@ import {
129
130
  UpdateDataEngineResponse,
130
131
  DeleteUserResponse,
131
132
  DescribeDatabasesResponse,
132
- LockComponentInfo,
133
+ DescribeNotebookSessionStatementSqlResultResponse,
133
134
  DescribeNotebookSessionsResponse,
134
135
  DescribeDMSPartitionsRequest,
135
136
  SmartOptimizerWrittenPolicy,
@@ -153,7 +154,7 @@ import {
153
154
  CreateTaskRequest,
154
155
  DescribeNotebookSessionRequest,
155
156
  DescribeAdvancedStoreLocationResponse,
156
- UpgradeDataEngineImageRequest,
157
+ LockComponentInfo,
157
158
  CSV,
158
159
  ModifyUserTypeRequest,
159
160
  NotebookSessionStatementInfo,
@@ -262,11 +263,12 @@ import {
262
263
  FavorInfo,
263
264
  DropDMSTableRequest,
264
265
  CancelSparkSessionBatchSQLResponse,
265
- DescribeNotebookSessionStatementSqlResultResponse,
266
+ DescribeDataEngineEventsRequest,
266
267
  DMSPartition,
267
268
  ViewBaseInfo,
268
269
  DatabaseInfo,
269
270
  WorkGroupDetailInfo,
271
+ UpgradeDataEngineImageRequest,
270
272
  SuspendResumeDataEngineResponse,
271
273
  DescribeDMSPartitionsResponse,
272
274
  DeleteDataEngineRequest,
@@ -325,6 +327,7 @@ import {
325
327
  DescribeDatasourceConnectionRequest,
326
328
  CheckLockMetaDataResponse,
327
329
  DescribeNotebookSessionStatementsRequest,
330
+ HouseEventsInfo,
328
331
  AlterDMSDatabaseRequest,
329
332
  CheckDataEngineImageCanBeUpgradeRequest,
330
333
  StatementInformation,
@@ -1251,6 +1254,16 @@ export class Client extends AbstractClient {
1251
1254
  return this.request("DetachUserPolicy", req, cb)
1252
1255
  }
1253
1256
 
1257
+ /**
1258
+ * 查询数据引擎事件
1259
+ */
1260
+ async DescribeDataEngineEvents(
1261
+ req: DescribeDataEngineEventsRequest,
1262
+ cb?: (error: string, rep: DescribeDataEngineEventsResponse) => void
1263
+ ): Promise<DescribeDataEngineEventsResponse> {
1264
+ return this.request("DescribeDataEngineEvents", req, cb)
1265
+ }
1266
+
1254
1267
  /**
1255
1268
  * 解绑工作组鉴权策略
1256
1269
  */
@@ -319,6 +319,22 @@ export interface DescribeDatabasesRequest {
319
319
  Asc?: boolean
320
320
  }
321
321
 
322
+ /**
323
+ * ip端口对信息
324
+ */
325
+ export interface IpPortPair {
326
+ /**
327
+ * ip信息
328
+ 注意:此字段可能返回 null,表示取不到有效值。
329
+ */
330
+ Ip?: string
331
+ /**
332
+ * 端口信息
333
+ 注意:此字段可能返回 null,表示取不到有效值。
334
+ */
335
+ Port?: number
336
+ }
337
+
322
338
  /**
323
339
  * 工作组部分信息
324
340
  */
@@ -992,19 +1008,38 @@ export interface SwitchDataEngineRequest {
992
1008
  }
993
1009
 
994
1010
  /**
995
- * ip端口对信息
1011
+ * DescribeDataEngineEvents返回参数结构体
996
1012
  */
997
- export interface IpPortPair {
1013
+ export interface DescribeDataEngineEventsResponse {
998
1014
  /**
999
- * ip信息
1015
+ * 事件详细信息
1000
1016
  注意:此字段可能返回 null,表示取不到有效值。
1001
1017
  */
1002
- Ip?: string
1018
+ Events: Array<HouseEventsInfo>
1003
1019
  /**
1004
- * 端口信息
1020
+ * 分页号
1005
1021
  注意:此字段可能返回 null,表示取不到有效值。
1006
1022
  */
1007
- Port?: number
1023
+ Page: number
1024
+ /**
1025
+ * 分页大小
1026
+ 注意:此字段可能返回 null,表示取不到有效值。
1027
+ */
1028
+ Size: number
1029
+ /**
1030
+ * 总页数
1031
+ 注意:此字段可能返回 null,表示取不到有效值。
1032
+ */
1033
+ TotalPages: number
1034
+ /**
1035
+ * 总条数
1036
+ 注意:此字段可能返回 null,表示取不到有效值。
1037
+ */
1038
+ TotalCount: number
1039
+ /**
1040
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1041
+ */
1042
+ RequestId?: string
1008
1043
  }
1009
1044
 
1010
1045
  /**
@@ -2690,41 +2725,35 @@ export interface DescribeDatabasesResponse {
2690
2725
  }
2691
2726
 
2692
2727
  /**
2693
- * 元数据加锁内容
2728
+ * DescribeNotebookSessionStatementSqlResult返回参数结构体
2694
2729
  */
2695
- export interface LockComponentInfo {
2696
- /**
2697
- * 数据库名称
2698
- */
2699
- DbName: string
2700
- /**
2701
- * 表名称
2702
- */
2703
- TableName?: string
2730
+ export interface DescribeNotebookSessionStatementSqlResultResponse {
2704
2731
  /**
2705
- * 分区
2732
+ * 任务Id
2706
2733
  */
2707
- Partition?: string
2734
+ TaskId?: string
2708
2735
  /**
2709
- * 锁类型:SHARED_READ、SHARED_WRITE、EXCLUSIVE
2736
+ * 结果数据
2710
2737
  */
2711
- LockType?: string
2738
+ ResultSet?: string
2712
2739
  /**
2713
- * 锁级别:DB、TABLE、PARTITION
2740
+ * schema
2714
2741
  */
2715
- LockLevel?: string
2742
+ ResultSchema?: Array<Column>
2716
2743
  /**
2717
- * 锁操作:SELECT,INSERT,UPDATE,DELETE,UNSET,NO_TXN
2744
+ * 分页信息
2745
+ 注意:此字段可能返回 null,表示取不到有效值。
2718
2746
  */
2719
- DataOperationType?: string
2747
+ NextToken?: string
2720
2748
  /**
2721
- * 是否保持Acid
2749
+ * 存储结果地址
2750
+ 注意:此字段可能返回 null,表示取不到有效值。
2722
2751
  */
2723
- IsAcid?: boolean
2752
+ OutputPath?: string
2724
2753
  /**
2725
- * 是否动态分区写
2754
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2726
2755
  */
2727
- IsDynamicPartitionWrite?: boolean
2756
+ RequestId?: string
2728
2757
  }
2729
2758
 
2730
2759
  /**
@@ -3365,13 +3394,41 @@ export interface DescribeAdvancedStoreLocationResponse {
3365
3394
  }
3366
3395
 
3367
3396
  /**
3368
- * UpgradeDataEngineImage请求参数结构体
3397
+ * 元数据加锁内容
3369
3398
  */
3370
- export interface UpgradeDataEngineImageRequest {
3399
+ export interface LockComponentInfo {
3371
3400
  /**
3372
- * 引擎ID
3401
+ * 数据库名称
3373
3402
  */
3374
- DataEngineId: string
3403
+ DbName: string
3404
+ /**
3405
+ * 表名称
3406
+ */
3407
+ TableName?: string
3408
+ /**
3409
+ * 分区
3410
+ */
3411
+ Partition?: string
3412
+ /**
3413
+ * 锁类型:SHARED_READ、SHARED_WRITE、EXCLUSIVE
3414
+ */
3415
+ LockType?: string
3416
+ /**
3417
+ * 锁级别:DB、TABLE、PARTITION
3418
+ */
3419
+ LockLevel?: string
3420
+ /**
3421
+ * 锁操作:SELECT,INSERT,UPDATE,DELETE,UNSET,NO_TXN
3422
+ */
3423
+ DataOperationType?: string
3424
+ /**
3425
+ * 是否保持Acid
3426
+ */
3427
+ IsAcid?: boolean
3428
+ /**
3429
+ * 是否动态分区写
3430
+ */
3431
+ IsDynamicPartitionWrite?: boolean
3375
3432
  }
3376
3433
 
3377
3434
  /**
@@ -6077,35 +6134,21 @@ export interface CancelSparkSessionBatchSQLResponse {
6077
6134
  }
6078
6135
 
6079
6136
  /**
6080
- * DescribeNotebookSessionStatementSqlResult返回参数结构体
6137
+ * DescribeDataEngineEvents请求参数结构体
6081
6138
  */
6082
- export interface DescribeNotebookSessionStatementSqlResultResponse {
6083
- /**
6084
- * 任务Id
6085
- */
6086
- TaskId?: string
6087
- /**
6088
- * 结果数据
6089
- */
6090
- ResultSet?: string
6139
+ export interface DescribeDataEngineEventsRequest {
6091
6140
  /**
6092
- * schema
6093
- */
6094
- ResultSchema?: Array<Column>
6095
- /**
6096
- * 分页信息
6097
- 注意:此字段可能返回 null,表示取不到有效值。
6141
+ * 虚拟集群名称
6098
6142
  */
6099
- NextToken?: string
6143
+ DataEngineName: string
6100
6144
  /**
6101
- * 存储结果地址
6102
- 注意:此字段可能返回 null,表示取不到有效值。
6145
+ * 返回数量,默认为10,最大为100
6103
6146
  */
6104
- OutputPath?: string
6147
+ Limit?: number
6105
6148
  /**
6106
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6149
+ * 偏移量,默认为0
6107
6150
  */
6108
- RequestId?: string
6151
+ Offset?: number
6109
6152
  }
6110
6153
 
6111
6154
  /**
@@ -6259,6 +6302,16 @@ export interface WorkGroupDetailInfo {
6259
6302
  RowFilterInfo: Policys
6260
6303
  }
6261
6304
 
6305
+ /**
6306
+ * UpgradeDataEngineImage请求参数结构体
6307
+ */
6308
+ export interface UpgradeDataEngineImageRequest {
6309
+ /**
6310
+ * 引擎ID
6311
+ */
6312
+ DataEngineId: string
6313
+ }
6314
+
6262
6315
  /**
6263
6316
  * SuspendResumeDataEngine返回参数结构体
6264
6317
  */
@@ -7834,6 +7887,27 @@ export interface DescribeNotebookSessionStatementsRequest {
7834
7887
  BatchId: string
7835
7888
  }
7836
7889
 
7890
+ /**
7891
+ * 集群事件日志
7892
+ */
7893
+ export interface HouseEventsInfo {
7894
+ /**
7895
+ * 事件时间
7896
+ 注意:此字段可能返回 null,表示取不到有效值。
7897
+ */
7898
+ Time: Array<string>
7899
+ /**
7900
+ * 事件类型
7901
+ 注意:此字段可能返回 null,表示取不到有效值。
7902
+ */
7903
+ EventsAction: Array<string>
7904
+ /**
7905
+ * 集群信息
7906
+ 注意:此字段可能返回 null,表示取不到有效值。
7907
+ */
7908
+ ClusterInfo: Array<string>
7909
+ }
7910
+
7837
7911
  /**
7838
7912
  * AlterDMSDatabase请求参数结构体
7839
7913
  */
@@ -20,7 +20,9 @@ import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  CreateLicenseResponse,
22
22
  KeyParam,
23
+ GenerateTDRMKeyResponse,
23
24
  FairPlayPemDigestInfo,
25
+ GenerateTDRMKeyRequest,
24
26
  CreateEncryptKeysResponse,
25
27
  CreateLicenseRequest,
26
28
  DescribeAllKeysRequest,
@@ -165,4 +167,14 @@ export class Client extends AbstractClient {
165
167
  ): Promise<DescribeFairPlayPemResponse> {
166
168
  return this.request("DescribeFairPlayPem", req, cb)
167
169
  }
170
+
171
+ /**
172
+ * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo
173
+ */
174
+ async GenerateTDRMKey(
175
+ req: GenerateTDRMKeyRequest,
176
+ cb?: (error: string, rep: GenerateTDRMKeyResponse) => void
177
+ ): Promise<GenerateTDRMKeyResponse> {
178
+ return this.request("GenerateTDRMKey", req, cb)
179
+ }
168
180
  }
@@ -56,6 +56,24 @@ SD、HD、UHD1、UHD2、AUDIO
56
56
  Iv?: string
57
57
  }
58
58
 
59
+ /**
60
+ * GenerateTDRMKey返回参数结构体
61
+ */
62
+ export interface GenerateTDRMKeyResponse {
63
+ /**
64
+ * 内容ID。
65
+ */
66
+ ContentId?: string
67
+ /**
68
+ * 加密密钥。
69
+ */
70
+ TXEncryptionToken?: string
71
+ /**
72
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
73
+ */
74
+ RequestId?: string
75
+ }
76
+
59
77
  /**
60
78
  * FairPlay 私钥摘要信息。
61
79
  */
@@ -87,6 +105,28 @@ export interface FairPlayPemDigestInfo {
87
105
  Md5PemDecryptKey: string
88
106
  }
89
107
 
108
+ /**
109
+ * GenerateTDRMKey请求参数结构体
110
+ */
111
+ export interface GenerateTDRMKeyRequest {
112
+ /**
113
+ * 使用的DRM方案类型,接口取值 NORMALAES 。
114
+ */
115
+ DrmType: string
116
+ /**
117
+ * 加密的track列表,接口取值 SD 。
118
+ */
119
+ Tracks: Array<string>
120
+ /**
121
+ * 一个加密内容的唯一标识。
122
+ */
123
+ ContentId: string
124
+ /**
125
+ * 内容类型。接口取值 LiveVideo 。
126
+ */
127
+ ContentType: string
128
+ }
129
+
90
130
  /**
91
131
  * CreateEncryptKeys返回参数结构体
92
132
  */
@@ -3955,7 +3955,7 @@ export interface Table {
3955
3955
  */
3956
3956
  ColumnMode?: string
3957
3957
  /**
3958
- * 同步的的列信息,当ColumnMode为Partial时,必填
3958
+ * 同步的列信息,当ColumnMode为Partial时,必填
3959
3959
  注意:此字段可能返回 null,表示取不到有效值。
3960
3960
  */
3961
3961
  Columns?: Array<Column>
@@ -234,14 +234,15 @@ export class Client extends AbstractClient {
234
234
  }
235
235
 
236
236
  /**
237
- * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
238
- `注意:`<br/>
239
- `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。` <br/>
240
- `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
241
- `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
242
- `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
243
- `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
244
- 跳转到小程序的实现,参考微信官方文档(分为<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>
237
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
238
+ **注意:**
239
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)
240
+ 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**,**不支持填写控件**
241
+ 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
242
+ 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接
243
+ 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
244
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
245
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
245
246
  */
246
247
  async CreateBatchQuickSignUrl(
247
248
  req: CreateBatchQuickSignUrlRequest,
@@ -558,19 +559,21 @@ export class Client extends AbstractClient {
558
559
 
559
560
  /**
560
561
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
561
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
562
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
563
562
 
564
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
563
+ **适用场景**:
564
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
565
565
 
566
- **若是B2C模板,还要满足以下任意一个条件**
567
- - 模板中配置的签署顺序是无序
568
- - B端企业的签署方式是静默签署
569
- - B端企业是非首位签署
566
+ **注意**:
567
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
568
+ - 模板中配置的签署顺序是无序
569
+ - B端企业的签署方式是静默签署
570
+ - B端企业是非首位签署
571
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
572
+ ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
573
+ 3. 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
570
574
 
571
- 通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
572
-
573
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
575
+ 二维码的样式如下图:
576
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
574
577
  */
575
578
  async CreateMultiFlowSignQRCode(
576
579
  req: CreateMultiFlowSignQRCodeRequest,
@@ -838,12 +841,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
838
841
  /**
839
842
  * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
840
843
 
841
- `注意:`<br/>
842
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
843
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
844
- `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
845
- `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
846
- 跳转到小程序的实现,参考微信官方文档(分为<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>
844
+ **注意**
845
+ 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
846
+ 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
847
+ 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
848
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
849
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
850
+ 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
847
851
  */
848
852
  async CreateFlowSignUrl(
849
853
  req: CreateFlowSignUrlRequest,
@@ -35,89 +35,82 @@ export interface DescribePersonCertificateResponse {
35
35
  export interface BillUsageDetail {
36
36
  /**
37
37
  * 合同流程ID,为32位字符串。
38
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
39
38
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
40
- 注意:此字段可能返回 null,表示取不到有效值。
41
39
  */
42
40
  FlowId?: string
43
41
  /**
44
42
  * 合同经办人名称
45
43
  如果有多个经办人用分号隔开。
46
- 注意:此字段可能返回 null,表示取不到有效值。
47
44
  */
48
45
  OperatorName?: string
49
46
  /**
50
47
  * 发起方组织机构名称
51
- 注意:此字段可能返回 null,表示取不到有效值。
52
48
  */
53
49
  CreateOrganizationName?: string
54
50
  /**
55
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
56
- 该名称还将用于合同签署完成后的下载文件名。
57
- 注意:此字段可能返回 null,表示取不到有效值。
51
+ * 合同流程的名称。
58
52
  */
59
53
  FlowName?: string
60
54
  /**
61
55
  * 当前合同状态,如下是状态码对应的状态。
62
- 0-还没有发起
63
- 1-等待签署
64
- 2-部分签署
65
- 3-拒签
66
- 4-已签署
67
- 5-已过期
68
- 6-已撤销
69
- 7-还没有预发起
70
- 8-等待填写
71
- 9-部分填写
72
- 10-拒填
73
- 11-已解除
74
- 注意:此字段可能返回 null,表示取不到有效值。
56
+ <ul>
57
+ <li>**0**: 还没有发起</li>
58
+ <li>**1**: 等待签署</li>
59
+ <li>**2**: 部分签署 </li>
60
+ <li>**3**: 拒签</li>
61
+ <li>**4**: 已签署 </li>
62
+ <li>**5**: 已过期 </li>
63
+ <li>**6**: 已撤销 </li>
64
+ <li>**7**: 还没有预发起</li>
65
+ <li>**8**: 等待填写</li>
66
+ <li>**9**: 部分填写 </li>
67
+ <li>**10**: 拒填</li>
68
+ <li>**11**: 已解除</li>
69
+ </ul>
75
70
  */
76
71
  Status?: number
77
72
  /**
78
- * 套餐类型
79
- 对应关系如下
80
- CloudEnterprise-企业版合同
81
- SingleSignature-单方签章
82
- CloudProve-签署报告
83
- CloudOnlineSign-腾讯会议在线签约
84
- ChannelWeCard-微工卡
85
- SignFlow-合同套餐
86
- SignFace-签署意愿(人脸识别)
87
- SignPassword-签署意愿(密码)
88
- SignSMS-签署意愿(短信)
89
- PersonalEssAuth-签署人实名(腾讯电子签认证)
90
- PersonalThirdAuth-签署人实名(信任第三方认证)
91
- OrgEssAuth-签署企业实名
92
- FlowNotify-短信通知
93
- AuthService-企业工商信息查询
94
- 注意:此字段可能返回 null,表示取不到有效值。
73
+ * 查询的套餐类型
74
+ 对应关系如下:
75
+ <ul>
76
+ <li>**CloudEnterprise**: 企业版合同</li>
77
+ <li>**SingleSignature**: 单方签章</li>
78
+ <li>**CloudProve**: 签署报告</li>
79
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
80
+ <li>**ChannelWeCard**: 微工卡</li>
81
+ <li>**SignFlow**: 合同套餐</li>
82
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
83
+ <li>**SignPassword**: 签署意愿(密码)</li>
84
+ <li>**SignSMS**: 签署意愿(短信)</li>
85
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
86
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
87
+ <li>**OrgEssAuth**: 签署企业实名</li>
88
+ <li>**FlowNotify**: 短信通知</li>
89
+ <li>**AuthService**: 企业工商信息查询</li>
90
+ </ul>
95
91
  */
96
92
  QuotaType?: string
97
93
  /**
98
94
  * 合同使用量
99
- 注意:此字段可能返回 null,表示取不到有效值。
95
+ 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
100
96
  */
101
97
  UseCount?: number
102
98
  /**
103
99
  * 消耗的时间戳,格式为Unix标准时间戳(秒)。
104
- 注意:此字段可能返回 null,表示取不到有效值。
105
100
  */
106
101
  CostTime?: number
107
102
  /**
108
103
  * 消耗的套餐名称
109
- 注意:此字段可能返回 null,表示取不到有效值。
110
104
  */
111
105
  QuotaName?: string
112
106
  /**
113
107
  * 消耗类型
114
- 1.扣费 2.撤销返还
115
- 注意:此字段可能返回 null,表示取不到有效值。
108
+ **1**.扣费
109
+ **2**.撤销返还
116
110
  */
117
111
  CostType?: number
118
112
  /**
119
113
  * 备注
120
- 注意:此字段可能返回 null,表示取不到有效值。
121
114
  */
122
115
  Remark?: string
123
116
  }
@@ -6448,21 +6441,23 @@ export interface DescribeBillUsageDetailRequest {
6448
6441
  Limit?: number
6449
6442
  /**
6450
6443
  * 查询的套餐类型 (选填 )不传则查询所有套餐;
6451
- 对应关系如下
6452
- CloudEnterprise-企业版合同
6453
- SingleSignature-单方签章
6454
- CloudProve-签署报告
6455
- CloudOnlineSign-腾讯会议在线签约
6456
- ChannelWeCard-微工卡
6457
- SignFlow-合同套餐
6458
- SignFace-签署意愿(人脸识别)
6459
- SignPassword-签署意愿(密码)
6460
- SignSMS-签署意愿(短信)
6461
- PersonalEssAuth-签署人实名(腾讯电子签认证)
6462
- PersonalThirdAuth-签署人实名(信任第三方认证)
6463
- OrgEssAuth-签署企业实名
6464
- FlowNotify-短信通知
6465
- AuthService-企业工商信息查询
6444
+ 目前支持:
6445
+ <ul>
6446
+ <li>**CloudEnterprise**: 企业版合同</li>
6447
+ <li>**SingleSignature**: 单方签章</li>
6448
+ <li>**CloudProve**: 签署报告</li>
6449
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
6450
+ <li>**ChannelWeCard**: 微工卡</li>
6451
+ <li>**SignFlow**: 合同套餐</li>
6452
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
6453
+ <li>**SignPassword**: 签署意愿(密码)</li>
6454
+ <li>**SignSMS**: 签署意愿(短信)</li>
6455
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
6456
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
6457
+ <li>**OrgEssAuth**: 签署企业实名</li>
6458
+ <li>**FlowNotify**: 短信通知</li>
6459
+ <li>**AuthService**: 企业工商信息查询</li>
6460
+ </ul>
6466
6461
  */
6467
6462
  QuotaType?: string
6468
6463
  /**