tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
951 lines (888 loc) • 457 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 企业超管信息 */
declare interface Admin {
/** 超管名 */
Name?: string;
/** 超管手机号，打码显示示例值：138****1569 */
Mobile?: string;
}
/** 企业变更超管信息。 */
declare interface AdminChangeInvitationInfo {
/** 要变更的企业Id。使用接口进行变更，所支持的企业有两种。1. 集团主企业替子企业进行超管变更。 子企业的企业 Id 可在更多-组织管理-集团组织管理处获取。如图位置2. 使用接口[创建企业认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 创建的企业，企业 Id 可以从回调[企业引导企业实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E4%B8%80-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%BC%81%E4%B8%9A%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)得到。 */
ChangeAdminOrganizationId: string;
/** 组织机构要变更的超管姓名。 跟超管变更的操作人保持一致。 */
NewAdminName: string;
/** 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。p.s. 如果上传授权书 ，需遵循以下条件1. 超管的信息（超管姓名，超管手机号）必须为必填参数。 */
AuthFiles: string[];
/** 组织机构要变更的超管手机号。跟超管变更的操作人保持一致。超管变更的手机号和超管变更的证件号，必须要传递一个。 */
NewAdminMobile?: string;
/** 组织机构要变更的超管证件类型支持以下类型- ID_CARD : 中国大陆居民身份证 (默认值)- HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证- HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)跟超管变更的操作人保持一致。 */
NewAdminIdCardType?: string;
/** 组织机构新超管证件号。跟超管变更的操作人保持一致。超管变更的手机号和超管变更的证件号，必须要传递一个。 */
NewAdminIdCardNumber?: string;
}
/** 代理相关应用信息，如集团主企业代子企业操作 */
declare interface Agent {
/** 代理机构的应用编号,32位字符串，一般不用传 */
AppId?: string;
/** 被代理机构的应用号，一般不用传 */
ProxyAppId?: string;
/** 被代理机构在电子签平台的机构编号，集团代理下场景必传 */
ProxyOrganizationId?: string;
/** 被代理机构的经办人，一般不用传 */
ProxyOperator?: string;
}
/** 签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式 */
declare interface ApproverComponentLimitType {
/** 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 */
RecipientId: string;
/** 签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式，可多选签名方式：HANDWRITE-手写签名ESIGN-个人印章类型OCR_ESIGN-AI智能识别手写签名SYSTEM_ESIGN-系统签名 */
Values: string[];
}
/** 合同参与者信息。 */
declare interface ApproverInfo {
/** 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:**0**：企业**1**：个人**3**：企业静默签署注：`类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。`**7**: 个人自动签署，适用于个人自动签场景。注: `个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。` */
ApproverType: number;
/** 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 */
ApproverName?: string;
/** 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此合同签署方。 */
ApproverMobile?: string;
/** 组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。 */
OrganizationName?: string;
/** 【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件 */
SignComponents?: Component[];
/** 签署方经办人的证件类型，支持以下类型，样式可以参考常见个人证件类型介绍ID_CARD 中国大陆居民身份证 (默认值)HONGKONG_AND_MACAO 港澳居民来往内地通行证HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)OTHER_CARD_TYPE 其他证件注: 1. 其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人至少要过一次大陆的海关才能使用。 */
ApproverIdCardType?: string;
/** 签署方经办人的证件号码，应符合以下规则中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 */
ApproverIdCardNumber?: string;
/** 通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知注意：`如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信` */
NotifyType?: string;
/** 收据场景设置签署人角色类型, 可以设置如下类型: **1** :收款人 **2** :开具人 **3** :见证人注: `收据场景为白名单功能，使用前请联系对接的客户经理沟通。` */
ApproverRole?: number;
/** 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的` */
ApproverRoleName?: string;
/** 【已不再使用】签署意愿确认渠道，默认为WEIXINAPP:人脸识别注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置 */
VerifyChannel?: string[];
/** 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：合同页数少于等于2页，阅读时间为3秒；合同页数为3到5页，阅读时间为5秒；合同页数大于等于6页，阅读时间为10秒。 */
PreReadTime?: number;
/** 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖） */
UserId?: string;
/** 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。 */
ApproverSource?: string;
/** 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。所有参与或签的人员均需具备该标识。注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。 */
CustomApproverTag?: string;
/** 可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人等。详细操作可以参考开发者中心的ApproverOption结构体。 */
ApproverOption?: ApproverOption;
/** 【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式此字段可传多个校验方式 */
ApproverVerifyTypes?: number[];
/** 【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式，可传递以下值：**1**：人脸认证，需进行人脸识别成功后才能签署合同；**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）默认为：1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)注：1. 用模板创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在创建合同重新指定无效2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明3. 校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。4. 设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。 */
ApproverSignTypes?: number[];
/** 此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下：**false**：（默认）不需要审批，直接签署。**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同` */
ApproverNeedSignReview?: boolean;
/** 【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。` */
AddSignComponentsLimits?: ComponentLimit[];
/** 签署须知：支持传入富文本，最长字数：500个中文字符 */
SignInstructionContent?: string;
/** 签署人的签署截止时间，格式为Unix标准时间戳（秒）注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同` */
Deadline?: number;
/** 【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件)注：`此参数仅在通过文件发起合同或者合同组时生效` */
Components?: Component[];
/** 进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。 */
SignEndpoints?: string[];
/** 快速注册相关信息 */
RegisterInfo?: RegisterInfo;
/** 是否不保存联系人默认 false 保存联系人 true 不保存联系人设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。如下图位置： */
NotSaveContact?: boolean;
}
/** 签署方信息，发起合同后可获取到对应的签署方信息，如角色ID，角色名称 */
declare interface ApproverItem {
/** 签署方唯一编号 */
SignId?: string;
/** 签署方角色编号 */
RecipientId?: string;
/** 签署方角色名称 */
ApproverRoleName?: string;
}
/** 签署人个性化能力信息 */
declare interface ApproverOption {
/** 签署方是否可以拒签 **false** : ( 默认)可以拒签 **true** :不可以拒签 */
NoRefuse?: boolean;
/** 签署方是否可以转他人处理 **false** : ( 默认)可以转他人处理 **true** :不可以转他人处理 */
NoTransfer?: boolean;
/** 允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑 */
CanEditApprover?: boolean;
/** 签署人信息补充类型，默认无需补充。 **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`注：1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关`2. 此参数在嵌入式场景下无效。 */
FillType?: number;
/** 签署人阅读合同限制参数 取值： LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底 LimitReadTime，阅读合同仅限制阅读时长 LimitBottom，阅读合同仅限制必须阅读到底 NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用） */
FlowReadLimit?: string;
/** 禁止在签署过程中添加签署日期控件 前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）： 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件 */
ForbidAddSignDate?: boolean;
}
/** 指定签署人限制项 */
declare interface ApproverRestriction {
/** 指定签署人名字 */
Name?: string;
/** 指定签署人手机号，11位数字 */
Mobile?: string;
/** 指定签署人证件类型，ID_CARD-身份证 */
IdCardType?: string;
/** 指定签署人证件号码，字母大写 */
IdCardNumber?: string;
}
/** 动态签署2.0合同参与人信息 */
declare interface ArchiveDynamicApproverData {
/** 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。 */
SignId?: string;
/** 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。填写控件和签署控件都与特定的角色编号关联。 */
RecipientId?: string;
}
/** 企业扩展服务授权列表详情 */
declare interface AuthInfoDetail {
/** 扩展服务类型，和入参一致 */
Type?: string;
/** 扩展服务名称 */
Name?: string;
/** 授权员工列表 */
HasAuthUserList?: HasAuthUser[];
/** 授权企业列表（企业自动签时，该字段有值） */
HasAuthOrganizationList?: HasAuthOrganization[];
/** 授权员工列表总数 */
AuthUserTotal?: number;
/** 授权企业列表总数 */
AuthOrganizationTotal?: number;
}
/** 企业认证信息 */
declare interface AuthRecord {
/** 经办人姓名。 */
OperatorName?: string;
/** 经办人手机号。 */
OperatorMobile?: string;
/** 认证授权方式： **0**：未选择授权方式（默认值） **1**：上传授权书 **2**：法人授权 **3**：法人认证 */
AuthType?: number;
/** 企业认证授权书审核状态： **0**：未提交授权书（默认值） **1**：审核通过 **2**：审核驳回 **3**：审核中 **4**：AI识别中 **5**：客户确认AI信息 */
AuditStatus?: number;
}
/** 授权用户 */
declare interface AuthorizedUser {
/** 电子签系统中的用户id */
UserId?: string;
}
/** 自动签开启、签署相关配置 */
declare interface AutoSignConfig {
/** 自动签开通个人用户信息, 包括名字,身份证等 */
UserInfo: UserThreeFactor;
/** 是否回调证书信息:**false**: 不需要(默认)**true**:需要注：`该字段已经失效，请勿设置此参数。` */
CertInfoCallback?: boolean;
/** 是否支持用户自定义签名印章:**false**: 不能自己定义(默认)**true**: 可以自己定义 */
UserDefineSeal?: boolean;
/** 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:**false**: 不需要(默认)**true**: 需要 */
SealImgCallback?: boolean;
/** 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。回调的相关说明可参考开发者中心的回调通知模块。 */
CallbackUrl?: string;
/** 开通时候的身份验证方式, 取值为：**WEIXINAPP** : 微信人脸识别**INSIGHT** : 慧眼人脸识别**TELECOM** : 运营商三要素验证注：如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT */
VerifyChannels?: string[];
/** 设置用户自动签合同的扣费方式。1: (默认)使用合同份额进行扣减注：`该字段已经失效，请勿设置此参数。` */
LicenseType?: number;
/** 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`跳转场景：**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：Android，IOS 成功结果返回：若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess */
JumpUrl?: string;
}
/** 批量认证企业任务详情信息，其中包括 TaskId，状态信息等。 */
declare interface BatchOrganizationRegistrationTasksDetails {
/** 生成注册链接的任务Id */
TaskId?: string;
/** 批量创建企业任务的状态ProcessingCreateSubmitAuthorizationFailed各个状态所代表的含义如下表格所示：任务状态名称任务状态详情Processing企业认证任务处理中，用户调用了CreateBatchOrganizationRegistrationTasks接口，但是任务还在处理中的状态Create创建企业认证链接任务完成，可以调用生成任务链接接口Submit企业认证任务已提交,到如下界面之后，会变为这个状态Authorization企业认证任务认证成功,点击下图下一步，进入到授权书上传或者法人认证，则会变为这个状态Failed企业认证任务失败 */
Status?: string;
/** 如果任务失败,会返回错误信息 */
ErrorMessage?: string;
}
/** 用户计费使用情况详情 */
declare interface BillUsageDetail {
/** 合同流程ID，为32位字符串。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 */
FlowId?: string;
/** 合同经办人名称如果有多个经办人用分号隔开。 */
OperatorName?: string;
/** 发起方组织机构名称 */
CreateOrganizationName?: string;
/** 合同流程的名称。 */
FlowName?: string;
/** 当前合同状态,如下是状态码对应的状态。**0**: 还没有发起**1**: 等待签署**2**: 部分签署 **3**: 拒签**4**: 已签署 **5**: 已过期 **6**: 已撤销 **7**: 还没有预发起**8**: 等待填写**9**: 部分填写 **10**: 拒签**11**: 已解除 */
Status?: number;
/** 查询的套餐类型对应关系如下:**CloudEnterprise**: 企业版合同**SingleSignature**: 单方签章**CloudProve**: 签署报告**CloudOnlineSign**: 腾讯会议在线签约**ChannelWeCard**: 微工卡**SignFlow**: 合同套餐**SignFace**: 签署意愿（人脸识别）**SignPassword**: 签署意愿（密码）**SignSMS**: 签署意愿（短信）**PersonalEssAuth**: 签署人实名（腾讯电子签认证）**PersonalThirdAuth**: 签署人实名（信任第三方认证）**OrgEssAuth**: 签署企业实名**FlowNotify**: 短信通知**AuthService**: 企业工商信息查询 */
QuotaType?: string;
/** 合同使用量注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量` */
UseCount?: number;
/** 消耗的时间戳，格式为Unix标准时间戳（秒）。 */
CostTime?: number;
/** 消耗的套餐名称 */
QuotaName?: string;
/** 消耗类型**1**.扣费**2**.撤销返还 */
CostType?: number;
/** 备注 */
Remark?: string;
}
/** 企业应用回调信息 */
declare interface CallbackInfo {
/** 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。 */
CallbackUrl: string;
/** 回调加密key，已废弃 */
Token?: string;
/** 回调加密key，用于回调消息加解密。 */
CallbackKey?: string;
/** 回调验签token，用于回调通知校验。 */
CallbackToken?: string;
}
/** 此结构体 (Caller) 用于描述调用方属性。 */
declare interface Caller {
/** 应用号 */
ApplicationId?: string;
/** 主机构ID */
OrganizationId?: string;
/** 经办人的用户ID，同UserId */
OperatorId?: string;
/** 下属机构ID */
SubOrganizationId?: string;
}
/** 撤销失败的流程信息 */
declare interface CancelFailureFlow {
/** 合同流程ID，为32位字符串。 */
FlowId?: string;
/** 撤销失败原因 */
Reason?: string;
}
/** 抄送信息 */
declare interface CcInfo {
/** 被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。 */
Mobile?: string;
/** 被抄送方姓名。抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。 */
Name?: string;
/** 被抄送方类型, 可设置以下类型: **0** :个人抄送方 **1** :企业员工抄送方 */
CcType?: number;
/** 被抄送方权限, 可设置如下权限: **0** :可查看合同内容 **1** :可查看合同内容也可下载原文 */
CcPermission?: number;
/** 通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知 */
NotifyType?: string;
}
/** 合同对比差异结果详情。 */
declare interface ComparisonDetail {
/** 合同对比差异点唯一ID。 */
ComparisonPointId?: string;
/** 对比前后差异类型，具体如下： **add**：新增 **change**：变更 **delete**：删除 */
ComparisonType?: string;
/** 对比内容类型，具体如下： **text**：文本 **table**：表格 **picture**：图片 */
ContentType?: string;
/** 原文文本。 */
OriginText?: string;
/** 对比文本。 */
DiffText?: string;
}
/** 此结构体 (Component) 用于描述控件属性。在通过文件发起合同时，对应的component有三种定位方式1. 绝对定位方式 （可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标）2. 表单域(FIELD)定位方式3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找 */
declare interface Component {
/** **如果是Component填写控件类型，则可选的字段为**： TEXT : 普通文本控件，输入文本字符串； MULTI_LINE_TEXT : 多行文本控件，输入文本字符串； CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE : 动态表格控件； ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔； SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容； DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串； WATERMARK : 水印控件；只能分配给发起方，必须设置ComponentExtra； DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；**如果是SignComponent签署控件类型，需要根据签署人的类型可选的字段为*** 企业方 SIGN_SEAL : 签署印章控件； SIGN_DATE : 签署日期控件； SIGN_SIGNATURE : 用户签名控件； SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认； SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容 SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言 SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择 SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。* 个人方 SIGN_DATE : 签署日期控件； SIGN_SIGNATURE : 用户签名控件； SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件； SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容 SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言 SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择 SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认； 注：` 表单域的控件不能作为印章和签名控件` */
ComponentType: string;
/** **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。 */
ComponentHeight: number;
/** **在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。 */
ComponentWidth: number;
/** **在绝对定位方式方式下**，指定控件所在PDF文件上的页码**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。注：1. 页码编号是从1开始编号的。2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。 */
ComponentPage: number;
/** **在绝对定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。 */
ComponentPosX: number;
/** **在绝对定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。 */
ComponentPosY: number;
/** 【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0 */
FileIndex: number;
/** 控件生成的方式： NORMAL : 绝对定位控件 FIELD : 表单域 KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找） */
GenerateMode?: string;
/** 控件唯一ID。**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。例：- 如传入的关键字"^甲方签署^"</font >，则会在PDF文件中有且仅有"甲方签署"关键字的地方（前后不能有其他字符</font >）进行对应操作。- 如传入的关键字为"甲方签署</font >"，则PDF文件中每个出现关键字的位置（前后可以有其他字符</font >）都会执行相应操作。注：`控件ID可以在一个PDF中不可重复`点击查看ComponentId在模板编辑页面的位置 */
ComponentId?: string;
/** **在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。注：`控件名可以在一个PDF中可以重复`点击查看ComponentName在模板页面的位置 */
ComponentName?: string;
/** 如果是填写控件，ComponentRequired表示在填写页面此控件是否必填false（默认）：可以不填写true ：必须填写此填写控件如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响 */
ComponentRequired?: boolean;
/** **在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可** */
ComponentRecipientId?: string;
/** **在所有的定位方式下**，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 FontAlign： Left/Right/Center，左对齐/居中/右对齐 FontColor：字符串类型，格式为RGB颜色数字 Bold是否加粗：true/false参数样例：`{"FontColor":"255,0,0","FontSize":12,"Bold":false}`ComponentType为DATE时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72参数样例：`{"FontColor":"255,0,0","FontSize":12}`ComponentType为WATERMARK时，支持以下参数： Font：目前只支持黑体、宋体、仿宋 FontSize： 范围6 :72 Opacity： 透明度，范围0 :1 Rotate： 水印旋转角度，范围0 :359 Density： 水印样式，1-宽松，2-标准（默认值），3-密集， Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中 SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息参数样例：`"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"`ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中 FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放ComponentType为SELECTOR时，支持以下参数： WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以通过**ComponentTypeLimit**参数控制签名方式 HANDWRITE : 需要实时手写的手写签名 HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE) OCR_ESIGN : AI智能识别手写签名 ESIGN : 个人印章类型 SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署） IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)参考样例：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`印章的对应关系参考下图ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他参考样例：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。ComponentType为SIGN_DATE时，支持以下参数： Font :字符串类型目前只支持"黑体"、"宋体"、"仿宋"，如果不填默认为"黑体" FontSize : 数字类型，范围6-72，默认值为12 FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数： PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例：` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度： Opacity：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度参数样例：`{"Opacity":0.7}`签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小： UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false参数样例：`{"UseSealSize":true}`签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容： Values：签署意见预设的需要用户填写的文本 ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）参数样例：`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`关键字模式下支持关键字找不到的情况下不进行报错的设置 IgnoreKeywordError :1-关键字查找不到时不进行报错场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例：` "{"IgnoreKeywordError":1}"`ComponentType为SIGN_VIRTUAL_COMBINATION时，支持以下参数：Children: 绝对定位模式下，用来指定此签批控件的组合子控件 参数样例：`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件 ChildrenComponent结构体定义: 字段名称 类型 描述 ComponentType string 子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT ComponentName string 子控件名称 Placeholder string 子控件提示语 ComponentOffsetX float 控件偏移位置X（相对于父控件（签批控件的ComponentX）） ComponentOffsetY float 控件偏移位置Y 相对于父控件（签批控件的ComponentY）） ComponentWidth float 控件宽 ComponentHeight float 控件高 ComponentExtra string 控件的附属信息，根据ComponentType设置 参数样例： 输入:{ ChildrenComponents: [ { ComponentType: SIGN_SIGNATURE, ComponentName: 个人签名, Placeholder: 请签名, ComponentOffsetX: 10, ComponentOffsetY: 30, ComponentWidth: 119, ComponentHeight: 43, ComponentExtra: {\ComponentTypeLimit\:[\SYSTEM_ESIGN\]} }, { ComponentType: SIGN_SELECTOR, ComponentName: 是否同意此协议, Placeholder: , ComponentOffsetX: 50, ComponentOffsetY: 130, ComponentWidth: 120, ComponentHeight: 43, ComponentExtra: {\Values\:[\同意\,\不同意\,\再想想\],\FontSize\:12,\FontAlign\:\Left\,\Font\:\黑体\,\MultiSelect\:false} }, { ComponentType: SIGN_MULTI_LINE_TEXT, ComponentName: 批注附言, Placeholder: , ComponentOffsetX: 150, ComponentOffsetY: 300, ComponentWidth: 200, ComponentHeight: 86, ComponentExtra: } ]} */
ComponentExtra?: string;
/** **在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可** */
IsFormType?: boolean;
/** 控件填充vaule，ComponentType和传入值类型对应关系： TEXT : 文本内容 MULTI_LINE_TEXT : 文本内容，可以用 \n 来控制换行位置 CHECK_BOX : true/false FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR : 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table) DATE : 格式化为：xxxx年xx月xx日（例如2024年05年28日） SIGN_SEAL : 印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png) SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)控件值约束说明： 特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 中国大陆手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串 水印控件 水印控件设置为CUSTOM_WATERMARK类型时的水印内容 注： `部分特殊控件需要在控制台配置模板形式创建` */
ComponentValue?: string;
/** **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。注意： `向左调整设置为负数， 向右调整设置成正数` */
OffsetX?: number;
/** **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。注意： `向上调整设置为负数， 向下调整设置成正数` */
OffsetY?: number;
/** **如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。 Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列 Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。 */
KeywordOrder?: string;
/** **如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。 */
KeywordPage?: number;
/** **如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值 Middle :居中 Below :正下方 Right :正右方 LowerRight :右下角 UpperRight :右上角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方 */
RelativeLocation?: string;
/** **如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。注意：关键字索引是从0开始计数的 */
KeywordIndexes?: number[];
/** **web嵌入发起合同场景下**， 是否锁定填写和签署控件值不允许嵌入页面进行编辑false（默认）：不锁定控件值，允许在页面编辑控件值true：锁定控件值，在页面无法编辑控件值 */
LockComponentValue?: boolean;
/** **web嵌入发起合同场景下**，是否禁止移动和删除填写和签署控件 false（默认） :可以移动和删除控件 true : 禁止移动和删除控件 */
ForbidMoveAndDelete?: boolean;
/** 【暂未使用】日期签署控件的字号，默认为 12 */
ComponentDateFontSize?: number;
/** 【暂未使用】第三方应用集成平台模板控件 ID 标识 */
ChannelComponentId?: string;
/** 【暂未使用】第三方应用集成中子客企业控件来源。 0 :平台指定； 1 :用户自定义 */
ChannelComponentSource?: number;
}
/** 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。 */
declare interface ComponentLimit {
/** 控件类型，支持以下类型SIGN_SEAL : 印章控件SIGN_PAGING_SEAL : 骑缝章控件SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件SIGN_SIGNATURE : 用户签名控件 */
ComponentType: string;
/** 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型 OFFICIAL : 企业公章 CONTRACT : 合同专用章 FINANCE : 财务专用章 PERSONNEL : 人事专用章 OTHER : 其他**注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`**2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）HANDWRITE : 需要实时手写的手写签名HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)OCR_ESIGN : OCR印章（智慧手写签名）ESIGN : 个人印章SYSTEM_ESIGN : 系统印章3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。 */
ComponentValue?: string[];
}
/** 合同审查个性化参数，用于控制页面的展示内容 */
declare interface ContractReviewWebUrlOption {
/** 禁用暂存。 默认 false，设置为 true 会隐藏界面上的临时保存按钮 */
DisableTemporaryStore?: boolean;
/** 禁用导出。默认 false，设置为 true 会隐藏界面上的导出按钮 */
DisableExport?: boolean;
/** 禁用重新审查。默认 false，设置为 true 会隐藏界面上的重新审查按钮 */
DisableReviewAgain?: boolean;
/** 禁用二维码分享。默认 false，设置为 true 会隐藏界面上的分享二维码 */
DisableWxQrcode?: boolean;
}
/** 合同摘要 */
declare interface ContractSummary {
/** 提取内容分类：Base 合同信息Identity 主体信息Performance 履约条款 */
Name?: string;
/** 详细信息 */
Infos?: ContractSummaryInfo[];
}
/** 合同摘要信息 */
declare interface ContractSummaryInfo {
/** 字段 key */
Key?: string;
/** 字段值 */
Value?: string;
/** 主体信息 */
Identity?: Identity | null;
}
/** 创建合同个性化参数 */
declare interface CreateFlowOption {
/** 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。true：允许编辑false：不允许编辑（默认值） */
CanEditFlow?: boolean;
/** 是否允许编辑模板控件true:允许编辑模板控件信息false:不允许编辑模板控件信息（默认值） */
CanEditFormField?: boolean;
/** 发起页面隐藏合同名称展示true:发起页面隐藏合同名称展示false:发起页面不隐藏合同名称展示（默认值） */
HideShowFlowName?: boolean;
/** 发起页面隐藏合同类型展示true:发起页面隐藏合同类型展示false:发起页面不隐藏合同类型展示（默认值） */
HideShowFlowType?: boolean;
/** 发起页面隐藏合同截止日期展示true:发起页面隐藏合同截止日期展示false:发起页面不隐藏合同截止日期展示（默认值） */
HideShowDeadline?: boolean;
/** 发起页面允许跳过添加签署人环节true:发起页面允许跳过添加签署人环节false:发起页面不允许跳过添加签署人环节（默认值） */
CanSkipAddApprover?: boolean;
/** 文件发起页面跳过文件上传步骤true:文件发起页面跳过文件上传步骤false:文件发起页面不跳过文件上传步骤（默认值） */
SkipUploadFile?: boolean;
/** 禁止编辑填写控件true:禁止编辑填写控件false:允许编辑填写控件（默认值） */
ForbidEditFillComponent?: boolean;
/** 定制化发起合同弹窗的描述信息，描述信息最长500字符 */
CustomCreateFlowDescription?: string;
/** 禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮” */
ForbidAddApprover?: boolean;
/** 是否可以编辑签署人包括新增，修改，删除 （默认） false -可以编辑签署人 true - 禁止编辑签署人注意：如果设置参数为 true， 则 参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空 */
ForbidEditApprover?: boolean;
/** 禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板 */
ForbidEditFlowProperties?: boolean;
/** 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用（注: 空数组代表未指定），具体的控件类型如下SIGN_SIGNATURE : 个人签名/印章SIGN_SEAL : 企业印章SIGN_PAGING_SEAL : 骑缝章SIGN_LEGAL_PERSON_SEAL : 法定代表人章SIGN_APPROVE : 签批SIGN_OPINION : 签署意见SIGN_PAGING_SIGNATURE : 手写签名骑缝控件BUSI-FULL-NAME : 企业全称BUSI-CREDIT-CODE : 统一社会信用代码BUSI-LEGAL-NAME : 法人/经营者姓名PERSONAL-NAME : 签署人姓名PERSONAL-MOBILE : 签署人手机号PERSONAL-IDCARD-TYPE : 签署人证件类型PERSONAL-IDCARD : 签署人证件号TEXT : 单行文本MULTI_LINE_TEXT : 多行文本CHECK_BOX : 勾选框SELECTOR : 选择器DIGIT : 数字DATE : 日期FILL_IMAGE : 图片ATTACHMENT : 附件EMAIL : 邮箱LOCATION : 地址EDUCATION : 学历GENDER : 性别DISTRICT : 省市区 */
HideComponentTypes?: string[];
/** 在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用（注: 空数组代表未指定），具体的控件类型如下SIGN_SIGNATURE : 个人签名/印章SIGN_SEAL : 企业印章SIGN_PAGING_SEAL : 骑缝章SIGN_LEGAL_PERSON_SEAL : 法定代表人章SIGN_APPROVE : 签批SIGN_OPINION : 签署意见SIGN_PAGING_SIGNATURE : 手写签名骑缝控件BUSI-FULL-NAME : 企业全称BUSI-CREDIT-CODE : 统一社会信用代码BUSI-LEGAL-NAME : 法人/经营者姓名PERSONAL-NAME : 签署人姓名PERSONAL-MOBILE : 签署人手机号PERSONAL-IDCARD-TYPE : 签署人证件类型PERSONAL-IDCARD : 签署人证件号TEXT : 单行文本MULTI_LINE_TEXT : 多行文本CHECK_BOX : 勾选框SELECTOR : 选择器DIGIT : 数字DATE : 日期FILL_IMAGE : 图片ATTACHMENT : 附件EMAIL : 邮箱LOCATION : 地址EDUCATION : 学历GENDER : 性别DISTRICT : 省市区 */
ShowComponentTypes?: string[];
/** 发起流程的可嵌入页面结果页配置 */
ResultPageConfig?: CreateResultPageConfig[];
/** 签署控件的配置信息，用在嵌入式发起的页面配置，包括 - 签署控件 是否默认展示日期. */
SignComponentConfig?: SignComponentConfig;
/** 是否禁止编辑（展示）水印控件属性（默认） false -否 true - 禁止编辑 */
ForbidEditWatermark?: boolean;
/** 隐藏操作指引: 具体的控件类型如下1 : 操作指引入口2 : 操作文档3 : 操作视频注：仅对新版页面生效 */
HideOperationInstructions?: number[];
/** 隐藏操作步骤: 具体的控件类型如下1 : 选择文件及签署方2 : 补充文件内容4 : 发起前合同信息与设置确认注：仅对新版页面生效 */
HideOperationSteps?: number[];
/** 本企业简称，注：仅对新版页面生效 */
SelfName?: string;
/** 发起后签署码隐藏，默认false，注：仅对新版页面生效 */
HideSignCodeAfterStart?: boolean;
/** 发起成功后是否预览合同 （默认） false -否 true - 展示预览按钮 */
PreviewAfterStart?: boolean;
/** 发起成功之后是否签署合同，仅当前经办人作为签署人时生效 （默认） false -否 true - 展示签署按钮 */
SignAfterStart?: boolean;
/** 发起过程中是否保存草稿 */
NeedFlowDraft?: boolean;
}
/** 发起流程的可嵌入页面操作结果页配置 */
declare interface CreateResultPageConfig {
/** 0 : 发起审批成功页面（通过接口创建发起流程web页面发起时设置了NeedCreateReview参数为true） */
Type: number;
/** 结果页标题，不超过50字 */
Title: string;
/** 结果页描述，不超过200字 */
Description?: string;
}
/** 创建员工的结果 */
declare interface CreateStaffResult {
/** 创建员工的成功列表 */
SuccessEmployeeData?: SuccessCreateStaffData[];
/** 创建员工的失败列表 */
FailedEmployeeData?: FailedCreateStaffData[];
}
/** 清理的企业认证流信息 */
declare interface DeleteOrganizationAuthorizationInfo {
/** 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。 */
AuthorizationId?: string;
/** 认证的企业名称 */
OrganizationName?: string;
/** 清除认证流产生的错误信息 */
Errormessage?: string;
}
/** 删除员工结果 */
declare interface DeleteStaffsResult {
/** 删除员工的成功数据 */
SuccessEmployeeData?: SuccessDeleteStaffData[];
/** 删除员工的失败数据 */
FailedEmployeeData?: FailedDeleteStaffData[];
}
/** 集成版员工部门信息。 */
declare interface Department {
/** 部门ID。 */
DepartmentId?: string;
/** 部门名称。 */
DepartmentName?: string;
}
/** 视频认证结果 */
declare interface DetectInfoVideoData {
/** 活体视频的base64编码，mp4格式注:`需进行base64解码获取活体视频文件` */
LiveNessVideo?: string;
}
/** 动态添加签署人的结果信息 */
declare interface DynamicFlowApproverResult {
/** 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。填写控件和签署控件都与特定的角色编号关联。在进行新增签署方操作时，建议记录下该签署方的角色编号。后续可以拉取流程信息，用来判断该签署方的当前状态。 */
RecipientId?: string;
/** 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。 */
SignId?: string;
/** 签署方当前状态，会出现下面的状态2：待签署3：已签署4：已拒绝5：已过期6：已撤销8：待填写9：因为各种原因（签署人改名等）而终止10：填写完成15：已解除19：转他人处理 */
ApproverStatus?: number;
}
/** 动态签署领取链接配置，当全部签署方均为动态签署方时生效。 */
declare interface DynamicSignOption {
/** 多份合同批量签署时，动态签署领取要求：0（默认值）: 可以领取部分合同进入签署。1 : 必须全部领取进入签署，生成链接的所有合同必须相同经办人完成合同的领取签署。 */
DynamicReceiveType?: number;
/** 动态签署方时，预设的企业名称，预设企业名称后，只允许对应的企业员工进行领取签署。 */
OrganizationName?: string;
}
/** 个性化参数 */
declare interface EmbedUrlOption {
/** 合同详情预览，允许展示控件信息true：允许在合同详情页展示控件false：（默认）不允许在合同详情页展示控件 */
ShowFlowDetailComponent?: boolean;
/** 模板预览，允许展示模板控件信息 true :允许在模板预览页展示控件 false :（默认）不允许在模板预览页展示控件 */
ShowTemplateComponent?: boolean;
/** 跳过上传文件，默认为false(展示上传文件页)- false: 展示上传文件页- true: 不展示上传文件页 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**， */
SkipUploadFile?: boolean;
/** 隐藏下载文件按钮，默认为false(展示下载文件按钮)- false: 展示下载文件按钮- true: 不展示下载文件按钮 注意: 此参数仅针对**EmbedType=PREVIEW_FLOW_DETAIL(查看合同详情)**有效 */
SkipDownloadFile?: boolean;
/** 是否禁止编辑（展示）水印控件属性（默认） false -否 true - 禁止编辑 */
ForbidEditWatermark?: boolean;
/** 印章描述 */
SealDescription?: string;
/** 是否禁止编辑印章描述内容（默认） false -否 true - 禁止编辑 */
ForbidEditSealDescription?: boolean;
}
/** 扩展服务开通和授权的详细信息 */
declare interface ExtendAuthInfo {
/** 扩展服务的类型，可能是以下值：OPEN_SERVER_SIGN：企业自动签署BATCH_SIGN：批量签署OVERSEA_SIGN：企业与港澳台居民签署合同AGE_LIMIT_EXPANSION：拓宽签署方年龄限制MOBILE_CHECK_APPROVER：个人签署方仅校验手机号HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方HIDE_ONE_KEY_SIGN：个人签署方手动签字PAGING_SEAL：骑缝章ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导 */
Type?: string;
/** 扩展服务的名称 */
Name?: string;
/** 扩展服务的开通状态：ENABLE : 已开通DISABLE : 未开通 */
Status?: string;
/** 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。 */
OperatorUserId?: string;
/** 扩展服务的操作时间，格式为Unix标准时间戳（秒）。 */
OperateOn?: number;
/** 该扩展服务若可以授权，此参数对应授权人员的列表 */
HasAuthUserList?: HasAuthUser[];
}
/** 印章扩展信息 */
declare interface ExtendScene {
/** 印章来源类型 */
GenerateType?: string;
/** 印章来源类型描述 */
GenerateTypeDesc?: string;
/** 印章来源logo */
GenerateTypeLogo?: string;
}
/** 合同智能提取字段信息 */
declare interface ExtractionField {
/** 用于合同智能提取的字段名称。注意: `长度不能超过30个字符` */
Name: string;
/** 指定合同智能提取的字段类型，目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。类型支持如下：1、TEXT（文本）2、DATE（日期）3、NUMBER（数字）4、OPTION（选项值） */
Type: string;
/** 用于描述字段信息。注意：1、描述字段不能超过100个字符 */
Description?: string;
/** 提取出合同中的字段信息。 */
Values?: string[];
/** 当字段类型`Type`为OPTION时为必输项，输入选项值 */
ChoiceList?: string[];
}
/** 合同信息提取字段值信息。 */
declare interface ExtractionFieldResult {
/** 字段ID */
Id?: string;
/** 用于合同智能提取的字段名称。 */
Name?: string;
/** 合同智能提取的字段类型，目前仅支持TEXT、DATE、NUMBER、OPTION类型。类型支持如下： 1、TEXT（文本） 2、DATE（日期） 3、NUMBER（数字） 4、OPTION（选项值） */
Type?: string;
/** 提取出合同中的字段信息。 */
Values?: string[];
/** 是否需要语义提取，默认为false */
RequiresSemanticExtraction?: boolean;
/** 提取出值在合同中的坐标位置信息 */
Positions?: PositionInfo[];
}
/** 合同信息提取结果 */
declare interface ExtractionTaskResult {
/** 用于合同信息提取的资源ID。 */
ResourceId?: string;
/** 用于合同信息提取的资源名称。 */
ResourceName?: string;
/** 根据当前合同提取出的字段信息 */
ExtractionFieldResults?: ExtractionFieldResult[];
}
/** 绑定角色失败信息 */
declare interface FailedCreateRoleData {
/** 用户userId */
UserId?: string;
/** 角色id列表 */
RoleIds?: string[];
}
/** 创建员工的失败数据 */
declare interface FailedCreateStaffData {
/** 员工名 */
DisplayName?: string;
/** 员工手机号 */
Mobile?: string;
/** 传入的企微账号id */
WeworkOpenId?: string;
/** 失败原因 */
Reason?: string;
}
/** 删除员工失败数据 */
declare interface FailedDeleteStaffData {
/** 员工在电子签的userId */
UserId?: string;
/** 员工在第三方平台的openId */
OpenId?: string;
/** 失败原因 */
Reason?: string;
}
/** 更新员工信息失败返回的数据信息 */
declare interface FailedUpdateStaffData {
/** 用户传入的名称 */
DisplayName?: string;
/** 用户传入的手机号，明文展示 */
Mobile?: string;
/** 失败原因 */
Reason?: string;
/** 员工在腾讯电子签平台的唯一身份标识，为32位字符串。可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。 */
UserId?: string;
/** 员工在第三方平台的openId */
OpenId?: string;
}
/** 模板中文件的信息结构 */
declare interface FileInfo {
/** 文件ID */
FileId?: string;
/** 文件名 */
FileName?: string;
/** 文件大小，单位为Byte */
FileSize?: number;
/** 文件上传时间，格式为Unix标准时间戳（秒） */
CreatedOn?: number;
}
/** 下载文件的URL信息 */
declare interface FileUrl {
/** 下载文件的URL，有效期为输入的UrlTtl，默认5分钟 */
Url: string;
/** 下载文件的附加信息。如果是pdf文件，会返回pdf文件每页的有效高宽 */
Option: string;
}
/** 补充签署人信息- RecipientId 必须指定- 通过企业微信自定义账号ID补充签署人时，ApproverSource 和 CustomUserId 必填，ApproverSource取值：WEWORKAPP- 通过二要素（姓名/手机号）补充签署人时，ApproverName 和 ApproverMobile 必填，ApproverSource设置为空- 补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充 */
declare interface FillApproverInfo {
/** 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。模板发起合同时，该参数为必填项。文件发起合同时，该参数无需传值。如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。 */
RecipientId: string;
/** 签署人来源WEWORKAPP: 企业微信仅【企微或签】时指定WEWORKAPP */
ApproverSource?: string;
/** 企业微信UserId当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId */
CustomUserId?: string;
/** 企业签署人的员工姓名。除企业微信应用场景（ApproverSource设置为WEWORKAPP）外，本字段为必填。 */
ApproverName?: string;
/** 补充企业签署人员工手机号ApproverSource!=WEWORKAPP时，必传 */
ApproverMobile?: string;
/** 补充企业动态签署人时，需要指定对应企业名称 */
OrganizationName?: string;
/** 签署方经办人的证件类型，支持以下类型ID_CARD 中国大陆居民身份证HONGKONG_AND_MACAO 中国港澳居民来往内地通行证HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)OTHER_CARD_TYPE 其他证件注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。``2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。` */
ApproverIdCardType?: string;
/** 签署方经办人的证件号码，应符合以下规则中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。` */
ApproverIdCardNumber?: string;
/** 合同流程ID- 补充合同组子合同动态签署人时必传。- 补充普通合同时，请阅读：补充签署人接口的接口使用说明 */
FlowId?: string;
/** 通知类型：当FillApproverType =0，或签场景补充签署人时，指定是否发送或签领取短信SMS：开启或签领取短信通知NONE：关闭或签领取短信通知当NotifyType=NONE时，可调用获取跳转至腾讯电子签小程序的签署链接接口生成签署链接来完成或签领取 */
NotifyType?: string;
}
/** 批量补充签署人时，补充失败的报错说明 */
declare interface FillError {
/** 为签署方经办人在签署合同中的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。与入参中补充的签署人角色ID对应，批量补充部分失败返回对应的错误信息。 */
RecipientId?: string;
/** 补充失败错误说明 */
ErrMessage?: string;
/** 合同流程ID，为32位字符串。 */
FlowId?: string;
}
/** 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值 */
declare interface FilledComponent {
/** 控件Id */
ComponentId?: string;
/** 控件名称 */
ComponentName?: string;
/** 控件填写状态；0-未填写；1-已填写 */
ComponentFillStatus?: string;
/** 控件填写内容 */
ComponentValue?: string;
/** 控件所属参与方Id */
ComponentRecipientId?: string;
/** 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。 */
ImageUrl?: string;
}
/** 查询过滤条件 */
declare interface Filter {
/** 查询过滤条件的Key */
Key: string;
/** 查询过滤条件的Value列表 */
Values: string[];
}
/** 签署人详情信息 */
declare interface FlowApproverDetail {
/** 签署时的相关信息 */
ApproveMessage?: string;
/** 签署方姓名 */
ApproveName?: string;
/** 签署方的签署状态0：还没有发起1：流程中 没有开始处理2：待签署3：已签署4：已拒绝5：已过期6：已撤销7：还没有预发起8：待填写9：因为各种原因而终止10：填写完成15：已解除19：转他人处理 */
ApproveStatus?: number;
/** 模板配置中的参与方ID,与控件绑定 */
ReceiptId?: string;
/** 客户自定义的用户ID */
CustomUserId?: string;
/** 签署人手机号 */
Mobile?: string;
/** 签署顺序，如果是有序签署，签署顺序从小到大 */
SignOrder?: number;
/** 签署人签署时间，时间戳，单位秒 */
ApproveTime?: number;
/** 签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业静默签 */
ApproveType?: string;
/** 签署方侧用户来源，如WEWORKAPP-企业微信等 */
ApproverSource?: string;
/** 客户自定义签署方标识 */
CustomApproverTag?: string;
/** 签署方企业Id */
OrganizationId?: string;
/** 签署方企业名称 */
OrganizationName?: string;
/** 签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。 */
SignId?: string;
/** 自定义签署人角色 */
ApproverRoleName?: string;
/** 模板配置中的参与方ID,与控件绑定 */
RecipientId?: string;
}
/** 签署链接信息。 */
declare interface FlowApproverUrlInfo {
/** 签署短链接。注意:1. 该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。2. 该链接不支持小程序嵌入，仅支持移动端浏览器打开。3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */
SignUrl?: string;
/** 签署人类型。- **1**: 个人 */
ApproverType?: number;
/** 签署人姓名。 */
ApproverName?: string;
/** 签署人手机号。 */
ApproverMobile?: string;
/** 签署长链接。注意:1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。3. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误） */
LongUrl?: string;
}
/** 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。 */
declare interface FlowBatchApproverInfo {
/** 合同流程ID。 */
FlowId?: string;
/** 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。` */
RecipientId?: string;
}
/** 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。 */
declare interface FlowBatchUrlInfo {
/** 批量签署合同和签署方的信息，用于补充动态签署人。 */
FlowBatchApproverInfos?: FlowBatchApproverInfo[];
}
/** 合同流程的基础信息 */
declare interface FlowBrief {
/** 合同流程ID，为32位字符串。 */
FlowId?: string;
/** 合同流程的名称。 */
FlowName?: string;
/** 合同流程描述信息。 */
FlowDescription?: string;
/** 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。 请使用 UserFlowType。 */
FlowType?: string;
/** 合同流程当前的签署状态, 会存在下列的状态值 **0** : 未开启流程(合同中不存在填写环节) **1** : 待签署 **2** : 部分签署 **3** : 已拒签 **4** : 已签署 **5** : 已过期 **6** : 已撤销 **7** : 未开启流程(合同中存在填写环节) **8** : 等待填写 **9** : 部分填写 **10** : 已拒填 **21** : 已解除 */
FlowStatus?: number;
/** 合同流程创建时间，格式为Unix标准时间戳（秒）。 */
CreatedOn?: number;
/** 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。 */
FlowMessage?: string;
/** 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。 */
Creator?: string;
/** 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。 */
Deadline?: number;
/** 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: */
UserFlowType?: UserFlowType;
/** 发起模板时,使用的模板Id */
TemplateId?: string;
}
/** 创建流程的签署方信息 */
declare interface FlowCreateApprover {
/** 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下： 0 :企业B端。 1 :个人C端。 3 :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考自动签署使用说明文档。 7 :个人C端自动签署，适用于个人自动签场景。注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。 */
ApproverType: number;
/** 组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定` */
OrganizationName?: string;
/** 签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。在未指定签署人电子签UserId情况下，为必填参数 */
ApproverName?: string;
/** 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。注：`在未指定签署人电子签UserId情况下，为必填参数` */
ApproverMobile?: string;
/** 证件类型，支持以下类型ID_CARD: 居民身份证 (默认值)HONGKONG_AND_MACAO : 港澳居民来往内地通行证HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) */
ApproverIdCardType?: string;
/** 证件号码，应符合以下规则中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。 */
ApproverIdCardNumber?: string;
/** 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。文件发起合同时，该参数无需传值。如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。 */
RecipientId?: string;
/** 签署意愿确认渠道，默认为WEIXINAPP:人脸识别注: 不再使用</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置` */
VerifyChannel?: string[];
/** 通知签署方经办人的方式, 有以下途径: **sms** : (默认)短信 **none** : 不通知注: `既是发起方又是签署方时，不给此签署方发送短信` */
NotifyType?: string;
/** 合同强制需要阅读全文，无需传此参数 */
IsFullText?: boolean;
/** 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：合同页数少于等于2页，阅读时间为3秒；合同页数为3到5页，阅读时间为5秒；合同页数大于等于6页，阅读时间为10秒。 */
PreReadTime?: number;
/** 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得注： 如果传进来的UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参（会用此UserId实名的身份证和登录的手机号覆盖） */
UserId?: string;
/** 字段不再使用，当前只支持true，默认为true */
Required?: boolean;
/** 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。 */
ApproverSource?: string;
/** 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。所有参与或签的人员均需具备该标识。注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。 */
CustomApproverTag?: string;
/** 快速注册相关信息 */
RegisterInfo?: RegisterInfo;
/** 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。 */
ApproverOption?: ApproverOption;
/** 签署完前端跳转的url，暂未使用 */
JumpUrl?: string;
/** 签署人的签署ID在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。 */
SignId?: string;
/** 此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下：**false**：（默认）不需要审批，直接签署。**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。注：`此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同` */
ApproverNeedSignReview?: boolean;
/** 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体 个人签名/印章 企业印章 骑缝章等签署控件`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主` */
SignComponents?: Component[];
/** 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体单行文本控件多行文本控件勾选框控件数字控件图片控件动态表格等填写控件`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主` */
Components?: Component[];
/** 当签署方控件类型为 SIGN_SIGNATURE 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括： HANDWRITE :需要实时手写的手写签名。 HANDWRITTEN_ESIGN :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE) OCR_ESIGN :AI智能识别手写签名。 ESIGN :个人印章类型。 IMG_ESIGN : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。 SYSTEM_ESIGN :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。各种签名的样式可以参考下图： */
ComponentLimitType?: string[];
/** 指定个人签署方查看合同的校验方式,可以传值如下: **1** : （默认）人脸识别,人脸识别后才能合同内容 **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）注: 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式此字段可传多个校验方式`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`. */
ApproverVerifyTypes?: number[];
/** 您可以指定签署方签署合同的认证校验方式，可传递以下值：**1**：人脸认证，需进行人脸识别成功后才能签署合同；**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）注：默认情况下，认证校验方式为人脸认证和签署密码两种形式；您可以传递多种值，表示可用多种认证校验方式。校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。注:`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主` */
ApproverSignTypes?: number[];
/** 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。注：`不指定该值时，默认为签署方自行选择。` */
SignTypeSelector?: number;
/** 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同` */
Deadline?: number;
/** 只有在生成H5签署链接的情形下（ 如调用获取H5签署链接、获取H5批量签署链接等接口），该配置才会生效。您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。注意：1. 视频认证为白名单功能，使用前请联系对接的客户经理沟通。2. 使用视频认证时，生成H5签署链接必须将签署认证方式指定为人脸（即ApproverSignTypes设置成人脸签署）。3. 签署完成后，可以通过查询签署认证人脸视频获取到当时的视频。 */
Intention?: Intention;
/** 进入签署流程的限制，目前支持以下选项： 空值（默认） :无限制，可在任何场景进入签署流程。 link :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。 */
SignEndpoints?: string[];
/** 是否不保存联系人默认 false 保存联系人 true 不保存联系人设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。如下图位置： */
NotSaveContact?: boolean;
}
/** 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息 */
declare interface FlowDetailInfo {
/** 合同流程ID，为32位字符串。 */
FlowId?: string;
/** 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */
FlowName?: string;
/** 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。 */
FlowType?: string;
/** 合同流程当前的签署状态, 会存在下列的状态值 **0** : 未开启流程(合同中不存在填写环节) **1** : 待签署 **2** : 部分签署 **3** : 已拒签 **4** : 已签署 **5** : 已过期 **6** : 已撤销 **7** : 未开启流程(合同中存在填写环节) **8** : 等待填写 **9** : 部分填写 **10** : 已拒填 **16** : 已失效（可能因为参与方修改姓名等原因） **21** : 已解除 */
FlowStatus?: number;
/** 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。 */
FlowMessage?: string;
/** 合同流程描述信息。 */
FlowDescription?: string;
/** 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。 */
CreatedOn?: number;
/** 合同流程的签署方数组 */
FlowApproverInfos?: FlowApproverDetail[];
/** 合同流程的关注方信息数组 */
CcInfos?: FlowApproverDetail[];
/** 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。 */
Creator?: string;
/** 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: */
UserFlowType?: UserFlowType;
/** 发起模板时,使用的模板Id */
TemplateId?: string;
}
/** 合同转交相关信息 */
declare interface FlowForwardInfo {
/** 合同流程ID，为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。 */
FlowId: string;
/** 签署方经办人在合同中的参与方ID，为32位字符串。 */
RecipientId: string;
}
/** 转交合同结果 */
declare interface FlowForwardResult {
/** 合同流程ID为32位字符串。您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。 */
FlowId?: string;
/** 如果失败，返回的错误细节。 */
ErrorDetail?: string;
}
/** 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。 */
declare interface FlowGroupApproverInfo {
/** 合同流程ID。 */
FlowId?: string;
/** 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。` */
RecipientId?: string;
}
/** 合同组签署方信息 */
declare interface FlowGroupApprovers {
/** 合同流程ID */
FlowId?: string;
/** 签署方信息，包含合同ID和角色ID用于定位RecipientId。 */
Approvers?: ApproverItem[];
}
/** 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息 */
declare interface FlowGroupInfo {
/** 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。该名称还将用于合同签署完成后的下载文件名。 */
FlowName: string;
/** 签署流程参与者信息，最大限制50方注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。 */
Approvers: ApproverInfo[];
/** 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。注：此字段定义为数组，但仅支持单个文件 */
FileIds?: string[];
/** 合同模板ID，为32位字符串。建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。 */
TemplateId?: string;
/** 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符 */
FlowType?: string;
/** 签署流程描述,最大长度1000个字符 */
FlowDescription?: string;
/** 签署流程的签署截止时间。值为unix时间戳,精确到秒,不传默认为当前时间一年后示例值：1604912664 */
Deadline?: number;
/** 合同（流程）的回