tencentcloud-sdk-nodejs-essbasic 4.1.191 → 4.1.197
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/package.json
CHANGED
|
@@ -1960,6 +1960,10 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1960
1960
|
* <p>是否开启动态合同(动态签署人2.0)<ul><li> <strong>false</strong> :(默认) 不开启动态合同(动态签署人2.0)</li><li> <strong>true</strong> :开启动态合同(动态签署人2.0),发起时不设置签署方,发起后可继续追加合同签署人</li></ul></p>
|
|
1961
1961
|
*/
|
|
1962
1962
|
OpenDynamicSignFlow?: boolean;
|
|
1963
|
+
/**
|
|
1964
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
|
|
1965
|
+
*/
|
|
1966
|
+
FlowOperateLimit?: FlowOperateLimit;
|
|
1963
1967
|
}
|
|
1964
1968
|
/**
|
|
1965
1969
|
* UploadFiles返回参数结构体
|
|
@@ -2906,6 +2910,15 @@ export interface CreateBatchOrganizationRegistrationTasksResponse {
|
|
|
2906
2910
|
*/
|
|
2907
2911
|
RequestId?: string;
|
|
2908
2912
|
}
|
|
2913
|
+
/**
|
|
2914
|
+
* 发起合同流程时对合同流程的部分操作加以限制的配置。
|
|
2915
|
+
*/
|
|
2916
|
+
export interface FlowOperateLimit {
|
|
2917
|
+
/**
|
|
2918
|
+
* <p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
|
|
2919
|
+
*/
|
|
2920
|
+
NoRelease?: boolean;
|
|
2921
|
+
}
|
|
2909
2922
|
/**
|
|
2910
2923
|
* ChannelVerifyPdf请求参数结构体
|
|
2911
2924
|
*/
|
|
@@ -4488,115 +4501,70 @@ export interface ArchiveDynamicFlowRequest {
|
|
|
4488
4501
|
*/
|
|
4489
4502
|
export interface FlowInfo {
|
|
4490
4503
|
/**
|
|
4491
|
-
*
|
|
4504
|
+
* <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
|
|
4492
4505
|
*/
|
|
4493
4506
|
FlowName: string;
|
|
4494
4507
|
/**
|
|
4495
|
-
*
|
|
4496
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
4497
|
-
示例值:1604912664
|
|
4508
|
+
* <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
|
|
4498
4509
|
*/
|
|
4499
4510
|
Deadline: number;
|
|
4500
4511
|
/**
|
|
4501
|
-
*
|
|
4502
|
-
如果使用模板发起接口,此参数为必填。
|
|
4503
|
-
|
|
4504
|
-
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
|
|
4505
|
-
|
|
4506
|
-
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
|
|
4507
|
-
|
|
4512
|
+
* <p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
|
|
4508
4513
|
*/
|
|
4509
4514
|
TemplateId?: string;
|
|
4510
4515
|
/**
|
|
4511
|
-
*
|
|
4512
|
-
|
|
4513
|
-
注:
|
|
4514
|
-
<font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
|
|
4515
|
-
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
|
|
4516
|
-
|
|
4517
|
-
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
|
|
4518
|
-
|
|
4516
|
+
* <p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
|
|
4519
4517
|
*/
|
|
4520
4518
|
FlowApprovers?: Array<FlowApproverInfo>;
|
|
4521
4519
|
/**
|
|
4522
|
-
*
|
|
4523
|
-
|
|
4524
|
-
注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
|
|
4525
|
-

|
|
4520
|
+
* <p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
|
|
4526
4521
|
*/
|
|
4527
4522
|
FormFields?: Array<FormField>;
|
|
4528
4523
|
/**
|
|
4529
|
-
*
|
|
4524
|
+
* <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
|
|
4530
4525
|
* @deprecated
|
|
4531
4526
|
*/
|
|
4532
4527
|
CallbackUrl?: string;
|
|
4533
4528
|
/**
|
|
4534
|
-
*
|
|
4529
|
+
* <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
|
|
4535
4530
|
*/
|
|
4536
4531
|
FlowType?: string;
|
|
4537
4532
|
/**
|
|
4538
|
-
*
|
|
4533
|
+
* <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
|
|
4539
4534
|
*/
|
|
4540
4535
|
FlowDescription?: string;
|
|
4541
4536
|
/**
|
|
4542
|
-
*
|
|
4543
|
-
|
|
4544
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
|
4537
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
|
|
4545
4538
|
*/
|
|
4546
4539
|
CustomerData?: string;
|
|
4547
4540
|
/**
|
|
4548
|
-
*
|
|
4549
|
-
<ul><li>{合同名称} </li>
|
|
4550
|
-
<li>{发起方企业} </li>
|
|
4551
|
-
<li>{发起方姓名} </li>
|
|
4552
|
-
<li>{签署方N企业}</li>
|
|
4553
|
-
<li>{签署方N姓名}</li></ul>
|
|
4554
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
4555
|
-
|
|
4556
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
4557
|
-
|
|
4558
|
-
合同名称:租房合同
|
|
4559
|
-
发起方:腾讯公司(张三)
|
|
4560
|
-
签署方:李四
|
|
4561
|
-
|
|
4562
|
-

|
|
4563
|
-
|
|
4541
|
+
* <p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
|
|
4564
4542
|
*/
|
|
4565
4543
|
CustomShowMap?: string;
|
|
4566
4544
|
/**
|
|
4567
|
-
*
|
|
4568
|
-
|
|
4569
|
-
<b>注</b>
|
|
4570
|
-
1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
|
|
4571
|
-
2. 请确保抄送人列表中的成员不与任何签署人重复。
|
|
4545
|
+
* <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
|
|
4572
4546
|
*/
|
|
4573
4547
|
CcInfos?: Array<CcInfo>;
|
|
4574
4548
|
/**
|
|
4575
|
-
*
|
|
4576
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
4577
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
4578
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
4579
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
4580
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
4581
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
4549
|
+
* <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
|
|
4582
4550
|
*/
|
|
4583
4551
|
NeedSignReview?: boolean;
|
|
4584
4552
|
/**
|
|
4585
|
-
*
|
|
4586
|
-
<ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
|
|
4587
|
-
<li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
|
4553
|
+
* <p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
|
4588
4554
|
*/
|
|
4589
4555
|
CcNotifyType?: number;
|
|
4590
4556
|
/**
|
|
4591
|
-
*
|
|
4592
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
|
4593
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
4557
|
+
* <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
|
|
4594
4558
|
*/
|
|
4595
4559
|
AutoSignScene?: string;
|
|
4596
4560
|
/**
|
|
4597
|
-
*
|
|
4561
|
+
* <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
|
|
4598
4562
|
*/
|
|
4599
4563
|
FlowDisplayType?: number;
|
|
4564
|
+
/**
|
|
4565
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
|
|
4566
|
+
*/
|
|
4567
|
+
FlowOperateLimit?: FlowOperateLimit;
|
|
4600
4568
|
}
|
|
4601
4569
|
/**
|
|
4602
4570
|
* ChannelCreateDynamicFlowApprover请求参数结构体
|