tencentcloud-sdk-nodejs 4.0.358 → 4.0.359
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.
- package/CHANGELOG.md +137 -0
- package/SERVICE_CHANGELOG.md +167 -66
- package/package.json +1 -1
- package/products.md +12 -12
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cdn/v20180606/cdn_models.ts +13 -1
- package/src/services/ess/v20201111/ess_client.ts +27 -1
- package/src/services/ess/v20201111/ess_models.ts +161 -51
- package/src/services/essbasic/v20210526/essbasic_client.ts +45 -19
- package/src/services/essbasic/v20210526/essbasic_models.ts +127 -15
- package/src/services/ivld/v20210903/ivld_client.ts +4 -2
- package/src/services/partners/v20180321/partners_models.ts +1 -1
- package/src/services/ses/v20201002/ses_client.ts +1 -1
- package/src/services/ses/v20201002/ses_models.ts +2 -2
- package/src/services/ssl/v20191205/ssl_models.ts +19 -1
- package/src/services/tcr/v20190924/tcr_models.ts +15 -0
- package/src/services/tdmq/v20200217/tdmq_models.ts +4 -4
- package/src/services/trtc/v20190722/trtc_client.ts +2 -0
- package/src/services/trtc/v20190722/trtc_models.ts +104 -1
- package/src/services/vod/v20180717/vod_models.ts +15 -11
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +11 -1
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +10 -1
- package/tencentcloud/services/ess/v20201111/ess_client.js +13 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +139 -46
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -9
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +23 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +109 -14
- package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +4 -2
- package/tencentcloud/services/ivld/v20210903/ivld_client.js +4 -2
- package/tencentcloud/services/partners/v20180321/partners_models.d.ts +1 -1
- package/tencentcloud/services/ses/v20201002/ses_client.d.ts +1 -1
- package/tencentcloud/services/ses/v20201002/ses_client.js +1 -1
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +17 -1
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +12 -0
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +4 -4
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +86 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +14 -10
- package/test/ess.v20201111.test.js +20 -0
- package/test/essbasic.v20210526.test.js +24 -4
|
@@ -598,7 +598,25 @@ export interface DescribeManagersResponse {
|
|
|
598
598
|
/**
|
|
599
599
|
* 根证书
|
|
600
600
|
*/
|
|
601
|
-
export
|
|
601
|
+
export interface RootCertificates {
|
|
602
|
+
/**
|
|
603
|
+
* 国密签名证书
|
|
604
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
605
|
+
*/
|
|
606
|
+
Sign: string
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* 国密加密证书
|
|
610
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
611
|
+
*/
|
|
612
|
+
Encrypt: string
|
|
613
|
+
|
|
614
|
+
/**
|
|
615
|
+
* 标准证书
|
|
616
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
617
|
+
*/
|
|
618
|
+
Standard: string
|
|
619
|
+
}
|
|
602
620
|
|
|
603
621
|
/**
|
|
604
622
|
* DescribeCertificate返回参数结构体
|
|
@@ -805,6 +805,11 @@ export interface CreateReplicationInstanceRequest {
|
|
|
805
805
|
* 复制实例地域名称
|
|
806
806
|
*/
|
|
807
807
|
ReplicationRegionName?: string
|
|
808
|
+
|
|
809
|
+
/**
|
|
810
|
+
* 是否同步TCR云标签至生成的COS Bucket
|
|
811
|
+
*/
|
|
812
|
+
SyncTag?: boolean
|
|
808
813
|
}
|
|
809
814
|
|
|
810
815
|
/**
|
|
@@ -2872,6 +2877,11 @@ export interface CreateInstanceRequest {
|
|
|
2872
2877
|
* 实例计费类型,0表示按量计费,1表示预付费,默认为按量计费
|
|
2873
2878
|
*/
|
|
2874
2879
|
RegistryChargeType?: number
|
|
2880
|
+
|
|
2881
|
+
/**
|
|
2882
|
+
* 是否同步TCR云标签至生成的COS Bucket
|
|
2883
|
+
*/
|
|
2884
|
+
SyncTag?: boolean
|
|
2875
2885
|
}
|
|
2876
2886
|
|
|
2877
2887
|
/**
|
|
@@ -3446,6 +3456,11 @@ export interface DeleteInstanceRequest {
|
|
|
3446
3456
|
* 是否删除存储桶,默认为false
|
|
3447
3457
|
*/
|
|
3448
3458
|
DeleteBucket?: boolean
|
|
3459
|
+
|
|
3460
|
+
/**
|
|
3461
|
+
* 是否dryRun模式,缺省值:false
|
|
3462
|
+
*/
|
|
3463
|
+
DryRun?: boolean
|
|
3449
3464
|
}
|
|
3450
3465
|
|
|
3451
3466
|
/**
|
|
@@ -5576,7 +5576,7 @@ export interface CreateCmqQueueRequest {
|
|
|
5576
5576
|
Tags?: Array<Tag>
|
|
5577
5577
|
|
|
5578
5578
|
/**
|
|
5579
|
-
*
|
|
5579
|
+
* 队列可回溯存储空间:若开启消息回溯,取值范围:10240MB - 512000MB,若不开启消息回溯,取值:0
|
|
5580
5580
|
*/
|
|
5581
5581
|
RetentionSizeInMB?: number
|
|
5582
5582
|
}
|
|
@@ -6077,12 +6077,12 @@ export interface PublishCmqMsgRequest {
|
|
|
6077
6077
|
TopicName: string
|
|
6078
6078
|
|
|
6079
6079
|
/**
|
|
6080
|
-
*
|
|
6080
|
+
* 消息内容,消息总大小需不大于1024K
|
|
6081
6081
|
*/
|
|
6082
6082
|
MsgContent: string
|
|
6083
6083
|
|
|
6084
6084
|
/**
|
|
6085
|
-
*
|
|
6085
|
+
* 消息标签,支持传递多标签或单路由,单个标签、路由长度不能超过64个字符。
|
|
6086
6086
|
*/
|
|
6087
6087
|
MsgTag?: Array<string>
|
|
6088
6088
|
}
|
|
@@ -6292,7 +6292,7 @@ export interface ModifyCmqQueueAttributeRequest {
|
|
|
6292
6292
|
Transaction?: number
|
|
6293
6293
|
|
|
6294
6294
|
/**
|
|
6295
|
-
*
|
|
6295
|
+
* 队列可回溯存储空间:若开启消息回溯,取值范围:10240MB - 512000MB,若不开启消息回溯,取值:0
|
|
6296
6296
|
*/
|
|
6297
6297
|
RetentionSizeInMB?: number
|
|
6298
6298
|
}
|
|
@@ -794,6 +794,18 @@ export interface EncodeParams {
|
|
|
794
794
|
* MeasureTrtcMcuExternal返回参数结构体
|
|
795
795
|
*/
|
|
796
796
|
export interface MeasureTrtcMcuExternalResponse {
|
|
797
|
+
/**
|
|
798
|
+
* 应用的用量信息数组。
|
|
799
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
800
|
+
*/
|
|
801
|
+
Usages: Array<OneSdkAppIdTranscodeTimeUsagesNewInfo>
|
|
802
|
+
|
|
803
|
+
/**
|
|
804
|
+
* 用户计费类型
|
|
805
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
806
|
+
*/
|
|
807
|
+
Type: string
|
|
808
|
+
|
|
797
809
|
/**
|
|
798
810
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
799
811
|
*/
|
|
@@ -1056,6 +1068,77 @@ export interface WaterMarkImage {
|
|
|
1056
1068
|
Height: number
|
|
1057
1069
|
}
|
|
1058
1070
|
|
|
1071
|
+
/**
|
|
1072
|
+
* 查询旁路转码计费时长。
|
|
1073
|
+
查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
1074
|
+
*/
|
|
1075
|
+
export interface SdkAppIdTrtcMcuTranscodeTimeNewUsage {
|
|
1076
|
+
/**
|
|
1077
|
+
* 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。
|
|
1078
|
+
*/
|
|
1079
|
+
TimeKey: string
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* 语音时长,单位:秒。
|
|
1083
|
+
*/
|
|
1084
|
+
AudioTime: number
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* 视频时长-标清SD,单位:秒。
|
|
1088
|
+
*/
|
|
1089
|
+
VideoTimeH264SD: number
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
* 视频时长-高清HD,单位:秒。
|
|
1093
|
+
*/
|
|
1094
|
+
VideoTimeH264HD: number
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* 视频时长-全高清FHD,单位:秒。
|
|
1098
|
+
*/
|
|
1099
|
+
VideoTimeH264FHD: number
|
|
1100
|
+
|
|
1101
|
+
/**
|
|
1102
|
+
* 视频时长-带宽,单位:mbps。
|
|
1103
|
+
*/
|
|
1104
|
+
Flux: number
|
|
1105
|
+
|
|
1106
|
+
/**
|
|
1107
|
+
* 视频时长-标清2K,单位:秒。
|
|
1108
|
+
*/
|
|
1109
|
+
VideoTimeH2642K: number
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* 视频时长-标清4K,单位:秒。
|
|
1113
|
+
*/
|
|
1114
|
+
VideoTimeH2644K: number
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* 视频时长-标清265SD,单位:秒。
|
|
1118
|
+
*/
|
|
1119
|
+
VideoTimeH265SD: number
|
|
1120
|
+
|
|
1121
|
+
/**
|
|
1122
|
+
* 视频时长-高清265HD,单位:秒。
|
|
1123
|
+
*/
|
|
1124
|
+
VideoTimeH265HD: number
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* 视频时长-全高清265FHD,单位:秒。
|
|
1128
|
+
*/
|
|
1129
|
+
VideoTimeH265FHD: number
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* 视频时长-标清2652K,单位:秒。
|
|
1133
|
+
*/
|
|
1134
|
+
VideoTimeH2652K: number
|
|
1135
|
+
|
|
1136
|
+
/**
|
|
1137
|
+
* 视频时长-标清265 4K,单位:秒。
|
|
1138
|
+
*/
|
|
1139
|
+
VideoTimeH2654K: number
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1059
1142
|
/**
|
|
1060
1143
|
* 查询旁路转码计费时长。
|
|
1061
1144
|
查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
@@ -1087,6 +1170,26 @@ export interface SdkAppIdTrtcMcuTranscodeTimeUsage {
|
|
|
1087
1170
|
VideoTimeFhd: number
|
|
1088
1171
|
}
|
|
1089
1172
|
|
|
1173
|
+
/**
|
|
1174
|
+
* 旁路转码时长的查询结果
|
|
1175
|
+
*/
|
|
1176
|
+
export interface OneSdkAppIdTranscodeTimeUsagesNewInfo {
|
|
1177
|
+
/**
|
|
1178
|
+
* 旁路转码时长查询结果数组
|
|
1179
|
+
*/
|
|
1180
|
+
SdkAppIdTranscodeTimeUsages: Array<SdkAppIdTrtcMcuTranscodeTimeNewUsage>
|
|
1181
|
+
|
|
1182
|
+
/**
|
|
1183
|
+
* 查询记录数量
|
|
1184
|
+
*/
|
|
1185
|
+
TotalNum: number
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。
|
|
1189
|
+
*/
|
|
1190
|
+
SdkAppId: string
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1090
1193
|
/**
|
|
1091
1194
|
* ModifyPicture返回参数结构体
|
|
1092
1195
|
*/
|
|
@@ -2215,7 +2318,7 @@ export interface AudioParams {
|
|
|
2215
2318
|
|
|
2216
2319
|
/**
|
|
2217
2320
|
* 声道数:
|
|
2218
|
-
1
|
|
2321
|
+
1:单声道;
|
|
2219
2322
|
2:双声道(默认)。
|
|
2220
2323
|
*/
|
|
2221
2324
|
Channel: number
|
|
@@ -1583,8 +1583,9 @@ export interface AudioTemplateInfoForUpdate {
|
|
|
1583
1583
|
<li>libmp3lame:更适合 flv;</li>
|
|
1584
1584
|
<li>mp2。</li>
|
|
1585
1585
|
当外层参数 Container 为 hls 时,可选值为:
|
|
1586
|
-
<li>libfdk_aac
|
|
1587
|
-
|
|
1586
|
+
<li>libfdk_aac。</li>
|
|
1587
|
+
当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为:
|
|
1588
|
+
<li>libfdk_aac。</li>
|
|
1588
1589
|
*/
|
|
1589
1590
|
Codec?: string
|
|
1590
1591
|
|
|
@@ -1711,8 +1712,9 @@ export interface AudioTemplateInfo {
|
|
|
1711
1712
|
<li>libmp3lame:更适合 flv;</li>
|
|
1712
1713
|
<li>mp2。</li>
|
|
1713
1714
|
当外层参数 Container 为 hls 时,可选值为:
|
|
1714
|
-
<li>libfdk_aac
|
|
1715
|
-
|
|
1715
|
+
<li>libfdk_aac。</li>
|
|
1716
|
+
当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为:
|
|
1717
|
+
<li>libfdk_aac。</li>
|
|
1716
1718
|
*/
|
|
1717
1719
|
Codec: string
|
|
1718
1720
|
|
|
@@ -1949,7 +1951,8 @@ export interface AiRecognitionTaskHeadTailResultInput {
|
|
|
1949
1951
|
export interface CreateAdaptiveDynamicStreamingTemplateRequest {
|
|
1950
1952
|
/**
|
|
1951
1953
|
* 自适应转码格式,取值范围:
|
|
1952
|
-
<li>HLS
|
|
1954
|
+
<li>HLS;</li>
|
|
1955
|
+
<li>MPEG-DASH。</li>
|
|
1953
1956
|
*/
|
|
1954
1957
|
Format: string
|
|
1955
1958
|
|
|
@@ -5749,6 +5752,11 @@ export interface ModifyAdaptiveDynamicStreamingTemplateRequest {
|
|
|
5749
5752
|
*/
|
|
5750
5753
|
Definition: number
|
|
5751
5754
|
|
|
5755
|
+
/**
|
|
5756
|
+
* <b>点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。</b>
|
|
5757
|
+
*/
|
|
5758
|
+
SubAppId?: number
|
|
5759
|
+
|
|
5752
5760
|
/**
|
|
5753
5761
|
* 模板名称,长度限制:64 个字符。
|
|
5754
5762
|
*/
|
|
@@ -5756,7 +5764,8 @@ export interface ModifyAdaptiveDynamicStreamingTemplateRequest {
|
|
|
5756
5764
|
|
|
5757
5765
|
/**
|
|
5758
5766
|
* 自适应转码格式,取值范围:
|
|
5759
|
-
<li>HLS
|
|
5767
|
+
<li>HLS;</li>
|
|
5768
|
+
<li>MPEG-DASH。</li>
|
|
5760
5769
|
*/
|
|
5761
5770
|
Format?: string
|
|
5762
5771
|
|
|
@@ -5784,11 +5793,6 @@ export interface ModifyAdaptiveDynamicStreamingTemplateRequest {
|
|
|
5784
5793
|
* 模板描述信息,长度限制:256 个字符。
|
|
5785
5794
|
*/
|
|
5786
5795
|
Comment?: string
|
|
5787
|
-
|
|
5788
|
-
/**
|
|
5789
|
-
* 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
|
|
5790
|
-
*/
|
|
5791
|
-
SubAppId?: number
|
|
5792
5796
|
}
|
|
5793
5797
|
|
|
5794
5798
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const sdkVersion = "4.0.
|
|
1
|
+
export declare const sdkVersion = "4.0.359";
|
|
@@ -2925,6 +2925,16 @@ disabled:未启用
|
|
|
2925
2925
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2926
2926
|
*/
|
|
2927
2927
|
ExtensionMode: number;
|
|
2928
|
+
/**
|
|
2929
|
+
* 流量包实际生效时间
|
|
2930
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2931
|
+
*/
|
|
2932
|
+
TrueEnableTime: string;
|
|
2933
|
+
/**
|
|
2934
|
+
* 流量包实际过期时间
|
|
2935
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2936
|
+
*/
|
|
2937
|
+
TrueExpireTime: string;
|
|
2928
2938
|
}
|
|
2929
2939
|
/**
|
|
2930
2940
|
* Bot cookie策略
|
|
@@ -4033,7 +4043,7 @@ export interface WebSocket {
|
|
|
4033
4043
|
*/
|
|
4034
4044
|
Switch: string;
|
|
4035
4045
|
/**
|
|
4036
|
-
* 设置超时时间,单位为秒,最大超时时间
|
|
4046
|
+
* 设置超时时间,单位为秒,最大超时时间300秒。
|
|
4037
4047
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4038
4048
|
*/
|
|
4039
4049
|
Timeout?: number;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, StartFlowResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowResponse, DescribeFlowTemplatesRequest } from "./ess_models";
|
|
3
|
+
import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, CreateMultiFlowSignQRCodeRequest, StartFlowResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest } from "./ess_models";
|
|
4
4
|
/**
|
|
5
5
|
* ess client
|
|
6
6
|
* @class
|
|
@@ -11,6 +11,11 @@ export declare class Client extends AbstractClient {
|
|
|
11
11
|
* 此接口用于发起流程
|
|
12
12
|
*/
|
|
13
13
|
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
14
|
+
/**
|
|
15
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
16
|
+
适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
|
|
17
|
+
*/
|
|
18
|
+
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
14
19
|
/**
|
|
15
20
|
* 用于撤销流程
|
|
16
21
|
*/
|
|
@@ -31,6 +36,10 @@ export declare class Client extends AbstractClient {
|
|
|
31
36
|
* 创建签署流程
|
|
32
37
|
*/
|
|
33
38
|
CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
41
|
+
*/
|
|
42
|
+
CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
|
|
34
43
|
/**
|
|
35
44
|
* 获取小程序跳转链接
|
|
36
45
|
|
|
@@ -33,6 +33,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
33
33
|
async StartFlow(req, cb) {
|
|
34
34
|
return this.request("StartFlow", req, cb);
|
|
35
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
38
|
+
适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
|
|
39
|
+
*/
|
|
40
|
+
async CreateMultiFlowSignQRCode(req, cb) {
|
|
41
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
42
|
+
}
|
|
36
43
|
/**
|
|
37
44
|
* 用于撤销流程
|
|
38
45
|
*/
|
|
@@ -63,6 +70,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
63
70
|
async CreateFlow(req, cb) {
|
|
64
71
|
return this.request("CreateFlow", req, cb);
|
|
65
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
75
|
+
*/
|
|
76
|
+
async CancelMultiFlowSignQRCode(req, cb) {
|
|
77
|
+
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
78
|
+
}
|
|
66
79
|
/**
|
|
67
80
|
* 获取小程序跳转链接
|
|
68
81
|
|
|
@@ -11,6 +11,23 @@ export interface UploadFile {
|
|
|
11
11
|
*/
|
|
12
12
|
FileName?: string;
|
|
13
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* CancelMultiFlowSignQRCode请求参数结构体
|
|
16
|
+
*/
|
|
17
|
+
export interface CancelMultiFlowSignQRCodeRequest {
|
|
18
|
+
/**
|
|
19
|
+
* 用户信息
|
|
20
|
+
*/
|
|
21
|
+
Operator: UserInfo;
|
|
22
|
+
/**
|
|
23
|
+
* 二维码id
|
|
24
|
+
*/
|
|
25
|
+
QrCodeId: string;
|
|
26
|
+
/**
|
|
27
|
+
* 应用信息
|
|
28
|
+
*/
|
|
29
|
+
Agent?: Agent;
|
|
30
|
+
}
|
|
14
31
|
/**
|
|
15
32
|
* DescribeFileUrls返回参数结构体
|
|
16
33
|
*/
|
|
@@ -291,6 +308,23 @@ export interface DescribeThirdPartyAuthCodeRequest {
|
|
|
291
308
|
*/
|
|
292
309
|
AuthCode: string;
|
|
293
310
|
}
|
|
311
|
+
/**
|
|
312
|
+
* 一码多扫签署二维码对象
|
|
313
|
+
*/
|
|
314
|
+
export interface SignQrCode {
|
|
315
|
+
/**
|
|
316
|
+
* 二维码id
|
|
317
|
+
*/
|
|
318
|
+
QrCodeId: string;
|
|
319
|
+
/**
|
|
320
|
+
* 二维码url
|
|
321
|
+
*/
|
|
322
|
+
QrCodeUrl: string;
|
|
323
|
+
/**
|
|
324
|
+
* 二维码过期时间
|
|
325
|
+
*/
|
|
326
|
+
ExpiredTime: number;
|
|
327
|
+
}
|
|
294
328
|
/**
|
|
295
329
|
* UploadFiles请求参数结构体
|
|
296
330
|
*/
|
|
@@ -461,6 +495,84 @@ KEYWORD 关键字,使用ComponentId指定关键字
|
|
|
461
495
|
*/
|
|
462
496
|
OffsetY?: number;
|
|
463
497
|
}
|
|
498
|
+
/**
|
|
499
|
+
* CreateMultiFlowSignQRCode返回参数结构体
|
|
500
|
+
*/
|
|
501
|
+
export interface CreateMultiFlowSignQRCodeResponse {
|
|
502
|
+
/**
|
|
503
|
+
* 签署二维码对象
|
|
504
|
+
*/
|
|
505
|
+
QrCode: SignQrCode;
|
|
506
|
+
/**
|
|
507
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
508
|
+
*/
|
|
509
|
+
RequestId?: string;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* 创建流程的签署方信息
|
|
513
|
+
*/
|
|
514
|
+
export interface FlowCreateApprover {
|
|
515
|
+
/**
|
|
516
|
+
* 参与者类型:
|
|
517
|
+
0:企业
|
|
518
|
+
1:个人
|
|
519
|
+
3:企业静默签署
|
|
520
|
+
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
521
|
+
*/
|
|
522
|
+
ApproverType: number;
|
|
523
|
+
/**
|
|
524
|
+
* 如果签署方为企业,需要填入企业全称
|
|
525
|
+
*/
|
|
526
|
+
OrganizationName?: string;
|
|
527
|
+
/**
|
|
528
|
+
* 是否需要签署
|
|
529
|
+
- `false`: 不需要签署
|
|
530
|
+
- `true`: 需要签署
|
|
531
|
+
*/
|
|
532
|
+
Required?: boolean;
|
|
533
|
+
/**
|
|
534
|
+
* 签署方经办人姓名
|
|
535
|
+
*/
|
|
536
|
+
ApproverName?: string;
|
|
537
|
+
/**
|
|
538
|
+
* 签署方经办人手机号码
|
|
539
|
+
*/
|
|
540
|
+
ApproverMobile?: string;
|
|
541
|
+
/**
|
|
542
|
+
* 签署方经办人证件号码
|
|
543
|
+
*/
|
|
544
|
+
ApproverIdCardNumber?: string;
|
|
545
|
+
/**
|
|
546
|
+
* 签署方经办人证件类型ID_CARD 身份证
|
|
547
|
+
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
548
|
+
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
549
|
+
*/
|
|
550
|
+
ApproverIdCardType?: string;
|
|
551
|
+
/**
|
|
552
|
+
* 签署方经办人在模板中的角色ID
|
|
553
|
+
*/
|
|
554
|
+
RecipientId?: string;
|
|
555
|
+
/**
|
|
556
|
+
* 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
|
|
557
|
+
*/
|
|
558
|
+
UserId?: string;
|
|
559
|
+
/**
|
|
560
|
+
* 签署前置条件:是否需要阅读全文,默认为不需要
|
|
561
|
+
*/
|
|
562
|
+
IsFullText?: boolean;
|
|
563
|
+
/**
|
|
564
|
+
* 签署前置条件:阅读时长限制,默认为不需要
|
|
565
|
+
*/
|
|
566
|
+
PreReadTime?: number;
|
|
567
|
+
/**
|
|
568
|
+
* 是否发送短信,sms--短信通知,none--不通知,默认为sms
|
|
569
|
+
*/
|
|
570
|
+
NotifyType?: string;
|
|
571
|
+
/**
|
|
572
|
+
* 签署意愿确认渠道,WEIXINAPP:人脸识别
|
|
573
|
+
*/
|
|
574
|
+
VerifyChannel?: Array<string>;
|
|
575
|
+
}
|
|
464
576
|
/**
|
|
465
577
|
* UploadFiles返回参数结构体
|
|
466
578
|
*/
|
|
@@ -765,69 +877,41 @@ export interface FileInfo {
|
|
|
765
877
|
CreatedOn?: number;
|
|
766
878
|
}
|
|
767
879
|
/**
|
|
768
|
-
*
|
|
880
|
+
* CreateMultiFlowSignQRCode请求参数结构体
|
|
769
881
|
*/
|
|
770
|
-
export interface
|
|
882
|
+
export interface CreateMultiFlowSignQRCodeRequest {
|
|
771
883
|
/**
|
|
772
|
-
*
|
|
773
|
-
0:企业
|
|
774
|
-
1:个人
|
|
775
|
-
3:企业静默签署
|
|
776
|
-
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
|
|
777
|
-
*/
|
|
778
|
-
ApproverType: number;
|
|
779
|
-
/**
|
|
780
|
-
* 如果签署方为企业,需要填入企业全称
|
|
781
|
-
*/
|
|
782
|
-
OrganizationName?: string;
|
|
783
|
-
/**
|
|
784
|
-
* 是否需要签署
|
|
785
|
-
- `false`: 不需要签署
|
|
786
|
-
- `true`: 需要签署
|
|
787
|
-
*/
|
|
788
|
-
Required?: boolean;
|
|
789
|
-
/**
|
|
790
|
-
* 签署方经办人姓名
|
|
884
|
+
* 模版ID
|
|
791
885
|
*/
|
|
792
|
-
|
|
793
|
-
/**
|
|
794
|
-
* 签署方经办人手机号码
|
|
795
|
-
*/
|
|
796
|
-
ApproverMobile?: string;
|
|
797
|
-
/**
|
|
798
|
-
* 签署方经办人证件号码
|
|
799
|
-
*/
|
|
800
|
-
ApproverIdCardNumber?: string;
|
|
886
|
+
TemplateId: string;
|
|
801
887
|
/**
|
|
802
|
-
*
|
|
803
|
-
HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
804
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
888
|
+
* 用户信息
|
|
805
889
|
*/
|
|
806
|
-
|
|
890
|
+
Operator: UserInfo;
|
|
807
891
|
/**
|
|
808
|
-
*
|
|
892
|
+
* 合同名称
|
|
809
893
|
*/
|
|
810
|
-
|
|
894
|
+
FlowName: string;
|
|
811
895
|
/**
|
|
812
|
-
*
|
|
896
|
+
* 应用信息
|
|
813
897
|
*/
|
|
814
|
-
|
|
898
|
+
Agent?: Agent;
|
|
815
899
|
/**
|
|
816
|
-
*
|
|
900
|
+
* 合同有效天数 默认7天 最高设置不超过30天
|
|
817
901
|
*/
|
|
818
|
-
|
|
902
|
+
FlowEffectiveDay?: number;
|
|
819
903
|
/**
|
|
820
|
-
*
|
|
904
|
+
* 二维码有效天数 默认7天 最高设置不超过90天
|
|
821
905
|
*/
|
|
822
|
-
|
|
906
|
+
QrEffectiveDay?: number;
|
|
823
907
|
/**
|
|
824
|
-
*
|
|
908
|
+
* 最大合同份数,默认5份 超过此上限 二维码自动失效
|
|
825
909
|
*/
|
|
826
|
-
|
|
910
|
+
MaxFlowNum?: number;
|
|
827
911
|
/**
|
|
828
|
-
*
|
|
912
|
+
* 回调地址
|
|
829
913
|
*/
|
|
830
|
-
|
|
914
|
+
CallbackUrl?: string;
|
|
831
915
|
}
|
|
832
916
|
/**
|
|
833
917
|
* StartFlow返回参数结构体
|
|
@@ -914,6 +998,15 @@ MULTI_LINE_TEXT - 多行文本控件
|
|
|
914
998
|
*/
|
|
915
999
|
NeedPreview?: boolean;
|
|
916
1000
|
}
|
|
1001
|
+
/**
|
|
1002
|
+
* CancelMultiFlowSignQRCode返回参数结构体
|
|
1003
|
+
*/
|
|
1004
|
+
export interface CancelMultiFlowSignQRCodeResponse {
|
|
1005
|
+
/**
|
|
1006
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1007
|
+
*/
|
|
1008
|
+
RequestId?: string;
|
|
1009
|
+
}
|
|
917
1010
|
/**
|
|
918
1011
|
* CreateFlow返回参数结构体
|
|
919
1012
|
*/
|