tencentcloud-sdk-nodejs 4.0.409 → 4.0.412
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 +510 -0
- package/SERVICE_CHANGELOG.md +596 -70
- package/package.json +1 -1
- package/products.md +30 -30
- package/src/common/sdk_version.ts +1 -1
- package/src/services/aa/v20200224/aa_client.ts +1 -42
- package/src/services/aa/v20200224/aa_models.ts +0 -624
- package/src/services/batch/v20170312/batch_models.ts +2 -2
- package/src/services/bda/v20200324/bda_models.ts +12 -0
- package/src/services/cat/v20180409/cat_models.ts +1 -5
- package/src/services/cbs/v20170312/cbs_models.ts +46 -34
- package/src/services/cdb/v20170320/cdb_models.ts +1 -1
- package/src/services/cdn/v20180606/cdn_models.ts +12 -0
- package/src/services/cfw/v20190904/cfw_models.ts +1 -1
- package/src/services/ckafka/v20190819/ckafka_client.ts +13 -1
- package/src/services/ckafka/v20190819/ckafka_models.ts +55 -10
- package/src/services/cpdp/v20190820/cpdp_client.ts +9 -36
- package/src/services/cpdp/v20190820/cpdp_models.ts +19 -260
- package/src/services/cvm/v20170312/cvm_client.ts +24 -11
- package/src/services/cvm/v20170312/cvm_models.ts +239 -194
- package/src/services/cwp/v20180228/cwp_models.ts +1 -1
- package/src/services/dnspod/v20210323/dnspod_models.ts +5 -0
- package/src/services/ess/v20201111/ess_models.ts +28 -15
- package/src/services/essbasic/v20210526/essbasic_client.ts +48 -22
- package/src/services/essbasic/v20210526/essbasic_models.ts +326 -112
- package/src/services/faceid/v20180301/faceid_models.ts +19 -3
- package/src/services/gaap/v20180529/gaap_models.ts +1 -1
- package/src/services/iai/v20180301/iai_models.ts +2 -2
- package/src/services/ic/v20190307/ic_client.ts +23 -10
- package/src/services/ic/v20190307/ic_models.ts +294 -168
- package/src/services/kms/v20190118/kms_models.ts +13 -13
- package/src/services/live/v20180801/live_client.ts +34 -6
- package/src/services/live/v20180801/live_models.ts +424 -228
- package/src/services/ocr/v20181119/ocr_client.ts +28 -12
- package/src/services/rce/v20201103/rce_client.ts +13 -28
- package/src/services/rce/v20201103/rce_models.ts +322 -403
- package/src/services/tag/v20180813/tag_client.ts +16 -3
- package/src/services/tag/v20180813/tag_models.ts +113 -43
- package/src/services/tcr/v20190924/tcr_models.ts +2 -2
- package/src/services/tem/v20210701/tem_client.ts +72 -8
- package/src/services/tem/v20210701/tem_models.ts +550 -111
- package/src/services/teo/v20220106/teo_models.ts +9 -3
- package/src/services/tiia/v20190529/tiia_client.ts +2 -2
- package/src/services/tiia/v20190529/tiia_models.ts +28 -20
- package/src/services/trtc/v20190722/trtc_client.ts +16 -91
- package/src/services/trtc/v20190722/trtc_models.ts +8 -360
- package/src/services/wedata/v20210820/wedata_client.ts +469 -16
- package/src/services/wedata/v20210820/wedata_models.ts +3015 -114
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/aa/v20200224/aa_client.d.ts +1 -9
- package/tencentcloud/services/aa/v20200224/aa_client.js +0 -12
- package/tencentcloud/services/aa/v20200224/aa_models.d.ts +0 -529
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
- package/tencentcloud/services/bda/v20200324/bda_models.d.ts +10 -0
- package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1 -5
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +40 -30
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +10 -0
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +46 -8
- package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +4 -12
- package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +4 -16
- package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +16 -218
- package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +5 -1
- package/tencentcloud/services/cvm/v20170312/cvm_client.js +6 -0
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +213 -174
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +1 -1
- package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +28 -15
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -5
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +19 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +291 -99
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +16 -3
- package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +1 -1
- package/tencentcloud/services/iai/v20180301/iai_models.d.ts +2 -2
- package/tencentcloud/services/ic/v20190307/ic_client.d.ts +5 -1
- package/tencentcloud/services/ic/v20190307/ic_client.js +6 -0
- package/tencentcloud/services/ic/v20190307/ic_models.d.ts +254 -148
- package/tencentcloud/services/kms/v20190118/kms_models.d.ts +13 -13
- package/tencentcloud/services/live/v20180801/live_client.d.ts +10 -1
- package/tencentcloud/services/live/v20180801/live_client.js +13 -0
- package/tencentcloud/services/live/v20180801/live_models.d.ts +363 -196
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +16 -0
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +16 -0
- package/tencentcloud/services/rce/v20201103/rce_client.d.ts +1 -5
- package/tencentcloud/services/rce/v20201103/rce_client.js +0 -6
- package/tencentcloud/services/rce/v20201103/rce_models.d.ts +270 -340
- package/tencentcloud/services/tag/v20180813/tag_client.d.ts +5 -1
- package/tencentcloud/services/tag/v20180813/tag_client.js +6 -0
- package/tencentcloud/services/tag/v20180813/tag_models.d.ts +95 -36
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +2 -2
- package/tencentcloud/services/tem/v20210701/tem_client.d.ts +23 -3
- package/tencentcloud/services/tem/v20210701/tem_client.js +32 -2
- package/tencentcloud/services/tem/v20210701/tem_models.d.ts +469 -98
- package/tencentcloud/services/teo/v20220106/teo_models.d.ts +8 -3
- package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +2 -2
- package/tencentcloud/services/tiia/v20190529/tiia_client.js +2 -2
- package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +26 -18
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +10 -37
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +10 -49
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +8 -309
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +147 -5
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +218 -6
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +2583 -125
- package/test/aa.v20200224.test.js +0 -20
- package/test/ckafka.v20190819.test.js +10 -0
- package/test/cpdp.v20190820.test.js +2 -22
- package/test/cvm.v20170312.test.js +10 -0
- package/test/essbasic.v20210526.test.js +24 -4
- package/test/ic.v20190307.test.js +10 -0
- package/test/live.v20180801.test.js +20 -0
- package/test/rce.v20201103.test.js +0 -10
- package/test/tag.v20180813.test.js +10 -0
- package/test/tem.v20210701.test.js +50 -0
- package/test/trtc.v20190722.test.js +2 -62
- package/test/wedata.v20210820.test.js +354 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { SyncProxyOrganizationResponse,
|
|
3
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, UploadFilesRequest, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateConvertTaskApiRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
|
|
4
4
|
/**
|
|
5
5
|
* essbasic client
|
|
6
6
|
* @class
|
|
@@ -9,8 +9,13 @@ export declare class Client extends AbstractClient {
|
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
10
|
/**
|
|
11
11
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
12
|
+
|
|
12
13
|
*/
|
|
13
14
|
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
|
|
17
|
+
*/
|
|
18
|
+
DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
|
|
14
19
|
/**
|
|
15
20
|
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
16
21
|
当前接口限制最多合同(流程)50个.
|
|
@@ -70,23 +75,27 @@ export declare class Client extends AbstractClient {
|
|
|
70
75
|
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
71
76
|
*/
|
|
72
77
|
ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* 渠道创建文件转换任务
|
|
80
|
+
*/
|
|
81
|
+
ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
|
|
73
82
|
/**
|
|
74
83
|
* 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。
|
|
75
84
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
76
85
|
*/
|
|
77
86
|
DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
|
|
78
87
|
/**
|
|
79
|
-
*
|
|
88
|
+
* 渠道版查询转换任务状态
|
|
80
89
|
*/
|
|
81
|
-
|
|
90
|
+
ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
|
|
82
91
|
/**
|
|
83
92
|
* 此接口(SyncProxyOrganization)用于同步渠道侧企业信息
|
|
84
93
|
*/
|
|
85
94
|
SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
|
|
86
95
|
/**
|
|
87
|
-
*
|
|
96
|
+
* 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
|
|
88
97
|
*/
|
|
89
|
-
|
|
98
|
+
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
90
99
|
/**
|
|
91
100
|
* 此接口(UploadFiles)用于文件上传。
|
|
92
101
|
调用时需要设置Domain 为 file.ess.tencent.cn
|
|
@@ -29,10 +29,17 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
31
|
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
|
32
|
+
|
|
32
33
|
*/
|
|
33
34
|
async CreateFlowsByTemplates(req, cb) {
|
|
34
35
|
return this.request("CreateFlowsByTemplates", req, cb);
|
|
35
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
|
|
39
|
+
*/
|
|
40
|
+
async DescribeResourceUrlsByFlows(req, cb) {
|
|
41
|
+
return this.request("DescribeResourceUrlsByFlows", req, cb);
|
|
42
|
+
}
|
|
36
43
|
/**
|
|
37
44
|
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
38
45
|
当前接口限制最多合同(流程)50个.
|
|
@@ -116,6 +123,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
116
123
|
async ChannelCreateBatchCancelFlowUrl(req, cb) {
|
|
117
124
|
return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
|
|
118
125
|
}
|
|
126
|
+
/**
|
|
127
|
+
* 渠道创建文件转换任务
|
|
128
|
+
*/
|
|
129
|
+
async ChannelCreateConvertTaskApi(req, cb) {
|
|
130
|
+
return this.request("ChannelCreateConvertTaskApi", req, cb);
|
|
131
|
+
}
|
|
119
132
|
/**
|
|
120
133
|
* 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。
|
|
121
134
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
@@ -124,10 +137,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
124
137
|
return this.request("DescribeUsage", req, cb);
|
|
125
138
|
}
|
|
126
139
|
/**
|
|
127
|
-
*
|
|
140
|
+
* 渠道版查询转换任务状态
|
|
128
141
|
*/
|
|
129
|
-
async
|
|
130
|
-
return this.request("
|
|
142
|
+
async ChannelGetTaskResultApi(req, cb) {
|
|
143
|
+
return this.request("ChannelGetTaskResultApi", req, cb);
|
|
131
144
|
}
|
|
132
145
|
/**
|
|
133
146
|
* 此接口(SyncProxyOrganization)用于同步渠道侧企业信息
|
|
@@ -136,10 +149,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
136
149
|
return this.request("SyncProxyOrganization", req, cb);
|
|
137
150
|
}
|
|
138
151
|
/**
|
|
139
|
-
*
|
|
152
|
+
* 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
|
|
140
153
|
*/
|
|
141
|
-
async
|
|
142
|
-
return this.request("
|
|
154
|
+
async DescribeFlowDetailInfo(req, cb) {
|
|
155
|
+
return this.request("DescribeFlowDetailInfo", req, cb);
|
|
143
156
|
}
|
|
144
157
|
/**
|
|
145
158
|
* 此接口(UploadFiles)用于文件上传。
|
|
@@ -105,45 +105,46 @@ ENTERPRISESERVER-企业静默签;
|
|
|
105
105
|
JumpUrl?: string;
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* ChannelCreateConvertTaskApi返回参数结构体
|
|
109
109
|
*/
|
|
110
|
-
export interface
|
|
110
|
+
export interface ChannelCreateConvertTaskApiResponse {
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* 任务id
|
|
113
113
|
*/
|
|
114
|
-
|
|
114
|
+
TaskId: string;
|
|
115
115
|
/**
|
|
116
116
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
117
117
|
*/
|
|
118
118
|
RequestId?: string;
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
121
|
+
* OperateChannelTemplate请求参数结构体
|
|
122
122
|
*/
|
|
123
|
-
export interface
|
|
123
|
+
export interface OperateChannelTemplateRequest {
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
126
126
|
*/
|
|
127
|
-
|
|
127
|
+
Agent: Agent;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
|
|
130
130
|
*/
|
|
131
|
-
|
|
131
|
+
OperateType: string;
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
134
|
-
1.ID_CARD 居民身份证
|
|
135
|
-
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
136
|
-
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
133
|
+
* 渠道方模板库模板唯一标识
|
|
137
134
|
*/
|
|
138
|
-
|
|
135
|
+
TemplateId: string;
|
|
139
136
|
/**
|
|
140
|
-
*
|
|
137
|
+
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
141
138
|
*/
|
|
142
|
-
|
|
139
|
+
ProxyOrganizationOpenIds?: string;
|
|
143
140
|
/**
|
|
144
|
-
*
|
|
141
|
+
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
145
142
|
*/
|
|
146
|
-
|
|
143
|
+
AuthTag?: string;
|
|
144
|
+
/**
|
|
145
|
+
* 操作者的信息
|
|
146
|
+
*/
|
|
147
|
+
Operator?: UserInfo;
|
|
147
148
|
}
|
|
148
149
|
/**
|
|
149
150
|
* 此结构体 (TemplateInfo) 用于描述模板的信息。
|
|
@@ -343,6 +344,23 @@ export interface OperateChannelTemplateResponse {
|
|
|
343
344
|
*/
|
|
344
345
|
RequestId?: string;
|
|
345
346
|
}
|
|
347
|
+
/**
|
|
348
|
+
* CreateSignUrls返回参数结构体
|
|
349
|
+
*/
|
|
350
|
+
export interface CreateSignUrlsResponse {
|
|
351
|
+
/**
|
|
352
|
+
* 签署参与者签署H5链接信息数组
|
|
353
|
+
*/
|
|
354
|
+
SignUrlInfos: Array<SignUrlInfo>;
|
|
355
|
+
/**
|
|
356
|
+
* 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
|
|
357
|
+
*/
|
|
358
|
+
ErrorMessages: Array<string>;
|
|
359
|
+
/**
|
|
360
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
361
|
+
*/
|
|
362
|
+
RequestId?: string;
|
|
363
|
+
}
|
|
346
364
|
/**
|
|
347
365
|
* CreateSignUrls请求参数结构体
|
|
348
366
|
*/
|
|
@@ -477,21 +495,29 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
477
495
|
Operator?: UserInfo;
|
|
478
496
|
}
|
|
479
497
|
/**
|
|
480
|
-
*
|
|
498
|
+
* ChannelGetTaskResultApi返回参数结构体
|
|
481
499
|
*/
|
|
482
|
-
export interface
|
|
500
|
+
export interface ChannelGetTaskResultApiResponse {
|
|
483
501
|
/**
|
|
484
|
-
*
|
|
502
|
+
* 任务Id
|
|
485
503
|
*/
|
|
486
|
-
|
|
504
|
+
TaskId: string;
|
|
487
505
|
/**
|
|
488
|
-
*
|
|
506
|
+
* 任务状态
|
|
489
507
|
*/
|
|
490
|
-
|
|
508
|
+
TaskStatus: number;
|
|
491
509
|
/**
|
|
492
|
-
*
|
|
510
|
+
* 状态描述
|
|
493
511
|
*/
|
|
494
|
-
|
|
512
|
+
TaskMessage: string;
|
|
513
|
+
/**
|
|
514
|
+
* 资源Id
|
|
515
|
+
*/
|
|
516
|
+
ResourceId: string;
|
|
517
|
+
/**
|
|
518
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
519
|
+
*/
|
|
520
|
+
RequestId?: string;
|
|
495
521
|
}
|
|
496
522
|
/**
|
|
497
523
|
* UploadFiles请求参数结构体
|
|
@@ -517,20 +543,23 @@ export interface UploadFilesRequest {
|
|
|
517
543
|
Operator?: UserInfo;
|
|
518
544
|
}
|
|
519
545
|
/**
|
|
520
|
-
*
|
|
546
|
+
* ChannelGetTaskResultApi请求参数结构体
|
|
521
547
|
*/
|
|
522
|
-
export interface
|
|
548
|
+
export interface ChannelGetTaskResultApiRequest {
|
|
523
549
|
/**
|
|
524
|
-
*
|
|
525
|
-
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
550
|
+
* 渠道信息
|
|
526
551
|
*/
|
|
527
552
|
Agent: Agent;
|
|
528
553
|
/**
|
|
529
|
-
*
|
|
554
|
+
* 任务Id
|
|
530
555
|
*/
|
|
531
|
-
|
|
556
|
+
TaskId: string;
|
|
532
557
|
/**
|
|
533
|
-
*
|
|
558
|
+
* 企业信息
|
|
559
|
+
*/
|
|
560
|
+
Organization?: OrganizationInfo;
|
|
561
|
+
/**
|
|
562
|
+
* 操作人信息
|
|
534
563
|
*/
|
|
535
564
|
Operator?: UserInfo;
|
|
536
565
|
}
|
|
@@ -549,6 +578,7 @@ export interface UploadFile {
|
|
|
549
578
|
}
|
|
550
579
|
/**
|
|
551
580
|
* 此结构体 (Component) 用于描述控件属性。
|
|
581
|
+
|
|
552
582
|
*/
|
|
553
583
|
export interface Component {
|
|
554
584
|
/**
|
|
@@ -567,12 +597,18 @@ export interface Component {
|
|
|
567
597
|
/**
|
|
568
598
|
* 如果是Component控件类型,则可选的字段为:
|
|
569
599
|
TEXT - 普通文本控件;
|
|
570
|
-
|
|
600
|
+
MULTI_LINE_TEXT - 多行文本控件;
|
|
601
|
+
CHECK_BOX - 勾选框控件;
|
|
602
|
+
FILL_IMAGE - 图片控件;
|
|
603
|
+
DYNAMIC_TABLE - 动态表格控件;
|
|
604
|
+
ATTACHMENT - 附件控件;
|
|
605
|
+
SELECTOR - 选择器控件;
|
|
606
|
+
|
|
571
607
|
如果是SignComponent控件类型,则可选的字段为
|
|
572
608
|
SIGN_SEAL - 签署印章控件;
|
|
573
609
|
SIGN_DATE - 签署日期控件;
|
|
574
610
|
SIGN_SIGNATURE - 用户签名控件;
|
|
575
|
-
SIGN_PERSONAL_SEAL -
|
|
611
|
+
SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
|
|
576
612
|
|
|
577
613
|
表单域的控件不能作为印章和签名控件
|
|
578
614
|
*/
|
|
@@ -626,8 +662,13 @@ TEXT控件可以指定字体
|
|
|
626
662
|
*/
|
|
627
663
|
ComponentExtra?: string;
|
|
628
664
|
/**
|
|
629
|
-
*
|
|
630
|
-
|
|
665
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
666
|
+
TEXT - 文本内容
|
|
667
|
+
MULTI_LINE_TEXT - 文本内容
|
|
668
|
+
CHECK_BOX - true/false
|
|
669
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
670
|
+
SELECTOR - 选项值
|
|
671
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
631
672
|
*/
|
|
632
673
|
ComponentValue?: string;
|
|
633
674
|
/**
|
|
@@ -670,27 +711,6 @@ export interface GetDownloadFlowUrlRequest {
|
|
|
670
711
|
*/
|
|
671
712
|
Operator?: UserInfo;
|
|
672
713
|
}
|
|
673
|
-
/**
|
|
674
|
-
* ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
675
|
-
*/
|
|
676
|
-
export interface ChannelCreateBatchCancelFlowUrlResponse {
|
|
677
|
-
/**
|
|
678
|
-
* 批量撤回url
|
|
679
|
-
*/
|
|
680
|
-
BatchCancelFlowUrl: string;
|
|
681
|
-
/**
|
|
682
|
-
* 签署流程批量撤回失败原因
|
|
683
|
-
*/
|
|
684
|
-
FailMessages: Array<string>;
|
|
685
|
-
/**
|
|
686
|
-
* 签署撤回url过期时间-年月日-时分秒
|
|
687
|
-
*/
|
|
688
|
-
UrlExpireOn: string;
|
|
689
|
-
/**
|
|
690
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
691
|
-
*/
|
|
692
|
-
RequestId?: string;
|
|
693
|
-
}
|
|
694
714
|
/**
|
|
695
715
|
* 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
|
696
716
|
*/
|
|
@@ -770,6 +790,31 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
770
790
|
*/
|
|
771
791
|
Operator?: UserInfo;
|
|
772
792
|
}
|
|
793
|
+
/**
|
|
794
|
+
* 机构信息
|
|
795
|
+
*/
|
|
796
|
+
export interface OrganizationInfo {
|
|
797
|
+
/**
|
|
798
|
+
* 用户在渠道的机构编号
|
|
799
|
+
*/
|
|
800
|
+
OrganizationOpenId: string;
|
|
801
|
+
/**
|
|
802
|
+
* 用户真实的IP
|
|
803
|
+
*/
|
|
804
|
+
ClientIp: string;
|
|
805
|
+
/**
|
|
806
|
+
* 机构的代理IP
|
|
807
|
+
*/
|
|
808
|
+
ProxyIp: string;
|
|
809
|
+
/**
|
|
810
|
+
* 机构在平台的编号
|
|
811
|
+
*/
|
|
812
|
+
OrganizationId?: string;
|
|
813
|
+
/**
|
|
814
|
+
* 用户渠道
|
|
815
|
+
*/
|
|
816
|
+
Channel?: string;
|
|
817
|
+
}
|
|
773
818
|
/**
|
|
774
819
|
* CreateFlowsByTemplates返回参数结构体
|
|
775
820
|
*/
|
|
@@ -796,6 +841,34 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
796
841
|
*/
|
|
797
842
|
RequestId?: string;
|
|
798
843
|
}
|
|
844
|
+
/**
|
|
845
|
+
* 合作企业经办人列表信息
|
|
846
|
+
*/
|
|
847
|
+
export interface ProxyOrganizationOperator {
|
|
848
|
+
/**
|
|
849
|
+
* 经办人ID(渠道颁发),最大长度64个字符
|
|
850
|
+
*/
|
|
851
|
+
Id: string;
|
|
852
|
+
/**
|
|
853
|
+
* 经办人姓名,最大长度50个字符
|
|
854
|
+
*/
|
|
855
|
+
Name?: string;
|
|
856
|
+
/**
|
|
857
|
+
* 经办人身份证件类型
|
|
858
|
+
1.ID_CARD 居民身份证
|
|
859
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
860
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
861
|
+
*/
|
|
862
|
+
IdCardType?: string;
|
|
863
|
+
/**
|
|
864
|
+
* 经办人证件号
|
|
865
|
+
*/
|
|
866
|
+
IdCardNumber?: string;
|
|
867
|
+
/**
|
|
868
|
+
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
869
|
+
*/
|
|
870
|
+
Mobile?: string;
|
|
871
|
+
}
|
|
799
872
|
/**
|
|
800
873
|
* PrepareFlows请求参数结构体
|
|
801
874
|
*/
|
|
@@ -1021,29 +1094,21 @@ export interface CreateSealByImageRequest {
|
|
|
1021
1094
|
Operator?: UserInfo;
|
|
1022
1095
|
}
|
|
1023
1096
|
/**
|
|
1024
|
-
*
|
|
1097
|
+
* 一码多扫签署二维码对象
|
|
1025
1098
|
*/
|
|
1026
|
-
export interface
|
|
1027
|
-
/**
|
|
1028
|
-
* 用户在渠道的编号,最大64位字符串
|
|
1029
|
-
*/
|
|
1030
|
-
OpenId?: string;
|
|
1031
|
-
/**
|
|
1032
|
-
* 用户的来源渠道
|
|
1033
|
-
*/
|
|
1034
|
-
Channel?: string;
|
|
1099
|
+
export interface SignQrCode {
|
|
1035
1100
|
/**
|
|
1036
|
-
*
|
|
1101
|
+
* 二维码id
|
|
1037
1102
|
*/
|
|
1038
|
-
|
|
1103
|
+
QrCodeId: string;
|
|
1039
1104
|
/**
|
|
1040
|
-
*
|
|
1105
|
+
* 二维码url
|
|
1041
1106
|
*/
|
|
1042
|
-
|
|
1107
|
+
QrCodeUrl: string;
|
|
1043
1108
|
/**
|
|
1044
|
-
*
|
|
1109
|
+
* 二维码过期时间
|
|
1045
1110
|
*/
|
|
1046
|
-
|
|
1111
|
+
ExpiredTime: number;
|
|
1047
1112
|
}
|
|
1048
1113
|
/**
|
|
1049
1114
|
* DescribeUsage返回参数结构体
|
|
@@ -1092,46 +1157,39 @@ export interface UsageDetail {
|
|
|
1092
1157
|
Cancel: number;
|
|
1093
1158
|
}
|
|
1094
1159
|
/**
|
|
1095
|
-
*
|
|
1160
|
+
* ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
1096
1161
|
*/
|
|
1097
|
-
export interface
|
|
1162
|
+
export interface ChannelCreateBatchCancelFlowUrlResponse {
|
|
1098
1163
|
/**
|
|
1099
|
-
*
|
|
1164
|
+
* 批量撤回url
|
|
1100
1165
|
*/
|
|
1101
|
-
|
|
1166
|
+
BatchCancelFlowUrl: string;
|
|
1102
1167
|
/**
|
|
1103
|
-
*
|
|
1168
|
+
* 签署流程批量撤回失败原因
|
|
1104
1169
|
*/
|
|
1105
|
-
|
|
1170
|
+
FailMessages: Array<string>;
|
|
1171
|
+
/**
|
|
1172
|
+
* 签署撤回url过期时间-年月日-时分秒
|
|
1173
|
+
*/
|
|
1174
|
+
UrlExpireOn: string;
|
|
1106
1175
|
/**
|
|
1107
1176
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1108
1177
|
*/
|
|
1109
1178
|
RequestId?: string;
|
|
1110
1179
|
}
|
|
1111
1180
|
/**
|
|
1112
|
-
*
|
|
1181
|
+
* DescribeResourceUrlsByFlows请求参数结构体
|
|
1113
1182
|
*/
|
|
1114
|
-
export interface
|
|
1183
|
+
export interface DescribeResourceUrlsByFlowsRequest {
|
|
1115
1184
|
/**
|
|
1116
|
-
* 渠道应用相关信息。
|
|
1185
|
+
* 渠道应用相关信息。
|
|
1186
|
+
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
1117
1187
|
*/
|
|
1118
1188
|
Agent: Agent;
|
|
1119
1189
|
/**
|
|
1120
|
-
*
|
|
1121
|
-
*/
|
|
1122
|
-
OperateType: string;
|
|
1123
|
-
/**
|
|
1124
|
-
* 渠道方模板库模板唯一标识
|
|
1125
|
-
*/
|
|
1126
|
-
TemplateId: string;
|
|
1127
|
-
/**
|
|
1128
|
-
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
1129
|
-
*/
|
|
1130
|
-
ProxyOrganizationOpenIds?: string;
|
|
1131
|
-
/**
|
|
1132
|
-
* 模板可见性, 全部可见-"all", 部分可见-"part"
|
|
1190
|
+
* 查询资源所对应的签署流程Id,最多支持50个。
|
|
1133
1191
|
*/
|
|
1134
|
-
|
|
1192
|
+
FlowIds?: Array<string>;
|
|
1135
1193
|
/**
|
|
1136
1194
|
* 操作者的信息
|
|
1137
1195
|
*/
|
|
@@ -1182,6 +1240,19 @@ export interface SyncFailReason {
|
|
|
1182
1240
|
*/
|
|
1183
1241
|
Message: string;
|
|
1184
1242
|
}
|
|
1243
|
+
/**
|
|
1244
|
+
* PrepareFlows返回参数结构体
|
|
1245
|
+
*/
|
|
1246
|
+
export interface PrepareFlowsResponse {
|
|
1247
|
+
/**
|
|
1248
|
+
* 待发起文件确认页
|
|
1249
|
+
*/
|
|
1250
|
+
ConfirmUrl: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1253
|
+
*/
|
|
1254
|
+
RequestId?: string;
|
|
1255
|
+
}
|
|
1185
1256
|
/**
|
|
1186
1257
|
* DescribeUsage请求参数结构体
|
|
1187
1258
|
*/
|
|
@@ -1375,10 +1446,17 @@ export interface Agent {
|
|
|
1375
1446
|
}
|
|
1376
1447
|
/**
|
|
1377
1448
|
* 此结构 (FormField) 用于描述内容控件填充结构。
|
|
1449
|
+
|
|
1378
1450
|
*/
|
|
1379
1451
|
export interface FormField {
|
|
1380
1452
|
/**
|
|
1381
|
-
*
|
|
1453
|
+
* 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
1454
|
+
TEXT - 文本内容
|
|
1455
|
+
MULTI_LINE_TEXT - 文本内容
|
|
1456
|
+
CHECK_BOX - true/false
|
|
1457
|
+
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
1458
|
+
SELECTOR - 选项值
|
|
1459
|
+
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
1382
1460
|
*/
|
|
1383
1461
|
ComponentValue: string;
|
|
1384
1462
|
/**
|
|
@@ -1392,6 +1470,60 @@ export interface FormField {
|
|
|
1392
1470
|
*/
|
|
1393
1471
|
ComponentName?: string;
|
|
1394
1472
|
}
|
|
1473
|
+
/**
|
|
1474
|
+
* 接口调用者信息
|
|
1475
|
+
*/
|
|
1476
|
+
export interface UserInfo {
|
|
1477
|
+
/**
|
|
1478
|
+
* 用户在渠道的编号,最大64位字符串
|
|
1479
|
+
*/
|
|
1480
|
+
OpenId?: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* 用户的来源渠道
|
|
1483
|
+
*/
|
|
1484
|
+
Channel?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* 自定义用户编号
|
|
1487
|
+
*/
|
|
1488
|
+
CustomUserId?: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* 用户真实IP
|
|
1491
|
+
*/
|
|
1492
|
+
ClientIp?: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* 用户代理IP
|
|
1495
|
+
*/
|
|
1496
|
+
ProxyIp?: string;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* ChannelCreateConvertTaskApi请求参数结构体
|
|
1500
|
+
*/
|
|
1501
|
+
export interface ChannelCreateConvertTaskApiRequest {
|
|
1502
|
+
/**
|
|
1503
|
+
* 无
|
|
1504
|
+
*/
|
|
1505
|
+
Agent: Agent;
|
|
1506
|
+
/**
|
|
1507
|
+
* 资源Id
|
|
1508
|
+
*/
|
|
1509
|
+
ResourceId: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* 资源类型 取值范围doc,docx,html之一
|
|
1512
|
+
*/
|
|
1513
|
+
ResourceType: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* 资源名称
|
|
1516
|
+
*/
|
|
1517
|
+
ResourceName: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* 无
|
|
1520
|
+
*/
|
|
1521
|
+
Organization?: OrganizationInfo;
|
|
1522
|
+
/**
|
|
1523
|
+
* 无
|
|
1524
|
+
*/
|
|
1525
|
+
Operator?: UserInfo;
|
|
1526
|
+
}
|
|
1395
1527
|
/**
|
|
1396
1528
|
* 签署人的流程信息明细
|
|
1397
1529
|
*/
|
|
@@ -1448,6 +1580,66 @@ export interface FlowApproverDetail {
|
|
|
1448
1580
|
}
|
|
1449
1581
|
/**
|
|
1450
1582
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1583
|
+
|
|
1584
|
+
【动态表格传参说明】
|
|
1585
|
+
当模板的 ComponentType='DYNAMIC_TABLE'时(渠道版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充动态表格(支持内容的单元格合并)
|
|
1586
|
+
输入示例
|
|
1587
|
+
|
|
1588
|
+
```
|
|
1589
|
+
{
|
|
1590
|
+
"headers":[
|
|
1591
|
+
{
|
|
1592
|
+
"content":"head1"
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"content":"head2"
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"content":"head3"
|
|
1599
|
+
}
|
|
1600
|
+
],
|
|
1601
|
+
"rowCount":3,
|
|
1602
|
+
"body":{
|
|
1603
|
+
"cells":[
|
|
1604
|
+
{
|
|
1605
|
+
"rowStart":1,
|
|
1606
|
+
"rowEnd":1,
|
|
1607
|
+
"columnStart":1,
|
|
1608
|
+
"columnEnd":1,
|
|
1609
|
+
"content":"123"
|
|
1610
|
+
},
|
|
1611
|
+
{
|
|
1612
|
+
"rowStart":2,
|
|
1613
|
+
"rowEnd":3,
|
|
1614
|
+
"columnStart":1,
|
|
1615
|
+
"columnEnd":2,
|
|
1616
|
+
"content":"456"
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"rowStart":3,
|
|
1620
|
+
"rowEnd":3,
|
|
1621
|
+
"columnStart":3,
|
|
1622
|
+
"columnEnd":3,
|
|
1623
|
+
"content":"789"
|
|
1624
|
+
}
|
|
1625
|
+
]
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
|
|
1629
|
+
```
|
|
1630
|
+
|
|
1631
|
+
表格参数说明
|
|
1632
|
+
|
|
1633
|
+
| 名称 | 类型 | 描述 |
|
|
1634
|
+
| ------------------- | ------- | ------------------------------------------------- |
|
|
1635
|
+
| headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
|
|
1636
|
+
| rowCount | Integer | 表格内容最大行数 |
|
|
1637
|
+
| cells.N.rowStart | Integer | 单元格坐标:行起始index |
|
|
1638
|
+
| cells.N.rowEnd | Integer | 单元格坐标:行结束index |
|
|
1639
|
+
| cells.N.columnStart | Integer | 单元格坐标:列起始index |
|
|
1640
|
+
| cells.N.columnEnd | Integer | 单元格坐标:列结束index |
|
|
1641
|
+
| cells.N.content | String | 单元格内容,字数不超过100 |
|
|
1642
|
+
|
|
1451
1643
|
*/
|
|
1452
1644
|
export interface FlowInfo {
|
|
1453
1645
|
/**
|