tencentcloud-sdk-nodejs
Version:
2,194 lines (2,137 loc) • 422 kB
TypeScript
/**
* DescribePersonCertificate返回参数结构体
*/
export interface DescribePersonCertificateResponse {
/**
* 证书的Base64
*/
Cert?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrganizationGroupInvitationLink请求参数结构体
*/
export interface CreateOrganizationGroupInvitationLinkRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 到期时间（以秒为单位的时间戳），其上限为30天的有效期限。
*/
ExpireTime: number;
}
/**
* 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
*/
export interface FlowBatchUrlInfo {
/**
* 批量签署合同和签署方的信息，用于补充动态签署人。
*/
FlowBatchApproverInfos?: Array<FlowBatchApproverInfo>;
}
/**
* 用户计费使用情况详情
*/
export interface BillUsageDetail {
/**
* 合同流程ID，为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId?: string;
/**
* 合同经办人名称
如果有多个经办人用分号隔开。
*/
OperatorName?: string;
/**
* 发起方组织机构名称
*/
CreateOrganizationName?: string;
/**
* 合同流程的名称。
*/
FlowName?: string;
/**
* 当前合同状态,如下是状态码对应的状态。
<ul>
<li>**0**: 还没有发起</li>
<li>**1**: 等待签署</li>
<li>**2**: 部分签署 </li>
<li>**3**: 拒签</li>
<li>**4**: 已签署 </li>
<li>**5**: 已过期 </li>
<li>**6**: 已撤销 </li>
<li>**7**: 还没有预发起</li>
<li>**8**: 等待填写</li>
<li>**9**: 部分填写 </li>
<li>**10**: 拒签</li>
<li>**11**: 已解除</li>
</ul>
*/
Status?: number;
/**
* 查询的套餐类型
对应关系如下:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
*/
QuotaType?: string;
/**
* 合同使用量
注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
*/
UseCount?: number;
/**
* 消耗的时间戳，格式为Unix标准时间戳（秒）。
*/
CostTime?: number;
/**
* 消耗的套餐名称
*/
QuotaName?: string;
/**
* 消耗类型
**1**.扣费
**2**.撤销返还
*/
CostType?: number;
/**
* 备注
*/
Remark?: string;
}
/**
* DescribeCancelFlowsTask返回参数结构体
*/
export interface DescribeCancelFlowsTaskResponse {
/**
* 批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
*/
TaskId?: string;
/**
* 任务状态，需要关注的状态
<ul><li>**PROCESSING** - 任务执行中</li>
<li>**END** - 任务处理完成</li>
<li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
*/
TaskStatus?: string;
/**
* 批量撤销成功的签署流程编号
*/
SuccessFlowIds?: Array<string>;
/**
* 批量撤销失败的签署流程信息
*/
FailureFlows?: Array<CancelFailureFlow>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 意愿核身点头确认模式结果
*/
export interface IntentionActionResult {
/**
* 意愿核身结果详细数据，与每段点头确认过程一一对应
*/
Details?: Array<IntentionActionResultDetail>;
}
/**
* DescribeUserFlowType返回参数结构体
*/
export interface DescribeUserFlowTypeResponse {
/**
* 查询到的所有用户合同类型列表
*/
AllUserFlowTypes?: Array<TemplateUserFlowType>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileCounterSignResult请求参数结构体
*/
export interface DescribeFileCounterSignResultRequest {
/**
* 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 加签任务Id
*/
TaskId?: string;
}
/**
* CreateSeal请求参数结构体
*/
export interface CreateSealRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
*/
SealName: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 电子印章生成方式
<ul>
<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
</ul>
*/
GenerateSource?: string;
/**
* 电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错
*/
SealType?: string;
/**
* 电子印章图片文件名称，1-50个中文字符。
*/
FileName?: string;
/**
* 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式
注: `通过图片创建的电子印章，需电子签平台人工审核`
*/
Image?: string;
/**
* 电子印章宽度,单位px
参数不再启用，系统会设置印章大小为标准尺寸。
*/
Width?: number;
/**
* 电子印章高度,单位px
参数不再启用，系统会设置印章大小为标准尺寸。
*/
Height?: number;
/**
* 电子印章印章颜色(默认红色RED),RED-红色
系统目前只支持红色印章创建。
*/
Color?: string;
/**
* 企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号)
横向文字的位置如下图中的"印章横向文字在这里"
*/
SealHorizontalText?: string;
/**
* 暂时不支持下弦文字设置
*/
SealChordText?: string;
/**
* 系统生成的印章只支持STAR
*/
SealCentralType?: string;
/**
* 通过文件上传时，服务端生成的电子印章上传图片的token
*/
FileToken?: string;
/**
* 印章样式, 可以选择的样式如下:
<ul><li>**circle**:(默认)圆形印章</li>
<li>**ellipse**:椭圆印章</li></ul>
*/
SealStyle?: string;
/**
* 印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**（默认）: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>
*/
SealSize?: string;
/**
* 企业税号
注:
<ul>
<li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li>
<li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li>
</ul>
*/
TaxIdentifyCode?: string;
}
/**
* 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
*/
export interface FlowGroupUrlInfo {
/**
* 合同组子合同和签署方的信息，用于补充动态签署人。
*/
FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>;
}
/**
* CancelFlow返回参数结构体
*/
export interface CancelFlowResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeExtendedServiceAuthDetail返回参数结构体
*/
export interface DescribeExtendedServiceAuthDetailResponse {
/**
* 服务授权的信息列表，根据查询类型返回特定扩展服务的授权状况。
*/
AuthInfoDetail?: AuthInfoDetail;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateIntegrationEmployees返回参数结构体
*/
export interface UpdateIntegrationEmployeesResponse {
/**
* 更新成功的用户列表
*/
SuccessEmployeeData?: Array<SuccessUpdateStaffData>;
/**
* 更新失败的用户列表
*/
FailedEmployeeData?: Array<FailedUpdateStaffData>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集成版员工部门信息。
*/
export interface Department {
/**
* 部门ID。
*/
DepartmentId?: string;
/**
* 部门名称。
*/
DepartmentName?: string;
}
/**
* CreatePreparedPersonalEsign请求参数结构体
*/
export interface CreatePreparedPersonalEsignRequest {
/**
* 个人用户姓名
*/
UserName: string;
/**
* 证件号码，应符合以下规则
<ul><li> 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
*/
IdCardNumber: string;
/**
* 印章名称，长度1-50个字。
*/
SealName: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>
*/
IdCardType?: string;
/**
* 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @deprecated
*/
SealImage?: string;
/**
* 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
*/
SealImageCompress?: boolean;
/**
* 手机号码；当需要开通自动签时，该参数必传
*/
Mobile?: string;
/**
* 此字段已废弃，请勿继续使用。
*/
EnableAutoSign?: boolean;
/**
* 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
*/
SealColor?: string;
/**
* 是否处理印章，默认不做印章处理。
取值如下：
<ul>
<li>false：不做任何处理；</li>
<li>true：做透明化处理和颜色增强。</li>
</ul>
*/
ProcessSeal?: boolean;
/**
* 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
FileId?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
LicenseType?: number;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
SceneKey?: string;
}
/**
* CreateLegalSealQrCode返回参数结构体
*/
export interface CreateLegalSealQrCodeResponse {
/**
* 二维码图片base64值，二维码有效期7天（604800秒）
二维码图片的样式如下图：
*/
QrcodeBase64?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationDepartments返回参数结构体
*/
export interface DescribeIntegrationDepartmentsResponse {
/**
* 部门信息列表。部门信息根据部门排序号OrderNo降序排列，根据部门创建时间升序排列。
*/
Departments?: Array<IntegrationDepartment>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFileCounterSign请求参数结构体
*/
export interface CreateFileCounterSignRequest {
/**
* 需要加签的文件Id。
注: `暂时只支持pdf类型的文件`
*/
FileId: string;
/**
* 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 是否使用同步模式。
<ul><li><b>false</b>:异步模式，返回taskId。需要使用taskId轮询结果查询接口。</li>
<li><b>true</b>: 同步模式，此接口将直接返回taskId和ResultFileId(加签后文件id)。</li></ul>
注：
1. 当加签文件较大的时候，建议使用异步接口进行操作。否则文件加签时间过长会导致接口超时。
*/
SyncMode?: boolean;
}
/**
* 模板中文件的信息结构
*/
export interface FileInfo {
/**
* 文件ID
*/
FileId?: string;
/**
* 文件名
*/
FileName?: string;
/**
* 文件大小，单位为Byte
*/
FileSize?: number;
/**
* 文件上传时间，格式为Unix标准时间戳（秒）
*/
CreatedOn?: number;
}
/**
* DescribeOrganizationVerifyStatus返回参数结构体
*/
export interface DescribeOrganizationVerifyStatusResponse {
/**
* 当前企业认证状态
<ul>
<li> <b>0 </b>:未认证</li>
<li> <b>1 </b> : 认证中</li>
<li> <b>2 </b> : 已认证</li>
</ul>
*/
VerifyStatus?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteExtendedServiceAuthInfos返回参数结构体
*/
export interface DeleteExtendedServiceAuthInfosResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowForwards请求参数结构体
*/
export interface CreateFlowForwardsRequest {
/**
* 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。
注意：`需要保证目标经办人已经加入企业且已实名`
*/
TargetUserId: string;
/**
* 企业签署方的合同及对应签署方
*/
FlowForwardInfos: Array<FlowForwardInfo>;
/**
* 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* CreateDynamicFlowApprover请求参数结构体
*/
export interface CreateDynamicFlowApproverRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串
*/
FlowId: string;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
Approvers: Array<ApproverInfo>;
/**
* 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
AutoSignScene?: string;
}
/**
* CreateFlowApprovers返回参数结构体
*/
export interface CreateFlowApproversResponse {
/**
* 批量补充签署人时，补充失败的报错说明
注:`目前仅补充动态签署人时会返回补充失败的原因`
*/
FillError?: Array<FillError>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFileUrls返回参数结构体
*/
export interface DescribeFileUrlsResponse {
/**
* 文件URL信息；
链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
*/
FileUrls?: Array<FileUrl>;
/**
* URL数量
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowReminds请求参数结构体
*/
export interface CreateFlowRemindsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 需执行催办的签署流程ID数组，最多包含100个。
*/
FlowIds: Array<string>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
*/
export interface IntentionQuestionResult {
/**
* 视频base64（其中包含全程问题和回答音频，mp4格式）
注：`需进行base64解码获取视频文件`
*/
Video?: string;
/**
* 和答案匹配结果列表
*/
ResultCode?: Array<string>;
/**
* 回答问题语音识别结果列表
*/
AsrResult?: Array<string>;
}
/**
* CancelUserAutoSignEnableUrl请求参数结构体
*/
export interface CancelUserAutoSignEnableUrlRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
*/
SceneKey: string;
/**
* 预撤销链接的用户信息，包含姓名、证件类型、证件号码等信息。
*/
UserInfo: UserThreeFactor;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 企业扩展服务授权列表详情
*/
export interface AuthInfoDetail {
/**
* 扩展服务类型，和入参一致
*/
Type?: string;
/**
* 扩展服务名称
*/
Name?: string;
/**
* 授权员工列表
*/
HasAuthUserList?: Array<HasAuthUser>;
/**
* 授权企业列表（企业自动签时，该字段有值）
*/
HasAuthOrganizationList?: Array<HasAuthOrganization>;
/**
* 授权员工列表总数
*/
AuthUserTotal?: number;
/**
* 授权企业列表总数
*/
AuthOrganizationTotal?: number;
}
/**
* 清理的企业认证流信息
*/
export interface DeleteOrganizationAuthorizationInfo {
/**
* 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
*/
AuthorizationId?: string;
/**
* 认证的企业名称
*/
OrganizationName?: string;
/**
* 清除认证流产生的错误信息
*/
Errormessage?: string;
}
/**
* ModifyApplicationCallbackInfo返回参数结构体
*/
export interface ModifyApplicationCallbackInfoResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMultiFlowSignQRCode返回参数结构体
*/
export interface CreateMultiFlowSignQRCodeResponse {
/**
* 一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。
*/
QrCode?: SignQrCode;
/**
* 一码多签签署码的链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
*/
SignUrls?: SignUrl;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeIntegrationDepartments请求参数结构体
*/
export interface DescribeIntegrationDepartmentsRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 查询类型，支持以下类型：
<ul><li>**0**：查询单个部门节点列表，不包含子节点部门信息</li>
<li>**1**：查询单个部门节点级一级子节点部门信息列表</li></ul>
*/
QueryType: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的部门ID。
注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
*/
DeptId?: string;
/**
* 查询的客户系统部门ID。
注：`如果同时指定了DeptId与DeptOpenId参数，系统将优先使用DeptId参数进行查询。当二者都未指定时，系统将返回根节点部门数据。`
*/
DeptOpenId?: string;
}
/**
* 关注方信息
*/
export interface ReviewerInfo {
/**
* 姓名
*/
Name?: string;
/**
* 手机号
*/
Mobile?: string;
}
/**
* 合同流程的基础信息
*/
export interface FlowBrief {
/**
* 合同流程ID，为32位字符串。
*/
FlowId?: string;
/**
* 合同流程的名称。
*/
FlowName?: string;
/**
* 合同流程描述信息。
*/
FlowDescription?: string;
/**
* 合同流程的类别分类（如销售合同/入职合同等）。
*/
FlowType?: string;
/**
* 合同流程当前的签署状态, 会存在下列的状态值
<ul><li> **0** : 未开启流程(合同中不存在填写环节)</li>
<li> **1** : 待签署</li>
<li> **2** : 部分签署</li>
<li> **3** : 已拒签</li>
<li> **4** : 已签署</li>
<li> **5** : 已过期</li>
<li> **6** : 已撤销</li>
<li> **7** : 未开启流程(合同中存在填写环节)</li>
<li> **8** : 等待填写</li>
<li> **9** : 部分填写</li>
<li> **10** : 已拒填</li>
<li> **21** : 已解除</li></ul>
*/
FlowStatus?: number;
/**
* 合同流程创建时间，格式为Unix标准时间戳（秒）。
*/
CreatedOn?: number;
/**
* 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
*/
FlowMessage?: string;
/**
* 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
*/
Creator?: string;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
*/
Deadline?: number;
}
/**
* DescribeThirdPartyAuthCode返回参数结构体
*/
export interface DescribeThirdPartyAuthCodeResponse {
/**
* AuthCode 中对应个人用户是否实名
<ul>
<li> **VERIFIED** : 此个人已实名</li>
<li> **UNVERIFIED**: 此个人未实名</li></ul>
*/
VerifyStatus?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUserVerifyStatus返回参数结构体
*/
export interface DescribeUserVerifyStatusResponse {
/**
* true:表示已实名
false：表示未实名
*/
VerifyStatus?: boolean;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 被授权的用户信息
*/
export interface HasAuthUser {
/**
* 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
*/
UserId?: string;
/**
* 当前员工的归属情况，可能值是：
MainOrg：在集团企业的场景下，返回此值代表是归属主企业
CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业
*/
BelongTo?: string;
/**
* 集团主企业id，当前企业为集团子企业时，该字段有值
*/
MainOrganizationId?: string;
}
/**
* DisableUserAutoSign返回参数结构体
*/
export interface DisableUserAutoSignResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业套餐余额情况
*/
export interface OrgBillSummary {
/**
* 套餐总数
*/
Total?: number;
/**
* 套餐使用数
*/
Used?: number;
/**
* 套餐剩余数
*/
Available?: number;
/**
* 套餐类型
对应关系如下:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
*/
QuotaType?: string;
}
/**
* ModifyExtendedService请求参数结构体
*/
export interface ModifyExtendedServiceRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 要管理的拓展服务类型。
<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
<li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>
<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>
<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>
<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>
<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>
<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>
<li>HIDE_ONE_KEY_SIGN：个人签署方手写签名时需逐个手写</li>
<li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE：个人签署方手动签名</li>
<li>ORGANIZATION_FLOW_EMAIL_NOTIFY：邮件通知签署方</li>
<li>FLOW_APPROVAL：合同审批强制开启</li>
<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li>
<li>APP_LOGIN：限制企业员工小程序端登录</li>
<li>PC_LOGIN：限制企业员工网页端登录</li>
</ul>
*/
ServiceType: string;
/**
* 操作类型
<ul>
<li>OPEN : 开通</li>
<li>CLOSE : 关闭</li>
</ul>
*/
Operate: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 链接跳转类型，支持以下类型
<ul>
<li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
<li>APP : 第三方APP或小程序跳转电子签小程序</li>
<li>WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。<font color="red">您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</font></li>
</ul>
*/
Endpoint?: string;
}
/**
* 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
*/
export interface IntentionAction {
/**
* 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
*/
Text?: string;
}
/**
* CreateBatchInitOrganizationUrl返回参数结构体
*/
export interface CreateBatchInitOrganizationUrlResponse {
/**
* 小程序路径
*/
MiniAppPath?: string;
/**
* 操作长链
*/
OperateLongUrl?: string;
/**
* 操作短链
*/
OperateShortUrl?: string;
/**
* 操作二维码
*/
QRCodeUrl?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindEmployeeUserIdWithClientOpenId返回参数结构体
*/
export interface BindEmployeeUserIdWithClientOpenIdResponse {
/**
* 绑定是否成功。
<ul><li>**0**：失败</li><li>**1**：成功</li></ul>
*/
Status?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationEmployees请求参数结构体
*/
export interface CreateIntegrationEmployeesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 待创建员工的信息最多不超过20个。
**1. 在创建企业微信员工的场景下** : 只需传入下面的参数，其他信息不支持设置。
<table> <thead> <tr> <th>参数</th> <th>是否必填</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>WeworkOpenId</td> <td>是</td> <td>企业微信用户账号ID</td> </tr> </tbody> </table>
**2. 在其他场景下** : 只需传入下面的参数，其他信息不支持设置。
<table> <thead> <tr> <th>参数</th> <th>是否必填</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>DisplayName</td> <td>是</td> <td>用户的真实名字</td> </tr> <tr> <td>Mobile</td> <td>是</td> <td>用户手机号码</td> </tr> <tr> <td>OpenId</td> <td>否</td> <td>用户的自定义ID</td> </tr> <tr> <td>Email</td> <td>否</td> <td>用户的邮箱</td> </tr> <tr> <td>Department.DepartmentId</td> <td>否</td> <td>用户加入后的部门ID</td> </tr> </tbody> </table>
注: `每个手机号每天最多使用3次`
*/
Employees: Array<Staff>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 员工邀请方式
可通过以下途径进行设置：
<ul><li>**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。</li></ul>
*/
InvitationNotifyType?: string;
/**
* 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
*/
JumpUrl?: string;
/**
* 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月</li></ul>注意：InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型（InvitationNotifyType）</td><td>Endpoint</td></tr><tr><td>SMS（默认）</td><td>不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递，会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL</td></tr></tbody></table>
*/
Endpoint?: string;
}
/**
* 创建合同个性化参数
*/
export interface CreateFlowOption {
/**
* 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。
<br/>true：允许编辑<br/>false：不允许编辑（默认值）<br/>
*/
CanEditFlow?: boolean;
/**
* 是否允许编辑模板控件
<br/>true:允许编辑模板控件信息
<br/>false:不允许编辑模板控件信息（默认值）
<br/>
*/
CanEditFormField?: boolean;
/**
* 发起页面隐藏合同名称展示
<br/>true:发起页面隐藏合同名称展示
<br/>false:发起页面不隐藏合同名称展示（默认值）
<br/>
*/
HideShowFlowName?: boolean;
/**
* 发起页面隐藏合同类型展示
<br/>true:发起页面隐藏合同类型展示
<br/>false:发起页面不隐藏合同类型展示（默认值）
<br/>
*/
HideShowFlowType?: boolean;
/**
* 发起页面隐藏合同截止日期展示
<br/>true:发起页面隐藏合同截止日期展示
<br/>false:发起页面不隐藏合同截止日期展示（默认值）
<br/>
*/
HideShowDeadline?: boolean;
/**
* 发起页面允许跳过添加签署人环节
<br/>true:发起页面允许跳过添加签署人环节
<br/>false:发起页面不允许跳过添加签署人环节（默认值）
<br/>
*/
CanSkipAddApprover?: boolean;
/**
* 文件发起页面跳过文件上传步骤
<br/>true:文件发起页面跳过文件上传步骤
<br/>false:文件发起页面不跳过文件上传步骤（默认值）
<br/>
*/
SkipUploadFile?: boolean;
/**
* 禁止编辑填写控件
<br/>true:禁止编辑填写控件
<br/>false:允许编辑填写控件（默认值）
<br/>
*/
ForbidEditFillComponent?: boolean;
/**
* 定制化发起合同弹窗的描述信息，描述信息最长500字符
*/
CustomCreateFlowDescription?: string;
/**
* 禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
*/
ForbidAddApprover?: boolean;
/**
* 是否可以编辑签署人包括新增，修改，删除
<ul><li>（默认） false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul>
注意：如果设置参数为 true， 则 参数签署人 [FlowApproverList](https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow) 不能为空
*/
ForbidEditApprover?: boolean;
/**
* 禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
*/
ForbidEditFlowProperties?: boolean;
/**
* 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用，具体的控件类型如下
<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
<li>SIGN_SEAL : 企业印章</li>
<li>SIGN_PAGING_SEAL : 骑缝章</li>
<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
<li>SIGN_APPROVE : 签批</li>
<li>SIGN_OPINION : 签署意见</li>
<li>BUSI-FULL-NAME : 企业全称</li>
<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
<li>PERSONAL-NAME : 签署人姓名</li>
<li>PERSONAL-MOBILE : 签署人手机号</li>
<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
<li>PERSONAL-IDCARD : 签署人证件号</li>
<li>TEXT : 单行文本</li>
<li>MULTI_LINE_TEXT : 多行文本</li>
<li>CHECK_BOX : 勾选框</li>
<li>SELECTOR : 选择器</li>
<li>DIGIT : 数字</li>
<li>DATE : 日期</li>
<li>FILL_IMAGE : 图片</li>
<li>ATTACHMENT : 附件</li>
<li>EMAIL : 邮箱</li>
<li>LOCATION : 地址</li>
<li>EDUCATION : 学历</li>
<li>GENDER : 性别</li>
<li>DISTRICT : 省市区</li></ul>
*/
HideComponentTypes?: Array<string>;
/**
* 在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用，具体的控件类型如下
<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
<li>SIGN_SEAL : 企业印章</li>
<li>SIGN_PAGING_SEAL : 骑缝章</li>
<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
<li>SIGN_APPROVE : 签批</li>
<li>SIGN_OPINION : 签署意见</li>
<li>BUSI-FULL-NAME : 企业全称</li>
<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
<li>PERSONAL-NAME : 签署人姓名</li>
<li>PERSONAL-MOBILE : 签署人手机号</li>
<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
<li>PERSONAL-IDCARD : 签署人证件号</li>
<li>TEXT : 单行文本</li>
<li>MULTI_LINE_TEXT : 多行文本</li>
<li>CHECK_BOX : 勾选框</li>
<li>SELECTOR : 选择器</li>
<li>DIGIT : 数字</li>
<li>DATE : 日期</li>
<li>FILL_IMAGE : 图片</li>
<li>ATTACHMENT : 附件</li>
<li>EMAIL : 邮箱</li>
<li>LOCATION : 地址</li>
<li>EDUCATION : 学历</li>
<li>GENDER : 性别</li>
<li>DISTRICT : 省市区</li></ul>
*/
ShowComponentTypes?: Array<string>;
/**
* 发起流程的可嵌入页面结果页配置
*/
ResultPageConfig?: Array<CreateResultPageConfig>;
/**
* 签署控件的配置信息，用在嵌入式发起的页面配置，包括
- 签署控件 是否默认展示日期.
*/
SignComponentConfig?: SignComponentConfig;
}
/**
* CreateOrganizationAuthFile返回参数结构体
*/
export interface CreateOrganizationAuthFileResponse {
/**
* 授权书链接，有效期5分钟。
*/
FileUrl?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
*/
export interface FilledComponent {
/**
* 控件Id
*/
ComponentId?: string;
/**
* 控件名称
*/
ComponentName?: string;
/**
* 控件填写状态；0-未填写；1-已填写
*/
ComponentFillStatus?: string;
/**
* 控件填写内容
*/
ComponentValue?: string;
/**
* 控件所属参与方Id
*/
ComponentRecipientId?: string;
/**
* 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
*/
ImageUrl?: string;
}
/**
* DescribeIntegrationRoles请求参数结构体
*/
export interface DescribeIntegrationRolesRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大支持 200。
*/
Limit: number;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 查询的关键字段，支持Key-Value单值查询。可选键值对如下：
<ul>
<li>Key:"RoleType"，查询角色类型，Values可选：
<ul><li>**"1"**：查询系统角色</li><li>**"2"**：查询自定义角色</li></ul>
</li><li>Key:"RoleStatus"，查询角色状态，Values可选：
<ul><li>**"1"**：查询启用角色</li><li>**"2"**：查询禁用角色</li></ul>
</li><li>Key:"IsGroupRole"，是否查询集团角色，Values可选：
<ul><li>**"0"**：查询非集团角色</li><li>**"1"**：查询集团角色</li></ul>
</li><li>Key:"IsReturnPermissionGroup"，是否返回角色对应权限树，Values可选：
<ul><li>**"0"**：接口不返回角色对应的权限树字段</li><li>**"1"**：接口返回角色对应的权限树字段</li></ul>
</li>
</ul>
*/
Filters?: Array<Filter>;
/**
* OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大2000。
分页参数, 需要limit, offset 配合使用
例如:
您希望得到第三页的数据, 且每页限制最多10条
您可以使用 LIMIT 10 OFFSET 20
*/
Offset?: number;
}
/**
* 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
*/
export interface FlowBatchApproverInfo {
/**
* 合同流程ID。
*/
FlowId?: string;
/**
* 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
*/
RecipientId?: string;
}
/**
* CreateFlowEvidenceReport请求参数结构体
*/
export interface CreateFlowEvidenceReportRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符串。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
*/
FlowId: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 指定申请的报告类型，可选类型如下：
<ul><li> **0** :合同签署报告（默认）</li>
<li> **1** :公证处核验报告</li></ul>
*/
ReportType?: number;
}
/**
* StartFlow返回参数结构体
*/
export interface StartFlowResponse {
/**
* 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
<ul><li> **START** : 发起成功, 合同进入签署环节</li>
<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能，使用前请联系对接的客户经理沟通。`</li>
<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
*/
Status?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 模板中指定的印章信息
*/
export interface SealInfo {
/**
* 印章ID
*/
SealId: string;
/**
* 印章类型。LEGAL_PERSON_SEAL: 法定代表人章；
ORGANIZATIONSEAL：企业印章；
OFFICIAL：企业公章；
CONTRACT：合同专用章
*/
SealType: string;
/**
* 印章名称
*/
SealName: string;
}
/**
* 集成版企业角色信息。
*/
export interface StaffRole {
/**
* 角色ID。
*/
RoleId?: string;
/**
* 角色名称。
*/
RoleName?: string;
}
/**
* 成员企业信息
*/
export interface GroupOrganization {
/**
* 成员企业名
*/
Name?: string;
/**
* 成员企业别名
*/
Alias?: string;
/**
* 成员企业id，为 32 位字符串，可在电子签PC 控制台，企业设置->企业电子签账号 获取
*/
OrganizationId?: string;
/**
* 记录更新时间， unix时间戳，单位秒
*/
UpdateTime?: number;
/**
* 成员企业加入集团的当前状态
<ul><li> **1**：待授权</li>
<li> **2**：已授权待激活</li>
<li> **3**：拒绝授权</li>
<li> **4**：已解除</li>
<li> **5**：已加入</li>
</ul>
*/
Status?: number;
/**
* 是否为集团主企业
*/
IsMainOrganization?: boolean;
/**
* 企业社会信用代码
*/
IdCardNumber?: string;
/**
* 企业超管信息
*/
AdminInfo?: Admin;
/**
* 企业许可证Id，此字段暂时不需要关注
*/
License?: string;
/**
* 企业许可证过期时间，unix时间戳，单位秒
*/
LicenseExpireTime?: number;
/**
* 成员企业加入集团时间，unix时间戳，单位秒
*/
JoinTime?: number;
/**
* 是否使用自建审批流引擎（即不是企微审批流引擎）
<ul><li> **true**：是</li>
<li> **false**：否</li></ul>
*/
FlowEngineEnable?: boolean;
}
/**
* 机构信息
*/
export interface OrganizationInfo {
/**
* 机构在平台的编号，内部字段，暂未开放
* @deprecated
*/
OrganizationId?: string;
/**
* 用户渠道，内部字段，暂未开放
* @deprecated
*/
Channel?: string;
/**
* 用户在渠道的机构编号，内部字段，暂未开放
* @deprecated
*/
OrganizationOpenId?: string;
/**
* 用户真实的IP，内部字段，暂未开放
* @deprecated
*/
ClientIp?: string;
/**
* 机构的代理IP，内部字段，暂未开放
* @deprecated
*/
ProxyIp?: string;
}
/**
* 动态签署2.0合同参与人信息
*/
export interface ArchiveDynamicApproverData {
/**
* 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。
可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
*/
SignId?: string;
/**
* 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。
填写控件和签署控件都与特定的角色编号关联。
*/
RecipientId?: string;
}
/**
* CreateOrganizationAuthUrl请求参数结构体
*/
export interface CreateOrganizationAuthUrlRequest {
/**
* 操作人信息
*/
Operator: UserInfo;
/**
* 指定授权方式 支持多选:
<ul>
<li><strong>1</strong>:上传授权书方式</li>
<li><strong>2</strong>: 法人授权方式</li>
<li><strong>3</strong>: 法人身份认证方式</li>
</ul>
*/
AuthorizationTypes?: Array<number | bigint>;
/**
* 认证企业名称，请确认该名称与企业营业执照中注册的名称一致。
注：
1. `如果名称中包含英文括号()，请使用中文括号（）代替。`
2. `EndPointType=“H5”或者"SHORT_H5"时，该参数必填`
*/
OrganizationName?: string;
/**
* 企业统一社会信用代码
*/
UniformSocialCreditCode?: string;
/**
* 企业法人的姓名
*/
LegalName?: string;
/**
* 认证完成跳回的链接，最长500个字符
*/
AutoJumpUrl?: string;
/**
* 营业执照企业地址
*/
OrganizationAddress?: string;
/**
* 认证人姓名
*/
AdminName?: string;
/**
* 认证人手机号
*/
AdminMobile?: string;
/**
* 认证人身份证号
*/
AdminIdCardNumber?: string;
/**
* 认证人证件类型， 支持以下类型
<ul><li><b>ID_CARD</b> : 中国大陆居民身份证 (默认值)</li>
<li><b>HONGKONG_AND_MACAO</b> : 中国港澳居民来往内地通行证</li>
<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
*/
AdminIdCardType?: string;
/**
* 对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
*/
UniformSocialCreditCodeSame?: boolean;
/**
* 对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
p.s. 仅在法人姓名不为空时有效
*/
LegalNameSame?: boolean;
/**
* 对方打开链接认证时，认证人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
p.s. 仅在认证人姓名不为空时有效
*/
AdminNameSame?: boolean;
/**
* 对方打开链接认证时，认证人居民身份证件号是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
p.s. 仅在认证人身份证号不为空时有效
*/
AdminIdCardNumberSame?: boolean;
/**
* 对方打开链接认证时，认证人手机号是否要与接口传递上来的保持一致。<ul>
<li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li>
<li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li>
</ul>
p.s. 仅在认证人手机号不为空时有效
*/
AdminMobileSame?: boolean;
/**
* 对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
p.s. 仅在企业名称不为空时有效
*/
OrganizationNameSame?: boolean;
/**
* 营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。
*/
BusinessLicense?: string;
/**
* 跳转链接类型：
<ul>
<li><b>PC</b>：适用于PC端的认证链接</li>
<li><b>APP</b>：用于全屏或半屏跳转的小程序链接</li>
<li><b>SHORT_URL</b>：跳转小程序的链接的短链形式</li>
<li><b>H5</b>：适用于H5页面的认证链接</li>
<li><b>SHORT_H5</b>：H5认证链接的短链形式</li>
</ul>
*/
Endpoint?: string;
/**
* 指定企业初始化引导，现在可以配置如下的选项：
<b>1</b>: 启用此选项后，在企业认证的最终步骤将添加创建印章的引导。如下图的位置
*/
Initialization?: Array<number | bigint>;
/**
* 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
授权书可以通过接口[生成企业授权书](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile) 来获得。
p.s. 如果上传授权书 ，需遵循以下条件
1. 超管的信息（超管姓名，超管手机号）必须为必填参数。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
*/
PowerOfAttorneys?: Array<string>;
}
/**
* CreateBatchQuickSignUrl返回参数结构体
*/
export interface CreateBatchQuickSignUrlResponse {
/**
* 签署人签署链接信息
*/
FlowApproverUrlInfo?: FlowApproverUrlInfo;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateIntegrationRole请求参数结构体
*/
export interface CreateIntegrationRoleRequest {
/**
* 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
*/
Name: string;
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 角色描述，最大长度为50个字符
*/
Description?: string;
/**
* 角色类型，0:saas角色，1:集团角色
默认0，saas角色
*/
IsGroupRole?: number;
/**
* 权限树
*/
PermissionGroups?: Array<PermissionGroup>;
/**
* 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
*/
SubOrganizationIds?: string;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* DeleteIntegrationRoleUsers返回参数结构体
*/
export interface DeleteIntegrationRoleUsersResponse {
/**
* 角色id
*/
RoleId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConvertTaskApi请求参数结构体
*/
export interface CreateConvertTaskApiRequest {
/**
* 需要进行转换的资源文件类型
支持的文件类型如下：
<ul><li>doc</li>
<li>docx</li>
<li>xls</li>
<li>xlsx</li>
<li>jpg</li>
<li>jpeg</li>
<li>png</li>
<li>html</li>
<li>bmp</li>
<li>txt</li></ul>
*/
ResourceType: string;
/**
* 需要进行转换操作的文件资源名称，带资源后缀名。
注: `资源名称长度限制为256个字符`
*/
ResourceName: string;
/**
* 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
注: `目前，此接口仅支持单个文件进行转换。`
*/
ResourceId: string;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator?: UserInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 暂未开放
* @deprecated
*/
Organization?: OrganizationInfo;
}
/**
* DeleteIntegrationEmployees返回参数结构体
*/
export interface DeleteIntegrationEmployeesResponse {
/**
* 员工删除结果。包含成功数据与失败数据。
<ul><li>**成功数据**：展示员工姓名、手机号与电子签平台UserId</li>
<li>**失败数据**：展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
*/
DeleteEmployeeResult?: DeleteStaffsResult;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 需要进行签署审核的签署人信息
*/
export interface NeedReviewApproverInfo {
/**
* 签署方经办人的类型，支持以下类型
<ul><li> ORGANIZATION 企业（含企业自动签）</li>
<li>PERSON 个人（含个人自动签）</li></ul>
*/
ApproverType: string;
/**
* 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
*/
ApproverName: string;
/**
* 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
*/
ApproverMobile?: string;
/**
* 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li>
<li>OTHER_CARD_TYPE 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
*/
ApproverIdCardType?: string;
/**
* 签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
*/
ApproverIdCardNumber?: string;
/**
* 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
*/
OrganizationName?: string;
}
/**
* CreateFlowGroupSignReview返回参数结构体
*/
export interface CreateFlowGroupSignReviewResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBatchSignUrl返回参数结构体
*/
export interface CreateBatchSignUrlResponse {
/**
* 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
注:
1. 非小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
*/
SignUrl?: string;
/**
* 链接过期时间以 Unix 时间戳格式表示，默认生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
*/
ExpiredTime?: number;
/**
* 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
注:
1. 小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
*/
MiniAppPath?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFlowReminds返回参数结构体
*/
export interface CreateFlowRemindsResponse {
/**
* 合同催办结果的详细信息列表。
*/
RemindFlowRecords?: Array<RemindFlowRecords>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationGroupOrganizations请求参数结构体
*/
export interface DescribeOrganizationGroupOrganizationsRequest {
/**
* 执行本接口操作的员工信息,userId必填。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
*/
Operator: UserInfo;
/**
* 指定分页每页返回的数据条数，单页最大1000
*/
Limit: number;
/**
* 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
*/
Offset: number;
/**
* 查询成员企业的企业名，模糊匹配
*/
Name?: string;
/**
* 成员企业加入集团的当前状态
<ul><li> **1**：待授权</li>
<li> **2**：已授权待激活</li>
<li> **3**：拒绝授权</li>
<li> **4**：已解除</li>
<li> **5**：已加入</li>
</ul>
*/
Status?: number;
/**
* 是否导出当前成员企业数据
<ul><li> **false**：不导出（默认值）</li>
<li> **true**：导出</li></ul>
*/
Export?: boolean;
/**
* 成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取
*/
Id?: string;
}
/**
* 代理相关应用信息，如集团主企业代子企业操作
*/
export interface Agent {
/**
* 代理机构的应用编号,32位字符串，一般不用传
* @deprecated
*/
AppId?: string;
/**
* 被代理机构的应用号，一般不用传
* @deprecated
*/
ProxyAppId?: string;
/**
* 被代理机构在电子签平台的机构编号，集团代理下场景必传
*/
ProxyOrganizationId?: string;
/**
* 被代理机构的经办人，一般不用传
* @deprecated
*/
ProxyOperator?: string;
}
/**
* DescribeUserAutoSignStatus返回参数结构体
*/
export interface DescribeUserAutoSignStatusResponse {
/**
* 查询用户是否已开通自动签
*/
IsOpen?: boolean;
/**
* 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
*/
LicenseFrom?: number;
/**
* 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
*/
LicenseTo?: number;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul>
*/
LicenseType?: number;
/**
* 用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。
*/
SealId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 签署人详情信息
*/
export interface FlowApproverDetail {
/**
* 签署时的相关信息
*/
ApproveMessage?: string;
/**
* 签署方姓名
*/
ApproveName?: string;
/**
* 签署方的签署状态
0：还没有发起
1：流程中 没有开始处理
2：待签署
3：已签署
4：已拒绝
5：已过期
6：已撤销
7：还没有预发起
8：待填写
9：因为各种原因而终止
10：填写完成
15：已解除
19：转他人处理
*/
ApproveStatus?: number;
/**
* 模板配置中的参与方ID,与控件绑定
* @deprecated
*/
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;
}
/**
* CreateFlowGroupByFiles请求参数结构体
*/
export interface CreateFlowGroupByFilesRequest {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
FlowGroupName: string;
/**
* 合同（流程）组的子合同信息，支持2-50个子合同
*/
FlowGroupInfos: Array<FlowGroupInfo>;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
/**
* 合同（流程）组的配置项信息。
其中包括：
<ul>
<li>是否通知本企业签署方</li>
<li>是否通知其他签署方</li>
</ul>
*/
FlowGroupOptions?: FlowGroupOptions;
}
/**
* DescribeFlowComponents返回参数结构体
*/
export interface DescribeFlowComponentsResponse {
/**
* 合同流程关联的填写控件信息，包括填写控件的归属方以及是否填写等内容。
*/
RecipientComponentInfos?: Array<RecipientComponentInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFlowEvidenceReport返回参数结构体
*/
export interface DescribeFlowEvidenceReportResponse {
/**
* 出证报告PDF的下载 URL，`有效期为5分钟`，超过有效期后将无法再下载。
*/
ReportUrl?: string;
/**
* 出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
*/
Status?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateWebThemeConfig请求参数结构体
*/
export interface CreateWebThemeConfigRequest {
/**
* 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 主题类型，取值如下：
<ul><li> **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置</li>
</ul>
*/
ThemeType: string;
/**
* 电子签logo是否展示，主体颜色等配置项
*/
WebThemeConfig: WebThemeConfig;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
Agent?: Agent;
}
/**
* 企业应用回调信息
*/
export interface CallbackInfo {
/**
* 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
*/
CallbackUrl: string;
/**
* 回调加密key，已废弃
* @deprecated
*/
Token?: string;
/**
* 回调加密key，用于回调消息加解密。
*/
CallbackKey?: string;
/**
* 回调验签token，用于回调通知校验。
*/
CallbackToken?: string;
}
/**
* DescribeSignFaceVideo请求参数结构体
*/
export interface DescribeSignFaceVideoRequest {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
Operator: UserInfo;
/**
* 合同流程ID，为32位字符