tencentcloud-sdk-nodejs 4.0.415 → 4.0.416
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 +60 -0
- package/SERVICE_CHANGELOG.md +90 -460
- package/package.json +1 -1
- package/products.md +4 -4
- package/src/common/sdk_version.ts +1 -1
- package/src/services/ess/v20201111/ess_client.ts +32 -16
- package/src/services/ess/v20201111/ess_models.ts +49 -6
- package/src/services/essbasic/v20210526/essbasic_client.ts +31 -16
- package/src/services/essbasic/v20210526/essbasic_models.ts +69 -31
- package/src/services/ocr/v20181119/ocr_client.ts +1 -1
- package/src/services/ocr/v20181119/ocr_models.ts +5 -0
- package/src/services/tem/v20210701/tem_client.ts +27 -3
- package/src/services/tem/v20210701/tem_models.ts +193 -105
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +16 -8
- package/tencentcloud/services/ess/v20201111/ess_client.js +19 -9
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +43 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -8
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +62 -29
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
- package/tencentcloud/services/tem/v20210701/tem_client.d.ts +9 -1
- package/tencentcloud/services/tem/v20210701/tem_client.js +12 -0
- package/tencentcloud/services/tem/v20210701/tem_models.d.ts +165 -90
- package/test/ess.v20201111.test.js +14 -4
- package/test/essbasic.v20210526.test.js +14 -4
- package/test/tem.v20210701.test.js +20 -0
|
@@ -255,6 +255,26 @@ export interface DescribeApplicationPodsRequest {
|
|
|
255
255
|
SourceChannel?: number
|
|
256
256
|
}
|
|
257
257
|
|
|
258
|
+
/**
|
|
259
|
+
* ingress tls 配置
|
|
260
|
+
*/
|
|
261
|
+
export interface IngressTls {
|
|
262
|
+
/**
|
|
263
|
+
* host 数组, 空数组表示全部域名的默认证书
|
|
264
|
+
*/
|
|
265
|
+
Hosts: Array<string>
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* secret name,如使用证书,则填空字符串
|
|
269
|
+
*/
|
|
270
|
+
SecretName: string
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* SSL Certificate Id
|
|
274
|
+
*/
|
|
275
|
+
CertificateId?: string
|
|
276
|
+
}
|
|
277
|
+
|
|
258
278
|
/**
|
|
259
279
|
* 分批发布单批次详情
|
|
260
280
|
*/
|
|
@@ -1018,23 +1038,38 @@ export interface DescribeEnvironmentStatusResponse {
|
|
|
1018
1038
|
}
|
|
1019
1039
|
|
|
1020
1040
|
/**
|
|
1021
|
-
*
|
|
1041
|
+
* 分批发布策略配置
|
|
1022
1042
|
*/
|
|
1023
|
-
export interface
|
|
1043
|
+
export interface DeployStrategyConf {
|
|
1024
1044
|
/**
|
|
1025
|
-
*
|
|
1045
|
+
* 总分批数
|
|
1026
1046
|
*/
|
|
1027
|
-
|
|
1047
|
+
TotalBatchCount?: number
|
|
1028
1048
|
|
|
1029
1049
|
/**
|
|
1030
|
-
*
|
|
1050
|
+
* beta分批实例数
|
|
1031
1051
|
*/
|
|
1032
|
-
|
|
1052
|
+
BetaBatchNum?: number
|
|
1033
1053
|
|
|
1034
1054
|
/**
|
|
1035
|
-
*
|
|
1055
|
+
* 分批策略:0-全自动,1-全手动,2-beta分批,beta批一定是手动的,3-首次发布
|
|
1036
1056
|
*/
|
|
1037
|
-
|
|
1057
|
+
DeployStrategyType?: number
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* 每批暂停间隔
|
|
1061
|
+
*/
|
|
1062
|
+
BatchInterval?: number
|
|
1063
|
+
|
|
1064
|
+
/**
|
|
1065
|
+
* 最小可用实例数
|
|
1066
|
+
*/
|
|
1067
|
+
MinAvailable?: number
|
|
1068
|
+
|
|
1069
|
+
/**
|
|
1070
|
+
* 是否强制发布
|
|
1071
|
+
*/
|
|
1072
|
+
Force?: boolean
|
|
1038
1073
|
}
|
|
1039
1074
|
|
|
1040
1075
|
/**
|
|
@@ -1077,6 +1112,22 @@ export interface DescribeConfigDataListRequest {
|
|
|
1077
1112
|
Limit?: number
|
|
1078
1113
|
}
|
|
1079
1114
|
|
|
1115
|
+
/**
|
|
1116
|
+
* EnableApplicationAutoscaler返回参数结构体
|
|
1117
|
+
*/
|
|
1118
|
+
export interface EnableApplicationAutoscalerResponse {
|
|
1119
|
+
/**
|
|
1120
|
+
* 是否成功
|
|
1121
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1122
|
+
*/
|
|
1123
|
+
Result: boolean
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1127
|
+
*/
|
|
1128
|
+
RequestId?: string
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1080
1131
|
/**
|
|
1081
1132
|
* 服务分页
|
|
1082
1133
|
*/
|
|
@@ -2005,6 +2056,22 @@ export interface DestroyEnvironmentResponse {
|
|
|
2005
2056
|
RequestId?: string
|
|
2006
2057
|
}
|
|
2007
2058
|
|
|
2059
|
+
/**
|
|
2060
|
+
* DisableApplicationAutoscaler返回参数结构体
|
|
2061
|
+
*/
|
|
2062
|
+
export interface DisableApplicationAutoscalerResponse {
|
|
2063
|
+
/**
|
|
2064
|
+
* 是否成功
|
|
2065
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2066
|
+
*/
|
|
2067
|
+
Result: boolean
|
|
2068
|
+
|
|
2069
|
+
/**
|
|
2070
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2071
|
+
*/
|
|
2072
|
+
RequestId?: string
|
|
2073
|
+
}
|
|
2074
|
+
|
|
2008
2075
|
/**
|
|
2009
2076
|
* DescribeIngress请求参数结构体
|
|
2010
2077
|
*/
|
|
@@ -2239,6 +2306,31 @@ export interface DeleteIngressRequest {
|
|
|
2239
2306
|
SourceChannel?: number
|
|
2240
2307
|
}
|
|
2241
2308
|
|
|
2309
|
+
/**
|
|
2310
|
+
* DisableApplicationAutoscaler请求参数结构体
|
|
2311
|
+
*/
|
|
2312
|
+
export interface DisableApplicationAutoscalerRequest {
|
|
2313
|
+
/**
|
|
2314
|
+
* 服务id
|
|
2315
|
+
*/
|
|
2316
|
+
ApplicationId: string
|
|
2317
|
+
|
|
2318
|
+
/**
|
|
2319
|
+
* 环境ID
|
|
2320
|
+
*/
|
|
2321
|
+
EnvironmentId: string
|
|
2322
|
+
|
|
2323
|
+
/**
|
|
2324
|
+
* 来源渠道
|
|
2325
|
+
*/
|
|
2326
|
+
SourceChannel?: number
|
|
2327
|
+
|
|
2328
|
+
/**
|
|
2329
|
+
* 弹性伸缩策略ID
|
|
2330
|
+
*/
|
|
2331
|
+
AutoscalerId?: string
|
|
2332
|
+
}
|
|
2333
|
+
|
|
2242
2334
|
/**
|
|
2243
2335
|
* DescribeRelatedIngresses请求参数结构体
|
|
2244
2336
|
*/
|
|
@@ -3324,15 +3416,21 @@ export interface DeployApplicationRequest {
|
|
|
3324
3416
|
OsFlavour?: string
|
|
3325
3417
|
|
|
3326
3418
|
/**
|
|
3327
|
-
*
|
|
3419
|
+
* metrics业务指标监控配置
|
|
3328
3420
|
*/
|
|
3329
3421
|
EnablePrometheusConf?: EnablePrometheusConf
|
|
3330
3422
|
|
|
3331
3423
|
/**
|
|
3332
|
-
* 1
|
|
3424
|
+
* 1:开始自动apm采集(skywalking);
|
|
3333
3425
|
0:关闭apm采集;
|
|
3334
3426
|
*/
|
|
3335
3427
|
EnableTracing?: number
|
|
3428
|
+
|
|
3429
|
+
/**
|
|
3430
|
+
* 1:开始自动metrics采集(open-telemetry);
|
|
3431
|
+
0:关闭metrics采集;
|
|
3432
|
+
*/
|
|
3433
|
+
EnableMetrics?: number
|
|
3336
3434
|
}
|
|
3337
3435
|
|
|
3338
3436
|
/**
|
|
@@ -3700,41 +3798,6 @@ export interface IngressRuleBackend {
|
|
|
3700
3798
|
ServicePort: number
|
|
3701
3799
|
}
|
|
3702
3800
|
|
|
3703
|
-
/**
|
|
3704
|
-
* 分批发布策略配置
|
|
3705
|
-
*/
|
|
3706
|
-
export interface DeployStrategyConf {
|
|
3707
|
-
/**
|
|
3708
|
-
* 总分批数
|
|
3709
|
-
*/
|
|
3710
|
-
TotalBatchCount?: number
|
|
3711
|
-
|
|
3712
|
-
/**
|
|
3713
|
-
* beta分批实例数
|
|
3714
|
-
*/
|
|
3715
|
-
BetaBatchNum?: number
|
|
3716
|
-
|
|
3717
|
-
/**
|
|
3718
|
-
* 分批策略:0-全自动,1-全手动,2-beta分批,beta批一定是手动的,3-首次发布
|
|
3719
|
-
*/
|
|
3720
|
-
DeployStrategyType?: number
|
|
3721
|
-
|
|
3722
|
-
/**
|
|
3723
|
-
* 每批暂停间隔
|
|
3724
|
-
*/
|
|
3725
|
-
BatchInterval?: number
|
|
3726
|
-
|
|
3727
|
-
/**
|
|
3728
|
-
* 最小可用实例数
|
|
3729
|
-
*/
|
|
3730
|
-
MinAvailable?: number
|
|
3731
|
-
|
|
3732
|
-
/**
|
|
3733
|
-
* 是否强制发布
|
|
3734
|
-
*/
|
|
3735
|
-
Force?: boolean
|
|
3736
|
-
}
|
|
3737
|
-
|
|
3738
3801
|
/**
|
|
3739
3802
|
* DescribeIngress返回参数结构体
|
|
3740
3803
|
*/
|
|
@@ -3963,6 +4026,80 @@ export interface PortMapping {
|
|
|
3963
4026
|
ServiceName?: string
|
|
3964
4027
|
}
|
|
3965
4028
|
|
|
4029
|
+
/**
|
|
4030
|
+
* 日志收集配置
|
|
4031
|
+
*/
|
|
4032
|
+
export interface LogConfig {
|
|
4033
|
+
/**
|
|
4034
|
+
* 名称
|
|
4035
|
+
*/
|
|
4036
|
+
Name: string
|
|
4037
|
+
|
|
4038
|
+
/**
|
|
4039
|
+
* 收集类型,container_stdout 为标准输出;container_file 为文件;
|
|
4040
|
+
*/
|
|
4041
|
+
InputType: string
|
|
4042
|
+
|
|
4043
|
+
/**
|
|
4044
|
+
* 日志集 ID
|
|
4045
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4046
|
+
*/
|
|
4047
|
+
LogsetId: string
|
|
4048
|
+
|
|
4049
|
+
/**
|
|
4050
|
+
* 日志主题 ID
|
|
4051
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4052
|
+
*/
|
|
4053
|
+
TopicId: string
|
|
4054
|
+
|
|
4055
|
+
/**
|
|
4056
|
+
* 日志提取模式,minimalist_log 为单行全文;multiline_log 为多行全文;
|
|
4057
|
+
*/
|
|
4058
|
+
LogType: string
|
|
4059
|
+
|
|
4060
|
+
/**
|
|
4061
|
+
* 首行正则表达式,当LogType=multiline_log 时生效
|
|
4062
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4063
|
+
*/
|
|
4064
|
+
BeginningRegex: string
|
|
4065
|
+
|
|
4066
|
+
/**
|
|
4067
|
+
* 收集文件目录,当 InputType=container_file 时生效
|
|
4068
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4069
|
+
*/
|
|
4070
|
+
LogPath: string
|
|
4071
|
+
|
|
4072
|
+
/**
|
|
4073
|
+
* 收集文件名模式,当 InputType=container_file 时生效
|
|
4074
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4075
|
+
*/
|
|
4076
|
+
FilePattern: string
|
|
4077
|
+
|
|
4078
|
+
/**
|
|
4079
|
+
* 创建时间
|
|
4080
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4081
|
+
*/
|
|
4082
|
+
CreateDate: string
|
|
4083
|
+
|
|
4084
|
+
/**
|
|
4085
|
+
* 更新时间
|
|
4086
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4087
|
+
*/
|
|
4088
|
+
ModifyDate: string
|
|
4089
|
+
|
|
4090
|
+
/**
|
|
4091
|
+
* 应用 ID
|
|
4092
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4093
|
+
*/
|
|
4094
|
+
ApplicationId: string
|
|
4095
|
+
|
|
4096
|
+
/**
|
|
4097
|
+
* 应用名
|
|
4098
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4099
|
+
*/
|
|
4100
|
+
ApplicationName: string
|
|
4101
|
+
}
|
|
4102
|
+
|
|
3966
4103
|
/**
|
|
3967
4104
|
* ModifyEnvironment返回参数结构体
|
|
3968
4105
|
*/
|
|
@@ -4050,77 +4187,28 @@ export interface DestroyLogConfigRequest {
|
|
|
4050
4187
|
}
|
|
4051
4188
|
|
|
4052
4189
|
/**
|
|
4053
|
-
*
|
|
4190
|
+
* EnableApplicationAutoscaler请求参数结构体
|
|
4054
4191
|
*/
|
|
4055
|
-
export interface
|
|
4192
|
+
export interface EnableApplicationAutoscalerRequest {
|
|
4056
4193
|
/**
|
|
4057
|
-
*
|
|
4194
|
+
* 服务id
|
|
4058
4195
|
*/
|
|
4059
|
-
|
|
4196
|
+
ApplicationId: string
|
|
4060
4197
|
|
|
4061
4198
|
/**
|
|
4062
|
-
*
|
|
4199
|
+
* 环境ID
|
|
4063
4200
|
*/
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
/**
|
|
4067
|
-
* 日志集 ID
|
|
4068
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4069
|
-
*/
|
|
4070
|
-
LogsetId: string
|
|
4071
|
-
|
|
4072
|
-
/**
|
|
4073
|
-
* 日志主题 ID
|
|
4074
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4075
|
-
*/
|
|
4076
|
-
TopicId: string
|
|
4201
|
+
EnvironmentId: string
|
|
4077
4202
|
|
|
4078
4203
|
/**
|
|
4079
|
-
*
|
|
4204
|
+
* 来源渠道
|
|
4080
4205
|
*/
|
|
4081
|
-
|
|
4082
|
-
|
|
4083
|
-
/**
|
|
4084
|
-
* 首行正则表达式,当LogType=multiline_log 时生效
|
|
4085
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4086
|
-
*/
|
|
4087
|
-
BeginningRegex: string
|
|
4088
|
-
|
|
4089
|
-
/**
|
|
4090
|
-
* 收集文件目录,当 InputType=container_file 时生效
|
|
4091
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4092
|
-
*/
|
|
4093
|
-
LogPath: string
|
|
4094
|
-
|
|
4095
|
-
/**
|
|
4096
|
-
* 收集文件名模式,当 InputType=container_file 时生效
|
|
4097
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4098
|
-
*/
|
|
4099
|
-
FilePattern: string
|
|
4100
|
-
|
|
4101
|
-
/**
|
|
4102
|
-
* 创建时间
|
|
4103
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4104
|
-
*/
|
|
4105
|
-
CreateDate: string
|
|
4106
|
-
|
|
4107
|
-
/**
|
|
4108
|
-
* 更新时间
|
|
4109
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4110
|
-
*/
|
|
4111
|
-
ModifyDate: string
|
|
4112
|
-
|
|
4113
|
-
/**
|
|
4114
|
-
* 应用 ID
|
|
4115
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4116
|
-
*/
|
|
4117
|
-
ApplicationId: string
|
|
4206
|
+
SourceChannel?: number
|
|
4118
4207
|
|
|
4119
4208
|
/**
|
|
4120
|
-
|
|
4121
|
-
|
|
4122
|
-
|
|
4123
|
-
ApplicationName: string
|
|
4209
|
+
* 弹性伸缩策略ID
|
|
4210
|
+
*/
|
|
4211
|
+
AutoscalerId?: string
|
|
4124
4212
|
}
|
|
4125
4213
|
|
|
4126
4214
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const sdkVersion = "4.0.
|
|
1
|
+
export declare const sdkVersion = "4.0.416";
|
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
|
|
3
|
+
import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
|
|
4
4
|
/**
|
|
5
5
|
* ess client
|
|
6
6
|
* @class
|
|
7
7
|
*/
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
|
+
/**
|
|
11
|
+
* 查询文件下载URL
|
|
12
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
13
|
+
*/
|
|
14
|
+
DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
|
|
10
15
|
/**
|
|
11
16
|
* 此接口用于发起流程
|
|
12
17
|
适用场景:见创建签署流程接口。
|
|
@@ -14,11 +19,13 @@ export declare class Client extends AbstractClient {
|
|
|
14
19
|
*/
|
|
15
20
|
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
16
21
|
/**
|
|
17
|
-
*
|
|
18
|
-
|
|
19
|
-
|
|
22
|
+
* 提交企业签署流程审批结果
|
|
23
|
+
适用场景:
|
|
24
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
25
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
26
|
+
|
|
20
27
|
*/
|
|
21
|
-
|
|
28
|
+
CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
|
|
22
29
|
/**
|
|
23
30
|
* 用于撤销签署流程
|
|
24
31
|
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
@@ -32,10 +39,11 @@ export declare class Client extends AbstractClient {
|
|
|
32
39
|
*/
|
|
33
40
|
CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
|
|
34
41
|
/**
|
|
35
|
-
*
|
|
36
|
-
|
|
42
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
43
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
44
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
37
45
|
*/
|
|
38
|
-
|
|
46
|
+
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
39
47
|
/**
|
|
40
48
|
* 通过AuthCode查询用户是否实名
|
|
41
49
|
*/
|
|
@@ -27,6 +27,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
27
27
|
constructor(clientConfig) {
|
|
28
28
|
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* 查询文件下载URL
|
|
32
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
33
|
+
*/
|
|
34
|
+
async DescribeFileUrls(req, cb) {
|
|
35
|
+
return this.request("DescribeFileUrls", req, cb);
|
|
36
|
+
}
|
|
30
37
|
/**
|
|
31
38
|
* 此接口用于发起流程
|
|
32
39
|
适用场景:见创建签署流程接口。
|
|
@@ -36,12 +43,14 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
36
43
|
return this.request("StartFlow", req, cb);
|
|
37
44
|
}
|
|
38
45
|
/**
|
|
39
|
-
*
|
|
40
|
-
|
|
41
|
-
|
|
46
|
+
* 提交企业签署流程审批结果
|
|
47
|
+
适用场景:
|
|
48
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
49
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
50
|
+
|
|
42
51
|
*/
|
|
43
|
-
async
|
|
44
|
-
return this.request("
|
|
52
|
+
async CreateFlowSignReview(req, cb) {
|
|
53
|
+
return this.request("CreateFlowSignReview", req, cb);
|
|
45
54
|
}
|
|
46
55
|
/**
|
|
47
56
|
* 用于撤销签署流程
|
|
@@ -60,11 +69,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
60
69
|
return this.request("CreateDocument", req, cb);
|
|
61
70
|
}
|
|
62
71
|
/**
|
|
63
|
-
*
|
|
64
|
-
|
|
72
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
73
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
74
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
65
75
|
*/
|
|
66
|
-
async
|
|
67
|
-
return this.request("
|
|
76
|
+
async CreateMultiFlowSignQRCode(req, cb) {
|
|
77
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
68
78
|
}
|
|
69
79
|
/**
|
|
70
80
|
* 通过AuthCode查询用户是否实名
|
|
@@ -327,6 +327,19 @@ export interface DescribeThirdPartyAuthCodeRequest {
|
|
|
327
327
|
*/
|
|
328
328
|
AuthCode: string;
|
|
329
329
|
}
|
|
330
|
+
/**
|
|
331
|
+
* 查询过滤条件
|
|
332
|
+
*/
|
|
333
|
+
export interface Filter {
|
|
334
|
+
/**
|
|
335
|
+
* 查询过滤条件的Key
|
|
336
|
+
*/
|
|
337
|
+
Key: string;
|
|
338
|
+
/**
|
|
339
|
+
* 查询过滤条件的Value列表
|
|
340
|
+
*/
|
|
341
|
+
Values: Array<string>;
|
|
342
|
+
}
|
|
330
343
|
/**
|
|
331
344
|
* 一码多扫签署二维码对象
|
|
332
345
|
*/
|
|
@@ -925,6 +938,15 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
925
938
|
*/
|
|
926
939
|
PreReadTime?: number;
|
|
927
940
|
}
|
|
941
|
+
/**
|
|
942
|
+
* CreateFlowSignReview返回参数结构体
|
|
943
|
+
*/
|
|
944
|
+
export interface CreateFlowSignReviewResponse {
|
|
945
|
+
/**
|
|
946
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
947
|
+
*/
|
|
948
|
+
RequestId?: string;
|
|
949
|
+
}
|
|
928
950
|
/**
|
|
929
951
|
* 此结构体 (Caller) 用于描述调用方属性。
|
|
930
952
|
*/
|
|
@@ -1089,17 +1111,32 @@ export interface CreateConvertTaskApiResponse {
|
|
|
1089
1111
|
RequestId?: string;
|
|
1090
1112
|
}
|
|
1091
1113
|
/**
|
|
1092
|
-
*
|
|
1114
|
+
* CreateFlowSignReview请求参数结构体
|
|
1093
1115
|
*/
|
|
1094
|
-
export interface
|
|
1116
|
+
export interface CreateFlowSignReviewRequest {
|
|
1095
1117
|
/**
|
|
1096
|
-
*
|
|
1118
|
+
* 调用方用户信息,userId 必填
|
|
1097
1119
|
*/
|
|
1098
|
-
|
|
1120
|
+
Operator: UserInfo;
|
|
1099
1121
|
/**
|
|
1100
|
-
*
|
|
1122
|
+
* 签署流程编号
|
|
1101
1123
|
*/
|
|
1102
|
-
|
|
1124
|
+
FlowId: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* 企业内部审核结果
|
|
1127
|
+
PASS: 通过
|
|
1128
|
+
REJECT: 拒绝
|
|
1129
|
+
*/
|
|
1130
|
+
ReviewType: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* 审核原因
|
|
1133
|
+
当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
|
|
1134
|
+
*/
|
|
1135
|
+
ReviewMessage?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* 应用相关信息
|
|
1138
|
+
*/
|
|
1139
|
+
Agent?: Agent;
|
|
1103
1140
|
}
|
|
1104
1141
|
/**
|
|
1105
1142
|
* CreateConvertTaskApi请求参数结构体
|
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse,
|
|
3
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
|
|
4
4
|
/**
|
|
5
5
|
* essbasic client
|
|
6
6
|
* @class
|
|
7
7
|
*/
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
|
+
/**
|
|
11
|
+
* 此接口(UploadFiles)用于文件上传。
|
|
12
|
+
调用时需要设置Domain 为 file.ess.tencent.cn
|
|
13
|
+
*/
|
|
14
|
+
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
10
15
|
/**
|
|
11
16
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
12
17
|
|
|
@@ -17,11 +22,12 @@ export declare class Client extends AbstractClient {
|
|
|
17
22
|
*/
|
|
18
23
|
DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
|
|
19
24
|
/**
|
|
20
|
-
*
|
|
21
|
-
当前接口限制最多合同(流程)50个.
|
|
25
|
+
* 提交企业签署流程审批结果
|
|
22
26
|
|
|
27
|
+
在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
28
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
23
29
|
*/
|
|
24
|
-
|
|
30
|
+
ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
|
|
25
31
|
/**
|
|
26
32
|
* 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
|
|
27
33
|
*/
|
|
@@ -97,8 +103,9 @@ export declare class Client extends AbstractClient {
|
|
|
97
103
|
*/
|
|
98
104
|
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
99
105
|
/**
|
|
100
|
-
* 此接口(
|
|
101
|
-
|
|
106
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
107
|
+
当前接口限制最多合同(流程)50个.
|
|
108
|
+
|
|
102
109
|
*/
|
|
103
|
-
|
|
110
|
+
GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
|
|
104
111
|
}
|
|
@@ -27,6 +27,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
27
27
|
constructor(clientConfig) {
|
|
28
28
|
super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig);
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* 此接口(UploadFiles)用于文件上传。
|
|
32
|
+
调用时需要设置Domain 为 file.ess.tencent.cn
|
|
33
|
+
*/
|
|
34
|
+
async UploadFiles(req, cb) {
|
|
35
|
+
return this.request("UploadFiles", req, cb);
|
|
36
|
+
}
|
|
30
37
|
/**
|
|
31
38
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
32
39
|
|
|
@@ -41,12 +48,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
41
48
|
return this.request("DescribeResourceUrlsByFlows", req, cb);
|
|
42
49
|
}
|
|
43
50
|
/**
|
|
44
|
-
*
|
|
45
|
-
当前接口限制最多合同(流程)50个.
|
|
51
|
+
* 提交企业签署流程审批结果
|
|
46
52
|
|
|
53
|
+
在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
54
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
47
55
|
*/
|
|
48
|
-
async
|
|
49
|
-
return this.request("
|
|
56
|
+
async ChannelCreateFlowSignReview(req, cb) {
|
|
57
|
+
return this.request("ChannelCreateFlowSignReview", req, cb);
|
|
50
58
|
}
|
|
51
59
|
/**
|
|
52
60
|
* 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
|
|
@@ -155,11 +163,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
155
163
|
return this.request("DescribeFlowDetailInfo", req, cb);
|
|
156
164
|
}
|
|
157
165
|
/**
|
|
158
|
-
* 此接口(
|
|
159
|
-
|
|
166
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
167
|
+
当前接口限制最多合同(流程)50个.
|
|
168
|
+
|
|
160
169
|
*/
|
|
161
|
-
async
|
|
162
|
-
return this.request("
|
|
170
|
+
async GetDownloadFlowUrl(req, cb) {
|
|
171
|
+
return this.request("GetDownloadFlowUrl", req, cb);
|
|
163
172
|
}
|
|
164
173
|
}
|
|
165
174
|
exports.Client = Client;
|