tencentcloud-sdk-nodejs 4.0.551 → 4.0.552

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 (36) hide show
  1. package/CHANGELOG.md +112 -0
  2. package/SERVICE_CHANGELOG.md +125 -127
  3. package/package.json +1 -1
  4. package/products.md +11 -11
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +2 -2
  7. package/src/services/asr/v20190614/asr_models.ts +4 -0
  8. package/src/services/bma/v20221115/bma_models.ts +6 -0
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +2 -2
  10. package/src/services/ess/v20201111/ess_client.ts +40 -2
  11. package/src/services/ess/v20201111/ess_models.ts +292 -92
  12. package/src/services/essbasic/v20210526/essbasic_client.ts +11 -11
  13. package/src/services/essbasic/v20210526/essbasic_models.ts +61 -53
  14. package/src/services/gme/v20180711/gme_client.ts +130 -67
  15. package/src/services/gme/v20180711/gme_models.ts +1040 -813
  16. package/src/services/trtc/v20190722/trtc_client.ts +3 -1
  17. package/tencentcloud/common/sdk_version.d.ts +1 -1
  18. package/tencentcloud/common/sdk_version.js +1 -1
  19. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +2 -2
  20. package/tencentcloud/services/asr/v20190614/asr_client.js +2 -2
  21. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +4 -0
  22. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +5 -0
  23. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +2 -2
  24. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +13 -1
  25. package/tencentcloud/services/ess/v20201111/ess_client.js +18 -0
  26. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +251 -80
  27. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -11
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -11
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +60 -53
  30. package/tencentcloud/services/gme/v20180711/gme_client.d.ts +26 -5
  31. package/tencentcloud/services/gme/v20180711/gme_client.js +37 -6
  32. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +978 -783
  33. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +3 -1
  34. package/tencentcloud/services/trtc/v20190722/trtc_client.js +3 -1
  35. package/test/ess.v20201111.test.js +30 -0
  36. package/test/gme.v20180711.test.js +54 -4
@@ -425,7 +425,9 @@ TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过
425
425
  }
426
426
 
427
427
  /**
428
- * 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据。
428
+ * 接口内部调用计量接口,计量接口迁通用集群后不可用。目前已有新的对外接口可以供用户使用。
429
+
430
+ 获取Trtc的用量统计数据。走计费渠道二期 只允许查两天的数据。
429
431
  当前接口已不再更新维护,请使用新版音视频用量接口:DescribeTrtcUsage (https://cloud.tencent.com/document/product/647/81425)
430
432
  */
