tencentcloud-sdk-nodejs 4.0.686 → 4.0.688
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 +719 -0
- package/SERVICE_CHANGELOG.md +1004 -294
- package/package.json +1 -1
- package/products.md +31 -30
- package/src/common/sdk_version.ts +1 -1
- package/src/services/advisor/v20200721/advisor_client.ts +2 -2
- package/src/services/advisor/v20200721/advisor_models.ts +53 -53
- package/src/services/ams/v20201229/ams_client.ts +4 -3
- package/src/services/ams/v20201229/ams_models.ts +1 -1
- package/src/services/apigateway/v20180808/apigateway_models.ts +20 -0
- package/src/services/asr/v20190614/asr_models.ts +102 -48
- package/src/services/cdb/v20170320/cdb_client.ts +1 -0
- package/src/services/cdb/v20170320/cdb_models.ts +43 -7
- package/src/services/ckafka/v20190819/ckafka_client.ts +13 -0
- package/src/services/ckafka/v20190819/ckafka_models.ts +35 -0
- package/src/services/cvm/v20170312/cvm_models.ts +6 -1
- package/src/services/cynosdb/v20190107/cynosdb_client.ts +1 -1
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +8 -3
- package/src/services/dlc/v20210125/dlc_client.ts +1 -1
- package/src/services/dlc/v20210125/dlc_models.ts +1 -1
- package/src/services/ecc/v20181213/ecc_client.ts +1 -0
- package/src/services/ecc/v20181213/ecc_models.ts +35 -0
- package/src/services/es/v20180416/es_client.ts +2 -1
- package/src/services/es/v20180416/es_models.ts +209 -170
- package/src/services/ess/v20201111/ess_client.ts +33 -32
- package/src/services/ess/v20201111/ess_models.ts +176 -160
- package/src/services/essbasic/v20210526/essbasic_models.ts +47 -5
- package/src/services/ims/v20201229/ims_client.ts +2 -2
- package/src/services/index.ts +1 -0
- package/src/services/monitor/v20180724/monitor_models.ts +5 -0
- package/src/services/mrs/v20200910/mrs_client.ts +3 -2
- package/src/services/mrs/v20200910/mrs_models.ts +2 -2
- package/src/services/nlp/v20190408/nlp_client.ts +4 -2
- package/src/services/ocr/v20181119/ocr_client.ts +1 -1
- package/src/services/ocr/v20181119/ocr_models.ts +1 -1
- package/src/services/ses/v20201002/ses_models.ts +9 -4
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +31 -19
- package/src/services/tcss/v20201101/tcss_client.ts +3 -2
- package/src/services/tcss/v20201101/tcss_models.ts +278 -113
- package/src/services/teo/v20220901/teo_models.ts +13 -12
- package/src/services/thpc/v20230321/thpc_models.ts +4 -0
- package/src/services/tse/v20201207/tse_client.ts +40 -25
- package/src/services/tse/v20201207/tse_models.ts +184 -6
- package/src/services/vm/v20201229/vm_client.ts +6 -6
- package/src/services/vm/v20201229/vm_models.ts +2 -2
- package/src/services/vod/v20180717/vod_client.ts +3 -13
- package/src/services/vod/v20180717/vod_models.ts +512 -448
- package/src/services/waf/v20180125/waf_client.ts +25 -0
- package/src/services/waf/v20180125/waf_models.ts +150 -23
- package/src/services/weilingwith/index.ts +5 -0
- package/src/services/weilingwith/v20230427/index.ts +6 -0
- package/src/services/weilingwith/v20230427/weilingwith_client.ts +93 -0
- package/src/services/weilingwith/v20230427/weilingwith_models.ts +197 -0
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/advisor/v20200721/advisor_models.d.ts +52 -52
- package/tencentcloud/services/ams/v20201229/ams_client.d.ts +4 -3
- package/tencentcloud/services/ams/v20201229/ams_client.js +4 -3
- package/tencentcloud/services/ams/v20201229/ams_models.d.ts +1 -1
- package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +20 -0
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +102 -48
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +42 -7
- 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 +32 -0
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +6 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +8 -3
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +1 -1
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +1 -1
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +1 -1
- package/tencentcloud/services/ecc/v20181213/ecc_models.d.ts +34 -0
- package/tencentcloud/services/es/v20180416/es_models.d.ts +200 -162
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +30 -21
- package/tencentcloud/services/ess/v20201111/ess_client.js +29 -22
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +176 -158
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +47 -5
- package/tencentcloud/services/ims/v20201229/ims_client.d.ts +2 -2
- package/tencentcloud/services/ims/v20201229/ims_client.js +2 -2
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +2 -0
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +5 -0
- package/tencentcloud/services/mrs/v20200910/mrs_client.d.ts +2 -1
- package/tencentcloud/services/mrs/v20200910/mrs_client.js +2 -1
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +2 -2
- package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +3 -1
- package/tencentcloud/services/nlp/v20190408/nlp_client.js +3 -1
- 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 +1 -1
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +9 -4
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +31 -19
- package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +2 -2
- package/tencentcloud/services/tcss/v20201101/tcss_client.js +1 -1
- package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +277 -113
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +13 -12
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +4 -0
- package/tencentcloud/services/tse/v20201207/tse_client.d.ts +13 -9
- package/tencentcloud/services/tse/v20201207/tse_client.js +18 -12
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +179 -6
- package/tencentcloud/services/vm/v20201229/vm_client.d.ts +6 -6
- package/tencentcloud/services/vm/v20201229/vm_client.js +6 -6
- package/tencentcloud/services/vm/v20201229/vm_models.d.ts +2 -2
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -5
- package/tencentcloud/services/vod/v20180717/vod_client.js +0 -6
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +510 -446
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +9 -1
- package/tencentcloud/services/waf/v20180125/waf_client.js +12 -0
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +145 -23
- package/tencentcloud/services/weilingwith/index.d.ts +6 -0
- package/tencentcloud/services/weilingwith/index.js +7 -0
- package/tencentcloud/services/weilingwith/v20230427/index.d.ts +6 -0
- package/tencentcloud/services/weilingwith/v20230427/index.js +9 -0
- package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +30 -0
- package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +61 -0
- package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +169 -0
- package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.js +18 -0
- package/test/ckafka.v20190819.test.js +10 -0
- package/test/ess.v20201111.test.js +0 -10
- package/test/tse.v20201207.test.js +18 -8
- package/test/vod.v20180717.test.js +0 -10
- package/test/waf.v20180125.test.js +20 -0
- package/test/weilingwith.v20230427.test.js +71 -0
|
@@ -116,7 +116,7 @@ export interface DescribeFlowEvidenceReportRequest {
|
|
|
116
116
|
*/
|
|
117
117
|
Operator: UserInfo;
|
|
118
118
|
/**
|
|
119
|
-
*
|
|
119
|
+
* 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
|
|
120
120
|
*/
|
|
121
121
|
ReportId: string;
|
|
122
122
|
/**
|
|
@@ -924,11 +924,12 @@ export interface FlowApproverDetail {
|
|
|
924
924
|
*/
|
|
925
925
|
export interface CreateFlowGroupByFilesRequest {
|
|
926
926
|
/**
|
|
927
|
-
*
|
|
927
|
+
* 执行本接口操作的员工信息。
|
|
928
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
928
929
|
*/
|
|
929
930
|
Operator: UserInfo;
|
|
930
931
|
/**
|
|
931
|
-
*
|
|
932
|
+
* 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
932
933
|
*/
|
|
933
934
|
FlowGroupName: string;
|
|
934
935
|
/**
|
|
@@ -936,11 +937,17 @@ export interface CreateFlowGroupByFilesRequest {
|
|
|
936
937
|
*/
|
|
937
938
|
FlowGroupInfos: Array<FlowGroupInfo>;
|
|
938
939
|
/**
|
|
939
|
-
*
|
|
940
|
+
* 代理企业和员工的信息。
|
|
941
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
940
942
|
*/
|
|
941
943
|
Agent?: Agent;
|
|
942
944
|
/**
|
|
943
|
-
*
|
|
945
|
+
* 合同(流程)组的配置项信息。
|
|
946
|
+
其中包括:
|
|
947
|
+
<ul>
|
|
948
|
+
<li>是否通知本企业签署方</li>
|
|
949
|
+
<li>是否通知其他签署方</li>
|
|
950
|
+
</ul>
|
|
944
951
|
*/
|
|
945
952
|
FlowGroupOptions?: FlowGroupOptions;
|
|
946
953
|
}
|
|
@@ -963,17 +970,16 @@ export interface DescribeFlowComponentsResponse {
|
|
|
963
970
|
*/
|
|
964
971
|
export interface DescribeFlowEvidenceReportResponse {
|
|
965
972
|
/**
|
|
966
|
-
* 出证报告PDF的下载 URL
|
|
973
|
+
* 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
|
|
967
974
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
968
975
|
*/
|
|
969
976
|
ReportUrl?: string;
|
|
970
977
|
/**
|
|
971
|
-
*
|
|
972
|
-
|
|
973
|
-
<li
|
|
974
|
-
<li
|
|
975
|
-
<li
|
|
976
|
-
</ul>
|
|
978
|
+
* 出证任务执行的状态, 状态含义如下:
|
|
979
|
+
|
|
980
|
+
<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
981
|
+
<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
982
|
+
<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
977
983
|
*/
|
|
978
984
|
Status?: string;
|
|
979
985
|
/**
|
|
@@ -1460,8 +1466,7 @@ export interface AutoSignConfig {
|
|
|
1460
1466
|
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
1461
1467
|
|
|
1462
1468
|
<ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
1463
|
-
|
|
1464
|
-
|
|
1469
|
+
</ul>
|
|
1465
1470
|
*/
|
|
1466
1471
|
LicenseType?: number;
|
|
1467
1472
|
}
|
|
@@ -1786,9 +1791,7 @@ export interface DescribeUserAutoSignStatusResponse {
|
|
|
1786
1791
|
/**
|
|
1787
1792
|
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
1788
1793
|
|
|
1789
|
-
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
1790
|
-
<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
1791
|
-
|
|
1794
|
+
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
1792
1795
|
*/
|
|
1793
1796
|
LicenseType?: number;
|
|
1794
1797
|
/**
|
|
@@ -2284,55 +2287,82 @@ export interface CreateUserAutoSignEnableUrlResponse {
|
|
|
2284
2287
|
*/
|
|
2285
2288
|
export interface FlowGroupInfo {
|
|
2286
2289
|
/**
|
|
2287
|
-
*
|
|
2290
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
2291
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
2288
2292
|
*/
|
|
2289
2293
|
FlowName: string;
|
|
2290
2294
|
/**
|
|
2291
|
-
*
|
|
2295
|
+
* 签署流程参与者信息,最大限制50方
|
|
2296
|
+
注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
|
|
2292
2297
|
*/
|
|
2293
2298
|
Approvers: Array<ApproverInfo>;
|
|
2294
2299
|
/**
|
|
2295
|
-
*
|
|
2300
|
+
* 文件资源ID,通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得,为32位字符串。
|
|
2301
|
+
建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
|
|
2296
2302
|
*/
|
|
2297
2303
|
FileIds?: Array<string>;
|
|
2298
2304
|
/**
|
|
2299
|
-
*
|
|
2305
|
+
* 合同模板ID,为32位字符串。
|
|
2306
|
+
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
2307
|
+
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
2300
2308
|
*/
|
|
2301
2309
|
TemplateId?: string;
|
|
2302
2310
|
/**
|
|
2303
|
-
*
|
|
2311
|
+
* 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
2312
|
+
示例值:劳务合同
|
|
2304
2313
|
*/
|
|
2305
2314
|
FlowType?: string;
|
|
2306
2315
|
/**
|
|
2307
|
-
*
|
|
2316
|
+
* 签署流程描述,最大长度1000个字符
|
|
2308
2317
|
*/
|
|
2309
2318
|
FlowDescription?: string;
|
|
2310
2319
|
/**
|
|
2311
|
-
*
|
|
2320
|
+
* 签署流程的签署截止时间。
|
|
2321
|
+
|
|
2322
|
+
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
2323
|
+
示例值:1604912664
|
|
2312
2324
|
*/
|
|
2313
2325
|
Deadline?: number;
|
|
2314
2326
|
/**
|
|
2315
2327
|
* 合同(流程)的回调地址
|
|
2328
|
+
* @deprecated
|
|
2316
2329
|
*/
|
|
2317
2330
|
CallbackUrl?: string;
|
|
2318
2331
|
/**
|
|
2319
|
-
*
|
|
2332
|
+
* 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
2333
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
2334
|
+
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
2320
2335
|
*/
|
|
2321
2336
|
UserData?: string;
|
|
2322
2337
|
/**
|
|
2323
|
-
*
|
|
2338
|
+
* 发送类型:
|
|
2339
|
+
true:无序签
|
|
2340
|
+
false:有序签
|
|
2341
|
+
注:默认为false(有序签),请和模板中的配置保持一致
|
|
2342
|
+
示例值:true
|
|
2324
2343
|
*/
|
|
2325
2344
|
Unordered?: boolean;
|
|
2326
2345
|
/**
|
|
2327
|
-
*
|
|
2346
|
+
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
2347
|
+
<ul><li>单行文本控件</li>
|
|
2348
|
+
<li>多行文本控件</li>
|
|
2349
|
+
<li>勾选框控件</li>
|
|
2350
|
+
<li>数字控件</li>
|
|
2351
|
+
<li>图片控件</li>
|
|
2352
|
+
<li>动态表格等填写控件</li></ul>
|
|
2328
2353
|
*/
|
|
2329
2354
|
Components?: Array<Component>;
|
|
2330
2355
|
/**
|
|
2331
|
-
*
|
|
2356
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
2357
|
+
若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
2358
|
+
|
|
2359
|
+
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
2360
|
+
示例值:true
|
|
2332
2361
|
*/
|
|
2333
2362
|
NeedSignReview?: boolean;
|
|
2334
2363
|
/**
|
|
2335
|
-
*
|
|
2364
|
+
* 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
2365
|
+
示例值:E_PRESCRIPTION_AUTO_SIGN
|
|
2336
2366
|
*/
|
|
2337
2367
|
AutoSignScene?: string;
|
|
2338
2368
|
}
|
|
@@ -2621,19 +2651,6 @@ export interface FormField {
|
|
|
2621
2651
|
*/
|
|
2622
2652
|
ComponentName?: string;
|
|
2623
2653
|
}
|
|
2624
|
-
/**
|
|
2625
|
-
* CreateChannelSubOrganizationModifyQrCode请求参数结构体
|
|
2626
|
-
*/
|
|
2627
|
-
export interface CreateChannelSubOrganizationModifyQrCodeRequest {
|
|
2628
|
-
/**
|
|
2629
|
-
* 操作人信息,userId必填
|
|
2630
|
-
*/
|
|
2631
|
-
Operator: UserInfo;
|
|
2632
|
-
/**
|
|
2633
|
-
* 应用编号
|
|
2634
|
-
*/
|
|
2635
|
-
ApplicationId: string;
|
|
2636
|
-
}
|
|
2637
2654
|
/**
|
|
2638
2655
|
* 用户信息
|
|
2639
2656
|
*/
|
|
@@ -3006,16 +3023,16 @@ export interface RecipientComponentInfo {
|
|
|
3006
3023
|
*/
|
|
3007
3024
|
export interface CreateFlowEvidenceReportResponse {
|
|
3008
3025
|
/**
|
|
3009
|
-
* 出证报告 ID
|
|
3026
|
+
* 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
|
|
3010
3027
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3011
3028
|
*/
|
|
3012
3029
|
ReportId?: string;
|
|
3013
3030
|
/**
|
|
3014
|
-
* 出证任务执行的状态,
|
|
3031
|
+
* 出证任务执行的状态, 状态含义如下:
|
|
3015
3032
|
|
|
3016
|
-
<ul><li
|
|
3017
|
-
<li
|
|
3018
|
-
<li
|
|
3033
|
+
<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
3034
|
+
<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
3035
|
+
<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
3019
3036
|
*/
|
|
3020
3037
|
Status?: string;
|
|
3021
3038
|
/**
|
|
@@ -3224,65 +3241,23 @@ export interface CreateDocumentRequest {
|
|
|
3224
3241
|
ClientToken?: string;
|
|
3225
3242
|
}
|
|
3226
3243
|
/**
|
|
3227
|
-
*
|
|
3244
|
+
* 催办接口返回的详细信息。
|
|
3228
3245
|
*/
|
|
3229
|
-
export interface
|
|
3230
|
-
/**
|
|
3231
|
-
* 合同(流程)的ID
|
|
3232
|
-
*/
|
|
3233
|
-
FlowId?: string;
|
|
3234
|
-
/**
|
|
3235
|
-
* 合同(流程)的名字
|
|
3236
|
-
*/
|
|
3237
|
-
FlowName?: string;
|
|
3238
|
-
/**
|
|
3239
|
-
* 合同(流程)的类型
|
|
3240
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3241
|
-
*/
|
|
3242
|
-
FlowType?: string;
|
|
3243
|
-
/**
|
|
3244
|
-
* 流程状态
|
|
3245
|
-
- 0 还没有发起
|
|
3246
|
-
- 1 待签署
|
|
3247
|
-
- 2 部分签署
|
|
3248
|
-
- 3 已拒签
|
|
3249
|
-
- 4 已签署
|
|
3250
|
-
- 5 已过期
|
|
3251
|
-
- 6 已撤销
|
|
3252
|
-
- 7 还没有预发起
|
|
3253
|
-
- 8 等待填写
|
|
3254
|
-
- 9 部分填写
|
|
3255
|
-
- 10 拒填
|
|
3256
|
-
- 21 已解除
|
|
3257
|
-
*/
|
|
3258
|
-
FlowStatus?: number;
|
|
3259
|
-
/**
|
|
3260
|
-
* 合同(流程)的信息
|
|
3261
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3262
|
-
*/
|
|
3263
|
-
FlowMessage?: string;
|
|
3264
|
-
/**
|
|
3265
|
-
* 流程的描述
|
|
3266
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3267
|
-
*/
|
|
3268
|
-
FlowDescription?: string;
|
|
3269
|
-
/**
|
|
3270
|
-
* 合同(流程)的创建时间戳,单位秒
|
|
3271
|
-
*/
|
|
3272
|
-
CreatedOn?: number;
|
|
3246
|
+
export interface RemindFlowRecords {
|
|
3273
3247
|
/**
|
|
3274
|
-
*
|
|
3248
|
+
* 合同流程是否可以催办:
|
|
3249
|
+
true - 可以,false - 不可以。
|
|
3250
|
+
若无法催办,将返回RemindMessage以解释原因。
|
|
3275
3251
|
*/
|
|
3276
|
-
|
|
3252
|
+
CanRemind?: boolean;
|
|
3277
3253
|
/**
|
|
3278
|
-
*
|
|
3254
|
+
* 合同流程ID,为32位字符串。
|
|
3279
3255
|
*/
|
|
3280
|
-
|
|
3256
|
+
FlowId?: string;
|
|
3281
3257
|
/**
|
|
3282
|
-
*
|
|
3283
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3258
|
+
* 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
|
|
3284
3259
|
*/
|
|
3285
|
-
|
|
3260
|
+
RemindMessage?: string;
|
|
3286
3261
|
}
|
|
3287
3262
|
/**
|
|
3288
3263
|
* CreatePreparedPersonalEsign返回参数结构体
|
|
@@ -3319,7 +3294,8 @@ export interface DescribeOrganizationSealsResponse {
|
|
|
3319
3294
|
*/
|
|
3320
3295
|
export interface CreateEmbedWebUrlRequest {
|
|
3321
3296
|
/**
|
|
3322
|
-
*
|
|
3297
|
+
* 执行本接口操作的员工信息。
|
|
3298
|
+
<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
3323
3299
|
*/
|
|
3324
3300
|
Operator: UserInfo;
|
|
3325
3301
|
/**
|
|
@@ -3344,7 +3320,8 @@ export interface CreateEmbedWebUrlRequest {
|
|
|
3344
3320
|
*/
|
|
3345
3321
|
BusinessId?: string;
|
|
3346
3322
|
/**
|
|
3347
|
-
*
|
|
3323
|
+
* 代理企业和员工的信息。
|
|
3324
|
+
<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3348
3325
|
*/
|
|
3349
3326
|
Agent?: Agent;
|
|
3350
3327
|
/**
|
|
@@ -3352,7 +3329,7 @@ export interface CreateEmbedWebUrlRequest {
|
|
|
3352
3329
|
*/
|
|
3353
3330
|
Reviewer?: ReviewerInfo;
|
|
3354
3331
|
/**
|
|
3355
|
-
*
|
|
3332
|
+
* 个性化参数,用于控制页面展示内容
|
|
3356
3333
|
*/
|
|
3357
3334
|
Option?: EmbedUrlOption;
|
|
3358
3335
|
}
|
|
@@ -3425,20 +3402,22 @@ export interface GetTaskResultApiRequest {
|
|
|
3425
3402
|
*/
|
|
3426
3403
|
export interface FlowGroupOptions {
|
|
3427
3404
|
/**
|
|
3428
|
-
*
|
|
3429
|
-
VerifyCheck:
|
|
3430
|
-
MobileCheck
|
|
3405
|
+
* 签署人校验方式,支持以下类型
|
|
3406
|
+
<ul><li>VerifyCheck : 人脸识别 (默认值)</li>
|
|
3407
|
+
<li>MobileCheck : 手机号验证</li></ul>
|
|
3431
3408
|
参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
3432
3409
|
*/
|
|
3433
3410
|
ApproverVerifyType?: string;
|
|
3434
3411
|
/**
|
|
3435
3412
|
* 发起合同(流程)组本方企业经办人通知方式
|
|
3436
|
-
|
|
3413
|
+
签署通知类型,支持以下类型
|
|
3414
|
+
<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
|
|
3437
3415
|
*/
|
|
3438
3416
|
SelfOrganizationApproverNotifyType?: string;
|
|
3439
3417
|
/**
|
|
3440
3418
|
* 发起合同(流程)组他方经办人通知方式
|
|
3441
|
-
|
|
3419
|
+
签署通知类型,支持以下类型
|
|
3420
|
+
<ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
|
|
3442
3421
|
*/
|
|
3443
3422
|
OtherApproverNotifyType?: string;
|
|
3444
3423
|
}
|
|
@@ -3784,21 +3763,65 @@ export interface CreateIntegrationUserRolesRequest {
|
|
|
3784
3763
|
Agent?: Agent;
|
|
3785
3764
|
}
|
|
3786
3765
|
/**
|
|
3787
|
-
*
|
|
3766
|
+
* 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
|
3788
3767
|
*/
|
|
3789
|
-
export interface
|
|
3768
|
+
export interface FlowDetailInfo {
|
|
3790
3769
|
/**
|
|
3791
|
-
*
|
|
3770
|
+
* 合同(流程)的ID
|
|
3792
3771
|
*/
|
|
3793
|
-
|
|
3772
|
+
FlowId?: string;
|
|
3794
3773
|
/**
|
|
3795
|
-
*
|
|
3774
|
+
* 合同(流程)的名字
|
|
3796
3775
|
*/
|
|
3797
|
-
|
|
3776
|
+
FlowName?: string;
|
|
3798
3777
|
/**
|
|
3799
|
-
*
|
|
3778
|
+
* 合同(流程)的类型
|
|
3779
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3800
3780
|
*/
|
|
3801
|
-
|
|
3781
|
+
FlowType?: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* 流程状态
|
|
3784
|
+
- 0 还没有发起
|
|
3785
|
+
- 1 待签署
|
|
3786
|
+
- 2 部分签署
|
|
3787
|
+
- 3 已拒签
|
|
3788
|
+
- 4 已签署
|
|
3789
|
+
- 5 已过期
|
|
3790
|
+
- 6 已撤销
|
|
3791
|
+
- 7 还没有预发起
|
|
3792
|
+
- 8 等待填写
|
|
3793
|
+
- 9 部分填写
|
|
3794
|
+
- 10 拒填
|
|
3795
|
+
- 21 已解除
|
|
3796
|
+
*/
|
|
3797
|
+
FlowStatus?: number;
|
|
3798
|
+
/**
|
|
3799
|
+
* 合同(流程)的信息
|
|
3800
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3801
|
+
*/
|
|
3802
|
+
FlowMessage?: string;
|
|
3803
|
+
/**
|
|
3804
|
+
* 流程的描述
|
|
3805
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3806
|
+
*/
|
|
3807
|
+
FlowDescription?: string;
|
|
3808
|
+
/**
|
|
3809
|
+
* 合同(流程)的创建时间戳,单位秒
|
|
3810
|
+
*/
|
|
3811
|
+
CreatedOn?: number;
|
|
3812
|
+
/**
|
|
3813
|
+
* 合同(流程)的签署方数组
|
|
3814
|
+
*/
|
|
3815
|
+
FlowApproverInfos?: Array<FlowApproverDetail>;
|
|
3816
|
+
/**
|
|
3817
|
+
* 合同(流程)的关注方信息列表
|
|
3818
|
+
*/
|
|
3819
|
+
CcInfos?: Array<FlowApproverDetail>;
|
|
3820
|
+
/**
|
|
3821
|
+
* 合同发起人UserId
|
|
3822
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3823
|
+
*/
|
|
3824
|
+
Creator?: string;
|
|
3802
3825
|
}
|
|
3803
3826
|
/**
|
|
3804
3827
|
* 更新员工信息成功返回的数据信息
|
|
@@ -4282,11 +4305,11 @@ export interface CreateUserAutoSignEnableUrlRequest {
|
|
|
4282
4305
|
*/
|
|
4283
4306
|
export interface CreateOrganizationBatchSignUrlResponse {
|
|
4284
4307
|
/**
|
|
4285
|
-
*
|
|
4308
|
+
* 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
|
|
4286
4309
|
*/
|
|
4287
4310
|
SignUrl?: string;
|
|
4288
4311
|
/**
|
|
4289
|
-
*
|
|
4312
|
+
* 链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。
|
|
4290
4313
|
*/
|
|
4291
4314
|
ExpiredTime?: number;
|
|
4292
4315
|
/**
|
|
@@ -4308,25 +4331,6 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
|
|
|
4308
4331
|
*/
|
|
4309
4332
|
RequestId?: string;
|
|
4310
4333
|
}
|
|
4311
|
-
/**
|
|
4312
|
-
* 催办接口返回的详细信息。
|
|
4313
|
-
*/
|
|
4314
|
-
export interface RemindFlowRecords {
|
|
4315
|
-
/**
|
|
4316
|
-
* 合同流程是否可以催办:
|
|
4317
|
-
true - 可以,false - 不可以。
|
|
4318
|
-
若无法催办,将返回RemindMessage以解释原因。
|
|
4319
|
-
*/
|
|
4320
|
-
CanRemind?: boolean;
|
|
4321
|
-
/**
|
|
4322
|
-
* 合同流程ID,为32位字符串。
|
|
4323
|
-
*/
|
|
4324
|
-
FlowId?: string;
|
|
4325
|
-
/**
|
|
4326
|
-
* 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
|
|
4327
|
-
*/
|
|
4328
|
-
RemindMessage?: string;
|
|
4329
|
-
}
|
|
4330
4334
|
/**
|
|
4331
4335
|
* CancelUserAutoSignEnableUrl请求参数结构体
|
|
4332
4336
|
*/
|
|
@@ -4401,13 +4405,13 @@ export interface ApproverRestriction {
|
|
|
4401
4405
|
*/
|
|
4402
4406
|
export interface CreateWebThemeConfigRequest {
|
|
4403
4407
|
/**
|
|
4404
|
-
*
|
|
4408
|
+
* 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4405
4409
|
*/
|
|
4406
4410
|
Operator: UserInfo;
|
|
4407
4411
|
/**
|
|
4408
|
-
*
|
|
4409
|
-
<
|
|
4410
|
-
|
|
4412
|
+
* 主题类型,取值如下:
|
|
4413
|
+
<ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
|
|
4414
|
+
</ul>
|
|
4411
4415
|
*/
|
|
4412
4416
|
ThemeType: string;
|
|
4413
4417
|
/**
|
|
@@ -4415,7 +4419,8 @@ export interface CreateWebThemeConfigRequest {
|
|
|
4415
4419
|
*/
|
|
4416
4420
|
WebThemeConfig: WebThemeConfig;
|
|
4417
4421
|
/**
|
|
4418
|
-
* 代理企业和员工的信息。
|
|
4422
|
+
* 代理企业和员工的信息。
|
|
4423
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4419
4424
|
*/
|
|
4420
4425
|
Agent?: Agent;
|
|
4421
4426
|
}
|
|
@@ -4449,27 +4454,39 @@ export interface DeleteSealPoliciesRequest {
|
|
|
4449
4454
|
*/
|
|
4450
4455
|
export interface CreateOrganizationBatchSignUrlRequest {
|
|
4451
4456
|
/**
|
|
4452
|
-
*
|
|
4457
|
+
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
4458
|
+
支持填入集团子公司经办人 userId 代发合同。
|
|
4459
|
+
|
|
4460
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4453
4461
|
*/
|
|
4454
4462
|
Operator: UserInfo;
|
|
4455
4463
|
/**
|
|
4456
|
-
*
|
|
4464
|
+
* 请指定需执行批量签署的流程ID,数量范围为1-100。
|
|
4465
|
+
您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。
|
|
4466
|
+
用户将利用链接对这些合同实施批量操作。
|
|
4457
4467
|
*/
|
|
4458
4468
|
FlowIds: Array<string>;
|
|
4459
4469
|
/**
|
|
4460
|
-
*
|
|
4470
|
+
* 代理企业和员工的信息。
|
|
4471
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4461
4472
|
*/
|
|
4462
4473
|
Agent?: Agent;
|
|
4463
4474
|
/**
|
|
4464
|
-
*
|
|
4475
|
+
* 员工在腾讯电子签平台的独特身份标识,为32位字符串。
|
|
4476
|
+
您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
|
|
4477
|
+
UserId必须是传入合同(FlowId)中的签署人。
|
|
4478
|
+
- 1. 若UserId为空,Name和Mobile 必须提供。
|
|
4479
|
+
- 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
|
|
4465
4480
|
*/
|
|
4466
4481
|
UserId?: string;
|
|
4467
4482
|
/**
|
|
4468
|
-
*
|
|
4483
|
+
* 员工姓名,必须与手机号码一起使用。
|
|
4484
|
+
如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
4469
4485
|
*/
|
|
4470
4486
|
Name?: string;
|
|
4471
4487
|
/**
|
|
4472
|
-
*
|
|
4488
|
+
* 员工手机号,必须与姓名一起使用。
|
|
4489
|
+
如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
4473
4490
|
*/
|
|
4474
4491
|
Mobile?: string;
|
|
4475
4492
|
}
|
|
@@ -4605,15 +4622,15 @@ export interface DeleteIntegrationDepartmentRequest {
|
|
|
4605
4622
|
*/
|
|
4606
4623
|
export interface WebThemeConfig {
|
|
4607
4624
|
/**
|
|
4608
|
-
*
|
|
4609
|
-
<
|
|
4610
|
-
<
|
|
4611
|
-
<br/>默认false,不隐藏logo
|
|
4625
|
+
* 是否显示页面底部电子签logo,取值如下:
|
|
4626
|
+
<ul><li> **true**:页面底部显示电子签logo</li>
|
|
4627
|
+
<li> **false**:页面底部不显示电子签logo(默认)</li></ul>
|
|
4612
4628
|
*/
|
|
4613
4629
|
DisplaySignBrandLogo?: boolean;
|
|
4614
4630
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
|
|
4631
|
+
* 主题颜色:
|
|
4632
|
+
支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
|
|
4633
|
+
<br/>
|
|
4617
4634
|
*/
|
|
4618
4635
|
WebEmbedThemeColor?: string;
|
|
4619
4636
|
}
|
|
@@ -4827,7 +4844,7 @@ export interface ApproverOption {
|
|
|
4827
4844
|
export interface CreateEmbedWebUrlResponse {
|
|
4828
4845
|
/**
|
|
4829
4846
|
* 嵌入的web链接,有效期:5分钟
|
|
4830
|
-
EmbedType=PREVIEW_CC_FLOW,该url为h5链接
|
|
4847
|
+
<br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接
|
|
4831
4848
|
*/
|
|
4832
4849
|
WebUrl?: string;
|
|
4833
4850
|
/**
|
|
@@ -5661,17 +5678,18 @@ export interface EmbedUrlOption {
|
|
|
5661
5678
|
*/
|
|
5662
5679
|
export interface CreateBatchCancelFlowUrlRequest {
|
|
5663
5680
|
/**
|
|
5664
|
-
*
|
|
5681
|
+
* 执行本接口操作的员工信息。
|
|
5682
|
+
<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
5665
5683
|
*/
|
|
5666
5684
|
Operator: UserInfo;
|
|
5667
5685
|
/**
|
|
5668
5686
|
* 需要执行撤回的流程(合同)的编号列表,最多100个.
|
|
5669
|
-
|
|
5687
|
+
<br>列表中的流程(合同)编号不要重复.
|
|
5670
5688
|
*/
|
|
5671
5689
|
FlowIds: Array<string>;
|
|
5672
5690
|
/**
|
|
5673
|
-
*
|
|
5674
|
-
|
|
5691
|
+
* 代理企业和员工的信息。
|
|
5692
|
+
<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5675
5693
|
*/
|
|
5676
5694
|
Agent?: Agent;
|
|
5677
5695
|
}
|