tencentcloud-sdk-nodejs-ess 4.1.264 → 4.1.266
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
|
@@ -212,22 +212,19 @@ export interface CreateDynamicFlowApproverRequest {
|
|
|
212
212
|
*/
|
|
213
213
|
export interface DisableUserAutoSignRequest {
|
|
214
214
|
/**
|
|
215
|
-
*
|
|
216
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
215
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
217
216
|
*/
|
|
218
217
|
Operator: UserInfo;
|
|
219
218
|
/**
|
|
220
|
-
*
|
|
221
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
219
|
+
* <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
222
220
|
*/
|
|
223
221
|
SceneKey: string;
|
|
224
222
|
/**
|
|
225
|
-
*
|
|
223
|
+
* <p>需要关闭自动签的个人的信息,如姓名,证件信息等。</p>
|
|
226
224
|
*/
|
|
227
225
|
UserInfo: UserThreeFactor;
|
|
228
226
|
/**
|
|
229
|
-
*
|
|
230
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
227
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
231
228
|
*/
|
|
232
229
|
Agent?: Agent;
|
|
233
230
|
}
|
|
@@ -586,27 +583,23 @@ export interface ArchiveFlowApproverInfo {
|
|
|
586
583
|
*/
|
|
587
584
|
export interface DescribeUserAutoSignStatusResponse {
|
|
588
585
|
/**
|
|
589
|
-
*
|
|
586
|
+
* <p>查询用户是否已开通自动签</p>
|
|
590
587
|
*/
|
|
591
588
|
IsOpen?: boolean;
|
|
592
589
|
/**
|
|
593
|
-
*
|
|
594
|
-
|
|
595
|
-
值为unix时间戳,单位为秒。
|
|
590
|
+
* <p>自动签许可生效时间。当且仅当已通过许可开通自动签时有值。</p><p>值为unix时间戳,单位为秒。</p>
|
|
596
591
|
*/
|
|
597
592
|
LicenseFrom?: number;
|
|
598
593
|
/**
|
|
599
|
-
*
|
|
600
|
-
|
|
601
|
-
值为unix时间戳,单位为秒。
|
|
594
|
+
* <p>自动签许可到期时间。当且仅当已通过许可开通自动签时有值。</p><p>值为unix时间戳,单位为秒。</p>
|
|
602
595
|
*/
|
|
603
596
|
LicenseTo?: number;
|
|
604
597
|
/**
|
|
605
|
-
*
|
|
598
|
+
* <p>设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li><strong>0</strong>: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: <code>不可解绑释放更换他人</code></li><li><strong>1</strong>: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul></p>
|
|
606
599
|
*/
|
|
607
600
|
LicenseType?: number;
|
|
608
601
|
/**
|
|
609
|
-
*
|
|
602
|
+
* <p>用户开通自动签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。</p>
|
|
610
603
|
*/
|
|
611
604
|
SealId?: string;
|
|
612
605
|
/**
|
|
@@ -1168,173 +1161,103 @@ export interface CreateBatchInformationExtractionTaskRequest {
|
|
|
1168
1161
|
*/
|
|
1169
1162
|
export interface CreateFlowByFilesRequest {
|
|
1170
1163
|
/**
|
|
1171
|
-
*
|
|
1172
|
-
|
|
1173
|
-
注: 支持填入集团子公司经办人 userId 代发合同。
|
|
1174
|
-
|
|
1164
|
+
* <p>本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
|
|
1175
1165
|
*/
|
|
1176
1166
|
Operator: UserInfo;
|
|
1177
1167
|
/**
|
|
1178
|
-
*
|
|
1179
|
-
|
|
1180
|
-
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
|
1168
|
+
* <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
|
|
1181
1169
|
*/
|
|
1182
1170
|
FlowName: string;
|
|
1183
1171
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
|
|
1186
|
-
注: `目前,此接口仅支持单个文件发起。`
|
|
1172
|
+
* <p>本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。</p><p>注: <code>目前,此接口仅支持单个文件发起。</code></p>
|
|
1187
1173
|
*/
|
|
1188
1174
|
FileIds: Array<string>;
|
|
1189
1175
|
/**
|
|
1190
|
-
*
|
|
1191
|
-
|
|
1192
|
-
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
1176
|
+
* <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。</p>
|
|
1193
1177
|
*/
|
|
1194
1178
|
Approvers?: Array<ApproverInfo>;
|
|
1195
1179
|
/**
|
|
1196
|
-
*
|
|
1180
|
+
* <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
|
|
1197
1181
|
*/
|
|
1198
1182
|
FlowDescription?: string;
|
|
1199
1183
|
/**
|
|
1200
|
-
*
|
|
1201
|
-
如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
|
|
1202
|
-

|
|
1184
|
+
* <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"></p>
|
|
1203
1185
|
*/
|
|
1204
1186
|
FlowType?: string;
|
|
1205
1187
|
/**
|
|
1206
|
-
*
|
|
1207
|
-
<ul><li> 单行文本控件 </li>
|
|
1208
|
-
<li> 多行文本控件 </li>
|
|
1209
|
-
<li> 勾选框控件 </li>
|
|
1210
|
-
<li> 数字控件 </li>
|
|
1211
|
-
<li> 图片控件 </li>
|
|
1212
|
-
<li> 水印控件等 </li>
|
|
1213
|
-
</ul>
|
|
1214
|
-
|
|
1215
|
-

|
|
1188
|
+
* <p>发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)</p><ul><li> 单行文本控件 </li><li> 多行文本控件 </li><li> 勾选框控件 </li><li> 数字控件 </li><li> 图片控件 </li><li> 水印控件等 </li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
|
|
1216
1189
|
*/
|
|
1217
1190
|
Components?: Array<Component>;
|
|
1218
1191
|
/**
|
|
1219
|
-
*
|
|
1220
|
-
|
|
1221
|
-
<b>注</b>
|
|
1222
|
-
1. 抄送人名单中可以包括自然人以及本企业的员工。
|
|
1223
|
-
2. 请确保抄送人列表中的成员不与任何签署人重复。
|
|
1224
|
-
|
|
1192
|
+
* <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
|
|
1225
1193
|
*/
|
|
1226
1194
|
CcInfos?: Array<CcInfo>;
|
|
1227
1195
|
/**
|
|
1228
|
-
*
|
|
1229
|
-
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
1230
|
-
<li> **1**:签署完成后通知</li></ul>
|
|
1196
|
+
* <p>可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:</p><ul><li> **0**:合同发起时通知(默认值)</li><li> **1**:签署完成后通知</li></ul>
|
|
1231
1197
|
*/
|
|
1232
1198
|
CcNotifyType?: number;
|
|
1233
1199
|
/**
|
|
1234
|
-
*
|
|
1235
|
-
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
1236
|
-
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
1200
|
+
* <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
1237
1201
|
*/
|
|
1238
1202
|
NeedPreview?: boolean;
|
|
1239
1203
|
/**
|
|
1240
|
-
*
|
|
1241
|
-
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
|
|
1242
|
-
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
1243
|
-
注: `此参数在NeedPreview 为true时有效`
|
|
1244
|
-
|
|
1204
|
+
* <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
|
|
1245
1205
|
*/
|
|
1246
1206
|
PreviewType?: number;
|
|
1247
1207
|
/**
|
|
1248
|
-
*
|
|
1249
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
1208
|
+
* <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
|
|
1250
1209
|
*/
|
|
1251
1210
|
Deadline?: number;
|
|
1252
1211
|
/**
|
|
1253
|
-
*
|
|
1254
|
-
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
1255
|
-
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
1212
|
+
* <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
1256
1213
|
*/
|
|
1257
1214
|
Unordered?: boolean;
|
|
1258
1215
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
|
|
1261
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
|
1216
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
|
|
1262
1217
|
*/
|
|
1263
1218
|
UserData?: string;
|
|
1264
1219
|
/**
|
|
1265
|
-
*
|
|
1266
|
-
|
|
1267
|
-
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
1220
|
+
* <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
|
|
1268
1221
|
*/
|
|
1269
1222
|
RemindedOn?: number;
|
|
1270
1223
|
/**
|
|
1271
|
-
*
|
|
1224
|
+
* <p>指定个人签署方查看合同的校验方式<ul><li> <strong>VerifyCheck</strong> :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> <strong>MobileCheck</strong> : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul></p>
|
|
1272
1225
|
*/
|
|
1273
1226
|
ApproverVerifyType?: string;
|
|
1274
1227
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
1277
|
-
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
1278
|
-
|
|
1279
|
-
注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5
|
|
1228
|
+
* <p>签署方签署控件(印章/签名等)的生成方式:</p><ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li><li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul><p>注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5</p>
|
|
1280
1229
|
*/
|
|
1281
1230
|
SignBeanTag?: number;
|
|
1282
1231
|
/**
|
|
1283
|
-
*
|
|
1284
|
-
<ul><li>{合同名称} </li>
|
|
1285
|
-
<li>{发起方企业} </li>
|
|
1286
|
-
<li>{发起方姓名} </li>
|
|
1287
|
-
<li>{签署方N企业}</li>
|
|
1288
|
-
<li>{签署方N姓名}</li></ul>
|
|
1289
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
1290
|
-
|
|
1291
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
1292
|
-
|
|
1293
|
-
合同名称:租房合同
|
|
1294
|
-
发起方:腾讯公司(张三)
|
|
1295
|
-
签署方:李四
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-

|
|
1299
|
-
|
|
1300
|
-
|
|
1232
|
+
* <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>
|
|
1301
1233
|
*/
|
|
1302
1234
|
CustomShowMap?: string;
|
|
1303
1235
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1236
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
1306
1237
|
*/
|
|
1307
1238
|
Agent?: Agent;
|
|
1308
1239
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
|
1311
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
1240
|
+
* <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
|
|
1312
1241
|
*/
|
|
1313
1242
|
AutoSignScene?: string;
|
|
1314
1243
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
1317
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
1318
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
1319
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
1320
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
1321
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
1244
|
+
* <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
|
|
1322
1245
|
*/
|
|
1323
1246
|
NeedSignReview?: boolean;
|
|
1324
1247
|
/**
|
|
1325
|
-
*
|
|
1248
|
+
* <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>
|
|
1326
1249
|
*/
|
|
1327
1250
|
FlowDisplayType?: number;
|
|
1328
1251
|
/**
|
|
1329
|
-
*
|
|
1252
|
+
* <p>是否开启动态签署合同:<ul><li> <strong>true</strong>:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> <strong>false</strong>:不开启动态签署合同。</li></ul></p>
|
|
1330
1253
|
*/
|
|
1331
1254
|
OpenDynamicSignFlow?: boolean;
|
|
1332
1255
|
/**
|
|
1333
|
-
*
|
|
1256
|
+
* <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
|
|
1334
1257
|
*/
|
|
1335
1258
|
Workflow?: boolean;
|
|
1336
1259
|
/**
|
|
1337
|
-
*
|
|
1260
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
|
|
1338
1261
|
*/
|
|
1339
1262
|
FlowOperateLimit?: FlowOperateLimit;
|
|
1340
1263
|
}
|
|
@@ -2483,19 +2406,19 @@ export interface FailedCreateRoleData {
|
|
|
2483
2406
|
*/
|
|
2484
2407
|
export interface CreateEmployeeChangeUrlRequest {
|
|
2485
2408
|
/**
|
|
2486
|
-
*
|
|
2409
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
2487
2410
|
*/
|
|
2488
2411
|
Agent?: Agent;
|
|
2489
2412
|
/**
|
|
2490
|
-
*
|
|
2413
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
2491
2414
|
*/
|
|
2492
2415
|
Operator?: UserInfo;
|
|
2493
2416
|
/**
|
|
2494
|
-
*
|
|
2417
|
+
* <p>待修改的员工UserId</p>
|
|
2495
2418
|
*/
|
|
2496
2419
|
UserId?: string;
|
|
2497
2420
|
/**
|
|
2498
|
-
*
|
|
2421
|
+
* <p>待修改的员工手机号</p>
|
|
2499
2422
|
*/
|
|
2500
2423
|
NewMobile?: string;
|
|
2501
2424
|
}
|
|
@@ -2663,32 +2586,33 @@ export interface CreateBatchOrganizationRegistrationTasksRequest {
|
|
|
2663
2586
|
*/
|
|
2664
2587
|
export interface CreateContractComparisonTaskRequest {
|
|
2665
2588
|
/**
|
|
2666
|
-
*
|
|
2667
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2589
|
+
* <p>执行合同审查任务的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
2668
2590
|
*/
|
|
2669
2591
|
Operator: UserInfo;
|
|
2670
2592
|
/**
|
|
2671
|
-
*
|
|
2593
|
+
* <p>原版文件ID,对比基准的旧版本文件唯一标识,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。</p>
|
|
2672
2594
|
*/
|
|
2673
2595
|
OriginFileResourceId: string;
|
|
2674
2596
|
/**
|
|
2675
|
-
*
|
|
2597
|
+
* <p>新版文件ID,与旧版进行对比的新版本文件唯一标识,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。</p>
|
|
2676
2598
|
*/
|
|
2677
2599
|
DiffFileResourceId: string;
|
|
2678
2600
|
/**
|
|
2679
|
-
*
|
|
2601
|
+
* <p>对比任务备注,长度不能超过50个字符。</p>
|
|
2680
2602
|
*/
|
|
2681
2603
|
Comment?: string;
|
|
2682
2604
|
/**
|
|
2683
|
-
*
|
|
2684
|
-
|
|
2685
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
|
2605
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
|
|
2686
2606
|
*/
|
|
2687
2607
|
UserData?: string;
|
|
2688
2608
|
/**
|
|
2689
|
-
*
|
|
2609
|
+
* <p>标签列表,用户自定义的键值对(Key-Value),可绑定到资源上,用于资源的分类、管理和访问控制。</p>
|
|
2690
2610
|
*/
|
|
2691
2611
|
Tags?: Array<Tag>;
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>文档修订操作类型,对比任务执行前处理修订内容,适用于doc、docx存在修订情况。<br> 类型如下: <ul> <li> <strong>0</strong>:不做任何操作</li> <li> <strong>1</strong>:接受所有修订</li> </ul></p>
|
|
2614
|
+
*/
|
|
2615
|
+
RevisionOperation?: number;
|
|
2692
2616
|
}
|
|
2693
2617
|
/**
|
|
2694
2618
|
* DescribeBatchOrganizationRegistrationTasks返回参数结构体
|
|
@@ -3730,11 +3654,11 @@ export interface DescribeContractReviewChecklistsWebUrlRequest {
|
|
|
3730
3654
|
*/
|
|
3731
3655
|
export interface CreateContractComparisonTaskResponse {
|
|
3732
3656
|
/**
|
|
3733
|
-
*
|
|
3657
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度。</p>
|
|
3734
3658
|
*/
|
|
3735
3659
|
UserData?: string;
|
|
3736
3660
|
/**
|
|
3737
|
-
*
|
|
3661
|
+
* <p>合同对比任务ID,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/DescribeContractComparisonTask" target="_blank">查询合同对比任务结果</a>查看对比任务的结果。</p>
|
|
3738
3662
|
*/
|
|
3739
3663
|
TaskId?: string;
|
|
3740
3664
|
/**
|
|
@@ -5448,26 +5372,19 @@ export interface CreatePersonAuthCertificateImageRequest {
|
|
|
5448
5372
|
*/
|
|
5449
5373
|
export interface CreateFlowByFilesResponse {
|
|
5450
5374
|
/**
|
|
5451
|
-
*
|
|
5452
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
5453
|
-
|
|
5454
|
-
注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
|
|
5455
|
-
|
|
5456
|
-
[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
5375
|
+
* <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
|
|
5457
5376
|
*/
|
|
5458
5377
|
FlowId?: string;
|
|
5459
5378
|
/**
|
|
5460
|
-
*
|
|
5461
|
-
|
|
5462
|
-
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
5379
|
+
* <p>合同预览链接URL。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</p>
|
|
5463
5380
|
*/
|
|
5464
5381
|
PreviewUrl?: string;
|
|
5465
5382
|
/**
|
|
5466
|
-
*
|
|
5383
|
+
* <p>签署方信息,如角色ID、角色名称等</p>
|
|
5467
5384
|
*/
|
|
5468
5385
|
Approvers?: Array<ApproverItem>;
|
|
5469
5386
|
/**
|
|
5470
|
-
*
|
|
5387
|
+
* <p>发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回</p>
|
|
5471
5388
|
*/
|
|
5472
5389
|
WorkflowInstanceId?: string;
|
|
5473
5390
|
/**
|
|
@@ -5539,11 +5456,11 @@ export interface DescribeContractReviewChecklistsWebUrlResponse {
|
|
|
5539
5456
|
*/
|
|
5540
5457
|
export interface DescribeBillUsageResponse {
|
|
5541
5458
|
/**
|
|
5542
|
-
*
|
|
5459
|
+
* <p>企业套餐余额及使用情况</p>
|
|
5543
5460
|
*/
|
|
5544
5461
|
Summary?: Array<OrgBillSummary>;
|
|
5545
5462
|
/**
|
|
5546
|
-
*
|
|
5463
|
+
* <p>集团子企业套餐使用情况</p>
|
|
5547
5464
|
*/
|
|
5548
5465
|
SubOrgSummary?: Array<SubOrgBillSummary>;
|
|
5549
5466
|
/**
|
|
@@ -6457,11 +6374,11 @@ export interface Caller {
|
|
|
6457
6374
|
*/
|
|
6458
6375
|
export interface ExportContractComparisonTaskResponse {
|
|
6459
6376
|
/**
|
|
6460
|
-
*
|
|
6377
|
+
* <p>对比任务详情下载链接。</p>
|
|
6461
6378
|
*/
|
|
6462
6379
|
ResourceUrl?: string;
|
|
6463
6380
|
/**
|
|
6464
|
-
*
|
|
6381
|
+
* <p>下载链接有效截止时间。</p>
|
|
6465
6382
|
*/
|
|
6466
6383
|
ExpireTime?: number;
|
|
6467
6384
|
/**
|
|
@@ -6686,13 +6603,7 @@ export interface CreateOrganizationInfoChangeUrlResponse {
|
|
|
6686
6603
|
*/
|
|
6687
6604
|
export interface CreateFlowResponse {
|
|
6688
6605
|
/**
|
|
6689
|
-
*
|
|
6690
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
6691
|
-
|
|
6692
|
-
注:
|
|
6693
|
-
此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
6694
|
-
|
|
6695
|
-
|
|
6606
|
+
* <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注:<br>此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置(只在进入签署环节后有效)</a></p>
|
|
6696
6607
|
*/
|
|
6697
6608
|
FlowId?: string;
|
|
6698
6609
|
/**
|
|
@@ -6915,7 +6826,7 @@ export interface ExtractionField {
|
|
|
6915
6826
|
*/
|
|
6916
6827
|
export interface DescribeUserFlowTypeResponse {
|
|
6917
6828
|
/**
|
|
6918
|
-
*
|
|
6829
|
+
* <p>查询到的所有用户合同类型列表</p>
|
|
6919
6830
|
*/
|
|
6920
6831
|
AllUserFlowTypes?: Array<TemplateUserFlowType>;
|
|
6921
6832
|
/**
|
|
@@ -10498,22 +10409,19 @@ export interface DescribeFlowInfoResponse {
|
|
|
10498
10409
|
*/
|
|
10499
10410
|
export interface DescribeUserAutoSignStatusRequest {
|
|
10500
10411
|
/**
|
|
10501
|
-
*
|
|
10502
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
10412
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
10503
10413
|
*/
|
|
10504
10414
|
Operator: UserInfo;
|
|
10505
10415
|
/**
|
|
10506
|
-
*
|
|
10507
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
10416
|
+
* <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
10508
10417
|
*/
|
|
10509
10418
|
SceneKey: string;
|
|
10510
10419
|
/**
|
|
10511
|
-
*
|
|
10420
|
+
* <p>要查询状态的用户信息, 包括名字,身份证等</p>
|
|
10512
10421
|
*/
|
|
10513
10422
|
UserInfo: UserThreeFactor;
|
|
10514
10423
|
/**
|
|
10515
|
-
*
|
|
10516
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
10424
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
10517
10425
|
*/
|
|
10518
10426
|
Agent?: Agent;
|
|
10519
10427
|
}
|
|
@@ -11165,137 +11073,85 @@ export interface DescribeContractReviewTaskListWebUrlResponse {
|
|
|
11165
11073
|
*/
|
|
11166
11074
|
export interface CreateFlowRequest {
|
|
11167
11075
|
/**
|
|
11168
|
-
*
|
|
11169
|
-
|
|
11170
|
-
注: 支持填入集团子公司经办人 userId 代发合同。
|
|
11076
|
+
* <p>本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
|
|
11171
11077
|
*/
|
|
11172
11078
|
Operator: UserInfo;
|
|
11173
11079
|
/**
|
|
11174
|
-
*
|
|
11175
|
-
|
|
11176
|
-
该名称还将用于合同签署完成后文件下载的默认文件名称。
|
|
11080
|
+
* <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
|
|
11177
11081
|
*/
|
|
11178
11082
|
FlowName: string;
|
|
11179
11083
|
/**
|
|
11180
|
-
*
|
|
11181
|
-
|
|
11182
|
-
注:
|
|
11183
|
-
<font color="red" > <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。
|
|
11184
|
-
例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
|
|
11185
|
-
|
|
11186
|
-
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
|
|
11084
|
+
* <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png">点击查看模板参与人顺序定义位置</a></p>
|
|
11187
11085
|
*/
|
|
11188
11086
|
Approvers: Array<FlowCreateApprover>;
|
|
11189
11087
|
/**
|
|
11190
|
-
*
|
|
11088
|
+
* <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
|
|
11191
11089
|
*/
|
|
11192
11090
|
FlowDescription?: string;
|
|
11193
11091
|
/**
|
|
11194
|
-
*
|
|
11195
|
-
此合同类型需要跟模板配置的合同类型保持一致。
|
|
11092
|
+
* <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>此合同类型需要跟模板配置的合同类型保持一致。</p>
|
|
11196
11093
|
*/
|
|
11197
11094
|
FlowType?: string;
|
|
11198
11095
|
/**
|
|
11199
|
-
*
|
|
11096
|
+
* <p>该字段已不再使用</p>
|
|
11200
11097
|
*/
|
|
11201
11098
|
ClientToken?: string;
|
|
11202
11099
|
/**
|
|
11203
|
-
*
|
|
11204
|
-
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
11100
|
+
* <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
|
|
11205
11101
|
*/
|
|
11206
11102
|
DeadLine?: number;
|
|
11207
11103
|
/**
|
|
11208
|
-
*
|
|
11209
|
-
|
|
11210
|
-
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
11104
|
+
* <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
|
|
11211
11105
|
*/
|
|
11212
11106
|
RemindedOn?: number;
|
|
11213
11107
|
/**
|
|
11214
|
-
*
|
|
11215
|
-
|
|
11216
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
11108
|
+
* <p>调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
|
|
11217
11109
|
*/
|
|
11218
11110
|
UserData?: string;
|
|
11219
11111
|
/**
|
|
11220
|
-
*
|
|
11221
|
-
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
11222
|
-
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
11223
|
-
注:`请和模板中的配置保持一致`
|
|
11112
|
+
* <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>注:<code>请和模板中的配置保持一致</code>
|
|
11224
11113
|
*/
|
|
11225
11114
|
Unordered?: boolean;
|
|
11226
11115
|
/**
|
|
11227
|
-
*
|
|
11228
|
-
<ul><li>{合同名称} </li>
|
|
11229
|
-
<li>{发起方企业} </li>
|
|
11230
|
-
<li>{发起方姓名} </li>
|
|
11231
|
-
<li>{签署方N企业}</li>
|
|
11232
|
-
<li>{签署方N姓名}</li></ul>
|
|
11233
|
-
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
11234
|
-
|
|
11235
|
-
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
11236
|
-
|
|
11237
|
-
合同名称:租房合同
|
|
11238
|
-
发起方:腾讯公司(张三)
|
|
11239
|
-
签署方:李四
|
|
11240
|
-
|
|
11241
|
-

|
|
11242
|
-
|
|
11243
|
-
|
|
11116
|
+
* <p>您可以自定义<strong>腾讯电子签小程序合同列表页</strong>展示的合同内容模板,模板中支持以下变量:</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>
|
|
11244
11117
|
*/
|
|
11245
11118
|
CustomShowMap?: string;
|
|
11246
11119
|
/**
|
|
11247
|
-
*
|
|
11248
|
-
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
11249
|
-
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
11250
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
11251
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
11252
|
-
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
11253
|
-
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
11120
|
+
* <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
|
|
11254
11121
|
*/
|
|
11255
11122
|
NeedSignReview?: boolean;
|
|
11256
11123
|
/**
|
|
11257
|
-
*
|
|
11258
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
11124
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
11259
11125
|
*/
|
|
11260
11126
|
Agent?: Agent;
|
|
11261
11127
|
/**
|
|
11262
|
-
*
|
|
11263
|
-
|
|
11264
|
-
<b>注</b>
|
|
11265
|
-
1. 抄送人名单中可以包括自然人以及本企业的员工。
|
|
11266
|
-
2. 请确保抄送人列表中的成员不与任何签署人重复。
|
|
11128
|
+
* <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
|
|
11267
11129
|
*/
|
|
11268
11130
|
CcInfos?: Array<CcInfo>;
|
|
11269
11131
|
/**
|
|
11270
|
-
*
|
|
11271
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
|
11272
|
-
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
11132
|
+
* <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
|
|
11273
11133
|
*/
|
|
11274
11134
|
AutoSignScene?: string;
|
|
11275
11135
|
/**
|
|
11276
|
-
*
|
|
11136
|
+
* <p>暂未开放</p>
|
|
11277
11137
|
* @deprecated
|
|
11278
11138
|
*/
|
|
11279
11139
|
RelatedFlowId?: string;
|
|
11280
11140
|
/**
|
|
11281
|
-
*
|
|
11141
|
+
* <p>暂未开放</p>
|
|
11282
11142
|
* @deprecated
|
|
11283
11143
|
*/
|
|
11284
11144
|
CallbackUrl?: string;
|
|
11285
11145
|
/**
|
|
11286
|
-
*
|
|
11287
|
-
<ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>
|
|
11288
|
-
|
|
11289
|
-
效果如下:
|
|
11290
|
-

|
|
11146
|
+
* <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
|
|
11291
11147
|
*/
|
|
11292
11148
|
FlowDisplayType?: number;
|
|
11293
11149
|
/**
|
|
11294
|
-
*
|
|
11150
|
+
* <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
|
|
11295
11151
|
*/
|
|
11296
11152
|
Workflow?: boolean;
|
|
11297
11153
|
/**
|
|
11298
|
-
*
|
|
11154
|
+
* <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
|
|
11299
11155
|
*/
|
|
11300
11156
|
FlowOperateLimit?: FlowOperateLimit;
|
|
11301
11157
|
}
|
|
@@ -11835,13 +11691,11 @@ export interface OutputRisk {
|
|
|
11835
11691
|
*/
|
|
11836
11692
|
export interface CreateEmployeeChangeUrlResponse {
|
|
11837
11693
|
/**
|
|
11838
|
-
*
|
|
11694
|
+
* <p>修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a></p>
|
|
11839
11695
|
*/
|
|
11840
11696
|
MiniAppPath?: string;
|
|
11841
11697
|
/**
|
|
11842
|
-
*
|
|
11843
|
-
|
|
11844
|
-
|
|
11698
|
+
* <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
|
|
11845
11699
|
*/
|
|
11846
11700
|
ExpireTime?: number;
|
|
11847
11701
|
/**
|
|
@@ -12071,29 +11925,19 @@ export interface CreateFlowApproversRequest {
|
|
|
12071
11925
|
*/
|
|
12072
11926
|
export interface ExportContractComparisonTaskRequest {
|
|
12073
11927
|
/**
|
|
12074
|
-
*
|
|
12075
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
11928
|
+
* <p>执行合同审查任务的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
12076
11929
|
*/
|
|
12077
11930
|
Operator: UserInfo;
|
|
12078
11931
|
/**
|
|
12079
|
-
*
|
|
11932
|
+
* <p>合同对比任务ID,该参数通过调用接口CreateContractComparisonTask获取。</p>
|
|
12080
11933
|
*/
|
|
12081
11934
|
TaskId: string;
|
|
12082
11935
|
/**
|
|
12083
|
-
*
|
|
12084
|
-
类型如下:
|
|
12085
|
-
<ul>
|
|
12086
|
-
<li> **0**:【PDF】以新合同文件为基础,导出带有可视化对比点标注的PDF文件。</li>
|
|
12087
|
-
<li> **1**:【EXCEL】导出结构化的对比点明细表格,以列表形式罗列每一个差异点,包含改动位置、类型、标签及修改前后的完整内容。</li>
|
|
12088
|
-
</ul>
|
|
11936
|
+
* <p>导出对比结果文件类型。<br>类型如下:</p><ul><li> **0**:【PDF】以新合同文件为基础,导出带有可视化对比点标注的PDF文件。</li><li> **1**:【EXCEL】导出结构化的对比点明细表格,以列表形式罗列每一个差异点,包含改动位置、类型、标签及修改前后的完整内容。</li></ul>
|
|
12089
11937
|
*/
|
|
12090
11938
|
ExportType?: number;
|
|
12091
11939
|
/**
|
|
12092
|
-
*
|
|
12093
|
-
<ul>
|
|
12094
|
-
<li> **true**:导出文件标注去掉忽略项。</li>
|
|
12095
|
-
<li> **false**:导出文件包含所有对比点。</li>
|
|
12096
|
-
</ul>
|
|
11940
|
+
* <p>是否忽略,适用于PDF。</p><ul><li> **true**:导出文件标注去掉忽略项。</li><li> **false**:导出文件包含所有对比点。</li></ul>
|
|
12097
11941
|
*/
|
|
12098
11942
|
Ignore?: boolean;
|
|
12099
11943
|
}
|
|
@@ -13244,19 +13088,19 @@ export interface SubOrgBillSummary {
|
|
|
13244
13088
|
*/
|
|
13245
13089
|
export interface DescribeBillUsageRequest {
|
|
13246
13090
|
/**
|
|
13247
|
-
*
|
|
13091
|
+
* <p>查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于90天</p>
|
|
13248
13092
|
*/
|
|
13249
13093
|
StartTime: string;
|
|
13250
13094
|
/**
|
|
13251
|
-
*
|
|
13095
|
+
* <p>查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于90天</p>
|
|
13252
13096
|
*/
|
|
13253
13097
|
EndTime: string;
|
|
13254
13098
|
/**
|
|
13255
|
-
*
|
|
13099
|
+
* <p>查询的套餐类型 (选填 )不传则查询所有套餐;目前支持:<ul><li><strong>CloudEnterprise</strong>: 企业版合同</li><li><strong>SingleSignature</strong>: 单方签章</li><li><strong>CloudProve</strong>: 签署报告</li><li><strong>CloudOnlineSign</strong>: 腾讯会议在线签约</li><li><strong>ChannelWeCard</strong>: 微工卡</li><li><strong>SignFlow</strong>: 合同套餐</li><li><strong>SignFace</strong>: 签署意愿(人脸识别)</li><li><strong>SignPassword</strong>: 签署意愿(密码)</li><li><strong>SignSMS</strong>: 签署意愿(短信)</li><li><strong>PersonalEssAuth</strong>: 签署人实名(腾讯电子签认证)</li><li><strong>PersonalThirdAuth</strong>: 签署人实名(信任第三方认证)</li><li><strong>OrgEssAuth</strong>: 签署企业实名</li><li><strong>FlowNotify</strong>: 短信通知</li><li><strong>AuthService</strong>: 企业工商信息查询</li></ul></p>
|
|
13256
13100
|
*/
|
|
13257
13101
|
QuotaType?: string;
|
|
13258
13102
|
/**
|
|
13259
|
-
*
|
|
13103
|
+
* <p>是否展示集团子企业的明细,默认否</p>
|
|
13260
13104
|
*/
|
|
13261
13105
|
DisplaySubEnterprise?: boolean;
|
|
13262
13106
|
}
|
|
@@ -13776,22 +13620,19 @@ export interface ReleasedApprover {
|
|
|
13776
13620
|
*/
|
|
13777
13621
|
export interface DescribeUserFlowTypeRequest {
|
|
13778
13622
|
/**
|
|
13779
|
-
*
|
|
13780
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
13623
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
13781
13624
|
*/
|
|
13782
13625
|
Operator: UserInfo;
|
|
13783
13626
|
/**
|
|
13784
|
-
*
|
|
13785
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
13627
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
13786
13628
|
*/
|
|
13787
13629
|
Agent?: Agent;
|
|
13788
13630
|
/**
|
|
13789
|
-
*
|
|
13790
|
-
<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
|
|
13631
|
+
* <p>搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。</p><ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
|
|
13791
13632
|
*/
|
|
13792
13633
|
Filters?: Array<Filter>;
|
|
13793
13634
|
/**
|
|
13794
|
-
*
|
|
13635
|
+
* <p>查询绑定了模板的用户合同类型 <ul> <li>false(默认值),查询用户合同类型</li> <li>true,查询绑定了模板的用户合同类型</li> </ul></p>
|
|
13795
13636
|
*/
|
|
13796
13637
|
QueryBindTemplate?: boolean;
|
|
13797
13638
|
}
|