431
433
  async DescribeExternalTrtcMeasure(
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.551";
1
+ export declare const sdkVersion = "4.0.552";
@@ -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.551";
4
+ exports.sdkVersion = "4.0.552";
@@ -21,7 +21,7 @@ export declare class Client extends AbstractClient {
21
21
  DownloadAsrVocab(req: DownloadAsrVocabRequest, cb?: (error: string, rep: DownloadAsrVocabResponse) => void): Promise<DownloadAsrVocabResponse>;
22
22
  /**
23
23
  * 本接口服务对时长5小时以内的录音文件进行识别,异步返回识别全部结果。
24
- 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
24
+ 支持中文普通话、英语、粤语、日语、越南语、马来语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
25
25
  • 支持wav、mp3、m4a、flv、mp4、wma、3gp、amr、aac、ogg-opus、flac格式。
26
26
  • 支持语音 URL 和本地语音文件两种请求方式。语音 URL 的音频时长不能长于5小时,文件大小不超过1GB。本地语音文件调用不能大于5MB。
27
27
  • 提交录音文件识别请求后,在3小时内完成识别(大多数情况下1小时音频约3分钟以内完成识别,半小时内发送超过1000小时录音或者2万条识别任务的除外),识别结果在服务端可保存7天。
@@ -102,7 +102,7 @@ export declare class Client extends AbstractClient {
102
102
  */
103
103
  ModifyCustomization(req: ModifyCustomizationRequest, cb?: (error: string, rep: ModifyCustomizationResponse) => void): Promise<ModifyCustomizationResponse>;
104
104
  /**
105
- * 本接口用于对60秒之内的短音频文件进行识别。<br>• 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。<br>• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s,音频文件大小不能超过3MB。<br>• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。<br>• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"<br>• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。<br>• 默认接口请求频率限制:30次/秒,如您有提高请求频率限制的需求,请[前往购买](https://buy.cloud.tencent.com/asr)。
105
+ * 本接口用于对60秒之内的短音频文件进行识别。<br>• 支持中文普通话、英语、粤语、日语、越南语、马来语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。<br>• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s,音频文件大小不能超过3MB。<br>• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。<br>• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"<br>• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。<br>• 默认接口请求频率限制:30次/秒,如您有提高请求频率限制的需求,请[前往购买](https://buy.cloud.tencent.com/asr)。
106
106
  */
107
107
  SentenceRecognition(req: SentenceRecognitionRequest, cb?: (error: string, rep: SentenceRecognitionResponse) => void): Promise<SentenceRecognitionResponse>;
108
108
  /**
@@ -47,7 +47,7 @@ class Client extends abstract_client_1.AbstractClient {
47
47
  }
48
48
  /**
49
49
  * 本接口服务对时长5小时以内的录音文件进行识别,异步返回识别全部结果。
50
- 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
50
+ 支持中文普通话、英语、粤语、日语、越南语、马来语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
51
51
  • 支持wav、mp3、m4a、flv、mp4、wma、3gp、amr、aac、ogg-opus、flac格式。
52
52
  • 支持语音 URL 和本地语音文件两种请求方式。语音 URL 的音频时长不能长于5小时,文件大小不超过1GB。本地语音文件调用不能大于5MB。
53
53
  • 提交录音文件识别请求后,在3小时内完成识别(大多数情况下1小时音频约3分钟以内完成识别,半小时内发送超过1000小时录音或者2万条识别任务的除外),识别结果在服务端可保存7天。
@@ -156,7 +156,7 @@ class Client extends abstract_client_1.AbstractClient {
156
156
  return this.request("ModifyCustomization", req, cb);
157
157
  }
158
158
  /**
159
- * 本接口用于对60秒之内的短音频文件进行识别。<br>• 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。<br>• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s,音频文件大小不能超过3MB。<br>• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。<br>• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"<br>• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。<br>• 默认接口请求频率限制:30次/秒,如您有提高请求频率限制的需求,请[前往购买](https://buy.cloud.tencent.com/asr)。
159
+ * 本接口用于对60秒之内的短音频文件进行识别。<br>• 支持中文普通话、英语、粤语、日语、越南语、马来语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。<br>• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s,音频文件大小不能超过3MB。<br>• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。<br>• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"<br>• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。<br>• 默认接口请求频率限制:30次/秒,如您有提高请求频率限制的需求,请[前往购买](https://buy.cloud.tencent.com/asr)。
160
160
  */
161
161
  async SentenceRecognition(req, cb) {
162
162
  return this.request("SentenceRecognition", req, cb);
@@ -188,6 +188,8 @@ export interface SentenceRecognitionRequest {
188
188
  • 16k_en:16k 英语;
189
189
  • 16k_ca:16k 粤语;
190
190
  • 16k_ja:16k 日语;
191
+ • 16k_vi:16k 越南语;
192
+ • 16k_ms:16k 马来语;
191
193
  • 16k_zh_medical:16k 医疗;
192
194
  • 16k_zh-PY 中英粤;
193
195
  • 16k_zh_dialect:多方言,支持23种方言(上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话);
@@ -386,6 +388,8 @@ export interface CreateRecTaskRequest {
386
388
  • 16k_en:16k 英语;
387
389
  • 16k_ca:16k 粤语;
388
390
  • 16k_ja:16k 日语;
391
+ • 16k_vi:16k 越南语;
392
+ • 16k_ms:16k 马来语;
389
393
  • 16k_zh_edu 中文教育;
390
394
  • 16k_en_edu 英文教育;
391
395
  • 16k_zh_medical 医疗;
@@ -510,6 +510,11 @@ export interface FakeURLData {
510
510
  注意:此字段可能返回 null,表示取不到有效值。
511
511
  */
512
512
  CertificationStatus?: number;
513
+ /**
514
+ * 网址截图
515
+ 注意:此字段可能返回 null,表示取不到有效值。
516
+ */
517
+ Snapshot?: string;
513
518
  }
514
519
  /**
515
520
  * DeleteBPWhiteList请求参数结构体
@@ -5204,7 +5204,7 @@ export interface CreateInstancePreResponse {
5204
5204
  /**
5205
5205
  * 返回结果
5206
5206
  */
5207
- Result: CreateInstancePreResp;
5207
+ Result?: CreateInstancePreResp;
5208
5208
  /**
5209
5209
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5210
5210
  */
@@ -6928,7 +6928,7 @@ export interface CreateInstancePreRequest {
6928
6928
  Period: string;
6929
6929
  /**
6930
6930
  * 实例规格说明 专业版实例[所有规格]填写1.
6931
- 标准版实例 ([入门型]填写1,[标准型]填写2,[进阶型]填写3,[容量型]填写4,[高阶型1]填写5,[高阶性2]填写6,[高阶型3]填写7,[高阶型4]填写8,[独占型]填写9。
6931
+ 标准版实例 ([入门型(general)]填写1,[标准型(standard)]填写2,[进阶型(advanced)]填写3,[容量型(capacity)]填写4,[高阶型1(specialized-1)]填写5,[高阶性2(specialized-2)]填写6,[高阶型3(specialized-3)]填写7,[高阶型4(specialized-4)]填写8,[独占型(exclusive)]填写9。
6932
6932
  */
6933
6933
  InstanceType: number;
6934
6934
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, DeleteSealPoliciesResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, DescribeIntegrationMainOrganizationUserResponse, CreateSchemeUrlResponse, DeleteSealPoliciesRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreatePrepareFlowRequest, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, DeleteIntegrationEmployeesResponse, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, DescribeOrganizationGroupOrganizationsResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
3
+ import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateUserAutoSignEnableUrlRequest, DescribeIntegrationMainOrganizationUserResponse, CreateSchemeUrlResponse, DeleteSealPoliciesRequest, CreateFlowByFilesRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreatePrepareFlowRequest, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, DeleteIntegrationEmployeesResponse, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -42,6 +42,10 @@ callbackinfo包含: 回调地址和签名key
42
42
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
43
43
  */
44
44
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
45
+ /**
46
+ * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
47
+ */
48
+ CreateUserAutoSignEnableUrl(req: CreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CreateUserAutoSignEnableUrlResponse) => void): Promise<CreateUserAutoSignEnableUrlResponse>;
45
49
  /**
46
50
  * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
47
51
  出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
@@ -64,6 +68,10 @@ callbackinfo包含: 回调地址和签名key
64
68
  注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
65
69
  */
66
70
  CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
71
+ /**
72
+ * 企业方可以通过此接口关闭个人的自动签功能
73
+ */
74
+ DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
67
75
  /**
68
76
  * 提交企业签署流程审批结果
69
77
  适用场景:
@@ -99,6 +107,10 @@ callbackinfo包含: 回调地址和签名key
99
107
  注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
100
108
  */
101
109
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
110
+ /**
111
+ * 企业方可以通过此接口查询个人用户自动签开启状态
112
+ */
113
+ DescribeUserAutoSignStatus(req: DescribeUserAutoSignStatusRequest, cb?: (error: string, rep: DescribeUserAutoSignStatusResponse) => void): Promise<DescribeUserAutoSignStatusResponse>;
102
114
  /**
103
115
  * 查询出证报告,返回报告 URL。
104
116
  */
@@ -76,6 +76,12 @@ callbackinfo包含: 回调地址和签名key
76
76
  async DescribeFileUrls(req, cb) {
77
77
  return this.request("DescribeFileUrls", req, cb);
78
78
  }
79
+ /**
80
+ * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
81
+ */
82
+ async CreateUserAutoSignEnableUrl(req, cb) {
83
+ return this.request("CreateUserAutoSignEnableUrl", req, cb);
84
+ }
79
85
  /**
80
86
  * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
81
87
  出证需要一定时间,建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
@@ -106,6 +112,12 @@ callbackinfo包含: 回调地址和签名key
106
112
  async CreateFlowApprovers(req, cb) {
107
113
  return this.request("CreateFlowApprovers", req, cb);
108
114
  }
115
+ /**
116
+ * 企业方可以通过此接口关闭个人的自动签功能
117
+ */
118
+ async DisableUserAutoSign(req, cb) {
119
+ return this.request("DisableUserAutoSign", req, cb);
120
+ }
109
121
  /**
110
122
  * 提交企业签署流程审批结果
111
123
  适用场景:
@@ -153,6 +165,12 @@ callbackinfo包含: 回调地址和签名key
153
165
  async CreateFlow(req, cb) {
154
166
  return this.request("CreateFlow", req, cb);
155
167
  }
168
+ /**
169
+ * 企业方可以通过此接口查询个人用户自动签开启状态
170
+ */
171
+ async DescribeUserAutoSignStatus(req, cb) {
172
+ return this.request("DescribeUserAutoSignStatus", req, cb);
173
+ }
156
174
  /**
157
175
  * 查询出证报告,返回报告 URL。
158
176
  */
@@ -234,6 +234,15 @@ export interface DescribeThirdPartyAuthCodeResponse {
234
234
  */
235
235
  RequestId?: string;
236
236
  }
237
+ /**
238
+ * DisableUserAutoSign返回参数结构体
239
+ */
240
+ export interface DisableUserAutoSignResponse {
241
+ /**
242
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
243
+ */
244
+ RequestId?: string;
245
+ }
237
246
  /**
238
247
  * CreateIntegrationEmployees请求参数结构体
239
248
  */
@@ -749,18 +758,39 @@ false:有序签
749
758
  CcInfos?: Array<CcInfo>;
750
759
  }
751
760
  /**
752
- * 下载文件的URL信息
761
+ * 自动签开启、签署相关配置
753
762
  */
754
- export interface FileUrl {
763
+ export interface AutoSignConfig {
755
764
  /**
756
- * 下载文件的URL
765
+ * 自动签开通个人用户的三要素
766
+ 注意:此字段可能返回 null,表示取不到有效值。
757
767
  */
758
- Url: string;
768
+ UserInfo: UserThreeFactor;
759
769
  /**
760
- * 下载文件的附加信息
770
+ * 回调链接
761
771
  注意:此字段可能返回 null,表示取不到有效值。
762
772
  */
763
- Option: string;
773
+ CallbackUrl: string;
774
+ /**
775
+ * 是否回调证书信息
776
+ 注意:此字段可能返回 null,表示取不到有效值。
777
+ */
778
+ CertInfoCallback?: boolean;
779
+ /**
780
+ * 是否支持用户自定义签名印章
781
+ 注意:此字段可能返回 null,表示取不到有效值。
782
+ */
783
+ UserDefineSeal?: boolean;
784
+ /**
785
+ * 是否需要回调的时候返回印章(签名) 图片的 base64
786
+ 注意:此字段可能返回 null,表示取不到有效值。
787
+ */
788
+ SealImgCallback?: boolean;
789
+ /**
790
+ * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
791
+ 注意:此字段可能返回 null,表示取不到有效值。
792
+ */
793
+ VerifyChannels?: Array<string>;
764
794
  }
765
795
  /**
766
796
  * DescribeThirdPartyAuthCode请求参数结构体
@@ -822,6 +852,19 @@ export interface OrganizationInfo {
822
852
  */
823
853
  ProxyIp?: string;
824
854
  }
855
+ /**
856
+ * DescribeUserAutoSignStatus返回参数结构体
857
+ */
858
+ export interface DescribeUserAutoSignStatusResponse {
859
+ /**
860
+ * 是否开通
861
+ */
862
+ IsOpen?: boolean;
863
+ /**
864
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
865
+ */
866
+ RequestId?: string;
867
+ }
825
868
  /**
826
869
  * 补充签署人信息
827
870
  */
@@ -989,6 +1032,29 @@ export interface CreateBatchCancelFlowUrlResponse {
989
1032
  */
990
1033
  RequestId?: string;
991
1034
  }
1035
+ /**
1036
+ * 用户的三要素:姓名,证件号,证件类型
1037
+ */
1038
+ export interface UserThreeFactor {
1039
+ /**
1040
+ * 姓名
1041
+ 注意:此字段可能返回 null,表示取不到有效值。
1042
+ */
1043
+ Name: string;
1044
+ /**
1045
+ * 证件类型:
1046
+ ID_CARD 身份证
1047
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
1048
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1049
+ 注意:此字段可能返回 null,表示取不到有效值。
1050
+ */
1051
+ IdCardType: string;
1052
+ /**
1053
+ * 证件号,如果有 X 请大写
1054
+ 注意:此字段可能返回 null,表示取不到有效值。
1055
+ */
1056
+ IdCardNumber: string;
1057
+ }
992
1058
  /**
993
1059
  * CreateSealPolicy返回参数结构体
994
1060
  */
@@ -1002,6 +1068,24 @@ export interface CreateSealPolicyResponse {
1002
1068
  */
1003
1069
  RequestId?: string;
1004
1070
  }
1071
+ /**
1072
+ * DisableUserAutoSign请求参数结构体
1073
+ */
1074
+ export interface DisableUserAutoSignRequest {
1075
+ /**
1076
+ * 操作人信息
1077
+ */
1078
+ Operator: UserInfo;
1079
+ /**
1080
+ * 自动签场景:
1081
+ E_PRESCRIPTION_AUTO_SIGN 电子处方
1082
+ */
1083
+ SceneKey: string;
1084
+ /**
1085
+ * 关闭自动签的个人的三要素
1086
+ */
1087
+ UserInfo: UserThreeFactor;
1088
+ }
1005
1089
  /**
1006
1090
  * DescribeIntegrationEmployees返回参数结构体
1007
1091
  */
@@ -1105,95 +1189,37 @@ export interface FailedCreateStaffData {
1105
1189
  Reason: string;
1106
1190
  }
1107
1191
  /**
1108
- * CreateFlowByFiles请求参数结构体
1192
+ * CreateUserAutoSignEnableUrl返回参数结构体
1109
1193
  */
1110
- export interface CreateFlowByFilesRequest {
1111
- /**
1112
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1113
- */
1114
- Operator: UserInfo;
1194
+ export interface CreateUserAutoSignEnableUrlResponse {
1115
1195
  /**
1116
- * 签署流程名称,最大长度200个字符
1117
- */
1118
- FlowName: string;
1119
- /**
1120
- * 签署参与者信息,最大限制50方
1121
- */
1122
- Approvers: Array<ApproverInfo>;
1123
- /**
1124
- * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
1125
- */
1126
- FileIds: Array<string>;
1127
- /**
1128
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1129
- */
1130
- FlowType?: string;
1131
- /**
1132
- * 经办人内容控件配置
1196
+ * 跳转短链
1133
1197
  */
1134
- Components?: Array<Component>;
1198
+ Url?: string;
1135
1199
  /**
1136
- * 被抄送人的信息列表。
1137
- 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
1200
+ * 小程序AppId
1138
1201
  */
1139
- CcInfos?: Array<CcInfo>;
1140
- /**
1141
- * 是否需要预览,true:预览模式,false:非预览(默认);
1142
- 预览链接有效期300秒;
1143
-
1144
- 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
1145
- */
1146
- NeedPreview?: boolean;
1147
- /**
1148
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
1149
- */
1150
- PreviewType?: number;
1151
- /**
1152
- * 签署流程的签署截止时间。
1153
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1154
- */
1155
- Deadline?: number;
1156
- /**
1157
- * 发送类型:
1158
- true:无序签
1159
- false:有序签
1160
- 注:默认为false(有序签)
1161
- */
1162
- Unordered?: boolean;
1163
- /**
1164
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1165
- */
1166
- CustomShowMap?: string;
1167
- /**
1168
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1169
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1170
-
1171
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1172
- */
1173
- NeedSignReview?: boolean;
1202
+ AppId?: string;
1174
1203
  /**
1175
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1204
+ * 小程序 原始 Id
1176
1205
  */
1177
- UserData?: string;
1206
+ AppOriginalId?: string;
1178
1207
  /**
1179
- * 签署人校验方式
1180
- VerifyCheck: 人脸识别(默认)
1181
- MobileCheck:手机号验证
1182
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
1208
+ * 跳转路径
1183
1209
  */
1184
- ApproverVerifyType?: string;
1210
+ Path?: string;
1185
1211
  /**
1186
- * 签署流程描述,最大长度1000个字符
1212
+ * base64格式跳转二维码
1187
1213
  */
1188
- FlowDescription?: string;
1214
+ QrCode?: string;
1189
1215
  /**
1190
- * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
1216
+ * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
1191
1217
  */
1192
- SignBeanTag?: number;
1218
+ UrlType?: string;
1193
1219
  /**
1194
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1220
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1195
1221
  */
1196
- Agent?: Agent;
1222
+ RequestId?: string;
1197
1223
  }
1198
1224
  /**
1199
1225
  * CreateFlowSignUrl返回参数结构体
@@ -2067,6 +2093,28 @@ export interface CreateStaffResult {
2067
2093
  */
2068
2094
  FailedEmployeeData: Array<FailedCreateStaffData>;
2069
2095
  }
2096
+ /**
2097
+ * CreateUserAutoSignEnableUrl请求参数结构体
2098
+ */
2099
+ export interface CreateUserAutoSignEnableUrlRequest {
2100
+ /**
2101
+ * 操作人信息
2102
+ */
2103
+ Operator: UserInfo;
2104
+ /**
2105
+ * 自动签场景:
2106
+ E_PRESCRIPTION_AUTO_SIGN 电子处方
2107
+ */
2108
+ SceneKey: string;
2109
+ /**
2110
+ * 自动签开通,签署相关配置
2111
+ */
2112
+ AutoSignConfig: AutoSignConfig;
2113
+ /**
2114
+ * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
2115
+ */
2116
+ UrlType?: string;
2117
+ }
2070
2118
  /**
2071
2119
  * DescribeIntegrationMainOrganizationUser返回参数结构体
2072
2120
  */
@@ -2140,6 +2188,97 @@ export interface DeleteSealPoliciesRequest {
2140
2188
  */
2141
2189
  UserIds?: Array<string>;
2142
2190
  }
2191
+ /**
2192
+ * CreateFlowByFiles请求参数结构体
2193
+ */
2194
+ export interface CreateFlowByFilesRequest {
2195
+ /**
2196
+ * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
2197
+ */
2198
+ Operator: UserInfo;
2199
+ /**
2200
+ * 签署流程名称,最大长度200个字符
2201
+ */
2202
+ FlowName: string;
2203
+ /**
2204
+ * 签署参与者信息,最大限制50方
2205
+ */
2206
+ Approvers: Array<ApproverInfo>;
2207
+ /**
2208
+ * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
2209
+ */
2210
+ FileIds: Array<string>;
2211
+ /**
2212
+ * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
2213
+ */
2214
+ FlowType?: string;
2215
+ /**
2216
+ * 经办人内容控件配置
2217
+ */
2218
+ Components?: Array<Component>;
2219
+ /**
2220
+ * 被抄送人的信息列表。
2221
+ 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
2222
+ */
2223
+ CcInfos?: Array<CcInfo>;
2224
+ /**
2225
+ * 是否需要预览,true:预览模式,false:非预览(默认);
2226
+ 预览链接有效期300秒;
2227
+
2228
+ 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
2229
+ */
2230
+ NeedPreview?: boolean;
2231
+ /**
2232
+ * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
2233
+ */
2234
+ PreviewType?: number;
2235
+ /**
2236
+ * 签署流程的签署截止时间。
2237
+ 值为unix时间戳,精确到秒,不传默认为当前时间一年后
2238
+ */
2239
+ Deadline?: number;
2240
+ /**
2241
+ * 发送类型:
2242
+ true:无序签
2243
+ false:有序签
2244
+ 注:默认为false(有序签)
2245
+ */
2246
+ Unordered?: boolean;
2247
+ /**
2248
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2249
+ */
2250
+ CustomShowMap?: string;
2251
+ /**
2252
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
2253
+ 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2254
+
2255
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2256
+ */
2257
+ NeedSignReview?: boolean;
2258
+ /**
2259
+ * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
2260
+ */
2261
+ UserData?: string;
2262
+ /**
2263
+ * 签署人校验方式
2264
+ VerifyCheck: 人脸识别(默认)
2265
+ MobileCheck:手机号验证
2266
+ 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
2267
+ */
2268
+ ApproverVerifyType?: string;
2269
+ /**
2270
+ * 签署流程描述,最大长度1000个字符
2271
+ */
2272
+ FlowDescription?: string;
2273
+ /**
2274
+ * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
2275
+ */
2276
+ SignBeanTag?: number;
2277
+ /**
2278
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2279
+ */
2280
+ Agent?: Agent;
2281
+ }
2143
2282
  /**
2144
2283
  * CreatePrepareFlow返回参数结构体
2145
2284
  */
@@ -2303,6 +2442,20 @@ export interface ApproverOption {
2303
2442
  */
2304
2443
  NoTransfer?: boolean;
2305
2444
  }
2445
+ /**
2446
+ * 下载文件的URL信息
2447
+ */
2448
+ export interface FileUrl {
2449
+ /**
2450
+ * 下载文件的URL
2451
+ */
2452
+ Url: string;
2453
+ /**
2454
+ * 下载文件的附加信息
2455
+ 注意:此字段可能返回 null,表示取不到有效值。
2456
+ */
2457
+ Option: string;
2458
+ }
2306
2459
  /**
2307
2460
  * CreateSealPolicy请求参数结构体
2308
2461
  */
@@ -2924,6 +3077,24 @@ export interface CreateFlowResponse {
2924
3077
  */
2925
3078
  RequestId?: string;
2926
3079
  }
3080
+ /**
3081
+ * DescribeUserAutoSignStatus请求参数结构体
3082
+ */
3083
+ export interface DescribeUserAutoSignStatusRequest {
3084
+ /**
3085
+ * 操作人信息
3086
+ */
3087
+ Operator: UserInfo;
3088
+ /**
3089
+ * 自动签场景:
3090
+ E_PRESCRIPTION_AUTO_SIGN 电子处方
3091
+ */
3092
+ SceneKey: string;
3093
+ /**
3094
+ * 查询开启状态的用户信息
3095
+ */
3096
+ UserInfo: UserThreeFactor;
3097
+ }
2927
3098
  /**
2928
3099
  * 流程信息摘要
2929
3100
  */