tencentcloud-sdk-nodejs 4.0.766 → 4.0.768
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 +300 -0
- package/SERVICE_CHANGELOG.md +286 -143
- package/package.json +1 -1
- package/products.md +20 -20
- package/src/common/sdk_version.ts +1 -1
- package/src/services/billing/v20180709/billing_models.ts +15 -4
- package/src/services/cat/v20180409/cat_models.ts +1 -1
- package/src/services/cbs/v20170312/cbs_models.ts +4 -4
- package/src/services/cwp/v20180228/cwp_models.ts +17 -23
- package/src/services/dts/v20211206/dts_models.ts +97 -97
- package/src/services/ess/v20201111/ess_client.ts +68 -22
- package/src/services/ess/v20201111/ess_models.ts +144 -37
- package/src/services/essbasic/v20210526/essbasic_client.ts +34 -5
- package/src/services/essbasic/v20210526/essbasic_models.ts +155 -25
- package/src/services/faceid/v20180301/faceid_models.ts +8 -8
- package/src/services/iss/v20230517/iss_models.ts +12 -8
- package/src/services/ivld/v20210903/ivld_models.ts +3 -3
- package/src/services/mongodb/v20190725/mongodb_client.ts +3 -1
- package/src/services/mongodb/v20190725/mongodb_models.ts +57 -4
- package/src/services/monitor/v20180724/monitor_models.ts +7 -7
- package/src/services/omics/v20221128/omics_models.ts +21 -4
- package/src/services/sqlserver/v20180328/sqlserver_client.ts +6 -6
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +2 -2
- package/src/services/ssm/v20190923/ssm_models.ts +2 -2
- package/src/services/tcb/v20180608/tcb_models.ts +3 -3
- package/src/services/tsf/v20180326/tsf_client.ts +1 -1
- package/src/services/tsf/v20180326/tsf_models.ts +1 -1
- package/src/services/vod/v20180717/vod_client.ts +4 -3
- package/src/services/vod/v20180717/vod_models.ts +131 -132
- package/src/services/vpc/v20170312/vpc_models.ts +8 -0
- package/src/services/wedata/v20210820/wedata_client.ts +55 -16
- package/src/services/wedata/v20210820/wedata_models.ts +552 -71
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +15 -4
- package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1 -1
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -4
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +17 -23
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +97 -97
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +55 -18
- package/tencentcloud/services/ess/v20201111/ess_client.js +57 -18
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +141 -37
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +25 -5
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +26 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +152 -25
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +8 -8
- package/tencentcloud/services/iss/v20230517/iss_models.d.ts +12 -8
- package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +3 -3
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +1 -1
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +55 -4
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +7 -7
- package/tencentcloud/services/omics/v20221128/omics_models.d.ts +21 -4
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +6 -6
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +6 -6
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +2 -2
- package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +2 -2
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +3 -3
- package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
- package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
- package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -1
- package/tencentcloud/services/vod/v20180717/vod_client.js +2 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +131 -132
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +8 -0
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +17 -5
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +24 -6
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +545 -73
- package/test/ess.v20201111.test.js +12 -2
- package/test/essbasic.v20210526.test.js +10 -0
- package/test/wedata.v20210820.test.js +34 -4
|
@@ -27,6 +27,7 @@ import {
|
|
|
27
27
|
UpdateIntegrationEmployeesResponse,
|
|
28
28
|
Department,
|
|
29
29
|
CreatePreparedPersonalEsignRequest,
|
|
30
|
+
DeleteStaffsResult,
|
|
30
31
|
DescribeIntegrationDepartmentsResponse,
|
|
31
32
|
DeleteExtendedServiceAuthInfosResponse,
|
|
32
33
|
CreateFlowApproversResponse,
|
|
@@ -56,6 +57,8 @@ import {
|
|
|
56
57
|
DeleteIntegrationRoleUsersResponse,
|
|
57
58
|
CreateConvertTaskApiRequest,
|
|
58
59
|
DeleteIntegrationEmployeesResponse,
|
|
60
|
+
NeedReviewApproverInfo,
|
|
61
|
+
CreateFlowGroupSignReviewResponse,
|
|
59
62
|
CreateBatchSignUrlResponse,
|
|
60
63
|
CreateFlowRemindsResponse,
|
|
61
64
|
DescribeOrganizationGroupOrganizationsRequest,
|
|
@@ -200,7 +203,7 @@ import {
|
|
|
200
203
|
CreateUserAutoSignEnableUrlResponse,
|
|
201
204
|
SignUrl,
|
|
202
205
|
VerifyPdfResponse,
|
|
203
|
-
|
|
206
|
+
CreateFlowGroupSignReviewRequest,
|
|
204
207
|
DescribeBillUsageDetailRequest,
|
|
205
208
|
Admin,
|
|
206
209
|
Caller,
|
|
@@ -389,23 +392,20 @@ export class Client extends AbstractClient {
|
|
|
389
392
|
}
|
|
390
393
|
|
|
391
394
|
/**
|
|
392
|
-
*
|
|
393
|
-
|
|
394
|
-
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
395
|
-
|
|
396
|
-
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
395
|
+
* 提交合同组签署流程审批结果的适用场景包括:
|
|
397
396
|
|
|
398
|
-
|
|
397
|
+
1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时,若指定了以下参数 为true,则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
|
|
398
|
+
- [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
|
|
399
|
+
- [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
|
|
399
400
|
|
|
400
|
-
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
401
401
|
|
|
402
|
-
|
|
402
|
+
2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
403
403
|
*/
|
|
404
|
-
async
|
|
405
|
-
req:
|
|
406
|
-
cb?: (error: string, rep:
|
|
407
|
-
): Promise<
|
|
408
|
-
return this.request("
|
|
404
|
+
async CreateFlowGroupSignReview(
|
|
405
|
+
req: CreateFlowGroupSignReviewRequest,
|
|
406
|
+
cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void
|
|
407
|
+
): Promise<CreateFlowGroupSignReviewResponse> {
|
|
408
|
+
return this.request("CreateFlowGroupSignReview", req, cb)
|
|
409
409
|
}
|
|
410
410
|
|
|
411
411
|
/**
|
|
@@ -526,9 +526,36 @@ export class Client extends AbstractClient {
|
|
|
526
526
|
}
|
|
527
527
|
|
|
528
528
|
/**
|
|
529
|
-
*
|
|
530
|
-
|
|
531
|
-
|
|
529
|
+
* 提交企业流程审批结果
|
|
530
|
+
**当前存在两种审核操作:**
|
|
531
|
+
<ul>
|
|
532
|
+
<li>签署审核
|
|
533
|
+
<ul>
|
|
534
|
+
<li>在通过接口<ul>
|
|
535
|
+
<li>CreateFlowByFiles</li>
|
|
536
|
+
<li>CreateFlow</li>
|
|
537
|
+
<li>CreateFlowGroupByTemplates</li>
|
|
538
|
+
<li>CreateFlowGroupByFiles</li>
|
|
539
|
+
<li>CreatePrepareFlow</li>
|
|
540
|
+
</ul>
|
|
541
|
+
发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
|
|
542
|
+
<li>在通过接口
|
|
543
|
+
<ul>
|
|
544
|
+
<li>CreateFlowByFiles</li>
|
|
545
|
+
<li>CreateFlow</li>
|
|
546
|
+
<li>CreateFlowGroupByTemplates</li>
|
|
547
|
+
<li>CreateFlowGroupByFiles</li>
|
|
548
|
+
</ul>
|
|
549
|
+
发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
|
|
550
|
+
</ul>
|
|
551
|
+
</li>
|
|
552
|
+
<li>发起审核
|
|
553
|
+
<ul>
|
|
554
|
+
<li>通过接口CreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
|
|
555
|
+
</li>
|
|
556
|
+
</ul>
|
|
557
|
+
</li>
|
|
558
|
+
</ul>
|
|
532
559
|
*/
|
|
533
560
|
async CreateFlowSignReview(
|
|
534
561
|
req: CreateFlowSignReviewRequest,
|
|
@@ -677,11 +704,10 @@ export class Client extends AbstractClient {
|
|
|
677
704
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
678
705
|
|
|
679
706
|
注:
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
`3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`
|
|
707
|
+
<ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
|
|
708
|
+
<li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
|
|
709
|
+
<li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>
|
|
710
|
+
<li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>
|
|
685
711
|
|
|
686
712
|
其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
687
713
|
|
|
@@ -997,6 +1023,26 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
997
1023
|
return this.request("DescribeFlowBriefs", req, cb)
|
|
998
1024
|
}
|
|
999
1025
|
|
|
1026
|
+
/**
|
|
1027
|
+
* 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
|
|
1028
|
+
|
|
1029
|
+
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
1030
|
+
|
|
1031
|
+
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
1032
|
+
|
|
1033
|
+
适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
1034
|
+
|
|
1035
|
+
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
1036
|
+
|
|
1037
|
+
注意事项:SaaS角色和集团角色对应的权限树是不一样的。
|
|
1038
|
+
*/
|
|
1039
|
+
async CreateIntegrationRole(
|
|
1040
|
+
req: CreateIntegrationRoleRequest,
|
|
1041
|
+
cb?: (error: string, rep: CreateIntegrationRoleResponse) => void
|
|
1042
|
+
): Promise<CreateIntegrationRoleResponse> {
|
|
1043
|
+
return this.request("CreateIntegrationRole", req, cb)
|
|
1044
|
+
}
|
|
1045
|
+
|
|
1000
1046
|
/**
|
|
1001
1047
|
* 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
|
|
1002
1048
|
*/
|
|
@@ -382,6 +382,22 @@ BLUE 蓝色。
|
|
|
382
382
|
SceneKey?: string
|
|
383
383
|
}
|
|
384
384
|
|
|
385
|
+
/**
|
|
386
|
+
* 删除员工结果
|
|
387
|
+
*/
|
|
388
|
+
export interface DeleteStaffsResult {
|
|
389
|
+
/**
|
|
390
|
+
* 删除员工的成功数据
|
|
391
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
392
|
+
*/
|
|
393
|
+
SuccessEmployeeData: Array<SuccessDeleteStaffData>
|
|
394
|
+
/**
|
|
395
|
+
* 删除员工的失败数据
|
|
396
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
397
|
+
*/
|
|
398
|
+
FailedEmployeeData: Array<FailedDeleteStaffData>
|
|
399
|
+
}
|
|
400
|
+
|
|
385
401
|
/**
|
|
386
402
|
* DescribeIntegrationDepartments返回参数结构体
|
|
387
403
|
*/
|
|
@@ -538,35 +554,32 @@ export interface CreateMultiFlowSignQRCodeResponse {
|
|
|
538
554
|
*/
|
|
539
555
|
export interface FlowApproverUrlInfo {
|
|
540
556
|
/**
|
|
541
|
-
*
|
|
557
|
+
* 签署短链接。
|
|
542
558
|
注意:
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
559
|
+
1. 该链接有效期为<b>30分钟</b>,同时需要注意保密,不要外泄给无关用户。
|
|
560
|
+
2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。
|
|
561
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
546
562
|
*/
|
|
547
563
|
SignUrl?: string
|
|
548
564
|
/**
|
|
549
565
|
* 签署人类型。
|
|
550
566
|
- **1**: 个人
|
|
551
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
552
567
|
*/
|
|
553
568
|
ApproverType?: number
|
|
554
569
|
/**
|
|
555
570
|
* 签署人姓名。
|
|
556
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
557
571
|
*/
|
|
558
572
|
ApproverName?: string
|
|
559
573
|
/**
|
|
560
574
|
* 签署人手机号。
|
|
561
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
562
575
|
*/
|
|
563
576
|
ApproverMobile?: string
|
|
564
577
|
/**
|
|
565
|
-
*
|
|
578
|
+
* 签署长链接。
|
|
566
579
|
注意:
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
580
|
+
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
581
|
+
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
582
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
570
583
|
*/
|
|
571
584
|
LongUrl?: string
|
|
572
585
|
}
|
|
@@ -1098,6 +1111,61 @@ export interface DeleteIntegrationEmployeesResponse {
|
|
|
1098
1111
|
RequestId?: string
|
|
1099
1112
|
}
|
|
1100
1113
|
|
|
1114
|
+
/**
|
|
1115
|
+
* 需要进行签署审核的签署人信息
|
|
1116
|
+
*/
|
|
1117
|
+
export interface NeedReviewApproverInfo {
|
|
1118
|
+
/**
|
|
1119
|
+
* 签署方经办人的类型,支持以下类型
|
|
1120
|
+
<ul><li> ORGANIZATION 企业(含企业自动签)</li>
|
|
1121
|
+
<li>PERSON 个人(含个人自动签)</li></ul>
|
|
1122
|
+
*/
|
|
1123
|
+
ApproverType: string
|
|
1124
|
+
/**
|
|
1125
|
+
* 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1126
|
+
*/
|
|
1127
|
+
ApproverName: string
|
|
1128
|
+
/**
|
|
1129
|
+
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
|
|
1130
|
+
*/
|
|
1131
|
+
ApproverMobile?: string
|
|
1132
|
+
/**
|
|
1133
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
1134
|
+
<ul><li>ID_CARD 居民身份证 (默认值)</li>
|
|
1135
|
+
<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
1136
|
+
<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
1137
|
+
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
1138
|
+
|
|
1139
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1140
|
+
*/
|
|
1141
|
+
ApproverIdCardType?: string
|
|
1142
|
+
/**
|
|
1143
|
+
* 签署方经办人的证件号码,应符合以下规则
|
|
1144
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1145
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
1146
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
1147
|
+
*/
|
|
1148
|
+
ApproverIdCardNumber?: string
|
|
1149
|
+
/**
|
|
1150
|
+
* 组织机构名称。
|
|
1151
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
1152
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
1153
|
+
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
1154
|
+
|
|
1155
|
+
*/
|
|
1156
|
+
OrganizationName?: string
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
/**
|
|
1160
|
+
* CreateFlowGroupSignReview返回参数结构体
|
|
1161
|
+
*/
|
|
1162
|
+
export interface CreateFlowGroupSignReviewResponse {
|
|
1163
|
+
/**
|
|
1164
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1165
|
+
*/
|
|
1166
|
+
RequestId?: string
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1101
1169
|
/**
|
|
1102
1170
|
* CreateBatchSignUrl返回参数结构体
|
|
1103
1171
|
*/
|
|
@@ -1105,7 +1173,9 @@ export interface CreateBatchSignUrlResponse {
|
|
|
1105
1173
|
/**
|
|
1106
1174
|
* 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
|
|
1107
1175
|
|
|
1108
|
-
注:
|
|
1176
|
+
注:
|
|
1177
|
+
1. 非小程序和APP集成使用
|
|
1178
|
+
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1109
1179
|
*/
|
|
1110
1180
|
SignUrl?: string
|
|
1111
1181
|
/**
|
|
@@ -1115,7 +1185,9 @@ export interface CreateBatchSignUrlResponse {
|
|
|
1115
1185
|
/**
|
|
1116
1186
|
* 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
|
|
1117
1187
|
|
|
1118
|
-
注:
|
|
1188
|
+
注:
|
|
1189
|
+
1. 小程序和APP集成使用
|
|
1190
|
+
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1119
1191
|
*/
|
|
1120
1192
|
MiniAppPath?: string
|
|
1121
1193
|
/**
|
|
@@ -2807,31 +2879,24 @@ export interface CreateFlowSignReviewRequest {
|
|
|
2807
2879
|
Operator: UserInfo
|
|
2808
2880
|
/**
|
|
2809
2881
|
* 合同流程ID,为32位字符串。
|
|
2810
|
-
|
|
2811
|
-
|
|
2882
|
+
<ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
|
|
2883
|
+
<li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
|
|
2812
2884
|
*/
|
|
2813
2885
|
FlowId: string
|
|
2814
2886
|
/**
|
|
2815
|
-
*
|
|
2816
|
-
<ul><li>PASS:
|
|
2817
|
-
<li>REJECT:
|
|
2887
|
+
* 企业内部审核结果
|
|
2888
|
+
<ul><li>PASS: 审核通过</li>
|
|
2889
|
+
<li>REJECT: 审核拒绝</li>
|
|
2890
|
+
<li>SIGN_REJECT:拒签(流程结束)</li></ul>
|
|
2818
2891
|
*/
|
|
2819
2892
|
ReviewType: string
|
|
2820
|
-
/**
|
|
2821
|
-
* 审核结果原因,
|
|
2822
|
-
字符串长度不超过200
|
|
2823
|
-
当ReviewType 是拒绝(REJECT) 时此字段必填。
|
|
2824
|
-
|
|
2825
|
-
*/
|
|
2826
|
-
ReviewMessage?: string
|
|
2827
2893
|
/**
|
|
2828
2894
|
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
2829
2895
|
*/
|
|
2830
2896
|
Agent?: Agent
|
|
2831
2897
|
/**
|
|
2832
|
-
*
|
|
2833
|
-
|
|
2834
|
-
如果签署审核节点是个人, 此参数必填。
|
|
2898
|
+
* 审核节点的签署人标志,用于指定当前审核的签署方
|
|
2899
|
+
<ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
|
|
2835
2900
|
*/
|
|
2836
2901
|
RecipientId?: string
|
|
2837
2902
|
/**
|
|
@@ -2843,6 +2908,15 @@ export interface CreateFlowSignReviewRequest {
|
|
|
2843
2908
|
如果审核节点是个人,则操作类型只能为SignReview。
|
|
2844
2909
|
*/
|
|
2845
2910
|
OperateType?: string
|
|
2911
|
+
/**
|
|
2912
|
+
* 审核结果原因
|
|
2913
|
+
<ul><li>字符串长度不超过200</li>
|
|
2914
|
+
<li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
|
|
2915
|
+
<li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
|
|
2916
|
+
|
|
2917
|
+
|
|
2918
|
+
*/
|
|
2919
|
+
ReviewMessage?: string
|
|
2846
2920
|
}
|
|
2847
2921
|
|
|
2848
2922
|
/**
|
|
@@ -2881,6 +2955,9 @@ export interface CreateSchemeUrlResponse {
|
|
|
2881
2955
|
<ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
|
|
2882
2956
|
<li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
|
|
2883
2957
|
<li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
注: <font color="red">生成的链路后面不能再增加参数</font>
|
|
2884
2961
|
*/
|
|
2885
2962
|
SchemeUrl?: string
|
|
2886
2963
|
/**
|
|
@@ -3287,7 +3364,8 @@ FormField输入示例:
|
|
|
3287
3364
|
}
|
|
3288
3365
|
```
|
|
3289
3366
|
|
|
3290
|
-
当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue
|
|
3367
|
+
当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue支持填入附件图片或者文件的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
|
|
3368
|
+
支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf
|
|
3291
3369
|
|
|
3292
3370
|
```
|
|
3293
3371
|
FormField输入示例:
|
|
@@ -6642,19 +6720,48 @@ export interface VerifyPdfResponse {
|
|
|
6642
6720
|
}
|
|
6643
6721
|
|
|
6644
6722
|
/**
|
|
6645
|
-
*
|
|
6723
|
+
* CreateFlowGroupSignReview请求参数结构体
|
|
6646
6724
|
*/
|
|
6647
|
-
export interface
|
|
6725
|
+
export interface CreateFlowGroupSignReviewRequest {
|
|
6648
6726
|
/**
|
|
6649
|
-
*
|
|
6650
|
-
|
|
6727
|
+
* 执行本接口操作的员工信息。
|
|
6728
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
6651
6729
|
*/
|
|
6652
|
-
|
|
6730
|
+
Operator: UserInfo
|
|
6653
6731
|
/**
|
|
6654
|
-
*
|
|
6655
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
6732
|
+
* 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
|
|
6656
6733
|
*/
|
|
6657
|
-
|
|
6734
|
+
FlowGroupId: string
|
|
6735
|
+
/**
|
|
6736
|
+
* 提交的审核结果,审核结果有下面三种情况
|
|
6737
|
+
<ul><li><b>PASS</b>: 审核通过,合同流程可以继续执行签署等操作</li>
|
|
6738
|
+
<li><b>REJECT</b>: 审核拒绝,合同流程不会变动</li>
|
|
6739
|
+
<li><b>SIGN_REJECT</b>:拒签,合同流程直接结束,合同状态变为**合同拒签**</li></ul>
|
|
6740
|
+
*/
|
|
6741
|
+
ReviewType: string
|
|
6742
|
+
/**
|
|
6743
|
+
* 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
|
|
6744
|
+
|
|
6745
|
+
个人:二选一(选择其中任意信息组合即可)
|
|
6746
|
+
<ul><li>姓名+证件类型+证件号</li>
|
|
6747
|
+
<li>姓名+手机号</li></ul>
|
|
6748
|
+
|
|
6749
|
+
企业:二选一 (选择其中任意信息组合即可)
|
|
6750
|
+
<ul><li>企业名+姓名+证件类型+证件号</li>
|
|
6751
|
+
<li>企业名+姓名+手机号</li></ul>
|
|
6752
|
+
*/
|
|
6753
|
+
ApproverInfo: NeedReviewApproverInfo
|
|
6754
|
+
/**
|
|
6755
|
+
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
6756
|
+
*/
|
|
6757
|
+
Agent?: Agent
|
|
6758
|
+
/**
|
|
6759
|
+
* 审核不通过的原因,该字段的字符串长度不超过200个字符。
|
|
6760
|
+
|
|
6761
|
+
注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
|
|
6762
|
+
|
|
6763
|
+
*/
|
|
6764
|
+
ReviewMessage?: string
|
|
6658
6765
|
}
|
|
6659
6766
|
|
|
6660
6767
|
/**
|
|
@@ -62,6 +62,8 @@ import {
|
|
|
62
62
|
DownloadFlowInfo,
|
|
63
63
|
FlowApproverUrlInfo,
|
|
64
64
|
ChannelCreateWebThemeConfigRequest,
|
|
65
|
+
NeedReviewApproverInfo,
|
|
66
|
+
CreateFlowGroupSignReviewResponse,
|
|
65
67
|
ChannelCreateConvertTaskApiRequest,
|
|
66
68
|
ChannelCreateFlowByFilesRequest,
|
|
67
69
|
UploadFilesResponse,
|
|
@@ -194,6 +196,7 @@ import {
|
|
|
194
196
|
ChannelUpdateSealStatusRequest,
|
|
195
197
|
ChannelCreateFlowGroupByTemplatesRequest,
|
|
196
198
|
SignUrl,
|
|
199
|
+
CreateFlowGroupSignReviewRequest,
|
|
197
200
|
ChannelBillUsageDetail,
|
|
198
201
|
DescribeBillUsageDetailRequest,
|
|
199
202
|
RelieveInfo,
|
|
@@ -245,11 +248,22 @@ export class Client extends AbstractClient {
|
|
|
245
248
|
}
|
|
246
249
|
|
|
247
250
|
/**
|
|
248
|
-
* 提交企业流程审批结果
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
251
|
+
* 提交企业流程审批结果
|
|
252
|
+
**当前存在两种审核操作:**
|
|
253
|
+
<ul>
|
|
254
|
+
<li>签署审核
|
|
255
|
+
<ul>
|
|
256
|
+
<li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li><li>ChannelCreatePrepareFlow</li></ul> 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
|
|
257
|
+
<li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li></ul>发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
|
|
258
|
+
</ul>
|
|
259
|
+
</li>
|
|
260
|
+
<li>发起审核
|
|
261
|
+
<ul>
|
|
262
|
+
<li>通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
|
|
263
|
+
</li>
|
|
264
|
+
</ul>
|
|
265
|
+
</li>
|
|
266
|
+
</ul>
|
|
253
267
|
*/
|
|
254
268
|
async ChannelCreateFlowSignReview(
|
|
255
269
|
req: ChannelCreateFlowSignReviewRequest,
|
|
@@ -1217,6 +1231,21 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
1217
1231
|
return this.request("DescribeResourceUrlsByFlows", req, cb)
|
|
1218
1232
|
}
|
|
1219
1233
|
|
|
1234
|
+
/**
|
|
1235
|
+
* 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
|
|
1236
|
+
- [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
|
|
1237
|
+
- [FlowFileInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowfileinfo)
|
|
1238
|
+
- [FlowApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo)
|
|
1239
|
+
|
|
1240
|
+
2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
1241
|
+
*/
|
|
1242
|
+
async CreateFlowGroupSignReview(
|
|
1243
|
+
req: CreateFlowGroupSignReviewRequest,
|
|
1244
|
+
cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void
|
|
1245
|
+
): Promise<CreateFlowGroupSignReviewResponse> {
|
|
1246
|
+
return this.request("CreateFlowGroupSignReview", req, cb)
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1220
1249
|
/**
|
|
1221
1250
|
* 使用此接口,用来绑定企业实名员工的角色,
|
|
1222
1251
|
支持以电子签userId、客户系统openId两种方式进行绑定。
|