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
@@ -289,6 +289,21 @@ export interface DescribeDatabasesRequest {
289
289
  */
290
290
  Asc?: boolean;
291
291
  }
292
+ /**
293
+ * ip端口对信息
294
+ */
295
+ export interface IpPortPair {
296
+ /**
297
+ * ip信息
298
+ 注意:此字段可能返回 null,表示取不到有效值。
299
+ */
300
+ Ip?: string;
301
+ /**
302
+ * 端口信息
303
+ 注意:此字段可能返回 null,表示取不到有效值。
304
+ */
305
+ Port?: number;
306
+ }
292
307
  /**
293
308
  * 工作组部分信息
294
309
  */
@@ -934,19 +949,38 @@ export interface SwitchDataEngineRequest {
934
949
  StartStandbyCluster: boolean;
935
950
  }
936
951
  /**
937
- * ip端口对信息
952
+ * DescribeDataEngineEvents返回参数结构体
938
953
  */
939
- export interface IpPortPair {
954
+ export interface DescribeDataEngineEventsResponse {
940
955
  /**
941
- * ip信息
956
+ * 事件详细信息
942
957
  注意:此字段可能返回 null,表示取不到有效值。
943
958
  */
944
- Ip?: string;
959
+ Events: Array<HouseEventsInfo>;
945
960
  /**
946
- * 端口信息
961
+ * 分页号
947
962
  注意:此字段可能返回 null,表示取不到有效值。
948
963
  */
949
- Port?: number;
964
+ Page: number;
965
+ /**
966
+ * 分页大小
967
+ 注意:此字段可能返回 null,表示取不到有效值。
968
+ */
969
+ Size: number;
970
+ /**
971
+ * 总页数
972
+ 注意:此字段可能返回 null,表示取不到有效值。
973
+ */
974
+ TotalPages: number;
975
+ /**
976
+ * 总条数
977
+ 注意:此字段可能返回 null,表示取不到有效值。
978
+ */
979
+ TotalCount: number;
980
+ /**
981
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
982
+ */
983
+ RequestId?: string;
950
984
  }
951
985
  /**
952
986
  * DeleteSparkApp请求参数结构体
@@ -2562,41 +2596,35 @@ export interface DescribeDatabasesResponse {
2562
2596
  RequestId?: string;
2563
2597
  }
2564
2598
  /**
2565
- * 元数据加锁内容
2599
+ * DescribeNotebookSessionStatementSqlResult返回参数结构体
2566
2600
  */
2567
- export interface LockComponentInfo {
2568
- /**
2569
- * 数据库名称
2570
- */
2571
- DbName: string;
2572
- /**
2573
- * 表名称
2574
- */
2575
- TableName?: string;
2601
+ export interface DescribeNotebookSessionStatementSqlResultResponse {
2576
2602
  /**
2577
- * 分区
2603
+ * 任务Id
2578
2604
  */
2579
- Partition?: string;
2605
+ TaskId?: string;
2580
2606
  /**
2581
- * 锁类型:SHARED_READ、SHARED_WRITE、EXCLUSIVE
2607
+ * 结果数据
2582
2608
  */
2583
- LockType?: string;
2609
+ ResultSet?: string;
2584
2610
  /**
2585
- * 锁级别:DB、TABLE、PARTITION
2611
+ * schema
2586
2612
  */
2587
- LockLevel?: string;
2613
+ ResultSchema?: Array<Column>;
2588
2614
  /**
2589
- * 锁操作:SELECT,INSERT,UPDATE,DELETE,UNSET,NO_TXN
2615
+ * 分页信息
2616
+ 注意:此字段可能返回 null,表示取不到有效值。
2590
2617
  */
2591
- DataOperationType?: string;
2618
+ NextToken?: string;
2592
2619
  /**
2593
- * 是否保持Acid
2620
+ * 存储结果地址
2621
+ 注意:此字段可能返回 null,表示取不到有效值。
2594
2622
  */
2595
- IsAcid?: boolean;
2623
+ OutputPath?: string;
2596
2624
  /**
2597
- * 是否动态分区写
2625
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2598
2626
  */
2599
- IsDynamicPartitionWrite?: boolean;
2627
+ RequestId?: string;
2600
2628
  }
2601
2629
  /**
2602
2630
  * DescribeNotebookSessions返回参数结构体
@@ -3213,13 +3241,41 @@ export interface DescribeAdvancedStoreLocationResponse {
3213
3241
  RequestId?: string;
3214
3242
  }
3215
3243
  /**
3216
- * UpgradeDataEngineImage请求参数结构体
3244
+ * 元数据加锁内容
3217
3245
  */
3218
- export interface UpgradeDataEngineImageRequest {
3246
+ export interface LockComponentInfo {
3219
3247
  /**
3220
- * 引擎ID
3248
+ * 数据库名称
3221
3249
  */
3222
- DataEngineId: string;
3250
+ DbName: string;
3251
+ /**
3252
+ * 表名称
3253
+ */
3254
+ TableName?: string;
3255
+ /**
3256
+ * 分区
3257
+ */
3258
+ Partition?: string;
3259
+ /**
3260
+ * 锁类型:SHARED_READ、SHARED_WRITE、EXCLUSIVE
3261
+ */
3262
+ LockType?: string;
3263
+ /**
3264
+ * 锁级别:DB、TABLE、PARTITION
3265
+ */
3266
+ LockLevel?: string;
3267
+ /**
3268
+ * 锁操作:SELECT,INSERT,UPDATE,DELETE,UNSET,NO_TXN
3269
+ */
3270
+ DataOperationType?: string;
3271
+ /**
3272
+ * 是否保持Acid
3273
+ */
3274
+ IsAcid?: boolean;
3275
+ /**
3276
+ * 是否动态分区写
3277
+ */
3278
+ IsDynamicPartitionWrite?: boolean;
3223
3279
  }
3224
3280
  /**
3225
3281
  * CSV类型数据格式
@@ -5816,35 +5872,21 @@ export interface CancelSparkSessionBatchSQLResponse {
5816
5872
  RequestId?: string;
5817
5873
  }
5818
5874
  /**
5819
- * DescribeNotebookSessionStatementSqlResult返回参数结构体
5875
+ * DescribeDataEngineEvents请求参数结构体
5820
5876
  */
5821
- export interface DescribeNotebookSessionStatementSqlResultResponse {
5822
- /**
5823
- * 任务Id
5824
- */
5825
- TaskId?: string;
5826
- /**
5827
- * 结果数据
5828
- */
5829
- ResultSet?: string;
5830
- /**
5831
- * schema
5832
- */
5833
- ResultSchema?: Array<Column>;
5877
+ export interface DescribeDataEngineEventsRequest {
5834
5878
  /**
5835
- * 分页信息
5836
- 注意:此字段可能返回 null,表示取不到有效值。
5879
+ * 虚拟集群名称
5837
5880
  */
5838
- NextToken?: string;
5881
+ DataEngineName: string;
5839
5882
  /**
5840
- * 存储结果地址
5841
- 注意:此字段可能返回 null,表示取不到有效值。
5883
+ * 返回数量,默认为10,最大为100
5842
5884
  */
5843
- OutputPath?: string;
5885
+ Limit?: number;
5844
5886
  /**
5845
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5887
+ * 偏移量,默认为0
5846
5888
  */
5847
- RequestId?: string;
5889
+ Offset?: number;
5848
5890
  }
5849
5891
  /**
5850
5892
  * 迁移元数据分区对象
@@ -5993,6 +6035,15 @@ export interface WorkGroupDetailInfo {
5993
6035
  */
5994
6036
  RowFilterInfo: Policys;
5995
6037
  }
6038
+ /**
6039
+ * UpgradeDataEngineImage请求参数结构体
6040
+ */
6041
+ export interface UpgradeDataEngineImageRequest {
6042
+ /**
6043
+ * 引擎ID
6044
+ */
6045
+ DataEngineId: string;
6046
+ }
5996
6047
  /**
5997
6048
  * SuspendResumeDataEngine返回参数结构体
5998
6049
  */
@@ -7510,6 +7561,26 @@ export interface DescribeNotebookSessionStatementsRequest {
7510
7561
  */
7511
7562
  BatchId: string;
7512
7563
  }
7564
+ /**
7565
+ * 集群事件日志
7566
+ */
7567
+ export interface HouseEventsInfo {
7568
+ /**
7569
+ * 事件时间
7570
+ 注意:此字段可能返回 null,表示取不到有效值。
7571
+ */
7572
+ Time: Array<string>;
7573
+ /**
7574
+ * 事件类型
7575
+ 注意:此字段可能返回 null,表示取不到有效值。
7576
+ */
7577
+ EventsAction: Array<string>;
7578
+ /**
7579
+ * 集群信息
7580
+ 注意:此字段可能返回 null,表示取不到有效值。
7581
+ */
7582
+ ClusterInfo: Array<string>;
7583
+ }
7513
7584
  /**
7514
7585
  * AlterDMSDatabase请求参数结构体
7515
7586
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateLicenseResponse, CreateEncryptKeysResponse, CreateLicenseRequest, DescribeAllKeysRequest, CreateEncryptKeysRequest, ModifyFairPlayPemResponse, DescribeFairPlayPemResponse, DescribeDRMLicenseResponse, AddFairPlayPemResponse, AddFairPlayPemRequest, DeleteFairPlayPemRequest, DescribeKeysResponse, DescribeDRMLicenseRequest, DescribeAllKeysResponse, StartEncryptionRequest, ModifyFairPlayPemRequest, DeleteFairPlayPemResponse, StartEncryptionResponse, DescribeFairPlayPemRequest, DescribeKeysRequest } from "./drm_models";
3
+ import { CreateLicenseResponse, GenerateTDRMKeyResponse, GenerateTDRMKeyRequest, CreateEncryptKeysResponse, CreateLicenseRequest, DescribeAllKeysRequest, CreateEncryptKeysRequest, ModifyFairPlayPemResponse, DescribeFairPlayPemResponse, DescribeDRMLicenseResponse, AddFairPlayPemResponse, AddFairPlayPemRequest, DeleteFairPlayPemRequest, DescribeKeysResponse, DescribeDRMLicenseRequest, DescribeAllKeysResponse, StartEncryptionRequest, ModifyFairPlayPemRequest, DeleteFairPlayPemResponse, StartEncryptionResponse, DescribeFairPlayPemRequest, DescribeKeysRequest } from "./drm_models";
4
4
  /**
5
5
  * drm client
6
6
  * @class
@@ -57,4 +57,8 @@ export declare class Client extends AbstractClient {
57
57
  * 该接口用来查询设置的FairPlay私钥校验信息。可用该接口校验设置的私钥与本身的私钥是否一致。
58
58
  */
59
59
  DescribeFairPlayPem(req: DescribeFairPlayPemRequest, cb?: (error: string, rep: DescribeFairPlayPemResponse) => void): Promise<DescribeFairPlayPemResponse>;
60
+ /**
61
+ * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo
62
+ */
63
+ GenerateTDRMKey(req: GenerateTDRMKeyRequest, cb?: (error: string, rep: GenerateTDRMKeyResponse) => void): Promise<GenerateTDRMKeyResponse>;
60
64
  }
@@ -97,5 +97,11 @@ class Client extends abstract_client_1.AbstractClient {
97
97
  async DescribeFairPlayPem(req, cb) {
98
98
  return this.request("DescribeFairPlayPem", req, cb);
99
99
  }
100
+ /**
101
+ * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo
102
+ */
103
+ async GenerateTDRMKey(req, cb) {
104
+ return this.request("GenerateTDRMKey", req, cb);
105
+ }
100
106
  }
101
107
  exports.Client = Client;
@@ -37,6 +37,23 @@ export interface KeyParam {
37
37
  */
38
38
  Iv?: string;
39
39
  }
40
+ /**
41
+ * GenerateTDRMKey返回参数结构体
42
+ */
43
+ export interface GenerateTDRMKeyResponse {
44
+ /**
45
+ * 内容ID。
46
+ */
47
+ ContentId?: string;
48
+ /**
49
+ * 加密密钥。
50
+ */
51
+ TXEncryptionToken?: string;
52
+ /**
53
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
54
+ */
55
+ RequestId?: string;
56
+ }
40
57
  /**
41
58
  * FairPlay 私钥摘要信息。
42
59
  */
@@ -67,6 +84,27 @@ export interface FairPlayPemDigestInfo {
67
84
  */
68
85
  Md5PemDecryptKey: string;
69
86
  }
87
+ /**
88
+ * GenerateTDRMKey请求参数结构体
89
+ */
90
+ export interface GenerateTDRMKeyRequest {
91
+ /**
92
+ * 使用的DRM方案类型,接口取值 NORMALAES 。
93
+ */
94
+ DrmType: string;
95
+ /**
96
+ * 加密的track列表,接口取值 SD 。
97
+ */
98
+ Tracks: Array<string>;
99
+ /**
100
+ * 一个加密内容的唯一标识。
101
+ */
102
+ ContentId: string;
103
+ /**
104
+ * 内容类型。接口取值 LiveVideo 。
105
+ */
106
+ ContentType: string;
107
+ }
70
108
  /**
71
109
  * CreateEncryptKeys返回参数结构体
72
110
  */
@@ -3786,7 +3786,7 @@ export interface Table {
3786
3786
  */
3787
3787
  ColumnMode?: string;
3788
3788
  /**
3789
- * 同步的的列信息,当ColumnMode为Partial时,必填
3789
+ * 同步的列信息,当ColumnMode为Partial时,必填
3790
3790
  注意:此字段可能返回 null,表示取不到有效值。
3791
3791
  */
3792
3792
  Columns?: Array<Column>;
@@ -8,14 +8,15 @@ import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegration
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
12
- `注意:`<br/>
13
- `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。` <br/>
14
- `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
15
- `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
16
- `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
17
- `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
18
- 跳转到小程序的实现,参考微信官方文档(分为<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>
11
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
12
+ **注意:**
13
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)
14
+ 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**,**不支持填写控件**
15
+ 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
16
+ 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接
17
+ 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
18
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
19
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
19
20
  */
20
21
  CreateBatchQuickSignUrl(req: CreateBatchQuickSignUrlRequest, cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void): Promise<CreateBatchQuickSignUrlResponse>;
21
22
  /**
@@ -188,19 +189,21 @@ export declare class Client extends AbstractClient {
188
189
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
189
190
  /**
190
191
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
191
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
192
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
193
192
 
194
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
193
+ **适用场景**:
194
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
195
195
 
196
- **若是B2C模板,还要满足以下任意一个条件**
197
- - 模板中配置的签署顺序是无序
198
- - B端企业的签署方式是静默签署
199
- - B端企业是非首位签署
196
+ **注意**:
197
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
198
+ - 模板中配置的签署顺序是无序
199
+ - B端企业的签署方式是静默签署
200
+ - B端企业是非首位签署
201
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
202
+ ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
203
+ 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)
200
204
 
201
- 通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
202
-
203
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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)
205
+ 二维码的样式如下图:
206
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
204
207
  */
205
208
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
206
209
  /**
@@ -360,12 +363,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
360
363
  /**
361
364
  * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
362
365
 
363
- `注意:`<br/>
364
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
365
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
366
- `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
367
- `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
368
- 跳转到小程序的实现,参考微信官方文档(分为<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>
366
+ **注意**
367
+ 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
368
+ 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
369
+ 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
370
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
371
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
372
+ 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
369
373
  */
370
374
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
371
375
  /**
@@ -28,14 +28,15 @@ class Client extends abstract_client_1.AbstractClient {
28
28
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
29
29
  }
30
30
  /**
31
- * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
32
- `注意:`<br/>
33
- `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。` <br/>
34
- `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
35
- `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
36
- `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
37
- `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
38
- 跳转到小程序的实现,参考微信官方文档(分为<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>
31
+ * 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
32
+ **注意:**
33
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)
34
+ 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**,**不支持填写控件**
35
+ 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
36
+ 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接
37
+ 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
38
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
39
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
39
40
  */
40
41
  async CreateBatchQuickSignUrl(req, cb) {
41
42
  return this.request("CreateBatchQuickSignUrl", req, cb);
@@ -256,19 +257,21 @@ class Client extends abstract_client_1.AbstractClient {
256
257
  }
257
258
  /**
258
259
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
259
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
260
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
261
260
 
262
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
261
+ **适用场景**:
262
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
263
263
 
264
- **若是B2C模板,还要满足以下任意一个条件**
265
- - 模板中配置的签署顺序是无序
266
- - B端企业的签署方式是静默签署
267
- - B端企业是非首位签署
264
+ **注意**:
265
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
266
+ - 模板中配置的签署顺序是无序
267
+ - B端企业的签署方式是静默签署
268
+ - B端企业是非首位签署
269
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
270
+ ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
271
+ 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)
268
272
 
269
- 通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
270
-
271
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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)
273
+ 二维码的样式如下图:
274
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
272
275
  */
273
276
  async CreateMultiFlowSignQRCode(req, cb) {
274
277
  return this.request("CreateMultiFlowSignQRCode", req, cb);
@@ -464,12 +467,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
464
467
  /**
465
468
  * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
466
469
 
467
- `注意:`<br/>
468
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
469
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
470
- `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
471
- `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
472
- 跳转到小程序的实现,参考微信官方文档(分为<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>
470
+ **注意**
471
+ 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
472
+ 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
473
+ 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
474
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
475
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
476
+ 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
473
477
  */
474
478
  async CreateFlowSignUrl(req, cb) {
475
479
  return this.request("CreateFlowSignUrl", req, cb);