/**
 * CreateOrganizationGroupInvitationLink请求参数结构体
 */
export interface CreateOrganizationGroupInvitationLinkRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 到期时间（以秒为单位的时间戳），其上限为30天的有效期限。
     */
    ExpireTime: number;
}
/**
 * DescribeCancelFlowsTask返回参数结构体
 */
export interface DescribeCancelFlowsTaskResponse {
    /**
     * <p>批量撤销任务编号，为32位字符串，通过接口<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl">获取批量撤销签署流程腾讯电子签小程序链接</a>获得。</p>
     */
    TaskId?: string;
    /**
     * <p>任务状态，需要关注的状态</p><ul><li>**PROCESSING**  - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
     */
    TaskStatus?: string;
    /**
     * <p>批量撤销成功的签署流程编号</p>
     */
    SuccessFlowIds?: Array<string>;
    /**
     * <p>批量撤销失败的签署流程信息</p>
     */
    FailureFlows?: Array<CancelFailureFlow>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSeal请求参数结构体
 */
export interface CreateSealRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>电子印章名字，1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
     */
    SealName: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>电子印章生成方式</p><ul><li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li><li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li></ul>
     */
    GenerateSource?: string;
    /**
     * <p>电子印章类型 , 可选类型如下: <ul><li><strong>OFFICIAL</strong>: (默认)公章</li><li><strong>CONTRACT</strong>: 合同专用章;</li><li><strong>FINANCE</strong>: 财务专用章;</li><li><strong>PERSONNEL</strong>: 人事专用章</li><li><strong>INVOICE</strong>: 发票专用章</li><li><strong>OTHER</strong>: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错</p>
     */
    SealType?: string;
    /**
     * <p>电子印章图片文件名称，1-50个中文字符。</p>
     */
    FileName?: string;
    /**
     * <p>电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式</p><p>注: <code>通过图片创建的电子印章，需电子签平台人工审核</code></p>
     */
    Image?: string;
    /**
     * <p>电子印章宽度,单位px<br>参数不再启用，系统会设置印章大小为标准尺寸。</p>
     */
    Width?: number;
    /**
     * <p>电子印章高度,单位px<br>参数不再启用，系统会设置印章大小为标准尺寸。</p>
     */
    Height?: number;
    /**
     * <p>电子印章印章颜色(默认红色RED),RED-红色</p><p>系统目前只支持红色印章创建。</p>
     */
    Color?: string;
    /**
     * <p>企业印章横向文字，最多可填15个汉字  (若超过印章最大宽度，优先压缩字间距，其次缩小字号)<br>横向文字的位置如下图中的&quot;印章横向文字在这里&quot;</p><p><img src="https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png" alt="image"></p>
     */
    SealHorizontalText?: string;
    /**
     * <p>暂时不支持下弦文字设置</p>
     */
    SealChordText?: string;
    /**
     * <p>系统生成的印章只支持：STAR</p>
     */
    SealCentralType?: string;
    /**
     * <p>通过文件上传时，服务端生成的电子印章上传图片的token</p>
     */
    FileToken?: string;
    /**
     * <p>印章样式, 可以选择的样式如下: </p><ul><li>**circle**:(默认)圆形印章</li><li>**ellipse**:椭圆印章</li></ul>
     */
    SealStyle?: string;
    /**
     * <p>印章尺寸，格式为 宽_高（单位：mm，整数），用于签署时按物理尺寸将印章加盖到PDF。<br>取值范围：<br> • 图片上传印章（Image 或 FileToken 非空时生效）：支持自定义尺寸，宽、高均为 10-100 的整数（即 1cm-10cm），宽高比（宽/高）需在 0.1-10 之间。<br>• 系统生成印章（未传 Image 与 FileToken）：仅支持与SealStyle 匹配的固定枚举值：<br>  - 圆形印章（SealStyle=cycle）：38_38 / 40_40 / 42_42 / 45_45 / 50_50 / 58_58<br>  - 椭圆印章（SealStyle=ellipse）：40_30 / 45_30<br>字段依赖关系：<br> • 与 SealStyle关联：仅系统生成印章场景下 SealStyle 生效，此时 SealSize 需与 SealStyle对应的枚举匹配；图片上传印章场景 SealStyle 会被忽略，SealSize支持自定义。<br> • 与 SealType 关联：公章/合同章仅支持圆形枚举，财务/人事/其它章支持圆形或椭圆枚举。<br>• 与 Image / FileToken 关联：SealSize 是加盖到 PDF的物理尺寸，与上传图片的像素分辨率无绑定，图片会按 SealSize 缩放渲染；建议上传图片的宽高比与 SealSize 保持一致，避免拉伸形变。</p>
     */
    SealSize?: string;
    /**
     * <p>企业税号<br>注:</p><ul><li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li><li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li></ul>
     */
    TaxIdentifyCode?: string;
    /**
     * <p>印章描述内容</p>
     */
    SealDescription?: string;
    /**
     * <p>个性化配置字段，默认不传。</p>
     */
    Options?: Array<Option>;
}
/**
 * ModifyIntegrationDepartment返回参数结构体
 */
export interface ModifyIntegrationDepartmentResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CancelFlow返回参数结构体
 */
export interface CancelFlowResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 集成版员工部门信息。
 */
export interface Department {
    /**
     * 部门ID。
     */
    DepartmentId?: string;
    /**
     * 部门名称。
     */
    DepartmentName?: string;
}
/**
 * DescribeContractReviewWebUrl请求参数结构体
 */
export interface DescribeContractReviewWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同审查任务ID，该参数通过调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreateContractReviewWebUrl" target="_blank">创建合同审查web页面</a>获取。
     */
    TaskId: string;
}
/**
 * DescribeInformationExtractionTask请求参数结构体
 */
export interface DescribeInformationExtractionTaskRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 合同智能提取任务ID，该参数通过调用接口[批量创建合同智能提取任务接口](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/CreateBatchInformationExtractionTask)获取。
     */
    TaskId?: string;
}
/**
 * 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;
}
/**
 * DisableUserAutoSign请求参数结构体
 */
export interface DisableUserAutoSignRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey: string;
    /**
     * <p>需要关闭自动签的个人的信息，如姓名，证件信息等。</p>
     */
    UserInfo: UserThreeFactor;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * UploadFiles请求参数结构体
 */
export interface UploadFilesRequest {
    /**
     * <p>文件对应业务类型,可以选择的类型如下<ul><li> <strong>TEMPLATE</strong> : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li> <strong>DOCUMENT</strong> : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li> <strong>SEAL</strong> : 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li> <strong>ARCHIVE</strong> : 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li></ul>   [&quot;yDRSRUUgygj6rq2wUuO4zjEyBZ2NHiyT&quot;]</p><p>枚举值：</p><ul><li>TEMPLATE： 此上传的文件用户生成合同模板</li><li>DOCUMENT： 此文件用来发起合同流程</li><li>SEAL： 此文件用于印章的生成</li><li>ARCHIVE： 此文件用于归档文件夹</li></ul>
     */
    BusinessType: string;
    /**
     * <p>执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Caller?: Caller;
    /**
     * <p>请上传文件内容数组，最多可上传20个文件。</p><p><b>所有文件必须符合<font color="red">FileType</font>指定的文件类型。</b></p>
     */
    FileInfos?: Array<UploadFile>;
    /**
     * <p>文件类型， 默认通过文件内容和文件后缀一起解析得到文件类型，调用接口时可以显示的指定上传文件的类型。<br>可支持的指定类型如下:</p><ul><li>pdf</li><li>doc</li><li>docx</li><li>xls</li><li>xlsx</li><li>html</li><li>jpg</li><li>jpeg</li><li>png</li></ul>如：pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
     */
    FileType?: string;
    /**
     * <p>此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。</p><ul><li>**true**：将灰色矩阵置为白色。</li><li>**false**：无需处理，不会将灰色矩阵置为白色（默认）。</li></ul><p>注: <code>该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。</code></p>
     */
    CoverRect?: boolean;
    /**
     * <p>该字段已不再使用</p>
     */
    CustomIds?: Array<string>;
    /**
     * <p>不再使用，上传文件链接数组，最多支持20个URL</p>
     * @deprecated
     */
    FileUrls?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>文件过期时间的时间戳</p><p>取值范围：[1782835200, 4102329600]</p><p>单位：秒</p><p>设置上传文件的过期时间，此功能为付费能力，请联系电子签运营人员开通</p>
     */
    Deadline?: number;
}
/**
 * CreateFileConvertTask请求参数结构体
 */
export interface CreateFileConvertTaskRequest {
    /**
     * <p>需要进行转换的资源文件类型<br>支持的文件类型如下：</p><p>枚举值：</p><ul><li>doc： doc</li><li>docx： docx</li><li>xls： xls</li><li>xlsx： xlsx</li><li>jpg： jpg</li><li>jpeg： jpeg</li><li>png： png</li><li>html： html</li><li>bmp： bmp</li></ul>
     */
    ResourceType: string;
    /**
     * <p>需要进行转换操作的文件资源名称，带资源后缀名。</p><p>注:  <code>资源名称长度限制为256个字符</code></p>
     */
    ResourceName: string;
    /**
     * <p>需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。</p><p>注:  <code>目前，此接口仅支持单个文件进行转换。</code></p>
     */
    ResourceId: string;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
 */
export interface IntentionQuestionResult {
    /**
     * 视频base64（其中包含全程问题和回答音频，mp4格式）
  
  注：`需进行base64解码获取视频文件`
     */
    Video?: string;
    /**
     *  和答案匹配结果列表
     */
    ResultCode?: Array<string>;
    /**
     * 回答问题语音识别结果列表
     */
    AsrResult?: Array<string>;
}
/**
 * OperateSeals返回参数结构体
 */
export interface OperateSealsResponse {
    /**
     * 人脸验证操作人链接，用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)"，默认为空。
     */
    SealOperatorVerifyPath?: string;
    /**
     * 人脸验证操作人二维码链接，扫码后会跳转到腾讯电子签小程序进行人脸验证，默认为空。
     */
    SealOperatorVerifyQrcodeUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 被授权的用户信息
 */
export interface HasAuthUser {
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
     */
    UserId?: string;
    /**
     * 当前员工的归属情况，可能值是：
  MainOrg：在集团企业的场景下，返回此值代表是归属主企业
  CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业
     */
    BelongTo?: string;
    /**
     * 集团主企业id，当前企业为集团子企业时，该字段有值
     */
    MainOrganizationId?: string;
}
/**
 * CancelUserAutoSignEnableUrl返回参数结构体
 */
export interface CancelUserAutoSignEnableUrlResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateContractDiffTaskWebUrl返回参数结构体
 */
export interface CreateContractDiffTaskWebUrlResponse {
    /**
     * 接口返回的合同对比任务ID，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractDiffTaskWebUrl" target="_blank">获取合同对比结果web页面</a>查看对比任务的结果。
  当`SkipFileUpload`参数为`true`时才会返回值，否则为空。
     */
    TaskId?: string;
    /**
     * 合同对比嵌入式web页面链接，有效期：5分钟
  链接仅能使用一次
     */
    WebUrl?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
     */
    UserData?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * VerifyDigitFile请求参数结构体
 */
export interface VerifyDigitFileRequest {
    /**
     * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 加签接口返回的文件Id
     */
    FileId?: string;
}
/**
 * CreateFlowEvidenceReport请求参数结构体
 */
export interface CreateFlowEvidenceReportRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同流程ID，为32位字符串。<br>可登录腾讯电子签控制台，在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
     */
    FlowId: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>指定申请的报告类型，可选类型如下：<ul><li> <strong>0</strong> :合同签署报告（默认）</li></ul></p><p>枚举值：</p><ul><li>0： 合同签署报告</li></ul>
     */
    ReportType?: number;
    /**
     * <p>混合云模式获取合同文件合并出证，默认：不同意。注：此参数需要联系腾讯电子签运营进行开通后生效</p>
     */
    HybridEvidenceFlowFile?: boolean;
}
/**
 * 模板中指定的印章信息
 */
export interface SealInfo {
    /**
     * 印章ID
     */
    SealId: string;
    /**
     * 印章类型。LEGAL_PERSON_SEAL: 法定代表人章；
  ORGANIZATIONSEAL：企业印章；
  OFFICIAL：企业公章；
  CONTRACT：合同专用章
     */
    SealType: string;
    /**
     * 印章名称
     */
    SealName: string;
}
/**
 * 签署链接信息。
 */
export interface FlowApproverUrlInfo {
    /**
     * 签署短链接。
  注意:
  1. 该链接有效期为<b>30分钟</b>，同时需要注意保密，不要外泄给无关用户。
  2. 该链接不支持小程序嵌入，仅支持<b>移动端浏览器</b>打开。
  3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
     */
    SignUrl?: string;
    /**
     * 签署人类型。
  - **1**: 个人
     */
    ApproverType?: number;
    /**
     * 签署人姓名。
     */
    ApproverName?: string;
    /**
     * 签署人手机号。
     */
    ApproverMobile?: string;
    /**
     * 签署长链接。
  注意:
  1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
  2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
  3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
     */
    LongUrl?: string;
}
/**
 * 需要进行签署审核的签署人信息
 */
export interface NeedReviewApproverInfo {
    /**
     * <p>签署方经办人的类型，支持以下类型</p><ul><li> ORGANIZATION 企业（含企业自动签）</li><li>PERSON 个人（含个人自动签）</li></ul>
     */
    ApproverType: string;
    /**
     * <p>签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。</p>
     */
    ApproverName: string;
    /**
     * <p>签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。</p>
     */
    ApproverMobile?: string;
    /**
     * <p>签署方经办人的证件类型，支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li></ul>
     */
    ApproverIdCardType?: string;
    /**
     * <p>签署方经办人的证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    ApproverIdCardNumber?: string;
    /**
     * <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号()，请使用中文括号（）代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。</p>
     */
    OrganizationName?: 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;
}
/**
 * 归档合同的参与人信息
 */
export interface ArchiveFlowApproverInfo {
    /**
     * <p>个人签署人姓名，如果传入，必须是证件上的真实中文名；中文名最长 25 个字符；</p>
     */
    ApproverName?: string;
    /**
     * <p>参与者类型，用于区分个人或企业，可选类型如下:<br><strong>0</strong>：企业<br><strong>1</strong>：个人</p>
     */
    ApproverType?: number;
    /**
     * <p>企业签署方名称。长度不超过 200 个字符。<br>如果名称中包含英文括号()，请使用中文括号（）代替。<br>如果签署方是企业签署方(approverType = 0 )， 则企业名称必填。</p>
     */
    OrganizationName?: string;
    /**
     * <p>签署人手机号，必须是合法手机号。</p>
     */
    ApproverMobile?: string;
    /**
     * <p>签署人邮箱， 必须是合法邮箱格式。</p>
     */
    ApproverEmail?: string;
    /**
     * <p>签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a></p><ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul>
     */
    ApproverIdCardType?: string;
    /**
     * <p>签署方经办人的证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    ApproverIdCardNumber?: string;
    /**
     * <p>当前参与者的签署时间，Unix 秒级时间戳。</p>
     */
    ApproveTime?: number;
}
/**
 * DescribeUserAutoSignStatus返回参数结构体
 */
export interface DescribeUserAutoSignStatusResponse {
    /**
     * <p>查询用户是否已开通自动签</p>
     */
    IsOpen?: boolean;
    /**
     * <p>自动签许可生效时间。当且仅当已通过许可开通自动签时有值。</p><p>值为unix时间戳,单位为秒。</p>
     */
    LicenseFrom?: number;
    /**
     * <p>自动签许可到期时间。当且仅当已通过许可开通自动签时有值。</p><p>值为unix时间戳,单位为秒。</p>
     */
    LicenseTo?: number;
    /**
     * <p>设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li><strong>0</strong>: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: <code>不可解绑释放更换他人</code></li><li><strong>1</strong>: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul></p>
     */
    LicenseType?: number;
    /**
     * <p>用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。</p>
     */
    SealId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeContractReviewChecklistWebUrl返回参数结构体
 */
export interface DescribeContractReviewChecklistWebUrlResponse {
    /**
     * 嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    WebUrl?: string;
    /**
     * 清单 id
     */
    Id?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 标签
 */
export interface Tag {
    /**
     * 标签键，最大长度不超过50字符。
     */
    TagKey?: string;
    /**
     * 标签值，最大长度不超过50字符。
     */
    TagValue?: string;
}
/**
 * CreateFlowForwards返回参数结构体
 */
export interface CreateFlowForwardsResponse {
    /**
     * 失败的合同id以及错误详情
     */
    FailedFlows?: Array<FlowForwardResult>;
    /**
     * 成功的合同id
     */
    SuccessFlows?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFlowEvidenceReport请求参数结构体
 */
export interface DescribeFlowEvidenceReportRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生</p>
     */
    ReportId: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>指定申请的报告类型，可选类型如下：<ul><li> <strong>0</strong> :合同签署报告（默认）</li></ul></p><p>枚举值：</p><ul><li>0： 合同签署报告</li></ul>
     */
    ReportType?: number;
}
/**
 * ModifyPartnerAuthorization返回参数结构体
 */
export interface ModifyPartnerAuthorizationResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteSealPolicies请求参数结构体
 */
export interface DeleteSealPoliciesRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 印章授权编码数组。这个参数跟下面的SealId其中一个必填，另外一个可选填
     */
    PolicyIds?: Array<string>;
    /**
     * 电子印章ID，为32位字符串。
  建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
  可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
  注：印章ID。这个参数跟上面的PolicyIds其中一个必填，另外一个可选填。
     */
    SealId?: string;
    /**
     * 待授权的员工ID，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
     */
    UserIds?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateFlowGroupByTemplates返回参数结构体
 */
export interface CreateFlowGroupByTemplatesResponse {
    /**
     * 合同(流程)组的合同组Id
     */
    FlowGroupId?: string;
    /**
     * 合同(流程)组中子合同列表.
     */
    FlowIds?: Array<string>;
    /**
     * 合同组签署人信息。
     */
    Approvers?: Array<FlowGroupApprovers>;
    /**
     * FlowGroupNeedWorkflow
     */
    WorkflowInstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 视频认证结果
 */
export interface DetectInfoVideoData {
    /**
     * 活体视频的base64编码，mp4格式
  
  注:`需进行base64解码获取活体视频文件`
     */
    LiveNessVideo?: string;
}
/**
 * 合同审查个性化参数，用于控制页面的展示内容
 */
export interface ContractReviewWebUrlOption {
    /**
     * 禁用暂存。 默认 false，设置为 true 会隐藏界面上的临时保存按钮
     */
    DisableTemporaryStore?: boolean;
    /**
     * 禁用导出。默认 false，设置为 true 会隐藏界面上的导出按钮
     */
    DisableExport?: boolean;
    /**
     * 禁用重新审查。默认 false，设置为 true 会隐藏界面上的重新审查按钮
     */
    DisableReviewAgain?: boolean;
    /**
     * 禁用二维码分享。默认 false，设置为 true 会隐藏界面上的分享二维码
     */
    DisableWxQrcode?: boolean;
}
/**
 * ModifySingleSignOnEmployees返回参数结构体
 */
export interface ModifySingleSignOnEmployeesResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateWebThemeConfig返回参数结构体
 */
export interface CreateWebThemeConfigResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFlowInfo请求参数结构体
 */
export interface DescribeFlowInfoRequest {
    /**
     * <p>执行本接口操作的员工信息。 注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>需要查询的流程ID列表，最多可传入100个ID。<br>如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。</p><p>可登录腾讯电子签控制台，在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
     */
    FlowIds?: Array<string>;
    /**
     * <p>代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。</p>
     */
    FlowGroupId?: string;
}
/**
 * 企业批量注册链接信息
 */
export interface OrganizationAuthUrl {
    /**
     * 企业批量注册链接，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天
  跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
  <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead>  <tbody>
   <tr> <td>PC</td> <td>https://qian.tencent.com/console/batch-register?token=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr>
  <tr> <td>PC_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr>
  <tr> <td>APP</td> <td>/pages/guide/index?to=REGISTER_ENTERPRISE_FOR_BATCH&urlAuthToken=yDSx0UUgtjuaf4UEfd2MjCnfI1iuXFE6&orgName=批量认证线上测试企业9</td> <td>7天</td> </tr> </tbody> </table>
  注：
  `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
  
     */
    AuthUrl?: string;
    /**
     * 企业批量注册的错误信息，例如：企业三要素不通过
     */
    ErrorMessage?: string;
    /**
     * 企业批量注册的唯一 Id， 此 Id 可以用在[创建企业批量认证链接-单链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationAuthorizationUrl)。
     */
    SubTaskId?: string;
    /**
     * 企业批量注册 传递过来的企业名称，方便客户定位企业
     */
    OrganizationName?: string;
}
/**
 * 企业授权书信息参数， 需要保证这些参数跟营业执照中的信息一致。
 */
export interface OrganizationCommonInfo {
    /**
     * 组织机构名称。
  请确认该名称与企业营业执照中注册的名称一致。
  如果名称中包含英文括号()，请使用中文括号（）代替。
     */
    OrganizationName: string;
    /**
     * 组织机构企业统一社会信用代码。
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
     */
    UniformSocialCreditCode: string;
    /**
     * 组织机构法人的姓名。
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
     */
    LegalName: string;
    /**
     * 组织机构法人的证件类型
     */
    LegalIdCardType?: string;
    /**
     * 组织机构法人的证件号码
     */
    LegalIdCardNumber?: string;
    /**
     * 组织机构超管姓名。
  
     */
    AdminName?: string;
    /**
     * 组织机构超管手机号。
  
     */
    AdminMobile?: string;
    /**
     * 组织机构超管证件类型
  
     */
    AdminIdCardType?: string;
    /**
     * 组织机构超管证件号码
  
     */
    AdminIdCardNumber?: string;
    /**
     * 原超管姓名
     */
    OldAdminName?: string;
    /**
     * 原超管手机号
     */
    OldAdminMobile?: string;
    /**
     * 原超管证件类型
     */
    OldAdminIdCardType?: string;
    /**
     * 原超管证件号码
     */
    OldAdminIdCardNumber?: string;
}
/**
 * ArchiveDynamicFlow返回参数结构体
 */
export interface ArchiveDynamicFlowResponse {
    /**
     * 合同流程ID
     */
    FlowId?: string;
    /**
     * 动态签署人的参与人信息
     */
    Approvers?: Array<ArchiveDynamicApproverData>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateLegalSealQrCode请求参数结构体
 */
export interface CreateLegalSealQrCodeRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 机构信息，暂未开放
     * @deprecated
     */
    Organization?: OrganizationInfo;
}
/**
 * DescribeSingleSignOnEmployees请求参数结构体
 */
export interface DescribeSingleSignOnEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)
     */
    SsoApplicationId: string;
    /**
     * 需要查询的单点登录员工的唯一Id 值.不能超过 200 个。
  如果传递了 openIds，limit 和 offset 参数无效，
     */
    OpenIds?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 指定分页每页返回的数据条数，单页最大支持 200。如果不传， 则默认是 20.
     */
    Limit?: number;
    /**
     * OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大20000。 分页参数, 需要limit, offset 配合使用 例如: 您希望得到第三页的数据, 且每页限制最多10条 您可以使用 LIMIT 10 OFFSET 20
     */
    Offset?: number;
}
/**
 * 合同文件验签单个结果结构体
 */
export interface PdfVerifyResult {
    /**
     * 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
     */
    VerifyResult?: number;
    /**
     * 签署平台
  如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
  如果文件不在腾讯电子签平台签署，则为**其他平台**。
     */
    SignPlatform?: string;
    /**
     * 申请证书的主体的名字
  
  如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
  **企业**:  ESS@企业名称@编码
  **个人**: ESS@个人姓名@证件号@808854
  
  如果在其他平台签署的, 主体的名字参考其他平台的说明
     */
    SignerName?: string;
    /**
     * 签署时间的Unix时间戳，单位毫秒
     */
    SignTime?: number;
    /**
     * 证书签名算法,  如SHA1withRSA等算法
     */
    SignAlgorithm?: string;
    /**
     * 在数字证书申请过程中，系统会自动生成一个独一无二的序列号。
     */
    CertSn?: string;
    /**
     * 证书起始时间的Unix时间戳，单位毫秒
     */
    CertNotBefore?: number;
    /**
     * 证书过期时间的时间戳，单位毫秒
     */
    CertNotAfter?: number;
    /**
     * 签名域横坐标，单位px
     */
    ComponentPosX?: number;
    /**
     * 签名域纵坐标，单位px
     */
    ComponentPosY?: number;
    /**
     * 签名域宽度，单位px
     */
    ComponentWidth?: number;
    /**
     * 签名域高度，单位px
     */
    ComponentHeight?: number;
    /**
     * 签名域所在页码，1～N
     */
    ComponentPage?: number;
}
/**
 * CreateUserNameChangeUrl请求参数结构体
 */
export interface CreateUserNameChangeUrlRequest {
    /**
     * 操作人信息
     */
    Operator: UserInfo;
    /**
     * 要跳转的链接类型
  
  <ul>
  <li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
  <li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
  <li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>
  </ul>
  
  注：如果不传递，默认值是 <font color="red"> HTTP </font>
     */
    Endpoint?: string;
    /**
     * 在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
     */
    UserData?: string;
}
/**
 * 企业认证信息
 */
export interface AuthRecord {
    /**
     * 经办人姓名。
     */
    OperatorName?: string;
    /**
     * 经办人手机号。
     */
    OperatorMobile?: string;
    /**
     * 认证授权方式：
  <ul><li> **0**：未选择授权方式（默认值）</li>
  <li> **1**：上传授权书</li>
  <li> **2**：法人授权</li>
  <li> **3**：法人认证</li></ul>
     */
    AuthType?: number;
    /**
     * 企业认证授权书审核状态：
  <ul><li> **0**：未提交授权书（默认值）</li>
  <li> **1**：审核通过</li>
  <li> **2**：审核驳回</li>
  <li> **3**：审核中</li>
  <li> **4**：AI识别中</li>
  <li> **5**：客户确认AI信息</li></ul>
     */
    AuditStatus?: number;
    /**
     * 审核失败原因，
  当 AuditStatus 返回2时，则会返回具体的原因。
     */
    Reason?: string;
}
/**
 * UnbindEmployeeUserIdWithClientOpenId请求参数结构体
 */
export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  
  通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取，也可登录腾讯电子签控制台查看
  ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
     */
    UserId: string;
    /**
     * 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
  该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
     */
    OpenId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateBatchInformationExtractionTask请求参数结构体
 */
export interface CreateBatchInformationExtractionTaskRequest {
    /**
     * <p>执行合同智能提取的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同智能提取的文件资源编号列表，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF、WORD、PNG、JPEG文件资源编号。</p><p>注意：</p><ul><li>此接口仅支持5个文件发起</li><li>PDF、WORD文件限制在10M以内</li><li>PNG、JPEG文件限制在5M以内</li></ul>
     */
    ResourceIds: Array<string>;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>用户配置的合同智能提取字段模板ID，会基于此模板批量创建合同智能提取任务，为32位字符串。<br><a href="https://qcloudimg.tencent-cloud.cn/raw/99008608577532423ea437c7fdbedca1.png">点击查看模板Id在控制台上的位置</a></p><p>注:  <code>此配置优先级最高，设置了模板ID后Fields配置就会无效</code></p>
     */
    FieldTemplateId?: string;
    /**
     * <p>用于合同智能提取的字段信息。</p><p>注意：<code>字段模板优先级最高，如果设置了FieldTemplateId值，此配置就无效</code></p>
     */
    Fields?: Array<ExtractionField>;
}
/**
 * CreateFlowByFiles请求参数结构体
 */
export interface CreateFlowByFilesRequest {
    /**
     * <p>本合同的发起人  <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注： 支持填入集团子公司经办人 userId 代发合同。</p>
     */
    Operator: UserInfo;
    /**
     * <p>自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&amp;)、（+）组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
     */
    FlowName: string;
    /**
     * <p>本合同流程需包含的PDF文件资源编号列表，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。</p><p>注:  <code>目前，此接口仅支持单个文件发起。</code></p>
     */
    FileIds: Array<string>;
    /**
     * <p>合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。</p>
     */
    Approvers?: Array<ApproverInfo>;
    /**
     * <p>合同流程描述信息(可自定义此描述)，最大长度1000个字符。</p>
     */
    FlowDescription?: string;
    /**
     * <p>合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。<br>如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"></p>
     */
    FlowType?: string;
    /**
     * <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>
     */
    Components?: Array<Component>;
    /**
     * <p>合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
     */
    CcInfos?: Array<CcInfo>;
    /**
     * <p>可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：</p><ul><li> **0**：合同发起时通知（默认值）</li><li> **1**：签署完成后通知</li></ul>
     */
    CcNotifyType?: number;
    /**
     * <p>是否为预览模式，取值如下：</p><ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li><li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
     */
    NeedPreview?: boolean;
    /**
     * <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
     */
    PreviewType?: number;
    /**
     * <p>合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。</p>
     */
    Deadline?: number;
    /**
     * <p>合同流程的签署顺序类型：</p><ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
     */
    Unordered?: boolean;
    /**
     * <p>调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。</p>
     */
    RemindedOn?: number;
    /**
     * <p>指定个人签署方查看合同的校验方式<ul><li>   <strong>VerifyCheck</strong>  :（默认）人脸识别,人脸识别后才能查看合同内容 </li><li>   <strong>MobileCheck</strong>  :  手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul></p>
     */
    ApproverVerifyType?: string;
    /**
     * <p>签署方签署控件（印章/签名等）的生成方式：</p><ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li><li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul><p>注：签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5</p>
     */
    SignBeanTag?: number;
    /**
     * <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>
     */
    CustomShowMap?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）  </li><li> **OTHER** :  通用场景</li></ul>注: <code>个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。</code>
     */
    AutoSignScene?: string;
    /**
     * <p>发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：</p><ul><li> **false**：（默认）不需要审批，直接签署。</li><li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>注：<code>此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同</code>
     */
    NeedSignReview?: boolean;
    /**
     * <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>
     */
    FlowDisplayType?: number;
    /**
     * <p>是否开启动态签署合同：<ul><li> <strong>true</strong>：开启动态签署合同，可在发起时可以不传签署人，在签署过程中追加签署人（必须满足：1，发起方企业开启了模块化计费能力；2，发起方企业在企业应用管理中开启了动态签署人2.0能力）    。</li><li> <strong>false</strong>：不开启动态签署合同。</li></ul></p>
     */
    OpenDynamicSignFlow?: boolean;
    /**
     * <p>是否开启发起合同审批，默认：false（不开启），开启后，发起合同（StartFlow），会提交电子签内置的审批流</p>
     */
    Workflow?: boolean;
    /**
     * <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
     */
    FlowOperateLimit?: FlowOperateLimit;
}
/**
 * DescribeContractReviewChecklist请求参数结构体
 */
export interface DescribeContractReviewChecklistRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>需要获取的合同风险审查清单ID</p>
     */
    ChecklistId: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * 电子文档的控件填充信息。按照控件类型进行相应的填充。

当控件的 ComponentType=‘SIGN_SEAL'时，FormField.ComponentValue填入印章id。

* 可用于指定自动签模板未设置自动签印章时，可由接口传入自动签印章
* 若指定的控件上已设置ComponentValue，那以已经设置的ComponentValue为准

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "sealId（印章id）"
}
```

当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "文本内容"
}
```

当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "多行文本内容"
}
```

当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "true"
}
```

当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```

当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue支持填入附件图片或者文件的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
}
```

当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "选择的内容"
}
```
多选需要用“、”分割选项
```
{
    "ComponentId": "componentId1",
    "ComponentValue": "选项1、选项2"
}
```

当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "2023年01月01日"
}
```

当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；

```
FormField输入示例：
{
    "ComponentId": "componentId1",
    "ComponentValue": "广东省深圳市福田区"
}
```

【数据表格传参说明】
当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
输入示例1：

```
{
    "headers":[
        {
            "content":"head1"
        },
        {
            "content":"head2"
        },
        {
            "content":"head3"
        }
    ],
    "rowCount":3,
    "body":{
        "cells":[
            {
                "rowStart":1,
                "rowEnd":1,
                "columnStart":1,
                "columnEnd":1,
                "content":"123"
            },
            {
                "rowStart":2,
                "rowEnd":3,
                "columnStart":1,
                "columnEnd":2,
                "content":"456"
            },
            {
                "rowStart":3,
                "rowEnd":3,
                "columnStart":3,
                "columnEnd":3,
                "content":"789"
            }
        ]
    }
}
```

输入示例2（表格表头宽度比例配置）：

```
{
    "headers":[
        {
            "content":"head1",
            "widthPercent": 30
        },
        {
            "content":"head2",
            "widthPercent": 30
        },
        {
            "content":"head3",
            "widthPercent": 40
        }
    ],
    "rowCount":3,
    "body":{
        "cells":[
            {
                "rowStart":1,
                "rowEnd":1,
                "columnStart":1,
                "columnEnd":1,
                "content":"123"
            },
            {
                "rowStart":2,
                "rowEnd":3,
                "columnStart":1,
                "columnEnd":2,
                "content":"456"
            },
            {
                "rowStart":3,
                "rowEnd":3,
                "columnStart":3,
                "columnEnd":3,
                "content":"789"
            }
        ]
    }
}
```

输入示例3（表格设置字体加粗颜色）：

```
{
    "headers":[
        {
            "content":"head1"
        },
        {
            "content":"head2"
        },
        {
            "content":"head3"
        }
    ],
    "rowCount":3,
    "body":{
        "cells":[
            {
                "rowStart":1,
                "rowEnd":1,
                "columnStart":1,
                "columnEnd":1,
                "content":"123",
                "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
            },
            {
                "rowStart":2,
                "rowEnd":3,
                "columnStart":1,
                "columnEnd":2,
                "content":"456",
                "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
            },
            {
                "rowStart":3,
                "rowEnd":3,
                "columnStart":3,
                "columnEnd":3,
                "content":"789",
                "style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
            }
        ]
    }
}

```

输入示例4（表格设置表头不合成到文件）：

```
{
    "headers": [
        {
            "content": "序号"
        },
        {
            "content": "品牌"
        },
        {
            "content": "商品名称"
        },
        {
            "content": "粒径"
        },
        {
            "content": "规格"
        },
        {
            "content": "数量(包)"
        },
        {
            "content": "重量(吨)"
        }
    ],
    "rowCount": 5,
    "body": {
        "cells": [
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 1,
                "columnEnd": 1,
                "content": "1"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 2,
                "columnEnd": 2,
                "content": "品牌名称1"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 3,
                "columnEnd": 3,
                "content": "商品名称1"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 4,
                "columnEnd": 4,
                "content": "7#"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 5,
                "columnEnd": 5,
                "content": "20"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 6,
                "columnEnd": 6,
                "content": "50"
            },
            {
                "rowStart": 1,
                "rowEnd": 1,
                "columnStart": 7,
                "columnEnd": 7,
                "content": "1.000"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 1,
                "columnEnd": 1,
                "content": "2"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 2,
                "columnEnd": 2,
                "content": "品牌名称2"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 3,
                "columnEnd": 3,
                "content": "商品名称2"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 4,
                "columnEnd": 4,
                "content": "5#"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 5,
                "columnEnd": 5,
                "content": "20"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 6,
                "columnEnd": 6,
                "content": "20"
            },
            {
                "rowStart": 2,
                "rowEnd": 2,
                "columnStart": 7,
                "columnEnd": 7,
                "content": "0.400"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 1,
                "columnEnd": 1,
                "content": "3"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 2,
                "columnEnd": 2,
                "content": "品牌名称3"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 3,
                "columnEnd": 3,
                "content": "商品名称3"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 4,
                "columnEnd": 4,
                "content": "2#"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 5,
                "columnEnd": 5,
                "content": "20"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 6,
                "columnEnd": 6,
                "content": "5"
            },
            {
                "rowStart": 3,
                "rowEnd": 3,
                "columnStart": 7,
                "columnEnd": 7,
                "content": "0.100"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 1,
                "columnEnd": 1,
                "content": "4"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 2,
                "columnEnd": 2,
                "content": "品牌名称4"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 3,
                "columnEnd": 3,
                "content": "商品名称4"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 4,
                "columnEnd": 4,
                "content": "3#"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 5,
                "columnEnd": 5,
                "content": "20"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 6,
                "columnEnd": 6,
                "content": "10"
            },
            {
                "rowStart": 4,
                "rowEnd": 4,
                "columnStart": 7,
                "columnEnd": 7,
                "content": "0.200"
            },
            {
                "rowStart": 5,
                "rowEnd": 5,
                "columnStart": 1,
                "columnEnd": 5,
                "content": "合计"
            },
            {
                "rowStart": 5,
                "rowEnd": 5,
                "columnStart": 6,
                "columnEnd": 6,
                "content": "85"
            },
            {
                "rowStart": 5,
                "rowEnd": 5,
                "columnStart": 7,
                "columnEnd": 7,
                "content": "1.700"
            }
        ]
    },
    "settings": {
        "headerRowDisplay": false
    }
}
```

表格参数说明

| 名称                | 类型    | 描述                                              |
| ------------------- | ------- | ------------------------------------------------- |
| headers             | Array   | 表头：不超过10列，不支持单元格合并，字数不超过100 |
| rowCount            | Integer | 表格内容最大行数                                  |
| cells.N.rowStart    | Integer | 单元格坐标：行起始index                           |
| cells.N.rowEnd      | Integer | 单元格坐标：行结束index                           |
| cells.N.columnStart | Integer | 单元格坐标：列起始index                           |
| cells.N.columnEnd   | Integer | 单元格坐标：列结束index                           |
| cells.N.content     | String  | 单元格内容，字数不超过100                         |
| cells.N.style         | String  | 单元格字体风格配置 ，风格配置的json字符串  如： {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"}      |
| settings            | Object  | 表格全局设定。目前支持设置表头不显示，示例：{"headerRowDisplay":false}                                                         |

表格参数headers说明
widthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35

content String 表头单元格内容，字数不超过100


style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
 */
export interface FormField {
    /**
     * 控件填充vaule，ComponentType和传入值类型对应关系：
  <ul><li> <b>TEXT</b> : 文本内容</li>
  <li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \n 来控制换行位置</li>
  <li> <b>CHECK_BOX</b> : true/false</li>
  <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
  <li> <b>SELECTOR</b> : 选项值</li>
  <li> <b>DYNAMIC_TABLE</b>  - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
  <li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
  </ul>
  
  
  <b>控件值约束说明</b>：
  <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
  
     */
    ComponentValue: string;
    /**
     * 控件id，和ComponentName选择一项传入即可
  
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件ID的方式</a>
     */
    ComponentId?: string;
    /**
     * 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
  
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件名字的方式</a>
     */
    ComponentName?: string;
}
/**
 * OperateSeals请求参数结构体
 */
export interface OperateSealsRequest {
    /**
     * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 操作类型，int，目前支持传入以下类型：
  <ul><li>1：启用印章</li></ul>
  <ul><li>2：停用印章</li></ul>
     */
    Act?: number;
    /**
     * 需要操作的印章ID，数组形式，印章ID可从【web控制台->印章 】获取。
     */
    SealIds?: Array<string>;
    /**
     * 个性化配置字段，默认不传。
     */
    Options?: Array<Option>;
}
/**
 * 企业员工信息。
 */
export interface Staff {
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  注：`创建和更新场景无需填写。`
     */
    UserId?: string;
    /**
     * 显示的用户名/昵称。
     */
    DisplayName?: string;
    /**
     * 用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
     */
    Mobile?: string;
    /**
     * 用户邮箱。
     */
    Email?: string;
    /**
     * 用户在第三方平台ID。
  注：`如需在此接口提醒员工实名，该参数不传。`
     */
    OpenId?: string;
    /**
     * 员工角色信息。
  注：`创建和更新场景无需填写。`
     */
    Roles?: Array<StaffRole>;
    /**
     * 员工部门信息。
     */
    Department?: Department;
    /**
     * 员工是否实名。
  注：`创建和更新场景无需填写。`
     */
    Verified?: boolean;
    /**
     * 员工创建时间戳，单位秒。
  注：`创建和更新场景无需填写。`
     */
    CreatedOn?: number;
    /**
     * 员工实名时间戳，单位秒。
  注：`创建和更新场景无需填写。`
     */
    VerifiedOn?: number;
    /**
     * 员工是否离职：
  <ul><li>**0**：未离职</li><li>**1**：离职</li></ul>
  注：`创建和更新场景无需填写。`
     */
    QuiteJob?: number;
    /**
     * 员工离职交接人用户ID。
  注：`创建和更新场景无需填写。`
     */
    ReceiveUserId?: string;
    /**
     * 员工离职交接人用户OpenId。
  注：`创建和更新场景无需填写。`
     */
    ReceiveOpenId?: string;
    /**
     * 企业微信用户账号ID。
  注：`仅企微类型的企业创建员工接口支持该字段。`
     */
    WeworkOpenId?: string;
}
/**
 * DescribeFileUrls返回参数结构体
 */
export interface DescribeFileUrlsResponse {
    /**
     * <p>文件URL信息；<br>链接不是永久链接,  过期时间受UrlTtl入参的影响,  默认有效期5分钟后,  到期后链接失效。</p>
     */
    FileUrls?: Array<FileUrl>;
    /**
     * <p>URL数量</p>
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同摘要信息
 */
export interface ContractSummaryInfo {
    /**
     * 字段 key
     */
    Key?: string;
    /**
     * 字段值
     */
    Value?: string;
    /**
     * 主体信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Identity?: Identity;
}
/**
 * 解除协议文档中内容信息，包括但不限于：解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。下面各种字段在解除协议中的位置参考：

![image](https://qcloudimg.tencent-cloud.cn/raw/5087164cfe5a15fa3ced3180842d5da9.png)
 */
export interface RelieveInfo {
    /**
     * 解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
     */
    Reason: string;
    /**
     * 解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
  
     */
    RemainInForceItem?: string;
    /**
     * 原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
     */
    OriginalExpenseSettlement?: string;
    /**
     * 原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
     */
    OriginalOtherSettlement?: string;
    /**
     * 其他约定（如约定的与解除协议存在冲突的，以【其他约定】为准），最大支持200个字，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
     */
    OtherDeals?: string;
}
/**
 * CreateBatchAdminChangeInvitationsUrl返回参数结构体
 */
export interface CreateBatchAdminChangeInvitationsUrlResponse {
    /**
     * 批量企业注册链接-单链接包含多条认证流，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天
  跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
  <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead>  <tbody>
   <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr>
  <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr>
  <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>
  注：
  `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
  
     */
    Url?: string;
    /**
     * 链接过期时间，为 7 天后，创建时间，格式为Unix标准时间戳（秒）。
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSingleSignOnEmployees请求参数结构体
 */
export interface CreateSingleSignOnEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 待创建员工的信息最多不超过200个。
  
  注意：
  1. 传递的 openId 不能重复， 且字符不能超过64位。
  2. 传递的手机号不能重复。
  3. 绑定的角色必须存在且不能超过 10 个。
     */
    Employees: Array<SingleSignOnEmployees>;
    /**
     * 单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)
     */
    SsoApplicationId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。
 */
export interface RegistrationOrganizationInfo {
    /**
     * 组织机构名称。
  请确认该名称与企业营业执照中注册的名称一致。
  如果名称中包含英文括号()，请使用中文括号（）代替。
     */
    OrganizationName: string;
    /**
     * 组织机构企业统一社会信用代码。
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
     */
    UniformSocialCreditCode: string;
    /**
     * 组织机构法人的姓名。
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
     */
    LegalName: string;
    /**
     * 组织机构企业注册地址。
  请确认该企业注册地址与企业营业执照中注册的地址一致。
     */
    Address?: string;
    /**
     * 组织机构超管姓名。
  在注册流程中，必须是超管本人进行操作。
  如果法人做为超管管理组织机构,超管姓名就是法人姓名
  如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数。
     */
    AdminName?: string;
    /**
     * 组织机构超管手机号。
  在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。
  如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数
     */
    AdminMobile?: string;
    /**
     * 可选的此企业允许的授权方式, 可以设置的方式有:
  1：上传授权书
  2：法人授权超管
  5：授权书+对公打款
  
  
  注:
  `1. 当前仅支持一种认证方式`
  `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
  `3. 如果当前操作人是法人,则是法人认证`
     */
    AuthorizationTypes?: Array<number | bigint>;
    /**
     * 认证人身份证号，如果入参中传递超管授权书PowerOfAttorneys，则此参数为必填参数
  
     */
    AdminIdCardNumber?: string;
    /**
     * 认证人证件类型
  支持以下类型
  <ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>
  <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
  <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
  
     */
    AdminIdCardType?: string;
    /**
     * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
     */
    BusinessLicense?: string;
    /**
     * 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
  p.s. 如果上传授权书 ，需遵循以下条件
  1. 超管的信息（超管姓名，超管手机号）必须为必填参数。
  2. 超管的个人身份必须在电子签已经实名。
  2. 认证方式AuthorizationTypes必须只能是上传授权书方式
  
     */
    PowerOfAttorneys?: Array<string>;
}
/**
 * 模板对应的合同类型
 */
export interface TemplateUserFlowType {
    /**
     * 合同类型id
     */
    UserFlowTypeId?: string;
    /**
     * 合同类型名称
     */
    Name?: string;
    /**
     * 合同类型的具体描述
     */
    Description?: string;
    /**
     * 每个合同类型绑定的模板数量
     */
    TemplateNum?: number;
}
/**
 * ModifyIntegrationRole请求参数结构体
 */
export interface ModifyIntegrationRoleRequest {
    /**
     * 角色Id，可通过接口 DescribeIntegrationRoles 查询获取
     */
    RoleId: string;
    /**
     * 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
     */
    Name: string;
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  支持填入集团子公司经办人 userId 代发合同。
  
  注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 角色描述，最大长度为50个字符
     */
    Description?: string;
    /**
     * 权限树
     */
    PermissionGroups?: Array<PermissionGroup>;
    /**
     * 集团角色的话，需要传递集团子企业列表，如果是全选，则传1
     */
    SubOrganizationIds?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 删除员工的成功数据
 */
export interface SuccessDeleteStaffData {
    /**
     * 员工名
     */
    DisplayName?: string;
    /**
     * 员工手机号
     */
    Mobile?: string;
    /**
     * 员工在电子签平台的id
     */
    UserId?: string;
}
/**
 * DescribeUserVerifyStatus请求参数结构体
 */
export interface DescribeUserVerifyStatusRequest {
    /**
     * 用户信息
     */
    Operator: UserInfo;
    /**
     * 姓名
     */
    Name: string;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    IdCardNumber: string;
    /**
     * 证件类型，支持以下类型
  <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
  <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
  <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
     */
    IdCardType: string;
}
/**
 * 批量补充签署人时，补充失败的报错说明
 */
export interface FillError {
    /**
     * 为签署方经办人在签署合同中的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。与入参中补充的签署人角色ID对应，批量补充部分失败返回对应的错误信息。
     */
    RecipientId?: string;
    /**
     * 补充失败错误说明
     */
    ErrMessage?: string;
    /**
     * 合同流程ID，为32位字符串。
     */
    FlowId?: string;
}
/**
 * CancelOrganizationFlows请求参数结构体
 */
export interface CancelOrganizationFlowsRequest {
    /**
     * <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
     */
    Operator: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。 备注:<code>如果不传递撤回原因，那么默认撤回原因是 &quot;自动撤销（通过接口实现）&quot;</code></p>
     */
    CancelMessage?: string;
    /**
     * <p>撤销理由自定义格式,  会展示在合同预览的界面中,  可以选择下面的组合方式：<strong>0</strong> : 默认格式,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> :  合同封面页面会展示为:  发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称,  合同封面页面会展示为:  发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值：</p><ul><li>0： 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同</li><li>1： 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同</li><li>2： 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同</li><li>3： 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由</li></ul>
     */
    CancelMessageFormat?: number;
}
/**
 * 创建员工的结果
 */
export interface CreateStaffResult {
    /**
     * 创建员工的成功列表
     */
    SuccessEmployeeData?: Array<SuccessCreateStaffData>;
    /**
     * 创建员工的失败列表
     */
    FailedEmployeeData?: Array<FailedCreateStaffData>;
}
/**
 * 流程中参与方的信息结构
 */
export interface Recipient {
    /**
     * 签署参与者ID，唯一标识
     */
    RecipientId?: string;
    /**
     * 参与者类型。
  默认为空。
  ENTERPRISE-企业；
  INDIVIDUAL-个人；
  PROMOTER-发起方
     */
    RecipientType?: string;
    /**
     * 描述信息
     */
    Description?: string;
    /**
     * 角色名称
     */
    RoleName?: string;
    /**
     * 是否需要验证，
  默认为false-不需要验证
     */
    RequireValidation?: boolean;
    /**
     * 是否需要签署，
  默认为true-需要签署
     */
    RequireSign?: boolean;
    /**
     * 此参与方添加的顺序，从0～N
     */
    RoutingOrder?: number;
    /**
     * 是否需要发送，
  默认为true-需要发送
     */
    RequireDelivery?: boolean;
    /**
     * 邮箱地址
     */
    Email?: string;
    /**
     * 电话号码
     */
    Mobile?: string;
    /**
     * 关联的用户ID，电子签系统的用户ID
     */
    UserId?: string;
    /**
     * 发送方式，默认为EMAIL。
  EMAIL-邮件；
  MOBILE-手机短信；
  WECHAT-微信通知
     */
    DeliveryMethod?: string;
    /**
     * 参与方的一些附属信息，json格式
     */
    RecipientExtra?: string;
    /**
     * 签署人查看合同校验方式, 支持的类型如下:
  <ul><li> 1 :实名认证查看</li>
  <li> 2 :手机号校验查看</li></ul>
     */
    ApproverVerifyTypes?: Array<number | bigint>;
    /**
     * 签署人进行合同签署时的认证方式，支持的类型如下:
  <ul><li> 1 :人脸认证</li>
  <li> 2 :签署密码</li>
  <li> 3 :运营商三要素认证</li>
  <li> 4 :UKey认证</li>
  <li> 5 :设备指纹识别</li>
  <li> 6 :设备面容识别</li></ul>
     */
    ApproverSignTypes?: Array<number | bigint>;
    /**
     * 签署方是否可以转他人处理
  
  <ul><li> **false** : ( 默认)可以转他人处理</li>
  <li> **true** :不可以转他人处理</li></ul>
     */
    NoTransfer?: boolean;
}
/**
 * VerifyPdf请求参数结构体
 */
export interface VerifyPdfRequest {
    /**
     * 合同流程ID，为32位字符串。
  可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
     */
    FlowId: string;
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 绑定角色失败信息
 */
export interface FailedCreateRoleData {
    /**
     * 用户userId
     */
    UserId?: string;
    /**
     * 角色id列表
     */
    RoleIds?: Array<string>;
}
/**
 * CreateEmployeeChangeUrl请求参数结构体
 */
export interface CreateEmployeeChangeUrlRequest {
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>待修改的员工UserId</p>
     */
    UserId?: string;
    /**
     * <p>待修改的员工手机号</p>
     */
    NewMobile?: string;
}
/**
 * DescribeSingleSignOnEmployees返回参数结构体
 */
export interface DescribeSingleSignOnEmployeesResponse {
    /**
     * 单点登录企业员工信息
     */
    Employees?: Array<SingleSignOnEmployees>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 信息提取结果字段反馈错误原因
 */
export interface FeedbackInfoReason {
    /**
     * 反馈信息提取错误原因。
  `值如下`：
  - 1: 提取错误(提取不精准、提取为空等)
  - 2: 其他错误
     */
    ReasonType?: number;
    /**
     * 反馈提取错误详细错误原因，不能超过500个字符
     */
    ReasonContent?: string;
}
/**
 * 坐标详情
 */
export interface PositionInfo {
    /**
     * PDF文件页X坐标位置,以PDF单页左上角为坐标原点，单位是 “点”（Point，简称 pt）
     */
    X?: number;
    /**
     * PDF文件页Y坐标位置,以PDF单页左上角为坐标原点，单位是 “点”（Point，简称 pt）
     */
    Y?: number;
    /**
     * 距离X坐标的宽度，用于在PDF文件进行画框，单位是 “点”（Point，简称 pt）
     */
    Width?: number;
    /**
     * 距离Y坐标的高度，用于在PDF文件进行画框，单位是 “点”（Point，简称 pt）
     */
    Height?: number;
    /**
     * PDF文件页码索引，此值加1就是对应PDF文件的页码。
     */
    PageIndex?: number;
    /**
     * 系统生成的唯一ID值
     */
    Id?: string;
    /**
     * 开始位置
     */
    Begin?: number;
    /**
     * 结束位置
     */
    End?: number;
    /**
     * 文档类型，1：pdf，2：doc 文档
     */
    DocType?: number;
}
/**
 * CreateUserAutoSignEnableUrl请求参数结构体
 */
export interface CreateUserAutoSignEnableUrlRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey: string;
    /**
     * <p>自动签开通配置信息, 包括开通的人员的信息等</p>
     */
    AutoSignConfig: AutoSignConfig;
    /**
     * <p>生成的链接类型：</p><ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li><li> **H5SIGN** : 生成H5端开通链接</li></ul>
     */
    UrlType?: string;
    /**
     * <p>是否通知开通方，通知类型:<ul><li>默认为不通知开通方</li><li><strong>SMS</strong> :  短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul></p>
     */
    NotifyType?: string;
    /**
     * <p>如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项</p>
     */
    NotifyAddress?: string;
    /**
     * <p>链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。<code>如果不传，默认过期时间为当前时间往后7天。</code></p>
     */
    ExpiredTime?: number;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。</p>
     */
    UserData?: string;
    /**
     * <p>要跳转的链接类型<ul><li> <strong>HTTP</strong>：跳转电子签小程序或者H5的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链</li><li><strong>HTTP_SHORT_URL</strong>：跳转电子签小程序或者H5的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li><strong>APP</strong>： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型，注意：仅UrlType为空，即获取小程序端开通链接时有效</li></ul></p>
     */
    EndPoint?: string;
}
/**
 * CreateBatchOrganizationRegistrationTasks请求参数结构体
 */
export interface CreateBatchOrganizationRegistrationTasksRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 组织机构注册信息。
  一次最多支持10条认证流
     */
    RegistrationOrganizations: Array<RegistrationOrganizationInfo>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 要生成链接的类型, 可以选择的值如下:
  
  <ul>
  <li>(默认)PC: 生成PC端的链接</li>
  <li>SHORT_URL: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
  <li>APP：生成小程序跳转链接</li>
  <li>H5：生成H5跳转长链接</li>
  <li>SHORT_H5：生成H5跳转短链</li>
  </ul>
     */
    Endpoint?: string;
    /**
     * 认证链接使用单链接还是多链接模式
  
  <ul>
  <li>0 - 多链接(默认)，指批量生成链接， 每一个企业会拥有一个认证链接，然后分别认证</li>
  <li>1 - 单链接 ， 指批量生成链接，然后会将多个链接聚合成一个链接，进行认证</li>
  </ul>
  
  p.s.
  请注意， 如果使用单链接的模式并且认证方式是授权书方式的时候，必须在接口中传递超管授权书。
     */
    BatchAuthMethod?: number;
}
/**
 * CreateContractComparisonTask请求参数结构体
 */
export interface CreateContractComparisonTaskRequest {
    /**
     * <p>执行合同审查任务的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>原版文件ID，对比基准的旧版本文件唯一标识，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。</p>
     */
    OriginFileResourceId: string;
    /**
     * <p>新版文件ID，与旧版进行对比的新版本文件唯一标识，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。</p>
     */
    DiffFileResourceId: string;
    /**
     * <p>对比任务备注，长度不能超过50个字符。</p>
     */
    Comment?: string;
    /**
     * <p>调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。</p><p>在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。</p>
     */
    Tags?: Array<Tag>;
    /**
     * <p>文档修订操作类型，对比任务执行前处理修订内容，适用于doc、docx存在修订情况。<br> 类型如下： <ul> <li> <strong>0</strong>：不做任何操作</li> <li> <strong>1</strong>：接受所有修订</li> </ul></p>
     */
    RevisionOperation?: number;
}
/**
 * DescribeBatchOrganizationRegistrationTasks返回参数结构体
 */
export interface DescribeBatchOrganizationRegistrationTasksResponse {
    /**
     * 企业批量任务状态明细
     */
    Details?: Array<BatchOrganizationRegistrationTasksDetails>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreatePrepareFlow返回参数结构体
 */
export interface CreatePrepareFlowResponse {
    /**
     * 发起流程的web页面链接，有效期5分钟
     */
    Url?: string;
    /**
     * 创建的合同id（还未实际发起），每次调用会生成新的id，用户可以记录此字段对应后续页面发起的合同，若在页面上未成功发起，则此字段无效。
     */
    FlowId?: string;
    /**
     * 临时的草稿id（还未实际保存草稿），用户可以记录此字段对应后续页面保存的草稿，若在页面上未保存草稿，则此字段无效。
     */
    DraftId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeOrganizationVerifyStatus请求参数结构体
 */
export interface DescribeOrganizationVerifyStatusRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CancelMultiFlowSignQRCode请求参数结构体
 */
export interface CancelMultiFlowSignQRCodeRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode/)返回
     */
    QrCodeId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 审查通过项对应的引文信息
 */
export interface OutputReference {
    /**
     * 合同审查风险结果ID
     */
    RiskId?: string;
    /**
     * 风险名称
     */
    RiskName?: string;
    /**
     * 风险描述
     */
    RiskDescription?: string;
    /**
     * 风险要点分类名称
     */
    CategoryName?: string;
    /**
     * 审查依据
     */
    RiskBasis?: string;
    /**
     * 引文内容
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Excerpts?: Array<ReferenceExcerpt>;
}
/**
 * CreateSeal返回参数结构体
 */
export interface CreateSealResponse {
    /**
     * <p>电子印章ID，为32位字符串。<br>建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台，在 &quot;印章&quot;-&gt;&quot;印章中心&quot;选择查看的印章，在&quot;印章详情&quot; 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
     */
    SealId?: string;
    /**
     * <p>电子印章预览链接地址，地址默认失效时间为24小时。</p>
     */
    ImageUrl?: string;
    /**
     * <p>人脸验证操作人链接，用法可以参考&quot;<a href="https://qian.tencent.com/developers/company/openwxminiprogram/">跳转电子签小程序配置</a>&quot;，默认为空。</p>
     */
    SealOperatorVerifyPath?: string;
    /**
     * <p>人脸验证操作人二维码链接，扫码后会跳转到腾讯电子签小程序进行人脸验证，默认为空。</p>
     */
    SealOperatorVerifyQrcodeUrl?: string;
    /**
     * <p>创建印章预览逻辑，返回的是印章加盖在示例文件上的效果图片链接。链接有效期为90天。</p>
     */
    PreviewFileUrl?: string;
    /**
     * <p>创建印章预览逻辑，返回的是印章加盖在示例文件上的效果PDF文件链接。链接有效期为90天。</p>
     */
    PreviewPdfUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 小程序发起合同可选项
 */
export interface MiniAppCreateFlowOption {
    /**
     * 到期提醒日（linux时间戳） 精确到天
     */
    RemindedOn?: number;
    /**
     * 是否需要发起前进行审批
     */
    NeedCreateReview?: boolean;
    /**
     * 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：  <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
     */
    FlowDisplayType?: number;
    /**
     * 小程序集成发起，是否禁止发起时修改合同内容
  <ul>
  <li>false：默认值，不禁止发起时修改合同内容</li>
  <li>true：禁止发起时修改合同内容（将直接跳过添加/编辑签署人步骤，直接到核对合同信息页面</li>
  </ul>
  指定为true，效果如下：
  
  效果如下:![ForbidEditFlow](https://qcloudimg.tencent-cloud.cn/raw/2440eca624f2f6730fecbf69daad0533.jpg)
  
     */
    ForbidEditFlow?: boolean;
}
/**
 * CreateFlowGroupReminds请求参数结构体
 */
export interface CreateFlowGroupRemindsRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同(流程)组的合同组Id</p>
     */
    FlowGroupId: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * VerifyDigitalDataSign请求参数结构体
 */
export interface VerifyDigitalDataSignRequest {
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 加签原文
     */
    PlainText?: string;
    /**
     * 签名值
     */
    SignValue?: string;
}
/**
 * 部门信息
 */
export interface IntegrationDepartment {
    /**
     * 部门ID。
     */
    DeptId?: string;
    /**
     * 部门名。
     */
    DeptName?: string;
    /**
     * 父部门ID
     */
    ParentDeptId?: string;
    /**
     * 客户系统部门ID
     */
    DeptOpenId?: string;
    /**
     * 序列号。
     */
    OrderNo?: number;
}
/**
 * DescribeIntegrationRoles返回参数结构体
 */
export interface DescribeIntegrationRolesResponse {
    /**
     * OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0, 最大为2000
  分页参数, 需要limit, offset 配合使用
  例如:
  您希望得到第三页的数据, 且每页限制最多10条
  您可以使用 LIMIT 10 OFFSET 20
     */
    Offset?: number;
    /**
     * 指定分页每页返回的数据条数，单页最大支持 200。
     */
    Limit?: number;
    /**
     * 符合查询条件的总角色数。
     */
    TotalCount?: number;
    /**
     * 企业角色信息列表。
     */
    IntegrateRoles?: Array<IntegrateRole>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyExtendedService返回参数结构体
 */
export interface ModifyExtendedServiceResponse {
    /**
     * 操作跳转链接
  <ul>
  <li><strong>有效期：</strong> 跳转链接的有效期为24小时。</li>
  <li><strong>无跳转链接返回的情况：</strong> 如果在操作过程中没有返回跳转链接，这意味着无需进行跳转操作。在这种情况下，服务将会直接被开通或关闭。
  <li><strong>有跳转链接返回的情况：</strong> 当操作类型为“OPEN”（开通服务），并且扩展服务类型为以下之一时，  系统将返回一个操作链接。当前操作人（超级管理员或法人）需要点击此链接，以完成服务的开通操作。
  
  <ul>
  <li><strong>OPEN_SERVER_SIGN</strong>（企业自动签署）</li>
  </ul></li></li>
  </ul>
     */
    OperateUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeBillUsageDetail返回参数结构体
 */
export interface DescribeBillUsageDetailResponse {
    /**
     * 总数
     */
    Total?: number;
    /**
     * 消耗详情
     */
    Details?: Array<BillUsageDetail>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同摘要
 */
export interface ContractSummary {
    /**
     * 提取内容分类：
  Base 合同信息
  Identity 主体信息
  Performance 履约条款
     */
    Name?: string;
    /**
     * 详细信息
     */
    Infos?: Array<ContractSummaryInfo>;
}
/**
 * DescribeFlowBriefs返回参数结构体
 */
export interface DescribeFlowBriefsResponse {
    /**
     * 合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。
  注：`与入参 FlowIds 的顺序可能存在不一致的情况。`
     */
    FlowBriefs?: Array<FlowBrief>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeRiskIdentificationTaskFeedback请求参数结构体
 */
export interface DescribeRiskIdentificationTaskFeedbackRequest {
    /**
     * 执行合同审查任务的员工信息。
     */
    Operator: UserInfo;
    /**
     * 合同审查任务ID，该参数通过调用接口[批量创建合同智能提取任务](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/CreateBatchInformationExtractionTask)获取。
     */
    TaskId?: string;
}
/**
 * CreateBatchAdminChangeInvitations请求参数结构体
 */
export interface CreateBatchAdminChangeInvitationsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 组织机构超管变更信息。
  一次最多支持10条超管变更信息。
     */
    AdminChangeInvitationInfos: Array<AdminChangeInvitationInfo>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DescribeFlowTemplates返回参数结构体
 */
export interface DescribeFlowTemplatesResponse {
    /**
     * <p>模板详情列表数据</p>
     */
    Templates?: Array<TemplateInfo>;
    /**
     * <p>查询到的模板总数</p>
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 引用的资料
 */
export interface ReferenceExcerpt {
    /**
     * 原文内容
     */
    Content?: string;
    /**
     * 坐标信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Position?: PositionInfo;
}
/**
 * DescribePersonCertificate请求参数结构体
 */
export interface DescribePersonCertificateRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 个人用户的三要素信息：
  <ul><li>姓名</li>
  <li>证件号</li>
  <li>证件类型</li></ul>
     */
    UserInfo: UserThreeFactor;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 证书使用场景，可以选择的场景值如下:
  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey?: string;
}
/**
 * 合同对比差异结果详情。
 */
export interface ComparisonDetail {
    /**
     * 合同对比差异点唯一ID。
     */
    ComparisonPointId?: string;
    /**
     * 对比前后差异类型，具体如下：
  <ul><li> **add**：新增</li>
  <li> **change**：变更</li>
  <li> **delete**：删除</li>
  </ul>
     */
    ComparisonType?: string;
    /**
     * 对比内容类型，具体如下：
  <ul><li> **text**：文本</li>
  <li> **table**：表格</li>
  <li> **picture**：图片</li>
  </ul>
     */
    ContentType?: string;
    /**
     * 原文文本。
     */
    OriginText?: string;
    /**
     * 对比文本。
     */
    DiffText?: 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>
  </ul>
     */
    FormatType?: number;
}
/**
 * CreateBatchOrganizationAuthorizationUrl返回参数结构体
 */
export interface CreateBatchOrganizationAuthorizationUrlResponse {
    /**
     * 批量企业注册链接-单链接包含多条认证流，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天
  跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
  <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead>  <tbody>
   <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr>
  <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr>
  <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>
  注：
  `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
  
     */
    AuthUrl?: string;
    /**
     * 认证流认证失败信息
     */
    ErrorMessages?: Array<string>;
    /**
     * 链接过期时间，为 7 天后，创建时间，格式为Unix标准时间戳（秒）。
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyPartnerAutoSignAuthUrl返回参数结构体
 */
export interface ModifyPartnerAutoSignAuthUrlResponse {
    /**
     * <p>授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。</p>
     */
    Url?: string;
    /**
     * <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
     */
    MiniAppPath?: string;
    /**
     * <p>链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。</p>
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateIntegrationSubOrganizationActiveRecord请求参数结构体
 */
export interface CreateIntegrationSubOrganizationActiveRecordRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 待激活成员企业ID集合
     */
    SubOrganizationIds: Array<string>;
}
/**
 * CreateFileConvertTask返回参数结构体
 */
export interface CreateFileConvertTaskResponse {
    /**
     * <p>接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。</p>
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateOrganizationInfoChangeUrl请求参数结构体
 */
export interface CreateOrganizationInfoChangeUrlRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>企业信息变更类型，可选类型如下：</p><ul><li>**1**：企业超管变更</li><li>**2**：企业基础信息变更</li></ul>
     */
    ChangeType: number;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>他方企业的统一社会信用代码，如果不传默认生成当前企业信息变更链接</p>
     */
    UnifiedSocialCreditCode?: string;
}
/**
 * 抄送信息
 */
export interface CcInfo {
    /**
     * <p>被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此业务通知方。</p>
     */
    Mobile?: string;
    /**
     * <p>被抄送方姓名。<br>抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。</p>
     */
    Name?: string;
    /**
     * <p>被抄送方类型, 可设置以下类型:</p><ul><li> **0** :个人抄送方</li><li> **1** :企业员工抄送方</li></ul>
     */
    CcType?: number;
    /**
     * <p>被抄送方权限, 可设置如下权限:</p><ul><li> **0** :可查看合同内容</li><li> **1** :可查看合同内容也可下载原文</li></ul>
     */
    CcPermission?: number;
    /**
     * <p>通知签署方经办人的方式,  有以下途径:</p><ul><li> **sms** :  (默认)短信</li><li> **none** : 不通知</li></ul>
     */
    NotifyType?: string;
    /**
     * <p>被抄送方企业名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号()，请使用中文括号（）代替。</p><p>注意:<br><font color="red">此为白名单功能，需要联系客户经理，开通白名单后才能使用。</font><br>使用文档 <a href="https://qian.tencent.com/developers/company/enterprise_inbox">签署方/抄送方仅指定企业名称发起合同</a></p>
     */
    OrganizationName?: string;
}
/**
 * DescribePersonCertificate返回参数结构体
 */
export interface DescribePersonCertificateResponse {
    /**
     * 证书的Base64
     */
    Cert?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
 */
export interface FlowBatchUrlInfo {
    /**
     * 批量签署合同和签署方的信息，用于补充动态签署人。
     */
    FlowBatchApproverInfos?: Array<FlowBatchApproverInfo>;
}
/**
 * CreateBatchAdminChangeInvitations返回参数结构体
 */
export interface CreateBatchAdminChangeInvitationsResponse {
    /**
     * 批量生成企业认证链接的详细错误信息，
  顺序与输入参数保持一致。
  若企业认证均成功生成，则不返回错误信息；
  若存在任何错误，则返回具体的错误描述。
     */
    ErrorMessages?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署证书信息结构体
 */
export interface SignCertificate {
    /**
     * 证书序列号
     */
    SerialNumber?: string;
    /**
     * 证书持有者名称
     */
    CommonName?: string;
    /**
     * 证书生效时间
     */
    NotBefore?: number;
    /**
     * 证书失效时间
     */
    NotAfter?: number;
    /**
     * 证书颁发者名称
     */
    IssuerCommonName?: string;
}
/**
 * DescribeFileCounterSignResult请求参数结构体
 */
export interface DescribeFileCounterSignResultRequest {
    /**
     * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 加签任务Id
     */
    TaskId?: string;
}
/**
 * CreateContractDiffTaskWebUrl请求参数结构体
 */
export interface CreateContractDiffTaskWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 是否跳过文件上传确认页。
  当该参数值为`false`时，`OriginalFileResourceId`和`DiffFileResourceId`参数不需要传值，需要在生成的web页面中上传对比文件；
  当该参数值为`true`时，`OriginalFileResourceId`和`DiffFileResourceId`参数必填，生成的web页面将跳过上传页面显示对比结果。
     */
    SkipFileUpload: boolean;
    /**
     * 需要对比的原合同文件资源ID，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。
     */
    OriginalFileResourceId?: string;
    /**
     * 需要对比的新合同文件资源ID，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。
     */
    DiffFileResourceId?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
     */
    UserData?: string;
    /**
     * 标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。
     */
    Tags?: Array<Tag>;
}
/**
 * DescribeContractReviewTask请求参数结构体
 */
export interface DescribeContractReviewTaskRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同审查任务ID，该参数通过调用接口[批量创建合同审查任务](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/CreateBatchContractReviewTask)获取。
     */
    TaskId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateSchemeUrl请求参数结构体
 */
export interface CreateSchemeUrlRequest {
    /**
     * 执行本接口操作的员工信息, userId 必填。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
     */
    OrganizationName?: string;
    /**
     * 合同流程里边签署方经办人的姓名。
  
  `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
  
     */
    Name?: string;
    /**
     * 合同流程里边签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
     */
    Mobile?: string;
    /**
     * 证件类型，支持以下类型
  <ul><li>ID_CARD : 中国大陆居民身份证</li>
  <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
  <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
  
  `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
     */
    IdCardType?: string;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
  
  `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
     */
    IdCardNumber?: string;
    /**
     * 要跳转的链接类型
  
  <ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li>
  <li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li>
  <li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li></ul>
     */
    EndPoint?: string;
    /**
     * 合同流程ID
  注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传,   跳转其他页面可不传`
     */
    FlowId?: string;
    /**
     * 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
     */
    FlowGroupId?: string;
    /**
     * 要跳转到的页面类型 <ul><li> **0** : 腾讯电子签小程序个人首页 (默认) <a href="https://qcloudimg.tencent-cloud.cn/raw/a2667ea84ec993cc060321afe3191d65.jpg" target="_blank" >点击查看示例页面</a></li><li> **1** : 腾讯电子签小程序流程合同的详情页,即合同签署页面(注:`仅生成短链或者小程序Path时支持跳转合同详情页,即EndPoint传HTTP_SHORT_URL或者APP`)<a href="https://qcloudimg.tencent-cloud.cn/raw/446a679f09b1b7f40eb84e67face8acc.jpg" target="_blank" >点击查看示例页面</a></li><li> **2** : 腾讯电子签小程序合同列表页 <a href="https://qcloudimg.tencent-cloud.cn/raw/c7b80e44c1d68ae3270a6fc4939c7214.jpg" target="_blank" >点击查看示例页面</a> </li><li> **3** : 腾讯电子签小程序合同封面页  （注：`生成动态签署人补充链接时，必须指定为封面页`）<a href="https://qcloudimg.tencent-cloud.cn/raw/0d22cc587be4bf084877c151350c3bf7.jpg" target="_blank" >点击查看示例页面</a></li></ul>
     */
    PathType?: number;
    /**
     * 签署完成后是否自动回跳
  <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
  
  注:
  1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
  3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
     */
    AutoJumpBack?: boolean;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
  
  <ul><li> **0** :合同签署页面更多操作按钮</li>
  <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
  <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
  <li> **3** :签署成功页的查看详情按钮</li>
  <li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
  <li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
  
  
  注:  `字段为数组, 可以传值隐藏多个按钮`
     */
    Hides?: Array<number | bigint>;
    /**
     * 签署节点ID，用于生成动态签署人链接完成领取。
  
  注：`生成动态签署人补充链接时必传。`
     */
    RecipientId?: string;
    /**
     * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
     */
    FlowGroupUrlInfo?: FlowGroupUrlInfo;
    /**
     * <font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
  
  参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
     */
    UrlUseEnv?: string;
    /**
     * 在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。
     */
    PickUpAfterJoined?: boolean;
    /**
     * 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
     */
    CanSkipReadFlow?: boolean;
}
/**
 * 签署方信息，发起合同后可获取到对应的签署方信息，如角色ID，角色名称
 */
export interface ApproverItem {
    /**
     * 签署方唯一编号
     */
    SignId?: string;
    /**
     * 签署方角色编号
     */
    RecipientId?: string;
    /**
     * 签署方角色名称
     */
    ApproverRoleName?: string;
}
/**
 * CreateFlowApprovers返回参数结构体
 */
export interface CreateFlowApproversResponse {
    /**
     * 批量补充签署人时，补充失败的报错说明
  
  注:`目前仅补充动态签署人时会返回补充失败的原因`
     */
    FillError?: Array<FillError>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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 DeleteOrganizationAuthorizationInfo {
    /**
     * 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
     */
    AuthorizationId?: string;
    /**
     * 认证的企业名称
     */
    OrganizationName?: string;
    /**
     * 清除认证流产生的错误信息
     */
    Errormessage?: string;
}
/**
 * CreateDraftContractByPromptsTask请求参数结构体
 */
export interface CreateDraftContractByPromptsTaskRequest {
    /**
     * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 起草要求，范围要求 5-1000 字
     */
    Requirement: string;
    /**
     * 参考模板文件资源id（PDF/Word格式），大小不超过1M，通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
     */
    ReferenceTemplateId?: string;
    /**
     * 相关规定文件资源id列表（PDF/Word格式），最多3个文件，每个大小不超过1M，通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
     */
    RequirementFileIds?: Array<string>;
    /**
     * 起草合同的语言要求（zh，en）默认zh
     */
    ContractLanguage?: string;
}
/**
 * CreateLMInformationExtractionTaskFieldFeedback请求参数结构体
 */
export interface CreateLMInformationExtractionTaskFieldFeedbackRequest {
    /**
     * 执行合同智能提取任务的员工信息。
     */
    Operator: UserInfo;
    /**
     * 合同智能提取任务结果字段ID值。该参数通过调用接口[获取合同智能提取任务详情](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/DescribeInformationExtractionTask)返回中的Results. ExtractionFieldResults.Id获取。
     */
    Id?: string;
    /**
     * 合同智能提取任务反馈信息
     */
    Feedback?: FeedbackInfo;
}
/**
 * 关注方信息
 */
export interface ReviewerInfo {
    /**
     * 姓名
     */
    Name?: string;
    /**
     * 手机号
     */
    Mobile?: string;
}
/**
 * CreateContractReviewWebUrl返回参数结构体
 */
export interface CreateContractReviewWebUrlResponse {
    /**
     * 接口返回的合同审查任务ID，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/DescribeContractReviewWebUrl" target="_blank">获取合同审查结果web页面</a>查看审查任务的结果。
  
  注意： `当ResourceId参数不为空时才会返回此值。`
     */
    TaskId?: string;
    /**
     * 合同审查嵌入式web页面链接。
  
  注意：`链接有效期为5分钟，且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中，需要单独页面打开此链接显示`
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DisableUserAutoSign返回参数结构体
 */
export interface DisableUserAutoSignResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeContractReviewChecklistsWebUrl请求参数结构体
 */
export interface DescribeContractReviewChecklistsWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同审查清单个性化参数
     */
    Option?: ContractReviewChecklistWebUrlOption;
}
/**
 * CreateContractComparisonTask返回参数结构体
 */
export interface CreateContractComparisonTaskResponse {
    /**
     * <p>调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。</p>
     */
    UserData?: string;
    /**
     * <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>
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFileUrls请求参数结构体
 */
export interface DescribeFileUrlsRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>文件对应的业务类型，目前支持：<ul><li><strong>FLOW</strong> : <font color="red">如需下载合同文件请选择此项</font></li><li><strong>TEMPLATE</strong> : 如需下载模板文件请选择此项</li><li><strong>DOCUMENT</strong>: 如需下载文档文件请选择此项</li><li><strong>SEAL</strong>: 如需下载印章图片请选择此项</li><li><strong>DIGITFILE</strong>: 如需下载加签文件请选择此项</li><li><strong>ARCHIVE</strong>: 如需下载合同归档文件请选择此项</li></ul></p><p>枚举值：</p><ul><li>FLOW： 如需下载合同文件请选择此项</li><li>TEMPLATE： 如需下载模板文件请选择此项</li><li>DOCUMENT： 如需下载文档文件请选择此项</li><li>SEAL： 如需下载印章图片请选择此项</li><li>DIGITFILE： 如需下载加签文件请选择此项</li><li>ARCHIVE： 如需下载合同归档文件请选择此项</li></ul>
     */
    BusinessType: string;
    /**
     * <p>业务编号的数组，取值如下：<ul><li>流程编号</li><li>模板编号</li><li>文档编号</li><li>印章编号</li><li>加签文件编号</li><li>如需下载合同文件请传入FlowId，最大支持20个资源</li></ul></p>
     */
    BusinessIds: Array<string>;
    /**
     * <p>下载后的文件命名，只有FileType为zip的时候生效</p>
     */
    FileName?: string;
    /**
     * <p>要下载的文件类型，取值如下：</p><ul><li>JPG</li><li>PDF</li><li>ZIP</li></ul>
     */
    FileType?: string;
    /**
     * <p>指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 1000。</p>
     */
    Offset?: number;
    /**
     * <p>指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 100。</p>
     */
    Limit?: number;
    /**
     * <p>下载url过期时间，单位秒。0: 按默认值5分钟，允许范围：1s~24x60x60s(1天)</p>
     */
    UrlTtl?: number;
    /**
     * <p>暂不开放</p>
     * @deprecated
     */
    CcToken?: string;
    /**
     * <p>暂不开放</p>
     * @deprecated
     */
    Scene?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * CreateMiniAppPrepareFlow返回参数结构体
 */
export interface CreateMiniAppPrepareFlowResponse {
    /**
     * H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
     */
    LongUrl?: string;
    /**
     * H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
     */
    ShortUrl?: string;
    /**
     * APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
     */
    MiniAppPath?: string;
    /**
     * 创建的合同id（还未实际发起，也未扣费），每次调用会生成新的id，用户可以记录此字段对应后续在小程序发起的合同，若在小程序上未成功发起，则此字段无效。
     */
    FlowId?: string;
    /**
     * 跳转至电子签小程序的二维码链接
     */
    QrcodeUrl?: string;
    /**
     * 直接跳转至电子签小程序的二维码链接，无需通过中转页。需要自行将其转换为二维码，使用微信扫码后可直接进入。
     */
    WeixinQrcodeUrl?: string;
    /**
     * 链接过期时间，精确到秒，若在此过期时间前未使用，则链接失效。
  
     */
    ExpiredOn?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ImportContractReviewChecklist返回参数结构体
 */
export interface ImportContractReviewChecklistResponse {
    /**
     * <p>导入成功的合同审查清单ID</p>
     */
    ChecklistId?: 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;
}
/**
 * OperateTemplate请求参数结构体
 */
export interface OperateTemplateRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 模板ID，为32位字符串。
     */
    TemplateId: string;
    /**
     * 操作类型，可取值如下:
  <ul>
  <li>DELETE:  删除</li>
  <li>ENABLE: 启用</li>
  <li>DISABLE: 停用</li>
  <li>COPY: 复制新建</li>
  </ul>
     */
    OperateType: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 模板名称，长度不超过64字符。<br>
  模板复制时指定有效，若为空，则复制后模板名称为 **原模板名称_副本**。
     */
    TemplateName?: string;
}
/**
 * 催办合同组下签署人维度详细信息。
 */
export interface RemindFlowGroupDetail {
    /**
     * <p>该签署人在合同中的签署顺序</p>
     */
    ApproverOrder?: number;
    /**
     * <p>签署人对应的签署id，签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。</p><p>在<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl/">CreateFlowSignUrl</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl/">CreateBatchQuickSignUrl</a>等接口生成签署链接时，可以通过查询合同流程的详情信息接口 <a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a> 获取签署人的Signld，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</p>
     */
    SignId?: string;
    /**
     * <p>催办状态</p><p>枚举值：</p><ul><li>0： 成功</li><li>2： 无需催办</li><li>5： 超过次数限制</li></ul>
     */
    Status?: number;
    /**
     * <p>描述当前催办结果的原因</p>
     */
    Reason?: string;
}
/**
 * CreateBatchQuickSignUrl返回参数结构体
 */
export interface CreateBatchQuickSignUrlResponse {
    /**
     * <p>签署人签署链接信息</p>
     */
    FlowApproverUrlInfo?: FlowApproverUrlInfo;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 创建流程的签署方信息
 */
export interface FlowCreateApprover {
    /**
     * <p>在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：</p><ul><li> <b>0</b> :企业B端。</li><li> <b>1</b> :个人C端。</li><li> <b>3</b> :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li><li> <b>7</b> :个人C端自动签署，适用于个人自动签场景。注: <b>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</b> </li></ul>
     */
    ApproverType: number;
    /**
     * <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号()，请使用中文括号（）代替。</p><p>注: <code>当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定</code></p>
     */
    OrganizationName?: string;
    /**
     * <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。</p><p>在未指定签署人电子签UserId情况下，为必填参数</p>
     */
    ApproverName?: string;
    /**
     * <p>签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。</p><p>注：<code>在未指定签署人电子签UserId情况下，为必填参数</code></p>
     */
    ApproverMobile?: string;
    /**
     * <p>证件类型，支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li><li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li><li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
     */
    ApproverIdCardType?: string;
    /**
     * <p>证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    ApproverIdCardNumber?: string;
    /**
     * <p>签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。</p><p><b>模板发起合同时，该参数为必填项，可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates">查询模板信息接口</a>获得。</b><br><b>文件发起合同时，该参数无需传值。</b></p><p>如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。</p>
     */
    RecipientId?: string;
    /**
     * <p>签署意愿确认渠道，默认为WEIXINAPP:人脸识别</p><p>注: &lt;font color=&quot;red&quot;&gt;不再使用, <code>用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置</code></p>
     */
    VerifyChannel?: Array<string>;
    /**
     * <p>通知签署方经办人的方式,  有以下途径:</p><ul><li>  **SMS**  :  (默认)短信</li><li>  **EMAIL**  :  邮件</li><li>  **ALL**  :  邮件+短信</li><li>   **NONE**   : 不通知</li></ul><p>注: <code>既是发起方又是签署方时，不给此签署方发送短信</code></p><p>枚举值：</p><ul><li>SMS： 短信通知</li><li>EMAIL： 邮件通知</li><li>ALL： 邮件通知+短信通知</li><li>NONE： 不做任何形式的通知</li></ul>
     */
    NotifyType?: string;
    /**
     * <p>合同强制需要阅读全文，无需传此参数</p>
     */
    IsFullText?: boolean;
    /**
     * <p>签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：</p><ul><li>合同页数少于等于2页，阅读时间为3秒；</li><li>合同页数为3到5页，阅读时间为5秒；</li><li>合同页数大于等于6页，阅读时间为10秒。</li></ul>
     */
    PreReadTime?: number;
    /**
     * <p>签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得</p><p>注：<br>如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）</p>
     */
    UserId?: string;
    /**
     * <p><font color="red">字段不再使用</font>，当前只支持true，默认为true</p>
     */
    Required?: boolean;
    /**
     * <p>在企微场景下使用，需设置参数为<strong>WEWORKAPP</strong>，以表明合同来源于企微。</p>
     */
    ApproverSource?: string;
    /**
     * <p>在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。<br>所有参与或签的人员均需具备该标识。<br>注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。<br>如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。</p>
     */
    CustomApproverTag?: string;
    /**
     * <p>快速注册相关信息</p>
     */
    RegisterInfo?: RegisterInfo;
    /**
     * <p>签署人个性化能力值，如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。</p>
     */
    ApproverOption?: ApproverOption;
    /**
     * <p>签署完前端跳转的url，暂未使用</p>
     * @deprecated
     */
    JumpUrl?: string;
    /**
     * <p>签署人的签署ID</p><ul><li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。</li><li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li></ul>
     */
    SignId?: string;
    /**
     * <p>此签署人(员工或者个人)签署时，是否需要发起方企业审批，取值如下：</p><ul><li>**false**：（默认）不需要审批，直接签署。</li><li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul><p>注：<code>此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
     */
    ApproverNeedSignReview?: boolean;
    /**
     * <p>签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效</p><p>合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li> 个人签名/印章</li><li> 企业印章</li><li> 骑缝章等签署控件</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
     */
    SignComponents?: Array<Component>;
    /**
     * <p>签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效</p><p>合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>动态表格等填写控件</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
     */
    Components?: Array<Component>;
    /**
     * <p>当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：</p><ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li><li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li><li> <b>ESIGN</b> :个人印章类型。</li><li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li><li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul><p>各种签名的样式可以参考下图：<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg" alt="image"></p>
     */
    ComponentLimitType?: Array<string>;
    /**
     * <p>指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li><li>  **2**  : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul><p><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p><p>.</p>
     */
    ApproverVerifyTypes?: Array<number | bigint>;
    /**
     * <p>您可以指定签署方签署合同的认证校验方式，可传递以下值：</p><ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li><li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li><li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）</li><li>**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）</li><li>**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）</li></ul><p>注：</p><ul><li>默认情况下，认证校验方式为人脸认证和签署密码两种形式；</li><li>您可以传递多种值，表示可用多种认证校验方式。</li><li>校验方式不允许只包含设备指纹识别和设备面容识别，至少需要再增加一种其他校验方式。</li><li>设备指纹识别和设备面容识别只支持小程序使用，其他端暂不支持。</li></ul><p>注:<br><code>此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主</code></p>
     */
    ApproverSignTypes?: Array<number | bigint>;
    /**
     * <p>生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：</p><ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li><li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>注：<code>不指定该值时，默认为签署方自行选择。</code>
     */
    SignTypeSelector?: number;
    /**
     * <p>签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署</p><p>注: <code>若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同</code></p>
     */
    Deadline?: number;
    /**
     * <p><b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。</p><p>您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。</p><p>注意：</p><ol><li>视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时，<b>生成H5签署链接必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。</li><li>签署完成后，可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
     */
    Intention?: Intention;
    /**
     * <p>进入签署流程的限制，目前支持以下选项：</p><ul><li> <b>空值（默认）</b> :无限制，可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
     */
    SignEndpoints?: Array<string>;
    /**
     * <p>是否不保存联系人<br>默认 false 保存联系人  true 不保存联系人</p><p>设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。<br>联系人查看可登录<a href="https://test.qian.tencent.cn/console/">电子签控制台</a> 进行查看。<br>如下图位置：<br><img src="https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png" alt=""></p>
     */
    NotSaveContact?: boolean;
    /**
     * <p>客户指定的邮箱信息</p>
     */
    ApproverEmail?: string;
}
/**
 * CreateArchiveFlowTask请求参数结构体
 */
export interface CreateArchiveFlowTaskRequest {
    /**
     * <p>执行本接口操作的员工信息。注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>归档合同列表，一次最多支持50个合同</p>
     */
    ArchiveFlows: Array<CreateArchiveFlow>;
}
/**
 * DeleteSingleSignOnEmployees返回参数结构体
 */
export interface DeleteSingleSignOnEmployeesResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 权限树节点权限
 */
export interface Permission {
    /**
     * 权限名称
     */
    Name?: string;
    /**
     * 权限key
     */
    Key?: string;
    /**
     * 权限类型 1前端，2后端
     */
    Type?: number;
    /**
     * 是否隐藏
     */
    Hide?: number;
    /**
     * 数据权限标签 1:表示根节点，2:表示叶子结点
     */
    DataLabel?: number;
    /**
     * 数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
     */
    DataType?: number;
    /**
     * 数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
     */
    DataRange?: number;
    /**
     * 关联权限, 表示这个功能权限要受哪个数据权限管控
     */
    DataTo?: string;
    /**
     * 父级权限key
     */
    ParentKey?: string;
    /**
     * 是否选中
     */
    IsChecked?: boolean;
    /**
     * 子权限集合
     */
    Children?: Array<Permission>;
}
/**
 * CreateUserMobileChangeUrl返回参数结构体
 */
export interface CreateUserMobileChangeUrlResponse {
    /**
     * 腾讯电子签小程序的实名认证链接。 如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
  
  <b>1.如果EndPoint是APP</b>，
  得到的链接类似于<a href="">pages/guide/index?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
  
  <b>2.如果EndPoint是HTTP</b>，
  得到的链接类似于<a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=MOBILE_CHANGE_INTENTION&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  <b>3.如果EndPoint是HTTP_SHORT_URL</b>，
  得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  注： <font color="red">生成的链路后面不能再增加参数</font>
  
     */
    Url?: string;
    /**
     * 链接失效期限，为Unix时间戳（单位秒），有如下规则：
  
  <ul>
  <li>如果指定更换绑定手机号的用户(指定用户ID或姓名等信息)，则设定的链接失效期限为7天后。</li>
  <li>如果没有指定更换绑定手机号的用户，则生成通用跳转到个人换手机号的界面，链接不会过期。</li>
  </ul>
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFlowTemplates请求参数结构体
 */
export interface DescribeFlowTemplatesRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>查询内容控制</p><ul><li>**0**：模板列表及详情（默认）</li><li>**1**：仅模板列表</li></ul>
     */
    ContentType?: number;
    /**
     * <p>搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。<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></p>
     */
    Filters?: Array<Filter>;
    /**
     * <p>偏移量:从 0 开始，最大20000。</p>
     */
    Offset?: number;
    /**
     * <p>指定每页返回的数据条数，和Offset参数配合使用。</p><p>注：<code>1.默认值为20，单页做大值为200。</code></p>
     */
    Limit?: number;
    /**
     * <p>通过指定<a href="https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png">第三方应用的应用号（ApplicationId）</a>，您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。</p><p><strong>注意事项：</strong></p><ul><li>当 <strong>ApplicationId</strong> 为空时（默认），系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>（自建应用使用的模板）。</li><li>当 <strong>ApplicationId</strong> 不为空时，系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板（分享给第三方应用子企业的模板）。</li></ul>
     */
    ApplicationId?: string;
    /**
     * <p>默认为false，查询SaaS模板库列表；<br>为true，查询第三方应用集成平台企业模板库管理列表</p>
     * @deprecated
     */
    IsChannel?: boolean;
    /**
     * <p>暂未开放</p>
     * @deprecated
     */
    Organization?: OrganizationInfo;
    /**
     * <p>暂未开放</p>
     * @deprecated
     */
    GenerateSource?: number;
    /**
     * <p>是否获取模板预览链接。</p><ul><li><strong>false</strong>：不获取（默认）</li><li><strong>true</strong>：需要获取</li></ul>设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
     */
    WithPreviewUrl?: boolean;
}
/**
 * DescribeFlowEvidenceReport返回参数结构体
 */
export interface DescribeFlowEvidenceReportResponse {
    /**
     * <p>出证报告PDF的下载 URL，<code>有效期为5分钟</code>，超过有效期后将无法再下载。</p>
     */
    ReportUrl?: string;
    /**
     * <p>出证任务执行的状态, 状态含义如下：</p><ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li><li>**EvidenceStatusSuccess**：  出证任务执行成功</li><li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
     */
    Status?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateRiskIdentificationTaskFeedback返回参数结构体
 */
export interface CreateRiskIdentificationTaskFeedbackResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 批量认证企业任务详情信息，其中包括 TaskId，状态信息等。
 */
export interface BatchOrganizationRegistrationTasksDetails {
    /**
     * 生成注册链接的任务Id
     */
    TaskId?: string;
    /**
     * 批量创建企业任务的状态
  <ul>
  <li>Processing</li>
  <li>Create</li>
  <li>Submit</li>
  <li>Authorization</li>
  <li>Failed</li>
  </ul>
  
  各个状态所代表的含义如下表格所示：
  <table>
  <thead align="center" valign="center">
  <tr><th>任务状态名称</th><th>任务状态详情</th></tr>
  </thead>
  <tbody>
  <tr><th align="center" valign="center">Processing</th><th>企业认证任务处理中，用户调用了<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks">CreateBatchOrganizationRegistrationTasks</a>接口，但是任务还在处理中的状态</th></tr>
  <tr><th align="center" valign="center">Create</th><th>创建企业认证链接任务完成，可以调用生成任务链接接口</th></tr>
  <tr><th align="center" valign="center">Submit</th><th>企业认证任务已提交,到如下界面之后，会变为这个状态
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/acbcec8c7a71de14d9c041e3b8ca8b3f.png)</th></tr>
  <tr><th align="center" valign="center">Authorization</th><th>企业认证任务认证成功,点击下图下一步，进入到授权书上传或者法人认证，则会变为这个状态
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/c52448354871cffa729da8db4e3a6f18.png)</th></tr>
  <tr><th align="center" valign="center">Failed</th><th>企业认证任务失败</th></tr>
  </tbody>
  </table>
     */
    Status?: string;
    /**
     * 如果任务失败,会返回错误信息
     */
    ErrorMessage?: string;
    /**
     * 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。认证流 Id可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
     */
    AuthorizationInfoId?: string;
}
/**
 * 参与方填写控件信息
 */
export interface RecipientComponentInfo {
    /**
     * <p>签署方经办人在合同流程中的参与方ID，与控件绑定，是控件的归属方</p>
     */
    RecipientId?: string;
    /**
     * <p>参与方填写状态</p><ul><li>**空值** : 此参与方没有填写控件</li><li>**0**:  未填写, 表示此参与方还没有填写合同的填写控件</li><li>**1**:  已填写, 表示此参与方已经填写所有的填写控件</li></ul>
     */
    RecipientFillStatus?: string;
    /**
     * <p>是否为发起方</p><ul><li>true-发起方</li><li>false-参与方</li></ul>
     */
    IsPromoter?: boolean;
    /**
     * <p>该参与方填写控件信息列表</p>
     */
    Components?: Array<FilledComponent>;
    /**
     * <p>该参与方签批控件信息</p>
     */
    SignComponents?: Array<FilledComponent>;
}
/**
 * 根据合同对印章授权
 */
export interface SealPolicyAuthorizationFlows {
    /**
     * <p>合同id列表，最大支持50个</p>
     */
    FlowIds?: Array<string>;
    /**
     * <p>合同组id列表， 最大支持10个<br>FlowGroupIds(合同组)与FlowIds(合同列表) 两个参数只能选择其中一个，两者同时传会提示参数错误。</p>
     */
    FlowGroupIds?: Array<string>;
}
/**
 * ExportContractReviewResult返回参数结构体
 */
export interface ExportContractReviewResultResponse {
    /**
     * <p>文件下载链接</p>
     */
    Url?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 单点登录企业员工信息。
 */
export interface SingleSignOnEmployees {
    /**
     * 用户在idp分配的唯一值，需要保持跟在电子签应用集成->单点登录配置->端点配置中配置的。
  如下图配置![image](https://qcloudimg.tencent-cloud.cn/raw/6ff22248c930b2a7684322cac9401a9c.png)。
     */
    OpenId: string;
    /**
     * 企业员工姓名。 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
     */
    Name: string;
    /**
     * 用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
     */
    Mobile: string;
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  注：`创建和更新场景无需填写。`
     */
    UserId?: string;
    /**
     * 用户邮箱。
     */
    Email?: string;
    /**
     * 员工角色信息。
  此处roleId为电子签配置的 RoleId，可通过接口[查询企业角色列表](https://qian.tencent.com/developers/companyApis/roles/DescribeIntegrationRoles) 获取
     */
    RoleIds?: Array<string>;
    /**
     * 员工是否实名。
     */
    IsVerified?: boolean;
    /**
     * 员工创建时间戳，单位秒。
     */
    CreatedOn?: number;
}
/**
 * 页面主题配置
 */
export interface WebThemeConfig {
    /**
     * 是否显示页面底部电子签logo，取值如下：
  <ul><li> **true**：页面底部显示电子签logo</li>
  <li> **false**：页面底部不显示电子签logo（默认）</li></ul>
     */
    DisplaySignBrandLogo?: boolean;
    /**
     * 主题颜色：
  支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
  <br/>
     */
    WebEmbedThemeColor?: string;
}
/**
 * CreateBatchContractReviewTask请求参数结构体
 */
export interface CreateBatchContractReviewTaskRequest {
    /**
     * 执行合同审查任务的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同审查的PDF、WORD文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF、WORD文件资源编号。
  
  注:  `目前，此接口仅支持5个文件发起。每个文件限制在10M以下，文件必须是PDF、WORD格式`
     */
    ResourceIds: Array<string>;
    /**
     * 合同审查的审查尺度。默认为`0`严格尺度
  
  审查尺度如下：
  <ul>
      <li>**0** - 【严格】以保护己方利益为核心，对合同条款进行严格把控，尽可能争取对己方有利的条款，同时对对方提出的不合理条款可进行坚决修改或删除。</li>
      <li>**1** - 【中立】以公平合理为原则，平衡双方的权利义务，既不过分强调己方利益，也不过度让步，力求达成双方均可接受的条款。</li>
      <li>**2** - 【宽松】以促成交易为核心，对合同条款的修改要求较为宽松，倾向于接受对方提出的条款，以尽快达成合作。</li>
  </ul>
     */
    PolicyType?: number;
    /**
     * 该字段已不再使用！
  合同审查中的角色信息，通过明确入参角色的名称和描述，可以提高合同审查的效率和准确性。用户不做配置时大模型会根据合同内容推荐出风险识别角色的名称和描述信息。
     */
    Role?: RiskIdentificationRoleInfo;
    /**
     * 合同审查中的角色信息，通过明确入参角色的名称和描述，可以提高合同审查的效率和准确性。用户不做配置时大模型会根据合同内容推荐出风险识别角色的名称和描述信息。
     */
    Roles?: Array<RiskIdentificationRoleInfo>;
    /**
     * 该字段已不再使用！
  用户配置的审查清单ID，基于此清单ID批量创建合同审查任务，为32位字符串。[点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)。如果用户不做此配置大模型会根据合同内容在当前企业下的审查清单和系统默认的清单中选择一个清单进行审查。
     */
    ChecklistId?: string;
    /**
     * 用户配置的审查清单ID，基于此清单ID批量创建合同审查任务，为32位字符串。[点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)。如果用户不做此配置大模型会根据合同内容在当前企业下的审查清单和系统默认的清单中选择一个清单进行审查。
     */
    ChecklistIds?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 备注信息，长度不能超过100个字符
     */
    Comment?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
     */
    UserData?: string;
    /**
     * 启用附加通用风险审查清单。默认为启用状态
  可选值如下：
  
  - 1: 启用系统提供的附加通用风险审查清单
  - 2:不启用系统提供的附加通用风险审查清单
     */
    EnableGeneralChecklist?: number;
}
/**
 * DeleteIntegrationDepartment返回参数结构体
 */
export interface DeleteIntegrationDepartmentResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 自动签开启、签署相关配置
 */
export interface AutoSignConfig {
    /**
     * 自动签开通个人用户信息, 包括名字,身份证等
     */
    UserInfo: UserThreeFactor;
    /**
     * 是否回调证书信息:
  <ul><li>**false**: 不需要(默认)</li>
  <li>**true**:需要</li></ul>
  
  注：`该字段已经失效，请勿设置此参数。`
     */
    CertInfoCallback?: boolean;
    /**
     * 是否支持用户自定义签名印章:
  <ul><li>**false**: 不能自己定义(默认)</li>
  <li>**true**: 可以自己定义</li></ul>
     */
    UserDefineSeal?: boolean;
    /**
     * 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
  <ul><li>**false**: 不需要(默认)</li>
  <li>**true**: 需要</li></ul>
     */
    SealImgCallback?: boolean;
    /**
     * 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
  腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
     * @deprecated
     */
    CallbackUrl?: string;
    /**
     * 开通时候的身份验证方式, 取值为：
  <ul><li>**WEIXINAPP** : 微信人脸识别</li>
  <li>**INSIGHT** : 慧眼人脸识别</li>
  <li>**TELECOM** : 运营商三要素验证</li></ul>
  注：
  <ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li>
  <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
     */
    VerifyChannels?: Array<string>;
    /**
     * 设置用户自动签合同的扣费方式。
  
  <ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>
  
  注：`该字段已经失效，请勿设置此参数。`
     */
    LicenseType?: number;
    /**
     * 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
  
  注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
  
  跳转场景：
  <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
  <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
  
  成功结果返回：
  若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
     */
    JumpUrl?: string;
}
/**
 * DescribeThirdPartyAuthCode请求参数结构体
 */
export interface DescribeThirdPartyAuthCodeRequest {
    /**
     * 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
     */
    AuthCode: string;
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 发起合同流程时对合同流程的部分操作加以限制的配置。
 */
export interface FlowOperateLimit {
    /**
     * 发起合同流程时，对签署完成后是否能发起对应的解除合同加以限制：<ul><li><b>false（默认值）</b>: 合同流程完成签署后，支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后，<b>不支持</b>发起对应的解除协议。</li></ul>
     */
    NoRelease?: boolean;
}
/**
 * CreateBatchInitOrganizationUrl请求参数结构体
 */
export interface CreateBatchInitOrganizationUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 初始化操作类型
  <ul>
  <li>CREATE_SEAL : 创建印章</li>
  <li>AUTH_JOIN_ORGANIZATION_GROUP : 加入集团企业</li>
  <li>OPEN_AUTO_SIGN :开通企业自动签署</li>
  <li>PARTNER_AUTO_SIGN_AUTH :合作方企业授权自动签</li>
  <li>CHANGE_SUB_ORGANIZATION_ADMIN_AUTH :变更子企业超管授权(**授权后，主企业可变更子企业超管，此功能需联系客户经理开通白名单使用**)</li>
  </ul>
     */
    OperateTypes: Array<string>;
    /**
     * 批量操作的企业Id列表，最大支持50个
     */
    OrganizationIds: Array<string>;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
    /**
     * 被授权的合作方企业在电子签的企业电子签账号，当操作类型包含 PARTNER_AUTO_SIGN_AUTH （合作方企业授权自动签）时必传。
  
  企业电子签账号可在[电子签的网页端](https://qian.tencent.com/console/company-settings/company-center) ，于企业设置-企业信息菜单栏下复制获取。
  
  ![企业电子签账号](https://qcloudimg.tencent-cloud.cn/raw/4e6b30ee92f00671f7f1c5bd127c27db.png)
     */
    AuthorizedOrganizationId?: string;
    /**
     * 初始化操作类型里含有CHANGE_SUB_ORGANIZATION_ADMIN_AUTH（变更子企业超管授权）操作类型时，授权协议中主企业的签署方是否使用自动签（需操作人有自动签授权）
     */
    ChangeAdminAuthAutoSign?: boolean;
}
/**
 * DeleteOrganizationAuthorizations返回参数结构体
 */
export interface DeleteOrganizationAuthorizationsResponse {
    /**
     * 清理的认证流的详细信息，其中包括企业名称，认证流唯一 Id 以及清理过程中产生的错误信息
     */
    DeleteOrganizationAuthorizationInfos?: Array<DeleteOrganizationAuthorizationInfo>;
    /**
     * 批量清理认证流返回的状态值
  其中包括
  - 1 全部成功
  - 2 部分成功
  - 3 全部失败
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 小程序发起页面个性化配置参数
 */
export interface MiniAppCreateFlowPageOption {
    /**
     * 发起后隐藏签署码
     */
    HideSignCodeAfterStart?: boolean;
}
/**
 * 签署人详情信息
 */
export interface FlowApproverDetail {
    /**
     * <p>签署时的相关信息</p>
     */
    ApproveMessage?: string;
    /**
     * <p>签署方姓名</p>
     */
    ApproveName?: string;
    /**
     * <p>签署方的签署状态<br>0：还没有发起<br>1：流程中 没有开始处理<br>2：待签署<br>3：已签署<br>4：已拒绝<br>5：已过期<br>6：已撤销<br>7：还没有预发起<br>8：待填写<br>9：因为各种原因而终止<br>10：填写完成<br>15：已解除<br>19：转他人处理</p>
     */
    ApproveStatus?: number;
    /**
     * <p>模板配置中的参与方ID,与控件绑定</p>
     * @deprecated
     */
    ReceiptId?: string;
    /**
     * <p>客户自定义的用户ID</p>
     */
    CustomUserId?: string;
    /**
     * <p>签署人手机号</p>
     */
    Mobile?: string;
    /**
     * <p>签署顺序，如果是有序签署，签署顺序从小到大</p>
     */
    SignOrder?: number;
    /**
     * <p>签署人签署时间，时间戳，单位秒</p>
     */
    ApproveTime?: number;
    /**
     * <p>签署方类型，ORGANIZATION-企业员工，PERSON-个人，ENTERPRISESERVER-企业静默签</p>
     */
    ApproveType?: string;
    /**
     * <p>签署方侧用户来源，如WEWORKAPP-企业微信等</p>
     */
    ApproverSource?: string;
    /**
     * <p>客户自定义签署方标识</p>
     */
    CustomApproverTag?: string;
    /**
     * <p>签署方企业Id</p>
     */
    OrganizationId?: string;
    /**
     * <p>签署方企业名称</p>
     */
    OrganizationName?: string;
    /**
     * <p>签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。</p>
     */
    SignId?: string;
    /**
     * <p>自定义签署人角色</p>
     */
    ApproverRoleName?: string;
    /**
     * <p>模板配置中的参与方ID,与控件绑定</p>
     */
    RecipientId?: string;
    /**
     * <p>签署方转交记录列表，标识该签署方是由谁转交而来，按转交时间由远到近进行排序</p>
     */
    ForwardRecords?: Array<ForwardRecord>;
}
/**
 * CreateFlowForwards请求参数结构体
 */
export interface CreateFlowForwardsRequest {
    /**
     * 执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。
  
  注意：`需要保证目标经办人已经加入企业且已实名`
     */
    TargetUserId: string;
    /**
     * 企业签署方的合同及对应签署方
     */
    FlowForwardInfos: Array<FlowForwardInfo>;
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateIntegrationDepartment返回参数结构体
 */
export interface CreateIntegrationDepartmentResponse {
    /**
     * 电子签部门ID。建议开发者保存此部门ID，方便后续查询或修改部门信息。
     */
    DeptId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 跳转事件的结构体，其中包括认证期间收录，授权书审核，企业认证的回跳事件。
 */
export interface JumpEvent {
    /**
     * <p>跳转事件枚举</p><p>枚举值：</p><ul><li>1： 企业收录</li><li>2： 超管授权书审核</li><li>3： 企业认证完成</li></ul>
     */
    JumpEventType?: number;
    /**
     * <p>为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。<br>Endpoint如果是APP 类型，请传递<font color="red">&quot;true&quot;</font><br>如果 Endpoint 是 H5 类型，请参考文档<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a></p><p>p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。</p>
     */
    JumpUrl?: string;
}
/**
 * DeleteSealPolicies返回参数结构体
 */
export interface DeleteSealPoliciesResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeOrganizationAuthStatus返回参数结构体
 */
export interface DescribeOrganizationAuthStatusResponse {
    /**
     * 企业是否已认证
     */
    IsVerified?: boolean;
    /**
     * 企业认证状态 0-未认证 1-认证中 2-已认证
     */
    AuthStatus?: number;
    /**
     * 企业认证信息
     */
    AuthRecords?: Array<AuthRecord>;
    /**
     * 企业在腾讯电子签平台的唯一身份标识，为32位字符串。
  可登录腾讯电子签控制台，在 "更多"->"企业设置"->"企业中心"- 中查看企业电子签账号。
  p.s. 只有当前企业认证成功的时候返回
     */
    OrganizationId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeBatchOrganizationRegistrationTasks请求参数结构体
 */
export interface DescribeBatchOrganizationRegistrationTasksRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls)可以得到。
     */
    TaskIds?: Array<string>;
}
/**
 * 合同审查清单检查点
 */
export interface ChecklistPoint {
    /**
     * <p>合同风险审查清单检查点名称</p>
     */
    Summary: string;
    /**
     * <p>合同风险审查清单检查点详细描述，说明具体风险信息</p>
     */
    Explanation: string;
    /**
     * <p>合同风险审查清单检查点对应的风险等级，一般分为 高风险、中风险、一般风险</p>
     */
    RiskLevel: string;
    /**
     * <p>合同风险审查清单检查点ID，创建清单时无需填写</p>
     */
    Id?: string;
    /**
     * <p>合同风险审查清单检查点是否不可缺失，若为true，相关条款未出现在内容中，视作风险</p>
     */
    IsIndispensable?: boolean;
    /**
     * <p>合同风险审查清单检查点是否要求和参考条款一致</p>
     */
    IsConsistentWithReferenceItem?: boolean;
    /**
     * <p>合同风险审查清单检查点参考条款，用于辅助审查</p>
     */
    ReferenceItem?: string;
    /**
     * <p>合同风险审查清单检查点固定修改建议，优先级高于AiSuggestion</p>
     */
    Suggestion?: string;
    /**
     * <p>合同风险审查清单检查点AI修改建议提示，会参考该配置生成对应的修改建议</p>
     */
    AiSuggestion?: string;
    /**
     * <p>合同风险审查清单检查点表现标签，用于自定义不同的风险类型</p>
     */
    RiskPresentation?: Array<string>;
}
/**
 * 用户的三要素：姓名，证件号，证件类型
 */
export interface UserThreeFactor {
    /**
     * 签署方经办人的姓名。
  经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
     */
    Name: string;
    /**
     * 证件类型，支持以下类型
  <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
  <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
  <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
     */
    IdCardType: string;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    IdCardNumber: string;
}
/**
 * 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
 */
export interface SignQrCode {
    /**
     * 二维码ID，为32位字符串。
     */
    QrCodeId?: string;
    /**
     * 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
     */
    QrCodeUrl?: string;
    /**
     * 二维码的有截止时间，格式为Unix标准时间戳（秒）。
  一旦超过二维码的有效期限，该二维码将自动失效。
     */
    ExpiredTime?: number;
    /**
     * 微信小程序二维码
     */
    WeixinQrCodeUrl?: string;
}
/**
 * CreateSealPolicy返回参数结构体
 */
export interface CreateSealPolicyResponse {
    /**
     * <p>最终授权成功的用户ID，在腾讯电子签平台的唯一身份标识，为32位字符串。<br>可登录腾讯电子签控制台，在 &quot;更多能力&quot;-&gt;&quot;组织管理&quot; 中查看某位员工的UserId(在页面中展示为用户ID)。</p>
     */
    UserIds?: Array<string>;
    /**
     * <p>人脸验证操作人链接，用法可以参考&quot;<a href="https://qian.tencent.com/developers/company/openwxminiprogram/">跳转电子签小程序配置</a>&quot;，默认为空。</p>
     */
    SealOperatorVerifyPath?: string;
    /**
     * <p>人脸验证操作人二维码链接，扫码后会跳转到腾讯电子签小程序进行人脸验证，默认为空。</p>
     */
    SealOperatorVerifyQrcodeUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSchemeUrl返回参数结构体
 */
export interface CreateSchemeUrlResponse {
    /**
     * 腾讯电子签小程序的签署链接。
  
  <ul><li>如果EndPoint是**APP**，得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
  <li>如果EndPoint是**HTTP**，得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`，点击后会跳转到腾讯电子签小程序进行签署</li>
  <li>如果EndPoint是**HTTP_SHORT_URL**，得到的链接类似于 `https://essurl.cn/2n**42Nd`，点击后会跳转到腾讯电子签小程序进行签署</li></ul>
  
  
  注： <font color="red">生成的链路后面不能再增加参数</font>
     */
    SchemeUrl?: string;
    /**
     * 二维码，在生成动态签署人跳转封面页链接时返回  注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`
     */
    SchemeQrcodeUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowSignUrl返回参数结构体
 */
export interface CreateFlowSignUrlResponse {
    /**
     * <p>签署人签署链接信息</p>
     */
    FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RenewAutoSignLicense返回参数结构体
 */
export interface RenewAutoSignLicenseResponse {
    /**
     * 续期成功后新的自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
  
  值为unix时间戳,单位为秒。
     */
    LicenseTo?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 用户信息
 */
export interface UserInfo {
    /**
     * 用户在平台的编号
     */
    UserId?: string;
    /**
     * 用户的来源渠道，一般不用传，特定场景根据接口说明传值
     * @deprecated
     */
    Channel?: string;
    /**
     * 用户在渠道的编号，一般不用传，特定场景根据接口说明传值
     * @deprecated
     */
    OpenId?: string;
    /**
     * 用户真实IP，内部字段，暂未开放
     * @deprecated
     */
    ClientIp?: string;
    /**
     * 用户代理IP，内部字段，暂未开放
     * @deprecated
     */
    ProxyIp?: string;
}
/**
 * 合同审查清单大类
 */
export interface ChecklistCategory {
    /**
     * <p>合同风险审查清单分组名称，每个分组下可以包含多个检查点</p>
     */
    Name: string;
    /**
     * <p>合同风险审查清单检查点列表，每个检查点定义了一个具体的风险项</p>
     */
    Points?: Array<ChecklistPoint>;
}
/**
 * 授权企业列表（目前仅用于“企业自动签 -> 合作企业授权”）
 */
export interface HasAuthOrganization {
    /**
     * <p>授权企业id</p>
     */
    OrganizationId?: string;
    /**
     * <p>授权企业名称</p>
     */
    OrganizationName?: string;
    /**
     * <p>被授权企业id</p>
     */
    AuthorizedOrganizationId?: string;
    /**
     * <p>被授权企业名称</p>
     */
    AuthorizedOrganizationName?: string;
    /**
     * <p>授权模板id（仅当授权方式为模板授权时有值）</p>
     */
    TemplateId?: string;
    /**
     * <p>授权模板名称（仅当授权方式为模板授权时有值）</p>
     */
    TemplateName?: string;
    /**
     * <p>授权时间，格式为时间戳，单位s</p>
     */
    AuthorizeTime?: number;
}
/**
 * CreateIntegrationRole返回参数结构体
 */
export interface CreateIntegrationRoleResponse {
    /**
     * 角色id
     */
    RoleId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFlowComponents请求参数结构体
 */
export interface DescribeFlowComponentsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
  
  [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
     */
    FlowId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * VerifyDigitFile返回参数结构体
 */
export interface VerifyDigitFileResponse {
    /**
     * 加签文件MD5哈希值
     */
    PdfResourceMd5?: string;
    /**
     * 验签结果代码，代码的含义如下：<ul><li>**1**：文件验证成功。</li><li>**2**：文件验证失败。</li></ul>
     */
    VerifyResult?: number;
    /**
     * 验签序列号, 为11位数字组成的字符串
     */
    VerifySerialNo?: string;
    /**
     * 验签结果详情，每个签名域对应的验签结果。
     */
    VerifyDigitFileResults?: Array<VerifyDigitFileResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateContractReviewChecklistWebUrl返回参数结构体
 */
export interface CreateContractReviewChecklistWebUrlResponse {
    /**
     * 嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteIntegrationEmployees请求参数结构体
 */
export interface DeleteIntegrationEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 待离职员工的信息最多不超过100个。应符合以下规则：
  
  1. UserId和OpenId不可同时为空，必须填写其中一个，优先使用UserId。
  
  2. **若需要进行离职交接**，交接人信息ReceiveUserId和ReceiveOpenId不可同时为空，必须填写其中一个，优先使用ReceiveUserId。
     */
    Employees: Array<Staff>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 更新员工信息失败返回的数据信息
 */
export interface FailedUpdateStaffData {
    /**
     * 用户传入的名称
     */
    DisplayName?: string;
    /**
     * 用户传入的手机号，明文展示
     */
    Mobile?: string;
    /**
     * 失败原因
     */
    Reason?: string;
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
     */
    UserId?: string;
    /**
     * 员工在第三方平台的openId
     */
    OpenId?: string;
}
/**
 * GetTaskResultApi请求参数结构体
 */
export interface GetTaskResultApiRequest {
    /**
     * 转换任务Id，通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
     */
    TaskId: string;
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 暂未开放
     * @deprecated
     */
    Organization?: OrganizationInfo;
}
/**
 * 合同审查清单
 */
export interface Checklist {
    /**
     * 审查清单id
     */
    Id?: string;
    /**
     * 审查清单名称
     */
    Name?: string;
    /**
     * 审查点数量
     */
    Count?: number;
    /**
     * 启用状态
     */
    Enabled?: boolean;
    /**
     * 修改人
     */
    Updater?: string;
    /**
     * 修改时间
     */
    ModifiedOn?: number;
    /**
     * 是否官方清单
     */
    Official?: boolean;
    /**
     * 配置状态，[0(未配置), 1(已配置)]
     */
    ConfigStatus?: number;
}
/**
 * CreatePartnerAuthorizationLink请求参数结构体
 */
export interface CreatePartnerAuthorizationLinkRequest {
    /**
     * 执行本接口操作的员工信息。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 腾讯电子签平台给生态集成方分配的**生态集成业务标识**，
  <font color="red">**此生态集成业务标识需要提前联系产品经理配置**。</font>
     */
    BusinessId: string;
    /**
     * 合作方企业在腾讯电子签注册企业后生成的企业id，需要合作方企业登录
  <a href="https://qian.tencent.com/console/company-settings/company-center" target="_blank">电子签控制台</a>获取
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/20ce774cf8118b9f3742b8519ef935db.png)
  
     */
    PartnerOrganizationId: string;
    /**
     * 第三方应用的配置信息。
  其中包括 回调地址，加密KEY等信息。
     */
    ApplicationInfo: CallbackInfo;
    /**
     * 第三方应用下企业用户信息。
  其中包括企业的OrganizationOpenId和超管的UserOpenId。
  具体含义请参考结构体解释
     */
    ProxyOrganizationInfo: ProxyOrganizationInfo;
    /**
     * 若未填写，则会创建一个生态集成应用。
  若填写， 则必须是生态集成企业给合作方企业通过此接口**CreatePartnerAuthorizationLink**创建的应用号。
  应用号可以从下图位置获取。
  ![image](https://qcloudimg.tencent-cloud.cn/raw/9bc4ee2bd5972035d12033608df157c9.png)
     */
    PartnerApplicationId?: string;
}
/**
 * 动态签署领取链接配置，当全部签署方均为动态签署方时生效。
 */
export interface DynamicSignOption {
    /**
     * 多份合同批量签署时，动态签署领取要求：<ul><li><b>0（默认值）</b>: 可以领取部分合同进入签署。</li><li><b>1 </b>: 必须全部领取进入签署，生成链接的所有合同必须相同经办人完成合同的领取签署。</li></ul>
     */
    DynamicReceiveType?: number;
    /**
     * 动态签署方时，预设的企业名称，预设企业名称后，只允许对应的企业员工进行领取签署。
     */
    OrganizationName?: string;
}
/**
 * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
 */
export interface FlowDetailInfo {
    /**
     * <p>合同流程ID，为32位字符串。</p>
     */
    FlowId?: string;
    /**
     * <p>合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。</p>
     */
    FlowName?: string;
    /**
     * <p>合同流程的类别分类（如销售合同/入职合同等）。<br>该字段将被废弃，不建议使用。</p>
     */
    FlowType?: string;
    /**
     * <p>合同流程当前的签署状态, 会存在下列的状态值 </p><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> **16** : 已失效（可能因为参与方修改姓名等原因）</li> <li> **21** : 已解除</li></ul>
     */
    FlowStatus?: number;
    /**
     * <p>当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。</p>
     */
    FlowMessage?: string;
    /**
     * <p>合同流程描述信息。</p>
     */
    FlowDescription?: string;
    /**
     * <p>合同流程的创建时间戳，格式为Unix标准时间戳（秒）。</p>
     */
    CreatedOn?: number;
    /**
     * <p>合同流程的签署方数组</p>
     */
    FlowApproverInfos?: Array<FlowApproverDetail>;
    /**
     * <p>合同流程的关注方信息数组</p>
     */
    CcInfos?: Array<FlowApproverDetail>;
    /**
     * <p>合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。</p>
     */
    Creator?: string;
    /**
     * <p>用户合同的自定义分类。</p><p>自定义合同类型的位置，在下图所示地方:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png" alt="image"></p>
     */
    UserFlowType?: UserFlowType;
    /**
     * <p>发起模板时,使用的模板Id</p>
     */
    TemplateId?: string;
    /**
     * <p>合同备注列表</p>
     */
    FlowRemarks?: Array<string>;
}
/**
 * CreatePersonAuthCertificateImage请求参数结构体
 */
export interface CreatePersonAuthCertificateImageRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 个人用户名称
     */
    UserName: string;
    /**
     * 证件类型，支持以下类型
  <ul><li> ID_CARD  : 中国大陆居民身份证 (默认值)</li>
  <li> HONGKONG_AND_MACAO  : 中国港澳居民来往内地通行证</li>
  <li> HONGKONG_MACAO_AND_TAIWAN  : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
     */
    IdCardType: string;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    IdCardNumber: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 自动签使用的场景值, 可以选择的场景值如下:
  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
  
  注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
     */
    SceneKey?: string;
}
/**
 * CreateFlowByFiles返回参数结构体
 */
export interface CreateFlowByFilesResponse {
    /**
     * <p>合同流程ID，为32位字符串。<br>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</p><p>注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
     */
    FlowId?: string;
    /**
     * <p>合同预览链接URL。</p><p>注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</p>
     */
    PreviewUrl?: string;
    /**
     * <p>签署方信息，如角色ID、角色名称等</p>
     */
    Approvers?: Array<ApproverItem>;
    /**
     * <p>发起审批流id，仅在CreateFlowByFiles时指定了WorkFlow=true时返回</p>
     */
    WorkflowInstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UploadFiles返回参数结构体
 */
export interface UploadFilesResponse {
    /**
     * <p>文件资源ID数组，每个文件资源ID为32位字符串。<br>建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。<br>注:<code>有效期一个小时（超过一小时后系统不定期清理，会有部分时间差）, 有效期内此文件id可以反复使用, 超过有效期无法使用</code></p>
     */
    FileIds?: Array<string>;
    /**
     * <p>上传成功文件数量</p>
     */
    TotalCount?: number;
    /**
     * <p>文件过期时间的时间戳</p><p>单位：秒</p><p>默认值：当前上传时间的一小时内有效</p>
     */
    Deadline?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
 */
export interface PresetApproverInfo {
    /**
     * <p>预设参与方姓名。</p>
     */
    Name?: string;
    /**
     * <p>预设参与方手机号。</p>
     */
    Mobile?: string;
    /**
     * <p>预设参与方证件号，需要和IdCardType同时传入。</p><p>证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li></ul>
     */
    IdCardNumber?: string;
    /**
     * <p>预设参与方的证件类型，需要与IdCardNumber同时传入。</p><p>证件类型，支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
     */
    IdCardType?: string;
    /**
     * <p>企业用户动态签署方场景指定预设企业名称。</p><p><code>注意：1. 若为企业动态签署方场景，此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数，仅支持指定企业名称。</code></p>
     */
    OrganizationName?: string;
}
/**
 * DescribeContractReviewChecklistsWebUrl返回参数结构体
 */
export interface DescribeContractReviewChecklistsWebUrlResponse {
    /**
     * 嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeBillUsage返回参数结构体
 */
export interface DescribeBillUsageResponse {
    /**
     * <p>企业套餐余额及使用情况</p>
     */
    Summary?: Array<OrgBillSummary>;
    /**
     * <p>集团子企业套餐使用情况</p>
     */
    SubOrgSummary?: Array<SubOrgBillSummary>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyIntegrationDepartment请求参数结构体
 */
export interface ModifyIntegrationDepartmentRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 电子签部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
     */
    DeptId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 电子签父部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
     */
    ParentDeptId?: string;
    /**
     * 部门名称，最大长度为50个字符。
     */
    DeptName?: string;
    /**
     * 客户系统部门ID，最大长度为64个字符。
     */
    DeptOpenId?: string;
    /**
     * 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
     */
    OrderNo?: number;
}
/**
 * 合同转交相关信息
 */
export interface FlowForwardInfo {
    /**
     * 合同流程ID，为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
     */
    FlowId: string;
    /**
     * 签署方经办人在合同中的参与方ID，为32位字符串。
     */
    RecipientId: string;
}
/**
 * CreateOrganizationBatchSignUrl返回参数结构体
 */
export interface CreateOrganizationBatchSignUrlResponse {
    /**
     * <p>批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。</p>
     */
    SignUrl?: string;
    /**
     * <p>链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。</p>
     */
    ExpiredTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 模板中文件的信息结构
 */
export interface FileInfo {
    /**
     * 文件ID
     */
    FileId?: string;
    /**
     * 文件名
     */
    FileName?: string;
    /**
     * 文件大小，单位为Byte
     */
    FileSize?: number;
    /**
     * 文件上传时间，格式为Unix标准时间戳（秒）
     */
    CreatedOn?: number;
}
/**
 * 信息提取结果字段反馈
 */
export interface FeedbackInfo {
    /**
     * 合同信息提取结果反馈。
  `值如下`：
  - 0:  未反馈
  - 1: 信息提取正确
  - 2: 信息提取有错误
     */
    Result?: number;
    /**
     * 信息提取错误原因，当Result为2时需要填写此信息
     */
    Reason?: FeedbackInfoReason;
}
/**
 * CreatePartnerAutoSignAuthUrl请求参数结构体
 */
export interface CreatePartnerAutoSignAuthUrlRequest {
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>被授企业id/授权方企业id（即OrganizationId），和AuthorizedOrganizationName二选一传入</p>
     */
    AuthorizedOrganizationId?: string;
    /**
     * <p>被授企业名称/授权方企业的名字，和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号()，请使用中文括号（）代替。</code></p>
     */
    AuthorizedOrganizationName?: string;
    /**
     * <p>在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。</p><p>枚举值：</p><ul><li>OFFICIAL： 企业公章，用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT： 合同专用章，专门用于签署各类合同。</li><li>FINANCE： 财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证</li><li>PERSONNEL： 人事专用章，用于人事管理相关文件，如劳动合同、人事任命等。</li><li>OTHER： 其他类型印章，包含子类型</li></ul>
     */
    SealTypes?: Array<string>;
    /**
     * <p>在处理授权关系时，授权的方向</p><ul><li><strong>false</strong>（默认值）：表示我方授权他方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称，即接收授权的企业。</li><li><strong>true</strong>：表示他方授权我方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称，即提供授权的企业。</li></ul>
     */
    AuthToMe?: boolean;
}
/**
 * CreatePartnerAuthorizationLink返回参数结构体
 */
export interface CreatePartnerAuthorizationLinkResponse {
    /**
     * 授权链接，以短链形式返回。短链的有效期参考回参中的 ExpiredTime。
  
  注：
  
  1. 非小程序和APP集成使用
  
  2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
     */
    Link?: string;
    /**
     * 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateExtendedServiceAuthInfos返回参数结构体
 */
export interface CreateExtendedServiceAuthInfosResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同信息提取结果
 */
export interface ExtractionTaskResult {
    /**
     * 用于合同信息提取的资源ID。
     */
    ResourceId?: string;
    /**
     * 用于合同信息提取的资源名称。
     */
    ResourceName?: string;
    /**
     * 根据当前合同提取出的字段信息
     */
    ExtractionFieldResults?: Array<ExtractionFieldResult>;
}
/**
 * 指定签署人限制项
 */
export interface ApproverRestriction {
    /**
     * 指定签署人名字
     */
    Name?: string;
    /**
     * 指定签署人手机号，11位数字
     */
    Mobile?: string;
    /**
     * 指定签署人证件类型，ID_CARD-身份证
     */
    IdCardType?: string;
    /**
     * 指定签署人证件号码，字母大写
     */
    IdCardNumber?: string;
}
/**
 * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
 */
export interface IntentionAction {
    /**
     * 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
     */
    Text?: string;
}
/**
 * DescribeDraftContractByPromptsTask返回参数结构体
 */
export interface DescribeDraftContractByPromptsTaskResponse {
    /**
     * 任务状态，枚举，0 已创建，1 执行中，2 成功，3 失败
     */
    Status?: number;
    /**
     * 任务错误信息，仅在失败时返回
     */
    Message?: string;
    /**
     * 生成的合同名称
     */
    ContractName?: string;
    /**
     * 生成的合同文件资源id
     */
    ResourceId?: string;
    /**
     * 生成的合同文件下载链接，有效期2小时
     */
    ContractUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateOrganizationBatchSignUrl请求参数结构体
 */
export interface CreateOrganizationBatchSignUrlRequest {
    /**
     * <p>执行本接口操作的员工信息。使用此接口时，必须填写userId。<br>支持填入集团子公司经办人 userId 代发合同。</p><p>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 &quot;合同&quot;-&gt;&quot;合同中心&quot; 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。  注：生成动态签署方领取时此参数必传。</p>
     */
    FlowIds?: Array<string>;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>员工在腾讯电子签平台的独特身份标识，为32位字符串。<br>您可登录腾讯电子签控制台，在 &quot;更多能力&quot;-&gt;&quot;组织管理&quot; 中查阅某位员工的UserId（在页面中显示为用户ID）。<br>UserId必须是传入合同（FlowId）中的签署人。</p><ul><li>1. 若UserId为空，Name和Mobile 必须提供。</li><li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li></ul>
     */
    UserId?: string;
    /**
     * <p>员工姓名，必须与手机号码一起使用。<br>如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
     */
    Name?: string;
    /**
     * <p>员工手机号，必须与姓名一起使用。<br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
     */
    Mobile?: string;
    /**
     * <p>为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数  注：生成动态签署方领取时此参数必传。</p>
     */
    RecipientIds?: Array<string>;
    /**
     * <p>合同组Id，传入此参数则可以不传FlowIds</p>
     */
    FlowGroupId?: string;
    /**
     * <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p>
     */
    CanBatchReject?: boolean;
    /**
     * <p>动态签署方领取链接配置。</p>
     */
    DynamicSignOption?: DynamicSignOption;
}
/**
 * 企业角色数据信息
 */
export interface IntegrateRole {
    /**
     * 角色id
     */
    RoleId?: string;
    /**
     * 角色名
     */
    RoleName?: string;
    /**
     * 角色状态，1-启用，2-禁用
     */
    RoleStatus?: number;
    /**
     * 是否是集团角色，true-是，false-否
     */
    IsGroupRole?: boolean;
    /**
     * 管辖的子企业列表
     */
    SubOrgIdList?: Array<string>;
    /**
     * 权限树
     */
    PermissionGroups?: Array<PermissionGroup>;
}
/**
 * CreateDraftContractByPromptsTask返回参数结构体
 */
export interface CreateDraftContractByPromptsTaskResponse {
    /**
     * 起草任务id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteIntegrationDepartment请求参数结构体
 */
export interface DeleteIntegrationDepartmentRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 电子签中的部门ID，通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
     */
    DeptId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 交接部门ID。
  待删除部门中的合同、印章和模板数据，将会被交接至该部门ID下；若未填写则交接至公司根部门。
     */
    ReceiveDeptId?: string;
}
/**
 * 创建流程的签署方信息
 */
export interface MiniAppCreateApproverInfo {
    /**
     * 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
  
  <ul><li> <b>0</b> :企业B端。</li>
  <li> <b>1</b> :个人C端。</li>
  <li> <b>3</b> :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li>
  <li> <b>7</b> :个人C端自动签署，适用于个人自动签场景。注: <b>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</b> </li></ul>
     */
    ApproverType: number;
    /**
     * 组织机构名称。
  请确认该名称与企业营业执照中注册的名称一致。
  如果名称中包含英文括号()，请使用中文括号（）代替。
  
  注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
  
  
     */
    OrganizationName?: string;
    /**
     * 签署方经办人的姓名。
  经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
  
  在未指定签署人电子签UserId情况下，为必填参数
     */
    ApproverName?: string;
    /**
     * 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
  
  注：`在未指定签署人电子签UserId情况下，为必填参数`
  
     */
    ApproverMobile?: string;
    /**
     * 证件类型，支持以下类型
  <ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>
  <li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
  <li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
     */
    ApproverIdCardType?: string;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    ApproverIdCardNumber?: string;
    /**
     * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
  
  <b>模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
  <b>文件发起合同时，该参数无需传值。</b>
  
  如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
     */
    RecipientId?: string;
}
/**
 * ExportContractReviewResult请求参数结构体
 */
export interface ExportContractReviewResultRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同审查任务ID</p>
     */
    TaskId: string;
    /**
     * <p>导出文件类型</p><p>枚举值：</p><ul><li>1： WORD、PDF当前带风险批注文件</li><li>2： 审查结果＆摘要（.xIsx）</li><li>3： WORD、PDF审查合同内容时的文件（最原始文件）</li><li>4： WORD、PDF当前无风险批注文件</li></ul>
     */
    FileType: number;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * DescribeFileCounterSignResult返回参数结构体
 */
export interface DescribeFileCounterSignResultResponse {
    /**
     * 加签任务的状态。
  
  <ul>
  <li><b>PROCESSING</b>: 任务正在执行中。</li>
  <li><b>FINISHED</b>: 已执行成功</li>
  <li><b>FAILED</b>: 执行失败</li>
  </ul>
     */
    Status?: string;
    /**
     * 加签完成后新的文件Id
     */
    ResultFileId?: string;
    /**
     * 失败的错误信息，加签任务失败的情况下会返回。
     */
    ErrorDetail?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 此结构体 (Component) 用于描述控件属性。

在通过文件发起合同时，对应的component有三种定位方式
1. 绝对定位方式 （可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标）
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
 */
export interface Component {
    /**
     * <p><strong>如果是Component填写控件类型，则可选的字段为</strong>：</p><ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li><li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li><li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li><li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li><li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li><li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li><li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li><li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li><li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li><li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li><li> <b>VIRTUAL_COMBINATION</b> : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容</li></ul><p><strong>如果是SignComponent签署控件类型，<br>需要根据签署人的类型可选的字段为</strong></p><ul><li><p>企业方</p><ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li><li> <b>SIGN_DATE</b> : 签署日期控件；</li><li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li><li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li><li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li><li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li><li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li><li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul></li><li><p>个人方</p><ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li><li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li><li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li><li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li><li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li><li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li><li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul></li></ul><p>注：<code>表单域的控件不能作为印章和签名控件</code></p>
     */
    ComponentType: string;
    /**
     * <p><strong>在绝对定位方式和关键字定位方式下</strong>，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。</p>
     */
    ComponentHeight: number;
    /**
     * <p><strong>在绝对定位方式和关键字定位方式下</strong>，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。</p>
     */
    ComponentWidth: number;
    /**
     * <p><strong>在绝对定位方式方式下</strong>，指定控件所在PDF文件上的页码<br><strong>在使用文件发起的情况下</strong>，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。</p><p>注：</p><ol><li>页码编号是从<font color="red">1</font>开始编号的。</li><li><font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。</li></ol>
     */
    ComponentPage: number;
    /**
     * <p><strong>在绝对定位方式下</strong>，可以指定控件横向位置的位置，单位为pt（点）。</p>
     */
    ComponentPosX: number;
    /**
     * <p><strong>在绝对定位方式下</strong>，可以指定控件纵向位置的位置，单位为pt（点）。</p>
     */
    ComponentPosY: number;
    /**
     * <p><font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0</p>
     */
    FileIndex: number;
    /**
     * <p>控件生成的方式：</p><ul><li> <b>NORMAL</b> : 绝对定位控件</li><li> <b>FIELD</b> : 表单域</li><li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
     */
    GenerateMode?: string;
    /**
     * <p>控件唯一ID。</p><p><strong>在绝对定位方式方式下</strong>，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。</p><p><strong>在关键字定位方式下</strong>，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过&quot;^&quot;来决定是否使用关键字整词匹配能力。</p><p>例：</p><ul><li>如传入的关键字&lt;font color=&quot;red&quot;&gt;&quot;^甲方签署^&quot;，则会在PDF文件中有且仅有&quot;甲方签署&quot;关键字的地方（&lt;font color=&quot;red&quot;&gt;前后不能有其他字符）进行对应操作。</li><li>如传入的关键字为&lt;font color=&quot;red&quot;&gt;&quot;甲方签署&quot;，则PDF文件中每个出现关键字的位置（&lt;font color=&quot;red&quot;&gt;前后可以有其他字符）都会执行相应操作。</li></ul><p>注：<code>控件ID可以在一个PDF中不可重复</code></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a></p>
     */
    ComponentId?: string;
    /**
     * <p><strong>在绝对定位方式方式下</strong>，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。</p><p><strong>在表单域定位方式下</strong>，ComponentName不仅为控件名，也是表单域名称。</p><p>注：<code>控件名可以在一个PDF中可以重复</code></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a></p>
     */
    ComponentName?: string;
    /**
     * <p>如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填</p><ul><li>false（默认）：可以不填写</li><li>true ：必须填写此填写控件</li></ul>如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
     */
    ComponentRequired?: boolean;
    /**
     * <p><strong>在通过接口拉取控件信息场景下</strong>，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），<strong>发起合同时候不要填写此字段留空即可</strong></p>
     */
    ComponentRecipientId?: string;
    /**
     * <p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12,&quot;Bold&quot;:false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{&quot;FontColor&quot;:&quot;255,0,0&quot;,&quot;FontSize&quot;:12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>&quot;{\&quot;Font\&quot;:\&quot;黑体\&quot;,\&quot;FontSize\&quot;:20,\&quot;Opacity\&quot;:0.1,\&quot;Density\&quot;:2,\&quot;SubType\&quot;:\&quot;PERSON_INFO_WATERMARK\&quot;}&quot;</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以通过<strong>ComponentTypeLimit</strong>参数控制签名方式</p><ul><li> <b>HANDWRITE</b> :  需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{&quot;ComponentTypeLimit&quot;: [&quot;SYSTEM_ESIGN&quot;]}</code>印章的对应关系参考下图![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br><p><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过<strong>ComponentTypeLimit</strong>参数控制签署方签署时要使用的印章类型，支持指定以下印章类型</p><ul><li> <b>OFFICIAL</b> :  企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\&quot;ComponentTypeLimit\&quot;:[\&quot;PERSONNEL\&quot;,\&quot;FINANCE\&quot;]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、"仿宋"，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>&quot;{&quot;Format&quot;:&quot;yyyy m d&quot;,&quot;FontSize&quot;:12,&quot;Gaps&quot;:&quot;2,2&quot;, &quot;FontAlign&quot;:&quot;Right&quot;}&quot;</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>&quot;{&quot;PageRanges&quot;:[{&quot;BeginPage&quot;:1,&quot;EndPage&quot;:-1}]}&quot;</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{&quot;Opacity&quot;:0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{&quot;UseSealSize&quot;:true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul><b>参数样例</b>：<code>{&quot;Values&quot;:&quot;我已知晓内容并同意签署&quot;,&quot;ValuesArray&quot;:[&quot;我&quot;,&quot;已知晓&quot;,&quot;内容&quot;,&quot;并&quot;,&quot;同意&quot;,&quot;签署&quot;]}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>&quot;{&quot;IgnoreKeywordError&quot;:1}&quot;</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{&quot;Children&quot;:[&quot;ComponentId_29&quot;,&quot;ComponentId_27&quot;,&quot;ComponentId_28&quot;,&quot;ComponentId_30&quot;]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1">     <thead>         <tr>             <th>字段名称</th>             <th>类型</th>             <th>描述</th>         </tr>     </thead>     <tbody>         <tr>             <td>ComponentType</td>             <td>string</td>             <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>         </tr>         <tr>             <td>ComponentName</td>             <td>string</td>             <td>子控件名称</td>         </tr>         <tr>             <td>Placeholder</td>             <td>string</td>             <td>子控件提示语</td></tr><tr>             <td>ComponentValue</td>             <td>string</td>             <td>子控件值（签署方不可设置）</td>         </tr>                    <tr>             <td>ComponentOffsetX</td>             <td>float</td>             <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td>         </tr>         <tr>             <td>ComponentOffsetY</td>             <td>float</td>             <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td>         </tr>         <tr>             <td>ComponentWidth</td>             <td>float</td>             <td>控件宽</td>         </tr>         <tr>             <td>ComponentHeight</td>             <td>float</td>             <td>控件高</td>         </tr>         <tr>             <td>ComponentExtra</td>             <td>string</td>             <td>控件的附属信息，根据ComponentType设置</td>         </tr>     </tbody> </table><b>参数样例</b>：<p>输入:</p><pre>{    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:         }    ]}</pre></ul>
     */
    ComponentExtra?: string;
    /**
     * <p><strong>在通过接口拉取控件信息场景下</strong>，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，<strong>发起合同时候不要填写此字段留空即可</strong></p>
     */
    IsFormType?: boolean;
    /**
     * <p>控件填充vaule，ComponentType和传入值类型对应关系：</p><ul><li> <b>TEXT</b> : 文本内容</li><li> <b>MULTI_LINE_TEXT</b> : 文本内容，可以用  \n 来控制换行位置 </li><li> <b>CHECK_BOX</b> : true/false</li><li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li><li> <b>SELECTOR</b> : 选项值</li><li> <b>DYNAMIC_TABLE</b>  - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li><li> <b>DATE</b> : 格式化为：xxxx年xx月xx日（例如2024年05年28日）</li><li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li><li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取， [点击查看在控制台上位置](https://qcloudimg.tencent-cloud.cn/raw/f7b0f2ea4a534aada4b893dbf9671eae.png)</li></ul><p><b>控件值约束说明</b>：</p><table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>注：   <code>部分特殊控件需要在控制台配置模板形式创建</code>
     */
    ComponentValue?: string;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。<br>注意： <code>向左调整设置为负数， 向右调整设置成正数</code></p>
     */
    OffsetX?: number;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。<br>注意： <code>向上调整设置为负数， 向下调整设置成正数</code></p>
     */
    OffsetY?: number;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。</p><ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li><li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul><p>在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。</p>
     */
    KeywordOrder?: string;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。</p>
     */
    KeywordPage?: number;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，关键字生成的区域的对齐方式， 可以设置下面的值</p><ul><li> <b>Middle</b> :居中</li><li> <b>Below</b> :正下方</li><li> <b>Right</b> :正右方</li><li> <b>LowerRight</b> :右下角</li><li> <b>UpperRight</b> :右上角。</li></ul>示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
     */
    RelativeLocation?: string;
    /**
     * <p><strong>如果控件是关键字定位方式</strong>，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。</p><p>注意：关键字索引是从0开始计数的</p>
     */
    KeywordIndexes?: Array<number | bigint>;
    /**
     * <p><strong>web嵌入发起合同场景下</strong>， 是否锁定填写和签署控件值不允许嵌入页面进行编辑</p><ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li><li>true：锁定控件值，在页面无法编辑控件值</li></ul>
     */
    LockComponentValue?: boolean;
    /**
     * <p><strong>web嵌入发起合同场景下</strong>，是否禁止移动和删除填写和签署控件</p><ul><li> <b>false（默认）</b> :可以移动和删除控件</li><li> <b>true</b> : 禁止移动和删除控件</li></ul>
     */
    ForbidMoveAndDelete?: boolean;
    /**
     * <p><font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12</p>
     */
    ComponentDateFontSize?: number;
    /**
     * <p><font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识</p>
     */
    ChannelComponentId?: string;
    /**
     * <p><font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。</p><ul><li> <b>0</b> :平台指定；</li><li> <b>1</b> :用户自定义</li></ul>
     */
    ChannelComponentSource?: number;
}
/**
 * CreateFlowGroupReminds返回参数结构体
 */
export interface CreateFlowGroupRemindsResponse {
    /**
     * <p>合同组催办接口返回的详细信息。</p>
     */
    RemindFlowGroupRecords?: Array<RemindFlowGroupRecord>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateBatchSignUrl请求参数结构体
 */
export interface CreateBatchSignUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 签署方经办人的姓名。
  经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
  
  注：
  <ul>
  <li>请确保和合同中填入的一致。</li>
  <li>在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
  </ul>
     */
    Name?: string;
    /**
     * 手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：<ul><li>请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
     */
    Mobile?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 证件类型，支持以下类型
  <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
  
  注：
  1. `请确保和合同中填入的一致`。
  2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
     */
    IdCardType?: string;
    /**
     * 指定批量签署合同的签名类型，可传递以下值：<ul><li>**0**：手写签名</li><li>**1**：OCR楷体</li><li>**2**：姓名印章</li><li>**3**：图片印章</li><li>**4**：系统签名</li><li>**5**：长效手写签名（包含手写签名）</li></ul>注：<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）</li></ul></li><li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li></ul>
     */
    SignatureTypes?: Array<number | bigint>;
    /**
     * 证件号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
  
  注：
  1. `请确保和合同中填入的一致`。
  2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
     */
    IdCardNumber?: string;
    /**
     * 通知用户方式：
  <ul>
  <li>**NONE** : 不通知（默认）</li>
  <li>**SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）</li>
  </ul>
     */
    NotifyType?: string;
    /**
     * 批量签署的合同流程ID数组，<font color="red">此参数必传。</font>
  注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
     */
    FlowIds?: Array<string>;
    /**
     * 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
  
  注：
  <ul>
  <li>请确认该名称与企业营业执照中注册的名称一致。</li>
  <li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
  </ul>
     */
    OrganizationName?: string;
    /**
     * 是否直接跳转至合同内容页面进行签署
  <ul>
  <li>**false**: 会跳转至批量合同流程的列表,  点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
  <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
  </ul>
     */
    JumpToDetail?: boolean;
    /**
     * 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
     */
    FlowBatchUrlInfo?: FlowBatchUrlInfo;
    /**
     * 签署完成后是否自动回跳
  <ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
  
  注:
  1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
  3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必须用户手动点击完成按钮（微信的限制）</font>
     */
    AutoJumpBack?: boolean;
    /**
     * <font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
  
  参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
     */
    UrlUseEnv?: string;
    /**
     * 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>
  注：`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页（JumpToDetail参数为true），也不支持批量拒签功能`
     */
    CanBatchReject?: boolean;
    /**
     * 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>
  注：`1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。`
     */
    CanSkipReadFlow?: boolean;
}
/**
 * CreateBatchInformationExtractionTask返回参数结构体
 */
export interface CreateBatchInformationExtractionTaskResponse {
    /**
     * <p>合同智能提取的任务ID列表，每个任务ID为32位字符串。<br>建议开发者保存此任务ID，后续查询合同智能提取详情需要此任务ID。</p><p>注意：<code>返回的索引和ResourceIds数组一致</code></p>
     */
    TaskIds?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同组签署方信息
 */
export interface FlowGroupApprovers {
    /**
     * 合同流程ID
     */
    FlowId?: string;
    /**
     * 签署方信息，包含合同ID和角色ID用于定位RecipientId。
     */
    Approvers?: Array<ApproverItem>;
}
/**
 * DescribeContractComparisonTask请求参数结构体
 */
export interface DescribeContractComparisonTaskRequest {
    /**
     * 执行合同审查任务的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。
     */
    TaskId: string;
    /**
     * 是否返回详细的对比结果。为 true时，响应中将包含详细的对比信息，如相似度、文本差异具体内容等；为 false时，仅返回任务基本状态信息。
  注：`详细结果数据量可能较大，请按需开启。`
     */
    ShowDetail?: boolean;
    /**
     * 搜索条件，具体参考Filter结构体。本接口取值：
  
  1. **format-type：**
  按照【 合同文本格式类型 】进行过滤；
  类型：String；
  是否必填项：否；
  类型如下：
  <ul><li> **0**：段落（正文）</li>
  <li> **1**：标点符号</li>
  <li> **2**：页眉页脚</li>
  <li> **3**：目录</li>
  <li> **4**：印章</li>
  <li> **5**：序号</li>
  <li> **7**：下划线内容（填写区）</li>
  </ul>
     */
    Filters?: Array<Filter>;
}
/**
 * DescribeFlowBriefs请求参数结构体
 */
export interface DescribeFlowBriefsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 查询的合同流程ID列表最多支持100个流程ID。
  
  如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
  
  可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
     */
    FlowIds: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateInformationExtractionWebUrl返回参数结构体
 */
export interface CreateInformationExtractionWebUrlResponse {
    /**
     * 合同信息提取嵌入式web页面链接。
  
  注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    Url?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowGroupSignReview请求参数结构体
 */
export interface CreateFlowGroupSignReviewRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
     */
    FlowGroupId: string;
    /**
     * 提交的审核结果，审核结果有下面三种情况
  <ul><li><b>PASS</b>: 审核通过，合同流程可以继续执行签署等操作</li>
  <li><b>REJECT</b>: 审核拒绝，合同流程不会变动</li>
  <li><b>SIGN_REJECT</b>:拒签，合同流程直接结束，合同状态变为**合同拒签**</li></ul>
     */
    ReviewType: string;
    /**
     * 需要进行签署审核的签署人的个人信息或企业信息，签署方的匹配方式按照以下规则:
  
  个人：二选一（选择其中任意信息组合即可）
  <ul><li>姓名+证件类型+证件号</li>
  <li>姓名+手机号</li></ul>
  
  企业：二选一  （选择其中任意信息组合即可）
  <ul><li>企业名+姓名+证件类型+证件号</li>
  <li>企业名+姓名+手机号</li></ul>
     */
    ApproverInfo: NeedReviewApproverInfo;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
    /**
     * 审核不通过的原因，该字段的字符串长度不超过200个字符。
  
  注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`
  
     */
    ReviewMessage?: string;
}
/**
 * 企业超管信息
 */
export interface Admin {
    /**
     * 超管名
     */
    Name?: string;
    /**
     * 超管手机号，打码显示
  示例值：138****1569
  
     */
    Mobile?: string;
}
/**
 * 此结构体 (Caller) 用于描述调用方属性。
 */
export interface Caller {
    /**
     * 应用号
     * @deprecated
     */
    ApplicationId?: string;
    /**
     * 主机构ID
     * @deprecated
     */
    OrganizationId?: string;
    /**
     * 经办人的用户ID，同UserId
     */
    OperatorId?: string;
    /**
     * 下属机构ID
     * @deprecated
     */
    SubOrganizationId?: string;
}
/**
 * ExportContractComparisonTask返回参数结构体
 */
export interface ExportContractComparisonTaskResponse {
    /**
     * <p>对比任务详情下载链接。</p>
     */
    ResourceUrl?: string;
    /**
     * <p>下载链接有效截止时间。</p>
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeContractReviewChecklist返回参数结构体
 */
export interface DescribeContractReviewChecklistResponse {
    /**
     * <p>获取的合同风险审查清单ID</p>
     */
    ChecklistId?: string;
    /**
     * <p>获取的合同风险审查清单名称</p>
     */
    Name?: string;
    /**
     * <p>获取的合同风险审查清单是否启用</p>
     */
    Enabled?: boolean;
    /**
     * <p>获取的合同风险审查清单审查点列表</p>
     */
    Categories?: Array<ChecklistCategory>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 个性化参数
 */
export interface EmbedUrlOption {
    /**
     * 合同详情预览，允许展示控件信息
  <ul>
  <li><b>true</b>：允许在合同详情页展示控件</li>
  <li><b>false</b>：（默认）不允许在合同详情页展示控件</li>
  </ul>
     */
    ShowFlowDetailComponent?: boolean;
    /**
     * 模板预览，允许展示模板控件信息
  <ul><li> <b>true</b> :允许在模板预览页展示控件</li>
  <li> <b>false</b> :（默认）不允许在模板预览页展示控件</li></ul>
     */
    ShowTemplateComponent?: boolean;
    /**
     * 跳过上传文件，默认为false(展示上传文件页)![image](https://qcloudimg.tencent-cloud.cn/raw/8ca33745cf772e79831dbe5a70e82400.png)
  - false: 展示上传文件页
  - true: 不展示上传文件页
   
  
  注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，
     */
    SkipUploadFile?: boolean;
    /**
     * 隐藏下载文件按钮，默认为false(展示下载文件按钮)
  
  - false: 展示下载文件按钮
  - true: 不展示下载文件按钮
  
   
  
  注意: 此参数仅针对**EmbedType=PREVIEW_FLOW_DETAIL(查看合同详情)**有效
     */
    SkipDownloadFile?: boolean;
    /**
     * 是否禁止编辑（展示）水印控件属性
  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
  
     */
    ForbidEditWatermark?: boolean;
    /**
     * 印章描述
     */
    SealDescription?: string;
    /**
     * 是否禁止编辑印章描述内容
  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
     */
    ForbidEditSealDescription?: boolean;
}
/**
 * DescribeContractReviewMarkedRiskExportTask请求参数结构体
 */
export interface DescribeContractReviewMarkedRiskExportTaskRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 导出任务 ID。
     */
    TaskId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DescribeContractComparisonTask返回参数结构体
 */
export interface DescribeContractComparisonTaskResponse {
    /**
     * 合同对比任务ID。
     */
    TaskId?: string;
    /**
     * 合同对比任务状态。
  状态如下：
  <ul><li> **0**：待创建（未执行）</li>
  <li> **1**：对比中</li>
  <li> **2**：对比成功</li>
  <li> **3**：对比失败</li>
  </ul>
     */
    Status?: number;
    /**
     * 对比失败的具体原因描述，仅当状态为失败时返回此字段。
     */
    Message?: string;
    /**
     * 原版文件ID，对比基准的旧版本文件唯一标识。
     */
    OriginalFileResourceId?: string;
    /**
     * 新版文件ID，与旧版进行对比的新版本文件唯一标识。
     */
    DiffFileResourceId?: string;
    /**
     * 对比任务备注，长度不能超过50个字符。
     */
    Comment?: string;
    /**
     * 合同对比差异点总数。
     */
    TotalDiffCount?: number;
    /**
     * 合同对比新增点数量。
     */
    AddDiffCount?: number;
    /**
     * 合同对比修改点数量。
     */
    ChangeDiffCount?: number;
    /**
     * 合同对比删除点数量。
     */
    DeleteDiffCount?: number;
    /**
     * 提交人，提交此任务或请求的用户唯一标识。
     */
    Operator?: string;
    /**
     * 合同对比任务创建时间，时间戳。
     */
    CreateTime?: number;
    /**
     * 对比差异详情，请求参数ShowDetail为true时返回。
     */
    ComparisonDetail?: Array<ComparisonDetail>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeArchiveFlowTask请求参数结构体
 */
export interface DescribeArchiveFlowTaskRequest {
    /**
     * <p>执行本接口操作的员工信息。注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>任务id，<a href="">创建归档任务</a>时返回</p>
     */
    TaskId: string;
}
/**
 * CreateModifyAdminAuthorizationUrl返回参数结构体
 */
export interface CreateModifyAdminAuthorizationUrlResponse {
    /**
     * 变更企业超管授权书链接。
  没有有效期限制。
  
  注意：
  此链接仅能由当时认证企业的认证人使用。
     */
    Url?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateOrganizationInfoChangeUrl返回参数结构体
 */
export interface CreateOrganizationInfoChangeUrlResponse {
    /**
     * <p>创建的企业信息变更链接。</p>
     */
    Url?: string;
    /**
     * <p>链接过期时间。链接7天有效。</p>
     */
    ExpiredTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlow返回参数结构体
 */
export interface CreateFlowResponse {
    /**
     * <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>
     */
    FlowId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateUserNameChangeUrl返回参数结构体
 */
export interface CreateUserNameChangeUrlResponse {
    /**
     * 腾讯电子签小程序的个人更名链接。
  如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
  
  <strong>1.如果EndPoint是APP</strong>：
  得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
  
  <strong>2.如果EndPoint是HTTP</strong>：
  得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：
  得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  
  `注：` <font color="red">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>
     */
    UserVerifyUrl?: string;
    /**
     * 链接过期时间，为Unix时间戳（单位为秒）。
     */
    ExpireTime?: number;
    /**
     * 小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回
     */
    MiniAppId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifySingleSignOnEmployees请求参数结构体
 */
export interface ModifySingleSignOnEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)
     */
    SsoApplicationId: string;
    /**
     * 待修改员工的信息。
     */
    Employee: SingleSignOnEmployees;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DeleteSingleSignOnEmployees请求参数结构体
 */
export interface DeleteSingleSignOnEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 单点登录应用号的id,获取位置如下图![image](https://qcloudimg.tencent-cloud.cn/raw/9e61aaf390a5f90ea7606fe29b9a65fd.png)
     */
    SsoApplicationId: string;
    /**
     * 需要删除的单点登录员工的唯一Id 值
     */
    OpenId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CancelMultiFlowSignQRCode返回参数结构体
 */
export interface CancelMultiFlowSignQRCodeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 用户计费使用情况详情
 */
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;
}
/**
 * 合同智能提取字段信息
 */
export interface ExtractionField {
    /**
     * 用于合同智能提取的字段名称。
  
  注意: `长度不能超过30个字符`
     */
    Name: string;
    /**
     * 指定合同智能提取的字段类型，目前仅支持`TEXT`、`DATE`、`NUMBER`、`OPTION`类型。
  
  类型支持如下：
  1、TEXT（文本）
  2、DATE（日期）
  3、NUMBER（数字）
  4、OPTION（选项值）
     */
    Type: string;
    /**
     * 用于描述字段信息。
  
  注意：
  1、描述字段不能超过100个字符
     */
    Description?: string;
    /**
     * 提取出合同中的字段信息。
     */
    Values?: Array<string>;
    /**
     * 当字段类型`Type`为OPTION时为必输项，输入选项值
     */
    ChoiceList?: Array<string>;
}
/**
 * DescribeUserFlowType返回参数结构体
 */
export interface DescribeUserFlowTypeResponse {
    /**
     * <p>查询到的所有用户合同类型列表</p>
     */
    AllUserFlowTypes?: Array<TemplateUserFlowType>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同信息提取字段值信息。
 */
export interface ExtractionFieldResult {
    /**
     * 字段ID
     */
    Id?: string;
    /**
     * 用于合同智能提取的字段名称。
     */
    Name?: string;
    /**
     * 合同智能提取的字段类型，目前仅支持TEXT、DATE、NUMBER、OPTION类型。
  
  类型支持如下： 1、TEXT（文本） 2、DATE（日期） 3、NUMBER（数字） 4、OPTION（选项值）
     */
    Type?: string;
    /**
     * 提取出合同中的字段信息。
     */
    Values?: Array<string>;
    /**
     * 是否需要语义提取，默认为false
     */
    RequiresSemanticExtraction?: boolean;
    /**
     * 提取出值在合同中的坐标位置信息
     */
    Positions?: Array<PositionInfo>;
}
/**
 * DescribeExtendedServiceAuthDetail返回参数结构体
 */
export interface DescribeExtendedServiceAuthDetailResponse {
    /**
     * <p>服务授权的信息列表，根据查询类型返回特定扩展服务的授权状况。</p>
     */
    AuthInfoDetail?: AuthInfoDetail;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateLegalSealQrCode返回参数结构体
 */
export interface CreateLegalSealQrCodeResponse {
    /**
     * 二维码图片base64值，二维码有效期7天（604800秒）
  
  二维码图片的样式如下图：
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)
     */
    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;
}
/**
 * 提取web嵌入页面个性化设置
 */
export interface WebUrlOption {
    /**
     * 禁用链接预览
     */
    DisableLinkPreview?: boolean;
    /**
     * 禁用任务编辑
     */
    DisableTaskEditing?: boolean;
    /**
     * 禁用任务结果编辑
     */
    DisableTaskResultEditing?: boolean;
}
/**
 * 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;
}
/**
 * DescribeEnterpriseContractReviewChecklists返回参数结构体
 */
export interface DescribeEnterpriseContractReviewChecklistsResponse {
    /**
     * 查询的总条数
     */
    Total?: number;
    /**
     * 清单列表
     */
    Checklists?: Array<Checklist>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 企业扩展服务授权列表详情
 */
export interface AuthInfoDetail {
    /**
     * <p>扩展服务类型，和入参一致</p>
     */
    Type?: string;
    /**
     * <p>扩展服务名称</p>
     */
    Name?: string;
    /**
     * <p>授权员工列表</p>
     */
    HasAuthUserList?: Array<HasAuthUser>;
    /**
     * <p>授权企业列表（企业自动签时，该字段有值）</p>
     */
    HasAuthOrganizationList?: Array<HasAuthOrganization>;
    /**
     * <p>授权员工列表总数</p>
     */
    AuthUserTotal?: number;
    /**
     * <p>授权企业列表总数</p>
     */
    AuthOrganizationTotal?: number;
}
/**
 * ModifyApplicationCallbackInfo返回参数结构体
 */
export interface ModifyApplicationCallbackInfoResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 催办邮件结构体
 */
export interface RemindEmailInfo {
    /**
     * <p>签署编号</p>
     */
    SignId?: string;
    /**
     * <p>指定邮箱地址，催办时使用此邮箱替代 DB 中存储的邮箱</p>
     */
    ApproverEmail?: string;
}
/**
 * 用于定义合同风险识别角色信息。
 */
export interface RiskIdentificationRoleInfo {
    /**
     * 风险识别角色的名称。用于唯一标识和区分不同的风险识别角色。
  
  注意：`最大长度应不超过200个字符`
     */
    Name: string;
    /**
     * 风险识别角色的详细说明。
  
  注意： `最大长度应不超过500个字符`
     */
    Description?: string;
}
/**
 * CreateUserVerifyUrl请求参数结构体
 */
export interface CreateUserVerifyUrlRequest {
    /**
     * 操作人信息
     */
    Operator: UserInfo;
    /**
     * 要实名的姓名
     */
    Name?: string;
    /**
     * 要实名的身份证号码，
  身份证号码如果有x的话，统一传大写X
     */
    IdCardNumber?: string;
    /**
     * 证件类型，目前只支持身份证类型：ID_CARD
     */
    IdCardType?: string;
    /**
     * 要实名的手机号，兼容带+86的格式
     */
    Mobile?: string;
    /**
     * 实名完之后的跳转链接，最大长度1000个字符。
  链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
  
  注：此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
  
     */
    JumpUrl?: string;
    /**
     * 要跳转的链接类型
  
  <ul>
  <li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
  <li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
  <li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>
  <li><strong>H5</strong>：适用于跳转至电子签H5实名页面的长链接</li>
  <li><strong>H5_SHORT_URL</strong>：适用于跳转至电子签H5实名页面的短链接</li>
  </ul>
  
  注：如果不传递，默认值是 <font color="red"> APP </font>
     */
    Endpoint?: string;
    /**
     * 签署完成后是否自动回跳
  <ul><li>false：否, 实名完成不会自动跳转回来(默认)</li><li>true：是, 实名完成会自动跳转回来</li></ul>
  
  注:
  1. 该参数<font color="red">只针对APP类型（第三方APP或小程序跳转电子签小程序）场景</font> 的实名链接有效
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
  3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
     */
    AutoJumpBack?: boolean;
    /**
     * 在用户完成实名认证后，其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
     */
    UserData?: string;
}
/**
 * DescribeLMInformationExtractionTaskFieldFeedback请求参数结构体
 */
export interface DescribeLMInformationExtractionTaskFieldFeedbackRequest {
    /**
     * 执行合同智能提取任务的员工信息。
     */
    Operator: UserInfo;
    /**
     * 合同智能提取任务ID，该参数通过调用接口[批量创建合同智能提取任务](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/CreateBatchInformationExtractionTask/)获取。
     */
    TaskId?: 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 参数 只能二选一使用（注:
  <font color='red'>空数组代表未指定</font>），具体的控件类型如下
  
  <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>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</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 参数 只能二选一使用（注:
  <font color='red'>空数组代表未指定</font>），具体的控件类型如下
  <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>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</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;
    /**
     * 是否禁止编辑（展示）水印控件属性
  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
     */
    ForbidEditWatermark?: boolean;
    /**
     * 隐藏操作指引: 具体的控件类型如下
  
  <ul><li>1 : 操作指引入口</li>
  <li>2 : 操作文档</li>
  <li>3 : 操作视频</li>
  </ul>
  注：仅对新版页面生效
     * @deprecated
     */
    HideOperationInstructions?: Array<number | bigint>;
    /**
     * 隐藏操作步骤: 具体的控件类型如下
  
  <ul><li>1 : 选择文件及签署方</li>
  <li>2 : 补充文件内容</li>
  <li>4 : 发起前合同信息与设置确认</li>
  </ul>
  注：仅对新版页面生效
     */
    HideOperationSteps?: Array<number | bigint>;
    /**
     * 本企业简称，注：仅对新版页面生效
     */
    SelfName?: string;
    /**
     * 发起后签署码隐藏，默认false，注：仅对新版页面生效
     */
    HideSignCodeAfterStart?: boolean;
    /**
     * 发起成功后是否预览合同 <ul><li>（默认） false -否</li> <li> true - 展示预览按钮</li></ul>
     */
    PreviewAfterStart?: boolean;
    /**
     * 发起成功之后是否签署合同，仅当前经办人作为签署人时生效 <ul><li>（默认） false -否</li> <li> true - 展示签署按钮</li></ul>
     */
    SignAfterStart?: boolean;
    /**
     * 发起过程中是否保存草稿
     */
    NeedFlowDraft?: boolean;
}
/**
 * DescribeContractDiffTaskWebUrl返回参数结构体
 */
export interface DescribeContractDiffTaskWebUrlResponse {
    /**
     * 合同对比嵌入式web页面链接，有效期：5分钟
  链接仅能使用一次
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 机构信息
 */
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 {
    /**
     * <p>操作人信息</p>
     */
    Operator: UserInfo;
    /**
     * <p>指定授权方式 支持多选:</p><ul><li><strong>2</strong>: 法人授权方式</li><li><strong>5</strong>: 授权书+对公打款方式</li></ul>
     */
    AuthorizationTypes?: Array<number | bigint>;
    /**
     * <p>认证企业名称，请确认该名称与企业营业执照中注册的名称一致。</p><p>注：</p><ol><li><p><code>如果名称中包含英文括号()，请使用中文括号（）代替。</code></p></li><li><p><code>EndPointType=“H5”或者&quot;SHORT_H5&quot;时，该参数必填</code></p></li></ol>
     */
    OrganizationName?: string;
    /**
     * <p>企业统一社会信用代码</p>
     */
    UniformSocialCreditCode?: string;
    /**
     * <p>企业法人的姓名</p>
     */
    LegalName?: string;
    /**
     * <p><font color="red">即将废弃</font>，入参请使用JumpEvents。<br>认证完成跳回的链接，最长500个字符。</p>
     */
    AutoJumpUrl?: string;
    /**
     * <p>营业执照企业地址</p>
     */
    OrganizationAddress?: string;
    /**
     * <p>认证人姓名</p>
     */
    AdminName?: string;
    /**
     * <p>认证人手机号</p>
     */
    AdminMobile?: string;
    /**
     * <p>认证人身份证号</p>
     */
    AdminIdCardNumber?: string;
    /**
     * <p>认证人证件类型， 支持以下类型</p><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;
    /**
     * <p>对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p>
     */
    UniformSocialCreditCodeSame?: boolean;
    /**
     * <p>对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p><p>p.s. 仅在法人姓名不为空时有效</p>
     */
    LegalNameSame?: boolean;
    /**
     * <p>对方打开链接认证时，认证人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p><p>p.s. 仅在认证人姓名不为空时有效</p>
     */
    AdminNameSame?: boolean;
    /**
     * <p>对方打开链接认证时，认证人居民身份证件号是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p><p>p.s. 仅在认证人身份证号不为空时有效</p>
     */
    AdminIdCardNumberSame?: boolean;
    /**
     * <p>对方打开链接认证时，认证人手机号是否要与接口传递上来的保持一致。</p><ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul><p>p.s. 仅在认证人手机号不为空时有效</p>
     */
    AdminMobileSame?: boolean;
    /**
     * <p>对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p><p>p.s. 仅在企业名称不为空时有效</p>
     */
    OrganizationNameSame?: boolean;
    /**
     * <p>营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。</p>
     */
    BusinessLicense?: string;
    /**
     * <p>跳转链接类型：</p><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;
    /**
     * <p>指定企业初始化引导，现在可以配置如下的选项：</p><p><b>1</b>: 启用此选项后，在企业认证的最终步骤将添加创建印章的引导。如下图的位置<br><img src="https://qcloudimg.tencent-cloud.cn/raw/88e0b45095a5c589de8995462ad755dc.jpg" alt="image"><br><b>2</b>:开通企业授权API签署协议，目前仅支持PC网页端，即Endpoint=PC（该功能需联系电子签客服开通）<br><img src="https://qcloudimg.tencent-cloud.cn/raw/4d40b098acf7c04afd1c451a4f98fc90.png" alt="image"></p><p>枚举值：</p><ul><li>1： 创建印章</li><li>2： 开通企业授权API签署协议</li></ul>
     */
    Initialization?: Array<number | bigint>;
    /**
     * <p>授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。<br>授权书可以通过接口<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthFile">生成企业授权书</a> 来获得。<br>p.s. 如果上传授权书 ，需遵循以下条件 </p><ol><li>超管的信息（超管姓名，超管手机号）必须为必填参数。</li><li>认证方式AuthorizationTypes必须只能是上传授权书方式</li></ol>
     */
    PowerOfAttorneys?: Array<string>;
    /**
     * <p>调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 4096长度。</p><p>在. 企业引导企业实名认证后回调中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_staffs" target="_blank">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>组织机构对公打款账号，账户名跟企业名称一致。</p><p>p.s.<br>只有认证方式是授权书+对公打款时才生效。</p>
     */
    BankAccountNumber?: string;
    /**
     * <p>对方打开链接认证时，对公打款账号是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul></p><p>p.s. 仅在对公打款不为空时有效</p>
     */
    BankAccountNumberSame?: boolean;
    /**
     * <p>跳转事件，其中包括认证期间收录，授权书审核，企业认证的回跳事件。<br>p.s.<br>Endpoint如果是APP 类型，请传递JumpUrl为<font color="red">&quot;true&quot; </font><br>如果 Endpoint 是 H5 类型，请参考文档跳转电子签H5 </p><p>p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。</p>
     */
    JumpEvents?: Array<JumpEvent>;
    /**
     * <p>企业证照类型：<ul><li> <strong>USCC</strong> :(默认)工商组织营业执照</li><li> <strong>PRACTICELICENSEOFMEDICALINSTITUTION</strong> :医疗机构执业许可证</li><li> <strong>CLINICFILLINGCERTIFICATE</strong> :诊所备案证</li></ul></p><p>注意 ：<br>如果企业证照类型是医疗机构执业许可证或者诊所备案证，则参数设置企业授权方式(AuthorizationTypes)和企业认证方式(AuthorizationMethods)都无效.<br>医疗机构执业许可证和诊所备案证的企业授权方式  仅有授权书的方式。企业认证仅有上传营业执照的方式。</p>
     */
    OrganizationIdCardType?: string;
    /**
     * <p>是否允许编辑企业注册时的证照类型</p><p>true:不允许编辑。</p><p>false:允许编辑（默认值）。</p><p>注意：<br>入参中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。</p>
     */
    OrganizationIdCardTypeSame?: boolean;
    /**
     * <p>指定企业认证的授权方式 支持多选:</p><ul><li><strong>1</strong>: 上传营业执照</li><li><strong>2</strong>: 腾讯云快速认证</li><li><strong>3</strong>: 腾讯商户号授权<font color="red">（仅支持小程序端）</font></li></ul><p>注意：<br>1.如果没有指定，则默认是1,仅有上传营业执照。<br>2.H5 仅支持上传营业执照。</p>
     */
    AuthorizationMethod?: Array<number | bigint>;
    /**
     * <p>企业认证页面隐藏上传营业执照<br><img src="https://qcloudimg.tencent-cloud.cn/raw/cf827ce0e2043d8cc85e0735c9cfa3fc.png" alt="image"><br><img src="https://qcloudimg.tencent-cloud.cn/raw/f908cabe71238c78ee8fafc70888a344.png" alt="image"></p>
     */
    HideBizLicense?: boolean;
    /**
     * <p>对方打开链接认证时，公司地址是否要与接口传递上来的保持一致。</p><ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时会回显接口传递的值，且不可更改</li></ul>p.s. 仅在公司地址（OrganizationAddress）不为空时有效<p>如下图所示：<br><img src="https://qcloudimg.tencent-cloud.cn/raw/4aa67a434cdf522c04e32f2e1de0382b.png" alt="示例"><p></p></p>
     */
    AddressSame?: boolean;
    /**
     * <p>对方打开链接认证时，公司营业执照是否要与接口传递上来的保持一致。</p><ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致，用户可以进行修改</li><li><b>true</b>：启用状态，实际认证时回填的信息就是用户传递的值，并且不能修改</li></ul><p></p><p>p.s. 仅在公司营业执照（BusinessLicense）不为空时有效</p>如下图<img src="https://qcloudimg.tencent-cloud.cn/raw/7159637d5a8ac3d92b35813b1fc9660a.png" alt="示例">
     */
    BizLicenseSame?: boolean;
}
/**
 * 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?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CancelOrganizationFlows返回参数结构体
 */
export interface CancelOrganizationFlowsResponse {
    /**
     * <p>全量撤销企业合同任务编号，为32位字符串，可用于<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CancelOrganizationFlows">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E5%8D%81%E4%B8%80-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">全量撤销企业合同任务结果回调</a></p>
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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;
}
/**
 * CreateFlowGroupSignReview返回参数结构体
 */
export interface CreateFlowGroupSignReviewResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowReminds返回参数结构体
 */
export interface CreateFlowRemindsResponse {
    /**
     * <p>合同催办结果的详细信息列表。</p>
     */
    RemindFlowRecords?: Array<RemindFlowRecords>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 集团子企业使用集团主企业的套餐使用情况
 */
export interface SubOrgBillUsage {
    /**
     * 套餐使用数
     */
    Used?: 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;
}
/**
 * DescribeOrganizationGroupOrganizations请求参数结构体
 */
export interface DescribeOrganizationGroupOrganizationsRequest {
    /**
     * 执行本接口操作的员工信息,userId必填。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 指定分页每页返回的数据条数，单页最大支持 200。
     */
    Limit: number;
    /**
     * 偏移量，默认为0，最大20000。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688" target="_blank">简介</a>中的相关小节。
     */
    Offset: number;
    /**
     * 查询成员企业的企业名，模糊匹配
     * @deprecated
     */
    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>
  
  p.s.
  若传入此参数， LImit参数将无效，导出的为全量数据。
     */
    Export?: boolean;
    /**
     * 成员企业机构 ID，32 位字符串，在PC控制台 集团管理可获取
     */
    Id?: string;
}
/**
 * 代理相关应用信息，如集团主企业代子企业操作
 */
export interface Agent {
    /**
     * 代理机构的应用编号,32位字符串，一般不用传
     * @deprecated
     */
    AppId?: string;
    /**
     * 被代理机构的应用号，一般不用传
     * @deprecated
     */
    ProxyAppId?: string;
    /**
     * 被代理机构在电子签平台的机构编号，集团代理下场景必传
     */
    ProxyOrganizationId?: string;
    /**
     * 被代理机构的经办人，一般不用传
     * @deprecated
     */
    ProxyOperator?: string;
}
/**
 * DescribeFileConvertTask请求参数结构体
 */
export interface DescribeFileConvertTaskRequest {
    /**
     * <p>转换任务Id，通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>得到的转换任务id</p>
     */
    TaskId: string;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * 企业应用回调信息
 */
export interface CallbackInfo {
    /**
     * 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
     */
    CallbackUrl: string;
    /**
     * 回调加密key，已废弃
     * @deprecated
     */
    Token?: string;
    /**
     * 回调加密key，用于回调消息加解密。
     */
    CallbackKey?: string;
    /**
     * 回调验签token，用于回调通知校验。
     */
    CallbackToken?: string;
}
/**
 * DescribeBatchOrganizationRegistrationUrls请求参数结构体
 */
export interface DescribeBatchOrganizationRegistrationUrlsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id
     */
    TaskId: string;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
}
/**
 * 此结构体 (TemplateInfo) 用于描述模板的信息。

> **模板组成**
>
>  一个模板通常会包含以下结构信息
>- 模板基本信息
>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
>- 生成模板的文件基础信息 FileInfos
 */
export interface TemplateInfo {
    /**
     * 模板ID，模板的唯一标识
     */
    TemplateId?: string;
    /**
     * 模板的名字
     */
    TemplateName?: string;
    /**
     * 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
  
  [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
  
  
     */
    Recipients?: Array<Recipient>;
    /**
     * 模板的填充控件列表
  
  [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
     */
    Components?: Array<Component>;
    /**
     * 此模板中的签署控件列表
  
  [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
     */
    SignComponents?: Array<Component>;
    /**
     * 模板描述信息
     */
    Description?: string;
    /**
     * 此模板的资源ID
     */
    DocumentResourceIds?: Array<string>;
    /**
     * 生成模板的文件基础信息
     */
    FileInfos?: Array<FileInfo>;
    /**
     * 此模板里边附件的资源ID
     */
    AttachmentResourceIds?: Array<string>;
    /**
     * 签署人参与签署的顺序，可以分为以下两种方式：
  
  <b>无序</b>：不限定签署人的签署顺序，签署人可以在任何时间签署。此种方式值为 ：｛-1｝
  <b>有序</b>：通过序列数字标识签署顺序，从0开始编码，数字越大签署顺序越靠后，签署人按照指定的顺序依次签署。此种方式值为： ｛0，1，2，3………｝
     */
    SignOrder?: Array<number | bigint>;
    /**
     * 此模板的状态可以分为以下几种：
  
  <b>-1</b>：不可用状态。
  <b>0</b>：草稿态，即模板正在编辑或未发布状态。
  <b>1</b>：正式态，只有正式态的模板才可以发起合同。
     */
    Status?: number;
    /**
     * 模板的创建者信息，用户的名字
  
  注： `是创建者的名字，而非创建者的用户ID`
     */
    Creator?: string;
    /**
     * 模板创建的时间戳，格式为Unix标准时间戳（秒）
     */
    CreatedOn?: number;
    /**
     * 此模板创建方角色信息。
  
  [点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
  
     */
    Promoter?: Recipient;
    /**
     * 模板类型可以分为以下两种：
  
  <b>1</b>：带有本企业自动签署的模板，即签署过程无需签署人手动操作，系统自动完成签署。
  <b>3</b>：普通模板，即签署人需要手动进行签署操作。
     */
    TemplateType?: number;
    /**
     * 模板可用状态可以分为以下两种：
  
  <b>1</b>：（默认）启用状态，即模板可以正常使用。
  <b>2</b>：停用状态，即模板暂时无法使用。
  
  可到控制台启停模板
     */
    Available?: number;
    /**
     * 创建模板的企业ID，电子签的机构ID
     */
    OrganizationId?: string;
    /**
     * 模板创建人用户ID
     */
    CreatorId?: string;
    /**
     * 模板的 H5 预览链接，有效期为 5 分钟。
  您可以通过浏览器直接打开此链接预览模板，或将其嵌入到 iframe 中进行预览。
  
  注意：只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true，才会生成预览链接。
     */
    PreviewUrl?: string;
    /**
     * 用户自定义合同类型。
  
  返回配置模板的时候选择的合同类型。[点击查看配置的位置](https://qcloudimg.tencent-cloud.cn/raw/4a766f0540253bf2a05d50c58bd14990.png)
  
  自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
  
     */
    UserFlowType?: UserFlowType;
    /**
     * 模板版本的编号，旨在标识其独特的版本信息，通常呈现为一串字符串，由日期和递增的数字组成
     */
    TemplateVersion?: string;
    /**
     * 模板是否已发布可以分为以下两种状态：
  
  <b>true</b>：已发布状态，表示该模板已经发布并可以正常使用。
  <b>false</b>：未发布状态，表示该模板还未发布，无法使用。
     */
    Published?: boolean;
    /**
     * <b>集体账号场景下</b>： 集团账号分享给子企业的模板的来源模板ID。
     */
    ShareTemplateId?: string;
    /**
     * 此模板配置的预填印章列表（包括自动签署指定的印章）
     */
    TemplateSeals?: Array<SealInfo>;
    /**
     * 模板内部指定的印章列表
  注意：此字段可能返回 null，表示取不到有效值。
     * @deprecated
     */
    Seals?: Array<SealInfo>;
}
/**
 * DescribeEnterpriseContractReviewChecklists请求参数结构体
 */
export interface DescribeEnterpriseContractReviewChecklistsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 过滤条件
     */
    Filters?: Filter;
    /**
     * 指定每页返回的数据条数，和Offset参数配合使用。
     */
    Limit?: number;
    /**
     * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
     */
    Offset?: number;
}
/**
 * CreateDocument返回参数结构体
 */
export interface CreateDocumentResponse {
    /**
     * 合同流程的底层电子文档ID，为32位字符串。
  
  注:
  后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow)，合同才能进入签署环节
     */
    DocumentId?: string;
    /**
     * 合同预览链接URL。
  
  注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
  `2.当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容,完整的预览链接需通过[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign/#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取。
     */
    PreviewFileUrl?: string;
    /**
     * 签署方信息，如角色ID、角色名称等
     */
    Approvers?: Array<ApproverItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateIntegrationUserRoles返回参数结构体
 */
export interface CreateIntegrationUserRolesResponse {
    /**
     * 绑定角色失败列表信息
     */
    FailedCreateRoleData?: Array<FailedCreateRoleData>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateEmbedWebUrl返回参数结构体
 */
export interface CreateEmbedWebUrlResponse {
    /**
     * 嵌入的web链接，有效期：5分钟
  链接仅能使用一次
  建议：每次都用接口生成链接，保证链接的有效性
  <br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 集成版企业角色信息。
 */
export interface StaffRole {
    /**
     * 角色ID。
     */
    RoleId?: string;
    /**
     * 角色名称。
     */
    RoleName?: string;
}
/**
 * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
 */
export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
    /**
     * 解绑是否成功。
  <ul><li> **0**：失败 </li>
  <li> **1**：成功 </li></ul>
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateReleaseFlow返回参数结构体
 */
export interface CreateReleaseFlowResponse {
    /**
     * 解除协议流程编号
  `注意：这里的流程编号对应的合同是本次发起的解除协议。`
  
     */
    FlowId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同审查清单个性化参数，用于控制页面的展示内容
 */
export interface ContractReviewChecklistWebUrlOption {
    /**
     * 禁用新建清单功能。默认 false，设置为 true 会隐藏界面的新建按钮。
     */
    DisableCreateChecklist?: boolean;
}
/**
 * BindEmployeeUserIdWithClientOpenId请求参数结构体
 */
export interface BindEmployeeUserIdWithClientOpenIdRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  
  通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取，也可登录腾讯电子签控制台查看
  ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
     */
    UserId: string;
    /**
     * 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
     */
    OpenId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 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;
}
/**
 * DescribeExtendedServiceAuthDetail请求参数结构体
 */
export interface DescribeExtendedServiceAuthDetailRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>要查询的扩展服务类型。<br>如下所示：</p><ul><li>OPEN_SERVER_SIGN：企业静默签署</li><li>BATCH_SIGN：批量签署</li></ul>
     */
    ExtendServiceType?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>指定每页返回的数据条数，和Offset参数配合使用。 注：<code>1.默认值为20，单页做大值为200。</code></p>
     */
    Limit?: number;
    /**
     * <p>查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：<code>1.offset从0开始，即第一页为0。</code> <code>2.默认从第一页返回。</code></p>
     */
    Offset?: number;
    /**
     * <p>查询指定的合作方企业的授权信息，当ExtendServiceType=OPEN_SERVER_SIGN：企业静默签署时有效</p>
     */
    PartnerOrganizationName?: string;
}
/**
 * CreateOrganizationAuthFile请求参数结构体
 */
export interface CreateOrganizationAuthFileRequest {
    /**
     * 企业授权书信息参数， 需要自行保证这些参数跟营业执照中的信息一致。
     */
    OrganizationCommonInfo: OrganizationCommonInfo;
    /**
     * 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 执行本接口操作的员工信息。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator?: UserInfo;
    /**
     * 授权书类型：
  - 0: 企业认证超管授权书
  - 1: 超管变更授权书
  - 2: 企业注销授权书
     */
    Type?: number;
}
/**
 * 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
 */
export interface ComponentLimit {
    /**
     * <p>控件类型，支持以下类型</p><ul><li>SIGN_SEAL : 印章控件</li><li>SIGN_PAGING_SEAL : 骑缝章控件</li><li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li><li>SIGN_SIGNATURE : 用户签名控件</li></ul>
     */
    ComponentType: string;
    /**
     * <p>签署控件类型的值(可选)，用于限制签署时印章或者签名的选择范围</p><p>1.当 ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时，可指定印章类型或具体企业印章Id。具体场景与规则说明如下：</p><p>指定印章类型:可传入以下枚举值来限制印章类型</p><ul><li> <b>OFFICIAL</b> :  企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><p>指定具体印章Id:可通过传递 ComponentValue 来指定具体的企业印章ID（支持传入多个）<br><strong>限制条件</strong>：</p><ul><li>可为本企业（即发起方）的签署人指定本企业具体印章ID。</li><li>主企业发起或<a href="https://qian.tencent.com/developers/company/groupCompany">集团账号主代子</a>发起的业务场景下，也支持指定子企业的具体印章ID。</li><li><font color="red"><strong>他方企业签署人不支持指定具体印章ID</strong></font></li></ul><p><font color="red"><strong>注意： 若请求中同时指定了具体的印章ID和印章类型，将以印章ID为准，传入的印章类型参数会被自动忽略。</strong></font><br><br></p><p>2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）</p><ul><li>HANDWRITE : 需要实时手写的手写签名</li><li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li>OCR_ESIGN : OCR印章（智慧手写签名）</li><li>ESIGN : 个人印章</li><li>SYSTEM_ESIGN : 系统印章</li></ul><br>3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
     */
    ComponentValue?: Array<string>;
}
/**
 * ModifyPartnerAuthorization请求参数结构体
 */
export interface ModifyPartnerAuthorizationRequest {
    /**
     * 执行本接口操作的员工信息。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 腾讯电子签平台分配的生态集成业务的**业务标识**，**需要联系接入产品经理提供**。
     */
    BusinessId: string;
    /**
     * 合作方企业通过集成方创建的应用id, 必须与业务标记（Business）保持对应。
  ![image](https://qcloudimg.tencent-cloud.cn/raw/9bc4ee2bd5972035d12033608df157c9.png)
  
     */
    PartnerApplicationId: string;
    /**
     * 第三方应用的配置信息。其中包括 回调地址，加密KEY等信息。
  执行成功后会覆盖掉对应的第三方应用的回调相关配置。
     */
    ApplicationInfo: CallbackInfo;
}
/**
 * CreateIntegrationSubOrganizationActiveRecord返回参数结构体
 */
export interface CreateIntegrationSubOrganizationActiveRecordResponse {
    /**
     * 激活失败的成员企业ID集合
     */
    FailedSubOrganizationIds?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同备注
 */
export interface FlowRemarkItem {
    /**
     * <p>合同备注下标，对应最多5个备注位</p><p>取值范围：[0, 4]</p>
     */
    RemarkId?: number;
    /**
     * <p>合同备注内容，不超过 50 个字符，DELETE 时无需传入</p>
     */
    RemarkValue?: string;
}
/**
 * 补充签署人信息
- RecipientId 必须指定
-  通过企业微信自定义账号ID补充签署人时，ApproverSource 和 CustomUserId 必填，ApproverSource取值：WEWORKAPP
- 通过二要素（姓名/手机号）补充签署人时，ApproverName 和 ApproverMobile 必填，ApproverSource设置为空
- 补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充
 */
export interface FillApproverInfo {
    /**
     * <p>签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。<br>模板发起合同时，该参数为必填项。<br>文件发起合同时，该参数无需传值。<br>如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。</p>
     */
    RecipientId: string;
    /**
     * <p>签署人来源<br>WEWORKAPP: 企业微信<br><br>仅【企微或签】时指定WEWORKAPP</p>
     */
    ApproverSource?: string;
    /**
     * <p>企业微信UserId<br><br>当ApproverSource为WEWORKAPP的企微或签场景下，必须指企业自有应用获取企业微信的UserId</p>
     */
    CustomUserId?: string;
    /**
     * <p>企业签署人的员工姓名。除企业微信应用场景（ApproverSource设置为WEWORKAPP）外，本字段为必填。</p>
     */
    ApproverName?: string;
    /**
     * <p>补充企业签署人员工手机号</p><ul><li>ApproverSource!=WEWORKAPP时，必传</li></ul>
     */
    ApproverMobile?: string;
    /**
     * <p>补充企业动态签署人时，需要指定对应企业名称</p>
     */
    OrganizationName?: string;
    /**
     * <p>签署方经办人的证件类型，支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p>注: 补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。</p>
     */
    ApproverIdCardType?: string;
    /**
     * <p>签署方经办人的证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串</li></ul><p>注：<code>补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。</code></p>
     */
    ApproverIdCardNumber?: string;
    /**
     * <p>合同流程ID</p><ul><li>补充合同组子合同动态签署人时必传。</li><li>补充普通合同时，请阅读：<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口</a>的接口使用说明</li></ul>
     */
    FlowId?: string;
    /**
     * <p>通知类型：</p><li>当FillApproverType =0，或签场景补充签署人时，指定是否发送或签领取短信</li><li>SMS：开启或签领取短信通知</li><li>NONE：关闭或签领取短信通知</li><li>当NotifyType=NONE时，可调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl" target="_blank" rel="noopener noreferrer">获取跳转至腾讯电子签小程序的签署链接</a>接口生成签署链接来完成或签领取</li>
     */
    NotifyType?: string;
}
/**
 * CreatePersonAuthCertificateImage返回参数结构体
 */
export interface CreatePersonAuthCertificateImageResponse {
    /**
     * 个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
     */
    AuthCertUrl?: string;
    /**
     * 个人用户认证证书的编号, 为20位数字组成的字符串,  由腾讯电子签下发此编号 。
  该编号会合成到个人用户证书证明图片。
  
  注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
     */
    ImageCertId?: string;
    /**
     * 在数字证书申请过程中，系统会自动生成一个独一无二的序列号。请注意，当证书到期并自动续期时，该序列号将会发生变化。值得注意的是，此序列号不会被合成至个人用户证书的证明图片中。
     */
    SerialNumber?: string;
    /**
     * CA证书颁发时间，格式为Unix标准时间戳（秒）
  该时间格式化后会合成到个人用户证书证明图片
     */
    ValidFrom?: number;
    /**
     * CA证书有效截止时间，格式为Unix标准时间戳（秒）
  该时间格式化后会合成到个人用户证书证明图片
     */
    ValidTo?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 转交合同结果
 */
export interface FlowForwardResult {
    /**
     * 合同流程ID为32位字符串。您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
     */
    FlowId?: string;
    /**
     * 如果失败，返回的错误细节。
     */
    ErrorDetail?: string;
}
/**
 * DescribeLMInformationExtractionTaskFieldFeedback返回参数结构体
 */
export interface DescribeLMInformationExtractionTaskFieldFeedbackResponse {
    /**
     * 合同智能提取子任务反馈信息
     */
    SubTaskFeedbackList?: Array<SubTaskFeedback>;
    /**
     * 合同智能提取任务ID
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateLMInformationExtractionTaskFieldFeedback返回参数结构体
 */
export interface CreateLMInformationExtractionTaskFieldFeedbackResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeIntegrationEmployees返回参数结构体
 */
export interface DescribeIntegrationEmployeesResponse {
    /**
     * 员工信息列表。
     */
    Employees?: Array<Staff>;
    /**
     * 偏移量
     */
    Offset?: number;
    /**
     * 指定分页每页返回的数据条数，单页最大支持 20。
     */
    Limit?: number;
    /**
     * 符合条件的员工数量。
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyFlowDeadline返回参数结构体
 */
export interface ModifyFlowDeadlineResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateBatchCancelFlowUrl返回参数结构体
 */
export interface CreateBatchCancelFlowUrlResponse {
    /**
     * 批量撤回签署流程链接
     */
    BatchCancelFlowUrl?: string;
    /**
     * 签署流程撤回失败信息
  数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
     */
    FailMessages?: Array<string>;
    /**
     * 签署连接过期时间字符串：年月日-时分秒
  
     */
    UrlExpireOn?: string;
    /**
     * 批量撤销任务编号，为32位字符串，可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 创建员工的失败数据
 */
export interface FailedCreateStaffData {
    /**
     * 员工名
     */
    DisplayName?: string;
    /**
     * 员工手机号
     */
    Mobile?: string;
    /**
     * 传入的企微账号id
     */
    WeworkOpenId?: string;
    /**
     * 失败原因
     */
    Reason?: string;
}
/**
 * CreateUserAutoSignEnableUrl返回参数结构体
 */
export interface CreateUserAutoSignEnableUrlResponse {
    /**
     * <p>个人用户自动签的开通链接, 短链/长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
     */
    Url?: string;
    /**
     * <p>腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用</p><p>注: <code>如果获取的是H5链接, 则不会返回此值</code></p>
     */
    AppId?: string;
    /**
     * <p>腾讯电子签小程序的原始 Id,  ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用</p><p>注: <code>如果获取的是H5链接, 则不会返回此值</code></p>
     */
    AppOriginalId?: string;
    /**
     * <p>腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用</p><p>注: <code>如果获取的是H5链接, 则不会返回此值</code></p>
     */
    Path?: string;
    /**
     * <p>base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。</p><p>注: <code>如果获取的是H5链接, 则不会返回此二维码图片</code></p>
     */
    QrCode?: string;
    /**
     * <p>返回的链接类型</p><ul><li> 空: 默认小程序端链接</li><li> **H5SIGN** : h5端链接</li></ul>
     */
    UrlType?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
 */
export interface FlowGroupInfo {
    /**
     * <p>合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
     */
    FlowName: string;
    /**
     * <p>签署流程参与者信息，最大限制50方<br>注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。</p>
     */
    Approvers: Array<ApproverInfo>;
    /**
     * <p>文件资源ID，通过多文件上传<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获得，为32位字符串。<br>注：此字段定义为数组，但仅支持单个文件</p>
     */
    FileIds?: Array<string>;
    /**
     * <p>合同模板ID，为32位字符串。<br>建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。<br>可登录腾讯电子签控制台，在 &quot;模板&quot;-&gt;&quot;模板中心&quot;-&gt;&quot;列表展示设置&quot;选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
     */
    TemplateId?: string;
    /**
     * <p>签署流程的类型(如销售合同/入职合同等)，最大长度200个字符</p>
     */
    FlowType?: string;
    /**
     * <p>签署流程描述,最大长度1000个字符</p>
     */
    FlowDescription?: string;
    /**
     * <p>签署流程的签署截止时间。</p><p>值为unix时间戳,精确到秒,不传默认为当前时间一年后<br>示例值：1604912664</p>
     */
    Deadline?: number;
    /**
     * <p>合同（流程）的回调地址</p>
     * @deprecated
     */
    CallbackUrl?: string;
    /**
     * <p>调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>发送类型：<br>true：无序签<br>false：有序签<br>注：默认为false（有序签），请和模板中的配置保持一致<br>示例值：true</p>
     */
    Unordered?: boolean;
    /**
     * <p>模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>动态表格等填写控件</li></ul>
     */
    Components?: Array<Component>;
    /**
     * <p>发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。<br>若设置为true，审核结果需通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview">CreateFlowSignReview</a> 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。</p><p>注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。<br>示例值：true</p>
     */
    NeedSignReview?: boolean;
    /**
     * <p>个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN</p>
     */
    AutoSignScene?: string;
    /**
     * <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>
     */
    FlowDisplayType?: number;
    /**
     * <p>抄送人信息</p>
     */
    CcInfos?: Array<CcInfo>;
}
/**
 * CreatePartnerAutoSignAuthUrl返回参数结构体
 */
export interface CreatePartnerAutoSignAuthUrlResponse {
    /**
     * <p>授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。</p>
     */
    Url?: string;
    /**
     * <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
     */
    MiniAppPath?: string;
    /**
     * <p>链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。</p>
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ArchiveDynamicFlow请求参数结构体
 */
export interface ArchiveDynamicFlowRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID, 为32位字符串。
  
  可登录腾讯电子签控制台，[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
     */
    FlowId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * ModifyIntegrationRole返回参数结构体
 */
export interface ModifyIntegrationRoleResponse {
    /**
     * 角色id
     */
    RoleId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式
 */
export interface ApproverComponentLimitType {
    /**
     * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
     */
    RecipientId: string;
    /**
     * 签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式，可多选
  
  签名方式：
  <ul>
  <li>HANDWRITE-手写签名</li>
  <li>ESIGN-个人印章类型</li>
  <li>OCR_ESIGN-AI智能识别手写签名</li>
  <li>SYSTEM_ESIGN-系统签名</li>
  </ul>
     */
    Values: Array<string>;
}
/**
 * CreateSingleSignOnEmployees返回参数结构体
 */
export interface CreateSingleSignOnEmployeesResponse {
    /**
     * 导入员工返回的错误信息，信息数组的顺序跟导入的保持一致
     */
    ErrorMessages?: Array<string>;
    /**
     * 导入员工返回的状态码
  0-全部成功
  1-部分成功
  2-全部失败
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowEvidenceReport返回参数结构体
 */
export interface CreateFlowEvidenceReportResponse {
    /**
     * <p>出证报告 ID，可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL</p>
     */
    ReportId?: string;
    /**
     * <p>出证任务执行的状态, 状态含义如下：</p><ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li><li>**EvidenceStatusSuccess**：  出证任务执行成功</li><li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
     */
    Status?: string;
    /**
     * <p>此字段已经废除,不再使用.<br>出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取</p>
     * @deprecated
     */
    ReportUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 视频核身相关配置
 */
export interface RuleIdConfig {
    /**
     * 意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0：
  0-智能语速（根据播报文案的长度自动调整语音播报速度）
  1-固定1倍速
  2-固定1.2倍速
  3-固定1.5倍速
     */
    Speed?: number;
}
/**
 * OperateTemplate返回参数结构体
 */
export interface OperateTemplateResponse {
    /**
     * 模板ID，为32位字符串，模板复制新建时返回
     */
    TemplateId?: string;
    /**
     * 模板名称，模板复制新建时返回
     */
    TemplateName?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateOrganizationGroupInvitationLink返回参数结构体
 */
export interface CreateOrganizationGroupInvitationLinkResponse {
    /**
     * 加入集团二维码链接，子企业的管理员可以直接扫码进入。
  注意:1. 该链接有效期时间为ExpireTime，同时需要注意保密，不要外泄给无关用户。2. 该链接不支持小程序嵌入，仅支持<b>移动端浏览器</b>打开。3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
     */
    Link?: string;
    /**
     * 到期时间（以秒为单位的时间戳）
     */
    ExpireTime?: number;
    /**
     * 加入集团短链接。
  注意:
  1. 该链接有效期时间为ExpireTime，同时需要注意保密，不要外泄给无关用户。
  2. 该链接不支持小程序嵌入，仅支持<b>移动端浏览器</b>打开。
  3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
     */
    JumpUrl?: string;
    /**
     * 腾讯电子签小程序加入集团链接。
  
  <li>小程序和APP集成使用</li>
  <li>得到的链接类似于`pages/guide?shortKey=yDw***k1xFc5`, 用法可以参考：<a href="https://qian.tencent.com/developers/company/openwxminiprogram" target="_blank">跳转电子签小程序</a></li>
  
  
  注： <font color="red">生成的链路后面不能再增加参数</font>
     */
    MiniAppPath?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteIntegrationRoleUsers返回参数结构体
 */
export interface DeleteIntegrationRoleUsersResponse {
    /**
     * 角色id
     */
    RoleId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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;
    /**
     * 用户自定义合同类型。
  
  自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
  
  注意：
  如果传递了自定义合同类型，则每一个子合同设置的自定义合同类型将会失效，已最外层定义的为准。
  例如：
  这份合同组有三个子合同，设置合同类型为<font color="blue">人事/劳务</font>
  第一份子合同设置的合同自定义合同类型是<font color="blue">采购</font>
  第二份和第三份子合同设置的合同自定义合同类型是<font color="blue">人事/劳务</font>
  但最终这个合同组的合同类型是<font color="blue">人事/劳务</font>
  
  
  
  
  
     */
    UserFlowType?: UserFlowType;
}
/**
 * 催办接口返回的详细信息。
 */
export interface RemindFlowRecords {
    /**
     * 合同流程是否可以催办：
  true - 可以，false - 不可以。
  若无法催办，将返回RemindMessage以解释原因。
     */
    CanRemind?: boolean;
    /**
     * 合同流程ID，为32位字符串。
     */
    FlowId?: string;
    /**
     * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
     */
    RemindMessage?: string;
}
/**
 * CreatePreparedPersonalEsign返回参数结构体
 */
export interface CreatePreparedPersonalEsignResponse {
    /**
     * <p>导入生成的印章ID，为32位字符串。<br>建议开发者保存此印章ID，开头实名认证后，通过此 ID查询导入的印章。</p>
     */
    SealId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 此结构体(FlowGroupOptions)描述的是合同组的个性化配置，支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证（仅在合同组文件发起配置时生效）
 */
export interface FlowGroupOptions {
    /**
     * 签署人校验方式,支持以下类型
  <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
  <li>MobileCheck : 手机号验证</li></ul>
  参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
     */
    ApproverVerifyType?: string;
    /**
     * 发起合同（流程）组本方企业经办人通知方式
  签署通知类型，支持以下类型
  <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
     */
    SelfOrganizationApproverNotifyType?: string;
    /**
     * 发起合同（流程）组他方经办人通知方式
  签署通知类型，支持以下类型
  <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
     */
    OtherApproverNotifyType?: string;
    /**
     * 是否开启发起合同组的发起审批，默认：false(不开启)，开启后，发起合同组会提交电子签内置审批流
     */
    FlowGroupNeedWorkflow?: boolean;
}
/**
 * 创建合同，若对方签署人的企业信息还未在腾讯电子签注册。则在进行引导企业注册时控制企业填写的信息。
具体可查看[视频](https://qian.tencent.com/developers/video/?menu=scene&id=6)
 */
export interface RegisterInfo {
    /**
     * 法人姓名
     */
    LegalName: string;
    /**
     * 社会统一信用代码
  注意：此字段可能返回 null，表示取不到有效值。
     * @deprecated
     */
    Uscc?: string;
    /**
     * 社会统一信用代码
     */
    UnifiedSocialCreditCode?: string;
    /**
     * 组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。
     */
    OrganizationAddress?: string;
    /**
     * 指定企业认证的授权方式 支持多选:
  
  <ul>
  <li><strong>2</strong>: 法人授权方式</li>
  <li><strong>5</strong>: 授权书+对公打款方式</li>
  </ul>
     */
    AuthorizationTypes?: Array<number | bigint>;
    /**
     * 指定企业认证的授权方式:
  
  <ul>
  <li><strong>2</strong>: 法人授权方式</li>
  <li><strong>5</strong>: 授权书+对公打款方式</li>
  </ul>
     * @deprecated
     */
    AuthorizationType?: number;
    /**
     * 指定企业认证的授权方式 支持多选:
  
  <ul>
  <li><strong>1</strong>: 上传营业执照</li>
  <li><strong>2</strong>: 腾讯云快速认证</li>
  <li><strong>3</strong>: 腾讯商户号授权<font color="red">（仅支持小程序端）</font></li>
  </ul>
     */
    AuthorizationMethods?: Array<number | bigint>;
    /**
     * 企业证照类型：
  
  USCC :(默认)工商组织营业执照
  PRACTICELICENSEOFMEDICALINSTITUTION :医疗机构执业许可证
  CLINICFILLINGCERTIFICATE:诊所备案证
     */
    OrganizationIdCardType?: string;
    /**
     * 企业创建时候的个性化参数。
  其中，包括一下内容：
  LegalNameSame  是否可以编辑法人。
  UnifiedSocialCreditCodeSame  是否可以编辑证件号码。
  OrganizationIdCardTypeSame  是否可以更改证照类型。
     */
    RegisterInfoOption?: RegisterInfoOption;
}
/**
 * 合同审查反馈信息
 */
export interface RiskIdentificationFeedbackInfo {
    /**
     * 审查结果ID
     */
    RiskId?: string;
    /**
     * 反馈结果
  
  - 1: 其他错误
  - 2: 审查错误
  - 3: 审查正确
     */
    FeedbackResult?: number;
    /**
     * 反馈原因
     */
    Reason?: string;
}
/**
 * CreateReleaseFlow请求参数结构体
 */
export interface CreateReleaseFlowRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 待解除的签署流程编号（即原签署流程的编号）。
     */
    NeedRelievedFlowId: string;
    /**
     * 解除协议内容, 包括解除理由等信息。
     */
    ReliveInfo: RelieveInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
  如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
  
  注：
  1. 支持更换企业的签署人，不支持更换个人类型的签署人。
  2. 己方企业支持自动签署，他方企业不支持自动签署。
  3. <b>仅将需要替换的签署人添加至此列表</b>，无需替换的签署人无需添加进来。
     */
    ReleasedApprovers?: Array<ReleasedApprover>;
    /**
     * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
  如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
     */
    Deadline?: number;
    /**
     * 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
  
  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
     */
    UserData?: string;
}
/**
 * CreateIntegrationUserRoles请求参数结构体
 */
export interface CreateIntegrationUserRolesRequest {
    /**
     * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 绑定角色的用户id列表，不能重复，不能大于 100 个
     */
    UserIds: Array<string>;
    /**
     * 绑定角色的角色id列表，不能重复，不能大于 100，可以通过DescribeIntegrationRoles接口获取角色信息
     */
    RoleIds: Array<string>;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 更新员工信息成功返回的数据信息， 仅支持未实名的用户进行更新
会通过短信、企微消息或者H5Url 链接
如果是通过H5邀请加入的方式，会返回H5 链接
 */
export interface SuccessUpdateStaffData {
    /**
     * 传入的用户名称
     */
    DisplayName?: string;
    /**
     * 传入的手机号，没有打码
     */
    Mobile?: string;
    /**
     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
  可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
     */
    UserId?: string;
    /**
     * H5端员工实名链接
  只有入参 InvitationNotifyType = H5的时候才会进行返回。
     */
    Url?: string;
}
/**
 * 创建/修改员工成功返回的信息
现在支持saas/企微/H5端进行加入。
 */
export interface SuccessCreateStaffData {
    /**
     * 员工名
     */
    DisplayName?: string;
    /**
     * 员工手机号
     */
    Mobile?: string;
    /**
     * 员工在电子签平台的id
     */
    UserId?: string;
    /**
     * 提示，当创建已存在未实名用户时，该字段有值
     */
    Note?: string;
    /**
     * 传入的企微账号id
     */
    WeworkOpenId?: string;
    /**
     * 员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接 <table><tbody><tr><td>链接类型</td><td>有效期</td><td>示例</td></tr><tr><td>HTTP_SHORT_URL（短链）</td><td>一天</td><td>https://test.essurl.cn/fvG7UBEd0F</td></tr><tr><td>HTTP（长链）</td><td>一天</td><td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183</td></tr><tr><td>H5</td><td>30 天</td><td>https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d</td></tr><tr><td>APP</td><td>一天</td><td>/pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455 </td></tr></tbody></table>
     */
    Url?: string;
}
/**
 * 主体信息
 */
export interface Identity {
    /**
     * 统一社会信用代码
     */
    CreditCode?: string;
    /**
     * 组织机构代码
     */
    OrgCode?: string;
    /**
     * 营业执照注册编号
     */
    RegNo?: string;
    /**
     * 企业名称
     */
    EntName?: string;
    /**
     * 修改人法人代表姓名
     */
    LegalRepName?: string;
    /**
     * 渠道经营状态
     */
    OpState?: string;
    /**
     * 经营期限自(格式YYYY-MM-DD)
     */
    OpFromDate?: string;
    /**
     * 经营期限至
     */
    OpToDate?: string;
    /**
     * 成立日期(格式YYYY-MM-DD)
     */
    EstabDate?: string;
    /**
     * 核准日期(格式YYYY-MM-DD)
     */
    ApprDate?: string;
    /**
     * 吊销日期(格式YYYY-MM-DD)
     */
    RevoDate?: string;
    /**
     * 注销日期(格式YYYY-MM-DD)
     */
    CancelDate?: string;
    /**
     * 登记机关
     */
    RegOrg?: string;
    /**
     * 企业类型编码
     */
    EntTypeCode?: string;
    /**
     * 企业类型
     */
    EntType?: string;
    /**
     * 经营业务范围
     */
    BizScope?: string;
    /**
     * 许可经营项目
     */
    LicenseBizItem?: string;
    /**
     * 注册地址行政编号
     */
    RegAreaCode?: string;
    /**
     * 注册地址
     */
    RegAddress?: string;
    /**
     * 注册资本币种
     */
    RegCapitalCurtype?: string;
    /**
     * 注册资本（万元）
     */
    RegCapital?: string;
    /**
     * 实收资本（万元）
     */
    PaidCapital?: string;
    /**
     * 原注册号
     */
    OriRegNo?: string;
    /**
     * 企业英文名称
     */
    EntNameEng?: string;
    /**
     * 曾用名
     */
    OriEntName?: string;
    /**
     * 企业经营状态枚举。常见值如下：
  未定义的状态 = 0
  正常  = 1
  注销 = 2
  吊销 = 3
  吊销后注销 = 4
  撤销 = 5
  其他 = 99
     */
    OpStateCode?: number;
    /**
     * 查询日期(格式YYYY-MM-DD)
     */
    SearchDate?: string;
}
/**
 * CreateArchiveFlowTask返回参数结构体
 */
export interface CreateArchiveFlowTaskResponse {
    /**
     * <p>归档任务ID，后续使用 <a href="">查询归档任务状态</a>接口获取归档任务执行结果</p>
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
 */
export interface UploadFile {
    /**
     * Base64编码后的文件内容
     */
    FileBody: string;
    /**
     * 文件的名字。
  文件名的最大长度应不超过200个字符，并且文件名的后缀必须反映其文件类型。
  例如，PDF文件应以“.pdf”结尾，如“XXX.pdf”，而Word文件应以“.doc”或“.docx”结尾，如“XXX.doc”或“XXX.docx”。
     */
    FileName?: string;
}
/**
 * CreateFlowSignReview返回参数结构体
 */
export interface CreateFlowSignReviewResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RenewAutoSignLicense请求参数结构体
 */
export interface RenewAutoSignLicenseRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 自动签使用的场景值, 可以选择的场景值如下:
  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey: string;
    /**
     * 需要续期自动签的个人的信息，如姓名，证件信息等。
     */
    UserInfo: UserThreeFactor;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
 */
export interface FilledComponent {
    /**
     * 控件Id
     */
    ComponentId?: string;
    /**
     * 控件名称
     */
    ComponentName?: string;
    /**
     * 控件填写状态；0-未填写；1-已填写
     */
    ComponentFillStatus?: string;
    /**
     * 控件填写内容
     */
    ComponentValue?: string;
    /**
     * 控件所属参与方Id
     */
    ComponentRecipientId?: string;
    /**
     * 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
     */
    ImageUrl?: string;
}
/**
 * 合同组催办接口返回的详细信息。
 */
export interface RemindFlowGroupRecord {
    /**
     * <p>对应签署人出现的合同列表</p>
     */
    FlowIds?: Array<string>;
    /**
     * <p>对应签署人出现的合同名</p>
     */
    FlowNames?: Array<string>;
    /**
     * <p>签署人姓名</p>
     */
    ApproverName?: string;
    /**
     * <p>签署人手机号</p>
     */
    Mobile?: string;
    /**
     * <p>催办合同组下签署人维度详细信息</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    RemindMessageList?: Array<RemindFlowGroupDetail>;
}
/**
 * CreateWebThemeConfig请求参数结构体
 */
export interface CreateWebThemeConfigRequest {
    /**
     * 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 主题类型，取值如下：
  <ul><li> **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置</li>
  </ul>
     */
    ThemeType: string;
    /**
     * 电子签logo是否展示，主体颜色等配置项
     */
    WebThemeConfig: WebThemeConfig;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateEmployeeQualificationSealQrCode返回参数结构体
 */
export interface CreateEmployeeQualificationSealQrCodeResponse {
    /**
     * 二维码图片的Base64  注:  `此二维码的有效时间为7天，过期后需要重新生成新的二维码图片`
     */
    QrcodeBase64?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateUserVerifyUrl返回参数结构体
 */
export interface CreateUserVerifyUrlResponse {
    /**
     * 腾讯电子签小程序的实名认证链接。
  如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
  
  <strong>1.如果EndPoint是APP</strong>：
  得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
  
  <strong>2.如果EndPoint是HTTP</strong>：
  得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：
  得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署
  
  <strong>4.如果EndPoint是H5</strong>：
  得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>，点击后会跳转到腾讯电子签H5页面进行签署
  
  <strong>5.如果EndPoint是H5_SHORT_URL</strong>：
  得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签H5页面进行签署
  
  
  `注：` <font color="red">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>
  示例值：https://essurl.cn/2n**42Nd
     */
    UserVerifyUrl?: string;
    /**
     * 链接过期时间，为Unix时间戳（单位为秒）。
     */
    ExpireTime?: number;
    /**
     * 小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回
     */
    MiniAppId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetTaskResultApi返回参数结构体
 */
export interface GetTaskResultApiResponse {
    /**
     * 任务Id
     */
    TaskId?: string;
    /**
     * 任务状态，需要关注的状态
  <ul><li>**0**  :NeedTranform   - 任务已提交</li>
  <li>**4**  :Processing     - 文档转换中</li>
  <li>**8**  :TaskEnd        - 任务处理完成</li>
  <li>**-2** :DownloadFailed - 下载失败</li>
  <li>**-6** :ProcessFailed  - 转换失败</li>
  <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
     */
    TaskStatus?: number;
    /**
     * 状态描述，需要关注的状态
  <ul><li> **NeedTranform** : 任务已提交</li>
  <li> **Processing** : 文档转换中</li>
  <li> **TaskEnd** : 任务处理完成</li>
  <li> **DownloadFailed** : 下载失败</li>
  <li> **ProcessFailed** : 转换失败</li>
  <li> **ProcessTimeout** : 转换文件超时</li></ul>
     */
    TaskMessage?: string;
    /**
     * 资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)
     */
    ResourceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 用户自定义合同类型， 自定义合同类型的管理可以[点击查看在控制台位置的截图](https://qcloudimg.tencent-cloud.cn/raw/85a9b2ebce07b0cd6d75d5327d538235.png)
 */
export interface UserFlowType {
    /**
     * 合同类型ID
     */
    UserFlowTypeId?: string;
    /**
     * 合同类型名称
     */
    Name?: string;
    /**
     * 合同类型说明
     */
    Description?: string;
}
/**
 * CreatePrepareFlowGroup请求参数结构体
 */
export interface CreatePrepareFlowGroupRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
     */
    FlowGroupName: string;
    /**
     * 合同（流程）组的子合同信息，支持2-50个子合同
     */
    FlowGroupInfos: Array<FlowGroupInfo>;
    /**
     * 资源类型，取值有： <ul><li> **1**：模板</li> <li> **2**：文件</li></ul>
     */
    ResourceType: number;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 合同组发起控制参数，当前仅支持FlowGroupNeedWorkflow，表示开启嵌入式合同组发起审批
     */
    FlowGroupOptions?: FlowGroupOptions;
}
/**
 * CreateFileCounterSign返回参数结构体
 */
export interface CreateFileCounterSignResponse {
    /**
     * 加签任务的状态。
  
  <ul>
  <li><b>PROCESSING</b>: 任务正在执行中。</li>
  <li><b>FINISHED</b>: 已执行成功</li>
  </ul>
     */
    Status?: string;
    /**
     * 加签完成后新的文件Id
     */
    ResultFileId?: string;
    /**
     * 异步模式下用于轮询状态的任务Id
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数字加签文件验签结果
 */
export interface VerifyDigitFileResult {
    /**
     * 证书起始时间的Unix时间戳，单位毫秒
     */
    CertNotBefore?: number;
    /**
     * 证书过期时间的时间戳，单位毫秒
     */
    CertNotAfter?: number;
    /**
     * 证书序列号，在数字证书申请过程中，系统会自动生成一个独一无二的序号。
     */
    CertSn?: string;
    /**
     * 证书签名算法, 如SHA1withRSA等算法
     */
    SignAlgorithm?: string;
    /**
     * 签署时间的Unix时间戳，单位毫秒
     */
    SignTime?: number;
    /**
     * 签名类型。0表示带签章的数字签名，1表示仅数字签名
     */
    SignType?: number;
    /**
     * 申请证书的主体的名字
  
  如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
  **企业**:  ESS@企业名称@编码
  **个人**: ESS@个人姓名@证件号@808854
  
  如果在其他平台签署的, 主体的名字参考其他平台的说明
     */
    SignerName?: string;
}
/**
 * 签署人的转交记录详情
 */
export interface ForwardRecord {
    /**
     * <p>转交人打码后的姓名</p>
     */
    Name?: string;
    /**
     * <p>转交人打码后的手机号</p>
     */
    Mobile?: string;
    /**
     * <p>进行转交的原因</p><p>枚举值：</p><ul><li>QUIT_FORWARD： 离职转交</li><li>FORWARD： 员工操作转交</li></ul>
     */
    ForwardType?: string;
    /**
     * <p>转交的详情信息</p>
     */
    ForwardMessage?: string;
    /**
     * <p>转交时间</p><p>单位：时间戳（秒级）</p>
     */
    ForwardTime?: number;
}
/**
 * CreatePrepareFlow请求参数结构体
 */
export interface CreatePrepareFlowRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  支持填入集团子公司经办人 userId 代发合同。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 资源id，与ResourceType相对应，取值范围：
  <ul>
  <li>文件Id（通过UploadFiles获取文件资源Id）</li>
  <li>模板Id（通过控制台创建模板后获取模板Id）</li>
  <li>草稿Id（通过嵌入页面保存草稿后获取草稿Id）</li>
  </ul>
  注意：需要同时设置 ResourceType 参数指定资源类型
     */
    ResourceId: string;
    /**
     * 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
  
  该名称还将用于合同签署完成后文件下载的默认文件名称。
     */
    FlowName: string;
    /**
     * 资源类型，取值有：
  <ul><li> **1**：模板</li>
  <li> **2**：文件（默认值）</li>
  <li> **3**：草稿</li>
  </ul>
     */
    ResourceType?: number;
    /**
     * 合同流程的签署顺序类型：
  <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
  <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
     */
    Unordered?: boolean;
    /**
     * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
  
     */
    Deadline?: number;
    /**
     * 用户自定义合同类型Id
  
  该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取
  注: `该参数如果和FlowType同时传，以该参数优先生效`
     */
    UserFlowTypeId?: string;
    /**
     * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
     */
    FlowType?: string;
    /**
     * 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
  
  如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
     */
    Approvers?: Array<FlowCreateApprover>;
    /**
     * 开启或者关闭智能添加填写区：
  <ul><li> **OPEN**：开启（默认值）</li>
  <li> **CLOSE**：关闭</li></ul>
     */
    IntelligentStatus?: string;
    /**
     * 该字段已不再使用，请使用InitiatorComponents
     */
    Components?: Component;
    /**
     * 发起合同个性化参数
  用于满足创建及页面操作过程中的个性化要求
  具体定制化内容详见数据接口说明
     */
    FlowOption?: CreateFlowOption;
    /**
     * 发起方企业签署员工，在进行签署操作前，是否需要先通过企业内部审批流程 （签署审核）
  1. **false（默认）**：  无需审批，发起方企业签署员工可直接进行签署操作。
  2. **true**：  需要先走企业内部审批流程。 当流程进展到发起方企业签署员工时，其签署操作会被阻塞，等待企业内部审批结果。
  
  企业应通过 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a>审批接口，将内部审批结果通知腾讯电子签平台：
  1. 若通知为“审核通过”，发起方企业签署员工可继续完成签署操作。
  2. 若通知为“审核未通过”，平台将继续阻塞该签署方的签署操作，直到企业再次通知平台审核通过为止。
  
  说明： 此能力可用于与企业内部审批流程打通，适用于手动签署和自动签署两种模式。
     */
    NeedSignReview?: boolean;
    /**
     * 发起方在创建合同流程前，是否必须先通过企业内部审批流程 （发起审核）
  
  当设置为 `true` 时：
    1. 您需要在企业内部完成审批，并通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview" target="_blank">提交签署流程审批结果</a> 将审批结果回传给腾讯电子签。
    2. 只有当审核状态为“通过”时，合同流程正常发起。
    3. 若未通过或未回传审核结果，发起操作将被阻塞，阻止合同流程。
  
  当设置为 `false` （默认值）时：
    发起方无需经过企业内部审批，可直接发起合同流程。
     */
    NeedCreateReview?: boolean;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
     */
    UserData?: string;
    /**
     * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  
     */
    CcInfos?: Array<CcInfo>;
    /**
     * 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
  注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
     */
    FlowId?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
  
     */
    InitiatorComponents?: Array<Component>;
    /**
     * 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：  <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
     */
    FlowDisplayType?: number;
    /**
     * <font color="red">此字段已不再使用，请使用 CreateFlowOption 里面的 SignComponentConfig</font>
  签署控件的配置信息，用在嵌入式发起的页面配置，
  包括
  
  - 签署控件 是否默认展示日期.
     * @deprecated
     */
    SignComponentConfig?: SignComponentConfig;
    /**
     * 是否开启嵌入式合同发起时，提交发起审批流，默认：false（不开启），开启后，嵌入式合同发起后，会提交电子签内置审批流
     */
    Workflow?: boolean;
}
/**
 * DescribeCancelFlowsTask请求参数结构体
 */
export interface DescribeCancelFlowsTaskRequest {
    /**
     * <p>执行本接口操作的员工信息。<br><br>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</p>
     */
    Operator: UserInfo;
    /**
     * <p>批量撤销任务编号，为32位字符串，通过接口<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl">获取批量撤销签署流程腾讯电子签小程序链接</a>和接口<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CancelOrganizationFlows">全量撤销企业合同</a>获得。</p>
     */
    TaskId: string;
    /**
     * <p>代理企业和员工的信息。<br><br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>撤销任务类型</p><p>枚举值：</p><ul><li>0： 默认类型，获取批量撤销合同小程序链接的批量撤销任务</li><li>1： 全量撤销任务</li></ul><p>枚举值：</p><ul><li>0： 默认类型，批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务</li><li>1： 全量撤销任务</li></ul><p>枚举值：</p><ul><li>0： 默认类型，获取批量撤销合同小程序链接的批量撤销任务</li><li>1： 全量撤销任务</li></ul>
     */
    CancelType?: number;
}
/**
 * DescribeContractReviewMarkedRiskExportTask返回参数结构体
 */
export interface DescribeContractReviewMarkedRiskExportTaskResponse {
    /**
     * 导出文件 url。
     */
    Url?: string;
    /**
     * 任务状态。未知 = 0;   创建完成 = 1;   队列中 = 2;   执行中 = 3;   执行成功 = 4;   失败 = 5;   终止 = 6;
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSealPolicy请求参数结构体
 */
export interface CreateSealPolicyRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>用户在电子文件签署平台标识信息，具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用,<br>同时也支持使用主企业的User进行授权， 当使用主企业的User时， 需要有集团角色。</p>
     */
    Users: Array<UserInfo>;
    /**
     * <p>电子印章ID，为32位字符串。<br>建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台，在 &quot;印章&quot;-&gt;&quot;印章中心&quot;选择查看的印章，在&quot;印章详情&quot; 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
     */
    SealId: string;
    /**
     * <p>授权有效期，时间戳秒级。可以传0，代表有效期到2099年12月12日23点59分59秒。</p>
     */
    Expired: number;
    /**
     * <p>需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填，跟上面的Users同时起作用。<br>支持使用主企业的UserId进行授权， 当使用主企业的UserId时，该UserId 需要有集团角色。</p>
     */
    UserIds?: Array<string>;
    /**
     * <p>印章授权内容，最多300 个字符。</p>
     */
    Policy?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>个性化配置字段，默认不传。</p>
     */
    Options?: Array<Option>;
    /**
     * <p>针对用印的合同/合同组授权。<br>当单次用印授权时，可以仅在指定合同获得印章授权。<br>此场景下不会触发印章授权回调。</p>
     */
    AuthorizationFlows?: SealPolicyAuthorizationFlows;
}
/**
 * DescribeContractReviewTask返回参数结构体
 */
export interface DescribeContractReviewTaskResponse {
    /**
     * 该字段已不再使用！
  用于审查任务的审查清单ID。注意：如果用户没有配置清单时此值可能为空，需要等大模型根据合同内容推荐出可以使用的审查清单。
     */
    ChecklistId?: string;
    /**
     * 用于审查任务的审查清单ID。注意：如果用户没有配置清单时此值可能为空，需要等大模型根据合同内容推荐出可以使用的审查清单。
     */
    ChecklistIds?: Array<string>;
    /**
     * 合同审查任务创建时间。
     */
    CreatedOn?: number;
    /**
     * 合同审查任务完成时间。
     */
    FinishedOn?: number;
    /**
     * 合同审查的审查立场方。
  
  审查立场方如下：
  <ul>
      <li>**0** - 【严格】以保护己方利益为核心，对合同条款进行严格把控，尽可能争取对己方有利的条款，同时对对方提出的不合理条款可进行坚决修改或删除。</li>
      <li>**1** - 【中立】以公平合理为原则，平衡双方的权利义务，既不过分强调己方利益，也不过度让步，力求达成双方均可接受的条款。</li>
      <li>**2** - 【宽松】以促成交易为核心，对合同条款的修改要求较为宽松，倾向于接受对方提出的条款，以尽快达成合作。</li>
  </ul>
     */
    PolicyType?: number;
    /**
     * 合同审查的PDF、WORD文件资源ID。
     */
    ResourceId?: string;
    /**
     * 合同审查识别出的PDF文件风险信息，如果是空数组表示无风险。
  
  注意：`审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。`
     */
    Risks?: Array<OutputRisk>;
    /**
     * 该字段已不再使用！
  合同审查中的角色信息。注意： `如果用户没有配置审查角色时此值可能为null，需要等大模型根据合同内容推荐出审查角色信息。`
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Role?: RiskIdentificationRoleInfo;
    /**
     * 合同审查中的角色信息。注意： `如果用户没有配置审查角色时此值可能为null，需要等大模型根据合同内容推荐出审查角色信息。`
     */
    Roles?: Array<RiskIdentificationRoleInfo>;
    /**
     * 合同审查任务状态。
  状态如下：
  <ul>
      <li>**1** - 合同审查任务创建成功</li>
      <li>**2** - 合同审查任务排队中</li>
      <li>**3** - 合同审查任务执行中</li>
      <li>**4** - 合同审查任务执行成功</li>
      <li>**5** - 合同审查任务执行失败</li>
  </ul>
     */
    Status?: number;
    /**
     * 合同审查任务ID
     */
    TaskId?: string;
    /**
     * 审查任务备注信息，长度不能超过100个字符
     */
    Comment?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
     */
    UserData?: string;
    /**
     * 合同审查出的高风险项数量
     */
    HighRiskCount?: number;
    /**
     * 合同审查出的风险总数
     */
    TotalRiskCount?: number;
    /**
     * 通过项信息(详细引文信息)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ApprovedLists?: Array<OutputReference>;
    /**
     * 摘要信息
     */
    Summaries?: Array<ContractSummary>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CancelFlow请求参数结构体
 */
export interface CancelFlowRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID, 为32位字符串。
  
  可登录腾讯电子签控制台，[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
     */
    FlowId: string;
    /**
     * 撤销此合同流程的**撤销理由**，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
     */
    CancelMessage: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DescribeExtendedServiceAuthInfos请求参数结构体
 */
export interface DescribeExtendedServiceAuthInfosRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 要查询的扩展服务类型。
  默认为空，即查询当前支持的所有扩展服务信息。
  若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
  <ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
  <li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>
  <li>BATCH_SIGN：批量签署</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>ORGANIZATION_FLOW_EMAIL_NOTIFY：邮件通知签署方</li>
  <li>FLOW_APPROVAL：合同审批强制开启</li>
  <li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li>
  <li>HIDE_ONE_KEY_SIGN：个人签署方手写签名时需逐个手写</li>
  <li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE：个人签署方手动签名</li>
  <li>APP_LOGIN：限制企业员工小程序端登录</li>
  <li>PC_LOGIN：限制企业员工网页端登录</li>
  </ul>
     */
    ExtendServiceType?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * UpdateIntegrationEmployees请求参数结构体
 */
export interface UpdateIntegrationEmployeesRequest {
    /**
     * 执行本接口操作的员工信息,UserId必填。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 需要更新的员工信息，最多不超过100个。根据UserId或OpenId更新员工信息，必须填写其中一个，优先使用UserId。
  
  可更新以下字段，其他字段暂不支持
  <table> <thead> <tr> <th>参数</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>DisplayName</td> <td>用户的真实名字</td> </tr> <tr> <td>Mobile</td> <td>用户手机号码</td> </tr> <tr> <td>Email</td> <td>用户的邮箱</td> </tr> <tr> <td>Department.DepartmentId</td> <td>用户进入后的部门ID</td> </tr> </tbody> </table>
     */
    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;
}
/**
 * CreateFlowGroupByTemplates请求参数结构体
 */
export interface CreateFlowGroupByTemplatesRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
     */
    FlowGroupName: string;
    /**
     * 合同（流程）组的子合同信息，支持2-50个子合同
     */
    FlowGroupInfos: Array<FlowGroupInfo>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 合同（流程）组的配置项信息。
  其中包括：
  <ul>
  <li>是否通知本企业签署方</li>
  <li>是否通知其他签署方</li>
  </ul>
     */
    FlowGroupOptions?: FlowGroupOptions;
    /**
     * 用户自定义合同类型。
  自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
  
  注意： 如果传递了自定义合同类型，则每一个子合同对应模板上面的自定义合同类型将会失效，已最外层定义的为准。 例如： 这份合同组有三个子合同，设置合同类型为<font color="blue">人事/劳务</font> 第一份子合同选择的模板的合同自定义合同类型是<font color="blue">采购</font> 第二份和第三份子合同选择的模板的合同自定义合同类型是<font color="blue">人事/劳务</font> 但最终这个合同组的合同类型是<font color="blue">人事/劳务</font>
     */
    UserFlowType?: UserFlowType;
}
/**
 * CreateBatchContractReviewTask返回参数结构体
 */
export interface CreateBatchContractReviewTaskResponse {
    /**
     * 合同审查的任务ID列表，每个任务ID为32位字符串。
  建议开发者保存此任务ID，后续[查询合同审查任务取详情](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/DescribeContractReviewTask/)需要此任务ID。
  
  注意：`返回的索引和ResourceIds数组一致`
     */
    TaskIds?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSignFaceVideo请求参数结构体
 */
export interface DescribeSignFaceVideoRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
     */
    FlowId: string;
    /**
     * 签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
     */
    SignId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 流程签署二维码的签署信息，适用于客户系统整合二维码功能。
通过链接，用户可直接访问电子签名小程序并签署合同。
 */
export interface SignUrl {
    /**
     * 跳转至电子签名小程序签署的链接地址。
  适用于客户端APP及小程序直接唤起电子签名小程序。
     */
    AppSignUrl?: string;
    /**
     * 签署链接有效时间，格式类似"2022-08-05 15:55:01"
     */
    EffectiveTime?: string;
    /**
     * 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。
  打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
     */
    HttpSignUrl?: string;
}
/**
 * DescribeOrganizationSeals请求参数结构体
 */
export interface DescribeOrganizationSealsRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 指定分页每页返回的数据条数，如果不传默认为 20，单页最大支持 200。
     */
    Limit?: number;
    /**
     * 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 20000。
     */
    Offset?: number;
    /**
     * 查询授权用户信息类型，取值如下：
  
  <ul> <li><b>0</b>：（默认）不返回授权用户信息</li> <li><b>1</b>：返回授权用户的信息</li> </ul>
     */
    InfoType?: number;
    /**
     * 印章id，是否查询特定的印章（没有输入返回所有）
     */
    SealId?: string;
    /**
     * 印章种类列表（均为组织机构印章）。 若无特定需求，将展示所有类型的印章。 目前支持以下几种：<ul> <li><strong>OFFICIAL</strong>：企业公章；</li> <li><strong>CONTRACT</strong>：合同专用章；</li> <li><strong>FINANCE</strong>：财务专用章；</li> <li><strong>PERSONNEL</strong>：人事专用章；</li><li><strong>INVOICE</strong>：发票专用章；</li><li><strong>LEGAL_PERSON_SEAL</strong>：法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>：员工执业章。</li><li><strong>OTHER</strong>其他类型印章</li> </ul>
     */
    SealTypes?: Array<string>;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 需查询的印章状态列表。
  <ul>
  <li>空：（默认）仅查询启用状态的印章；</li>
  <li><strong>ALL</strong>：查询所有状态的印章；</li>
  <li><strong>CHECKING</strong>：查询待审核的印章；</li>
  <li><strong>SUCCESS</strong>：查询启用状态的印章；</li>
  <li><strong>FAIL</strong>：查询印章审核拒绝的印章；</li>
  <li><strong>DISABLE</strong>：查询已停用的印章；</li>
  <li><strong>STOPPED</strong>：查询已终止的印章；</li>
  <li><strong>VOID</strong>：查询已作废的印章；</li>
  <li><strong>INVALID</strong>：查询已失效的印章。</li>
  </ul>
     */
    SealStatuses?: Array<string>;
}
/**
 * CreateBatchOrganizationAuthorizationUrl请求参数结构体
 */
export interface CreateBatchOrganizationAuthorizationUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。
  此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
     */
    AdminName: string;
    /**
     * 组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
     */
    AdminMobile: string;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
    /**
     * 企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素（AdminName，AdminMobile，AdminIdCardNumber）配合使用。若 SubTaskId 不属于传入的超级管理员，将进行筛选。
     */
    SubTaskIds?: Array<string>;
    /**
     * 组织机构超管证件类型支持以下类型
  - ID_CARD : 中国大陆居民身份证 (默认值)
  -  HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
  - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
  此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
     */
    AdminIdCardType?: string;
    /**
     * 组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
     */
    AdminIdCardNumber?: string;
    /**
     * 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**QR_CODE**： 跳转电子签小程序的http_url的二维码形式,  可以在页面展示适合此类型</li></ul>
     */
    Endpoint?: string;
}
/**
 * CreateDigitalDataSign请求参数结构体
 */
export interface CreateDigitalDataSignRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。支持填入集团子公司经办人 userId 代发合同。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 数据加签的原文
     */
    PlainText?: string;
}
/**
 * CreateBatchCancelFlowUrl请求参数结构体
 */
export interface CreateBatchCancelFlowUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 需要执行撤回的流程(合同)的编号列表，最多100个.
  列表中的流程(合同)编号不要重复.
     */
    FlowIds: Array<string>;
    /**
     * 代理企业和员工的信息。
  <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateMultiFlowSignQRCode请求参数结构体
 */
export interface CreateMultiFlowSignQRCodeRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同模板ID，为32位字符串。<br>可登录腾讯电子签控制台，在 &quot;模板&quot;-&gt;&quot;模板中心&quot;-&gt;&quot;列表展示设置&quot;选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
     */
    TemplateId: string;
    /**
     * <p>合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
     */
    FlowName: string;
    /**
     * <p>通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。<br>一旦发起流程数超越该限制，该二维码将自动失效。</p>
     */
    MaxFlowNum?: number;
    /**
     * <p>二维码的有效期限，默认为7天，最高设定不得超过90天。<br>一旦超过二维码的有效期限，该二维码将自动失效。</p>
     * @deprecated
     */
    QrEffectiveDay?: number;
    /**
     * <p>合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。<br>若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。<br>最长设定期限不得超过30天。</p>
     */
    FlowEffectiveDay?: number;
    /**
     * <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><p>枚举值：</p><ul><li>0： 合同</li><li>1： 文件</li><li>2： 协议</li><li>3： 文书</li></ul><p>默认值：0</p>
     */
    FlowDisplayType?: number;
    /**
     * <p>指定签署人信息。<br>在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。</p>
     */
    Restrictions?: Array<ApproverRestriction>;
    /**
     * <p>调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置<br><br> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign<br><br> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83</p>
     * @deprecated
     */
    CallbackUrl?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>限制二维码用户条件（已弃用）</p>
     * @deprecated
     */
    ApproverRestrictions?: ApproverRestriction;
    /**
     * <p>指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。</p>
     */
    ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
    /**
     * <p>禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。</p>
     */
    ForbidPersonalMultipleSign?: boolean;
    /**
     * <p>合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。<br>例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。</p>
     */
    FlowNameAppendScannerInfo?: boolean;
    /**
     * <p>签署二维码的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示，若为空，则使用FlowName</p>
     */
    QrCodeName?: string;
    /**
     * <p>签署二维码截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为签署二维码创建后的7天时截止，最长可设置为签署二维码创建后的365天时截止。</p>
     */
    QrCodeExpiredOn?: number;
}
/**
 * DeleteExtendedServiceAuthInfos请求参数结构体
 */
export interface DeleteExtendedServiceAuthInfosRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 本企业员工的id，需要已实名，正常在职员工
     */
    UserIds: Array<string>;
    /**
     * 取值如下所示：
  <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
  <li>BATCH_SIGN：批量签署</li>
  </ul>
     */
    ExtendServiceType?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DescribeFlowInfo返回参数结构体
 */
export interface DescribeFlowInfoResponse {
    /**
     * <p>合同流程的详细信息。<br>如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。</p>
     */
    FlowDetailInfos?: Array<FlowDetailInfo>;
    /**
     * <p>合同组ID，只有在查询合同组信息时才会返回。</p>
     */
    FlowGroupId?: string;
    /**
     * <p>合同组名称，只有在查询合同组信息时才会返回。</p>
     */
    FlowGroupName?: string;
    /**
     * <p>合同组合同备注列表</p>
     */
    FlowGroupRemarks?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeUserAutoSignStatus请求参数结构体
 */
export interface DescribeUserAutoSignStatusRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey: string;
    /**
     * <p>要查询状态的用户信息, 包括名字,身份证等</p>
     */
    UserInfo: UserThreeFactor;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
}
/**
 * CreateFlowBlockchainEvidenceUrl请求参数结构体
 */
export interface CreateFlowBlockchainEvidenceUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
  建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
  可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
     */
    FlowId: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。
  默认值为有效期为当前时间后7天。
     */
    ExpiredOn?: number;
}
/**
 * CreateBatchQuickSignUrl请求参数结构体
 */
export interface CreateBatchQuickSignUrlRequest {
    /**
     * <p>批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。</p><ul><li>若为个人参与方：ApproverType=1</li><li>若为企业参与方：ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li></ul>注:<code>1. 暂不支持签署人拖动签署控件功能，以及签批控件。</code><code>2. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。</code>
     */
    FlowApproverInfo: FlowCreateApprover;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>批量签署的合同流程ID数组。<br>注: <code>在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。</code></p>
     */
    FlowIds?: Array<string>;
    /**
     * <p>合同组编号<br>注：<code>该参数和合同流程ID数组必须二选一</code></p>
     */
    FlowGroupId?: string;
    /**
     * <p>签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)</p>
     */
    JumpUrl?: string;
    /**
     * <p>指定批量签署合同的签名类型，可传递以下值：</p><ul><li>**0**：手写签名(默认)</li><li>**1**：OCR楷体</li><li>**2**：姓名印章</li><li>**3**：图片印章</li><li>**4**：系统签名</li><li>**5**：长效手写签名（包含手写签名）</li></ul>注：<ul><li>默认情况下，签名类型为手写签名</li><li>您可以传递多种值，表示可用多种签名类型。</li><li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li><li>若签署方为个人，签名类型“5:长效手写签名”不可用，签名方式将以合同中为准。</li></ul>
     */
    SignatureTypes?: Array<number | bigint>;
    /**
     * <p>指定批量签署合同的认证校验方式，可传递以下值：</p><ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li><li>**2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li><li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>注：<ul><li>默认情况下，认证校验方式为人脸和密码认证</li><li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
     */
    ApproverSignTypes?: Array<number | bigint>;
    /**
     * <p>生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：</p><ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li><li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>注：<code>不指定该值时，默认为签署方自行选择。</code>
     */
    SignTypeSelector?: number;
    /**
     * <p>批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。    </p><p>注: <code>若签署方为企业员工，暂不支持通过H5端进行动态签署人的补充</code></p>
     */
    FlowBatchUrlInfo?: FlowBatchUrlInfo;
    /**
     * <p><b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。  您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 </p><p> 注意： </p><ol><li>视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。</li><li>使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 </li><li>签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。</li></ol>
     */
    Intention?: Intention;
    /**
     * <p>用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。</p>
     */
    VideoVerifyTimesLimit?: number;
    /**
     * <p>缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。</p><p>注: <code>若参与方为企业员工时，暂不支持对参与方信息进行缓存</code></p>
     */
    CacheApproverInfo?: boolean;
    /**
     * <p>是否允许此链接中签署方批量拒签。<br> <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p><p>注：<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。</code></p>
     */
    CanBatchReject?: boolean;
    /**
     * <p>预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。若为个人动态签署方，支持预设姓名、证件、手机号。若为企业员工动态签署方，仅支持预设企业名称。</p>
     */
    PresetApproverInfo?: PresetApproverInfo;
    /**
     * <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注：<code>1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求，或者当前签署人没有指定印章使用权限，则无法使用此功能，会自动退化为逐份确认。</code></p>
     */
    CanSkipReadFlow?: boolean;
    /**
     * <p>链接的有效时间，单位为秒。取值范围为 30分钟（1800）-90天（7776000）。如果不传，默认有效期为30分钟。 </p><p>注意： </p><ol><li><code>出于安全性考虑，若有效期大于30分钟，同设备24小时内点击链接查看合同需要进行手机验证码校验。此校验将会扣除短信份额，不建议通过设置此值来缓存签署链接，建议在用户需要签署的时候临时生成链接。</code></li><li><code>动态签署方链接暂不支持修改过期时间。</code></li></ol>
     */
    ExpiredOn?: number;
}
/**
 * 创建归档合同信息
 */
export interface CreateArchiveFlow {
    /**
     * <p>合同文件的资源id，使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a> 上传文件返回resourceId，目前一个合同只能支持一个资源ID。</p>
     */
    ResourceIds: Array<string>;
    /**
     * <p>合同名称，不传时系统会使用合同资源文件名作为合同名称；最终合同名称不能为空；长度不能超过200，只能由中文、字母、数字和下划线组成。</p>
     */
    FlowName?: string;
    /**
     * <p>合同类型，自定义文本字符串，长度不能超过200。</p>
     */
    FlowType?: string;
    /**
     * <p>调用方业务系统中的合同业务编号，可以用于外部系统和归档合同做关联，长度不超过 128 字节</p>
     */
    BusinessId?: string;
    /**
     * <p>合同发起方/创建人名称，用于归档合同展示和检索，长度不超过 32 字符</p>
     */
    CreatorName?: string;
    /**
     * <p>签署人信息列表，用于记录合同由哪些个人或企业签署，最多 50 个参与者。</p>
     */
    ApproverInfo?: Array<ArchiveFlowApproverInfo>;
    /**
     * <p>关注人信息列表，用于记录合同关注对象，最多 50 个关注者。</p>
     */
    CcInfo?: Array<ArchiveFlowApproverInfo>;
    /**
     * <p>调用方自定义透传数据，可用于保存业务扩展信息，长度不超过 20480 字节。</p>
     */
    UserData?: string;
    /**
     * <p>合同描述/备注信息，长度不超过 1000 个字符</p>
     */
    FlowDescription?: string;
    /**
     * <p>合同签署完成时间，Unix 秒级时间戳</p>
     */
    ApproveTime?: number;
    /**
     * <p>合同发起时间/合同原始创建时间，Unix 秒级时间戳</p>
     */
    CustomCreatedOn?: number;
}
/**
 * DescribeExtendedServiceAuthInfos返回参数结构体
 */
export interface DescribeExtendedServiceAuthInfosResponse {
    /**
     * 服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
     */
    AuthInfoList?: Array<ExtendAuthInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 发起流程的可嵌入页面操作结果页配置
 */
export interface CreateResultPageConfig {
    /**
     * <ul>
    <li>0 : 发起审批成功页面（通过接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/" target="_blank">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true）</li>
  </ul>
     */
    Type: number;
    /**
     * 结果页标题，不超过50字
     */
    Title: string;
    /**
     * 结果页描述，不超过200字
     */
    Description?: string;
}
/**
 * 归档合同结果
 */
export interface ArchiveFlowResult {
    /**
     * <p>归档合同id</p>
     */
    FlowId?: string;
    /**
     * <p>合同处理结果</p><p>枚举值：</p><ul><li>0： 成功</li><li>1： 失败</li></ul>
     */
    ArchiveFlowStatus?: number;
    /**
     * <p>业务自定义id</p>
     */
    BusinessId?: string;
    /**
     * <p>资源ID列表</p>
     */
    ResourceIdList?: Array<string>;
    /**
     * <p>错误信息</p>
     */
    ErrorMessage?: string;
}
/**
 * 意愿核身点头确认模式结果
 */
export interface IntentionActionResult {
    /**
     * 意愿核身结果详细数据，与每段点头确认过程一一对应
     */
    Details?: Array<IntentionActionResultDetail>;
}
/**
 * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
 */
export interface FlowGroupUrlInfo {
    /**
     * 合同组子合同和签署方的信息，用于补充动态签署人。
     */
    FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>;
}
/**
 * 信息提取子任务反馈信息
 */
export interface SubTaskFeedback {
    /**
     * 信息提取子任务ID
     */
    SubTaskId?: string;
    /**
     * 提取结果反馈信息
     */
    FeedbackList?: Array<FeedbackList>;
}
/**
 * UpdateIntegrationEmployees返回参数结构体
 */
export interface UpdateIntegrationEmployeesResponse {
    /**
     * 更新成功的用户列表
     */
    SuccessEmployeeData?: Array<SuccessUpdateStaffData>;
    /**
     * 更新失败的用户列表
     */
    FailedEmployeeData?: Array<FailedUpdateStaffData>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyPartnerAutoSignAuthUrl请求参数结构体
 */
export interface ModifyPartnerAutoSignAuthUrlRequest {
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>被授企业id/授权方企业id（即OrganizationId），和AuthorizedOrganizationName二选一传入</p>
     */
    AuthorizedOrganizationId?: string;
    /**
     * <p>被授企业名称/授权方企业的名字，和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号()，请使用中文括号（）代替。</code></p>
     */
    AuthorizedOrganizationName?: string;
    /**
     * <p>在处理授权关系时，授权的方向</p><ul><li><strong>false</strong>（默认值）：表示我方授权他方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称，即接收授权的企业。</li><li><strong>true</strong>：表示他方授权我方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称，即提供授权的企业。</li></ul>
     */
    AuthToMe?: boolean;
    /**
     * <p>在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。</p><p>枚举值：</p><ul><li>OFFICIAL： 企业公章，用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT： 合同专用章，专门用于签署各类合同。</li><li>FINANCE： 财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证</li><li>PERSONNEL： 人事专用章，用于人事管理相关文件，如劳动合同、人事任命等。</li><li>OTHER： 其他类型印章，包含子类型</li></ul>
     */
    SealTypes?: Array<string>;
}
/**
 * DescribeInformationExtractionWebUrl返回参数结构体
 */
export interface DescribeInformationExtractionWebUrlResponse {
    /**
     * 合同信息提取嵌入式web页面链接。
  注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    Url?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateExtendedServiceAuthInfos请求参数结构体
 */
export interface CreateExtendedServiceAuthInfosRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 本企业员工的id，需要已实名，正常在职员工
     */
    UserIds: Array<string>;
    /**
     * 取值
  <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
  <li>BATCH_SIGN：批量签署</li>
  </ul>
     */
    ExtendServiceType?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreatePrepareFlowGroup返回参数结构体
 */
export interface CreatePrepareFlowGroupResponse {
    /**
     * 合同(流程)组的合同组Id
     */
    FlowGroupId?: string;
    /**
     * 嵌入式合同组发起链接
     */
    PrepareUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateMultiFlowSignQRCode返回参数结构体
 */
export interface CreateMultiFlowSignQRCodeResponse {
    /**
     * <p>一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。</p>
     */
    QrCode?: SignQrCode;
    /**
     * <p>一码多签签署码的链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。</p>
     */
    SignUrls?: SignUrl;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeThirdPartyAuthCode返回参数结构体
 */
export interface DescribeThirdPartyAuthCodeResponse {
    /**
     * AuthCode 中对应个人用户是否实名
  <ul>
  <li> **VERIFIED** : 此个人已实名</li>
  <li> **UNVERIFIED**: 此个人未实名</li></ul>
     */
    VerifyStatus?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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;
}
/**
 * CreateDigitalDataSign返回参数结构体
 */
export interface CreateDigitalDataSignResponse {
    /**
     * 加签签名值
     */
    SignValue?: string;
    /**
     * 加签时间戳
     */
    SignTimestamp?: string;
    /**
     * 签署证书信息
     */
    Certificate?: SignCertificate;
    /**
     * 签署算法
     */
    SignAlgorithm?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateOrganizationAuthFile返回参数结构体
 */
export interface CreateOrganizationAuthFileResponse {
    /**
     * 授权书链接，有效期5分钟。
     */
    FileUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
 */
export interface FlowBatchApproverInfo {
    /**
     * 合同流程ID。
     */
    FlowId?: string;
    /**
     * 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
     */
    RecipientId?: string;
}
/**
 * StartFlow返回参数结构体
 */
export interface StartFlowResponse {
    /**
     * 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
  <ul><li> **START** : 发起成功, 合同进入签署环节</li>
  <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境  `白名单功能，使用前请联系对接的客户经理沟通。`</li>
  <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
     */
    Status?: string;
    /**
     * 发起审批流id，仅在CreateFlow时指定了WorkFlow=true时返回
     */
    WorkflowInstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeRiskIdentificationTaskFeedback返回参数结构体
 */
export interface DescribeRiskIdentificationTaskFeedbackResponse {
    /**
     * 合同审查任务反馈信息列表
     */
    FeedbackList?: Array<RiskIdentificationFeedbackInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署控件的配置信息，用在嵌入式发起的页面配置，包括

- 签署控件是否默认展示日期.
 */
export interface SignComponentConfig {
    /**
     * 签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。
  
  - false 展示签署日期（默认）
  - true 不展示签署日期
  ![image](https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png)。
     */
    HideDate?: boolean;
}
/**
 * DescribeInformationExtractionWebUrl请求参数结构体
 */
export interface DescribeInformationExtractionWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同信息提取任务ID，该参数可通过回调事件[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)获取或者从控制台信息提取任务列表获取。
  
  注意：`不填写任务ID时返回信息提取任务列表URL，填写任务ID时返回信息提取任务详情URL`
     */
    TaskId?: string;
}
/**
 * DescribeFlowComponents返回参数结构体
 */
export interface DescribeFlowComponentsResponse {
    /**
     * 合同流程关联的填写控件信息，包括填写控件的归属方以及是否填写等内容。
     */
    RecipientComponentInfos?: Array<RecipientComponentInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeContractReviewWebUrl返回参数结构体
 */
export interface DescribeContractReviewWebUrlResponse {
    /**
     * 合同审查嵌入式web页面链接。
  注意：`链接有效期为5分钟，且链接仅能使用一次。如果上传的合同文件为word时不能进行iframe方式嵌入到贵方系统的网页中，需要单独页面打开此链接显示`
     */
    WebUrl?: string;
    /**
     * 合同审查任务状态。任务状态为`5`时没有WebUrl链接。
  状态如下：
  <ul>
      <li>**1** - 合同审查任务创建成功</li>
      <li>**2** - 合同审查任务排队中</li>
      <li>**3** - 合同审查任务执行中</li>
      <li>**4** - 合同审查任务执行成功</li>
      <li>**5** - 合同审查任务执行失败</li>
  </ul>
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 撤销失败的流程信息
 */
export interface CancelFailureFlow {
    /**
     * <p>合同流程ID，为32位字符串。</p>
     */
    FlowId?: string;
    /**
     * <p>撤销失败原因</p>
     */
    Reason?: string;
    /**
     * <p>合同流程名称</p>
     */
    FlowName?: string;
}
/**
 * OperateFlowRemarks返回参数结构体
 */
export interface OperateFlowRemarksResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeIntegrationEmployees请求参数结构体
 */
export interface DescribeIntegrationEmployeesRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 指定分页每页返回的数据条数，单页最大支持 20。
  如果没有传递， 则为默认值20。
     */
    Limit?: number;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 查询的关键字段，支持Key-Values查询。可选键值如下：
  <ul>
    <li>Key:**"Status"**，根据实名状态查询员工，Values可选：
      <ul><li>**["IsVerified"]**：查询已实名的员工</li><li>**["NotVerified"]**：查询未实名的员工</li></ul></li>
    <li>Key:**"DepartmentId"**，根据部门ID查询部门下的员工，Values为指定的部门ID：**["DepartmentId"]**</li>
    <li>Key:**"UserId"**，根据用户ID查询员工，Values为指定的用户ID：**["UserId"]**</li>
    <li>Key:**"UserWeWorkOpenId"**，根据用户企微账号ID查询员工，Values为指定用户的企微账号ID：**["UserWeWorkOpenId"]**</li>
    <li>Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**</li>
    <li>Key:**"RoleId"**，根据电子签角色ID查询员工，Values为指定的角色ID，满足其中任意一个角色即可：**["RoleId1","RoleId2",...]**</li>
  </ul>
     */
    Filters?: Array<Filter>;
    /**
     * 偏移量，默认为0，最大20000。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688" target="_blank">简介</a>中的相关小节。
     */
    Offset?: number;
}
/**
 * DescribeContractReviewTaskListWebUrl返回参数结构体
 */
export interface DescribeContractReviewTaskListWebUrlResponse {
    /**
     * 嵌入式web页面链接。注意：`链接有效期为5分钟，且链接仅能使用一次。`
     */
    WebUrl?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlow请求参数结构体
 */
export interface CreateFlowRequest {
    /**
     * <p>本合同的发起人，<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注： 支持填入集团子公司经办人 userId 代发合同。</p>
     */
    Operator: UserInfo;
    /**
     * <p>自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&amp;)、（+）组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
     */
    FlowName: string;
    /**
     * <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>
     */
    Approvers: Array<FlowCreateApprover>;
    /**
     * <p>合同流程描述信息(可自定义此描述)，最大长度1000个字符。</p>
     */
    FlowDescription?: string;
    /**
     * <p>合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。<br>此合同类型需要跟模板配置的合同类型保持一致。</p>
     */
    FlowType?: string;
    /**
     * <p>该字段已不再使用</p>
     */
    ClientToken?: string;
    /**
     * <p>合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。</p>
     */
    DeadLine?: number;
    /**
     * <p>合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。</p>
     */
    RemindedOn?: number;
    /**
     * <p>调用方自定义的个性化字段(可自定义此名称)，并以base64格式编码，支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
     */
    UserData?: string;
    /**
     * <p>合同流程的签署顺序类型：</p><ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>注：<code>请和模板中的配置保持一致</code>
     */
    Unordered?: boolean;
    /**
     * <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>
     */
    CustomShowMap?: string;
    /**
     * <p>发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：</p><ul><li> **false**：（默认）不需要审批，直接签署。</li><li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>注：<code>此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同</code>
     */
    NeedSignReview?: boolean;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
     */
    CcInfos?: Array<CcInfo>;
    /**
     * <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）  </li><li> **OTHER** :  通用场景</li></ul>注: <code>个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。</code>
     */
    AutoSignScene?: string;
    /**
     * <p>暂未开放</p>
     * @deprecated
     */
    RelatedFlowId?: string;
    /**
     * <p>暂未开放</p>
     * @deprecated
     */
    CallbackUrl?: string;
    /**
     * <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>
     */
    FlowDisplayType?: number;
    /**
     * <p>是否开启发起合同审批，默认：false（不开启），开启后，发起合同（StartFlow），会提交电子签内置的审批流</p>
     */
    Workflow?: boolean;
    /**
     * <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
     */
    FlowOperateLimit?: FlowOperateLimit;
}
/**
 * 下载文件的URL信息
 */
export interface FileUrl {
    /**
     * 下载文件的URL，有效期为输入的UrlTtl，默认5分钟
     */
    Url: string;
    /**
     * 下载文件的附加信息。如果是pdf文件，会返回pdf文件每页的有效高宽
     */
    Option: string;
}
/**
 * CreateContractReviewWebUrl请求参数结构体
 */
export interface CreateContractReviewWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 需要审查的合同文件资源ID,可通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。
  
  注:  `目前，每个文件限制在10M以下，文件仅支持pdf、doc、docx格式`
     */
    ResourceId?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
     */
    UserData?: string;
    /**
     * 个性化参数，用于控制页面展示内容
     */
    Option?: ContractReviewWebUrlOption;
}
/**
 * CreateDynamicFlowApprover返回参数结构体
 */
export interface CreateDynamicFlowApproverResponse {
    /**
     * 合同流程ID，为32位字符串
     */
    FlowId?: string;
    /**
     * 补充动态合同签署人的结果数组
     */
    DynamicFlowApproverList?: Array<DynamicFlowApproverResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateBatchOrganizationRegistrationTasks返回参数结构体
 */
export interface CreateBatchOrganizationRegistrationTasksResponse {
    /**
     * 生成注册链接的任务Id，
  根据这个id， 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接，进入认证流程
     */
    TaskId?: string;
    /**
     * 批量生成企业认证链接的详细错误信息，
  顺序与输入参数保持一致。
  若企业认证均成功生成，则不返回错误信息；
  若存在任何错误，则返回具体的错误描述。
     */
    ErrorMessages?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 业务逻辑个性化配置字段，默认不传

注: `配置前请联系对接的客户经理沟通确认。`
 */
export interface Option {
    /**
     * 个性化配置参数Key字段，对应传入字段的字段名
     */
    Key: string;
    /**
     * 个性化配置参数Value字段，对应传入字段的字段值
     */
    Value: string;
}
/**
 * DescribeOrganizationSeals返回参数结构体
 */
export interface DescribeOrganizationSealsResponse {
    /**
     * 在设定了SealId时，返回值为0或1；若未设定SealId，则返回公司的总印章数量
     */
    TotalCount?: number;
    /**
     * 查询到的印章结果数组
     */
    Seals?: Array<OccupiedSeal>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeBillUsageDetail请求参数结构体
 */
export interface DescribeBillUsageDetailRequest {
    /**
     * 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
     */
    StartTime: string;
    /**
     * 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
     */
    EndTime: string;
    /**
     * 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
     */
    Offset?: number;
    /**
     * 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
     */
    Limit?: 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>
  <li>**NoAuthSign**: 形式签</li>
  </ul>
     */
    QuotaType?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 信息提取任务反馈信息列表
 */
export interface FeedbackList {
    /**
     * 信息提取结果字段ID
     */
    Id?: string;
    /**
     * 反馈信息
     */
    Info?: FeedbackInfo;
}
/**
 * CreateBatchAdminChangeInvitationsUrl请求参数结构体
 */
export interface CreateBatchAdminChangeInvitationsUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 组织机构要变更的超管姓名。 在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的姓名保持一致。
  
     */
    NewAdminName: string;
    /**
     * 组织机构要变更的超管手机号。
  在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的手机号保持一致。
  
  超管手机号 和超管证件号 二选一 必填。
  
  注意：
  1. 如果新超管的个人身份在电子签进行了手机号的变更，之前提交的超管变更任务将无法获取。
     */
    NewAdminMobile?: string;
    /**
     * 组织机构要变更的超管证件类型支持以下类型
  - ID_CARD : 中国大陆居民身份证 (默认值)
  -  HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
  - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
  需要更当前操作人的证件类型保持一致。
  
     */
    NewAdminIdCardType?: string;
    /**
     * 组织机构要变更的超管证件号。
  在超管变更流程中，必须是超管本人进行操作，需要更当前操作人的证件号保持一致。
  
  超管手机号和超管证件号 二选一必填。
     */
    NewAdminIdCardNumber?: string;
    /**
     * 通知方式。
   NONE（默认）
   SMS  - 如果使用这个方式，则会给即将变更的超管发信息。
  注意：
  发送信息的手机号，是用户传递的手机号。
  如果用户同时传递了证件号，手机号会被用户在电子签注册的手机号进行覆盖。
     */
    NotifyType?: string;
    /**
     * 要跳转的链接类型
  <ul>
  <li> **HTTP**：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型 ，此时返回长链 （默认类型）。</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url，短信通知或者H5跳转适合此类型，此时返回短链。</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path，APP或者小程序跳转适合此类型。</li>
  <li>**QR_CODE**： 跳转电子签小程序的http_url的二维码形式，可以在页面展示适合此类型。</li>
  </ul>
     */
    Endpoint?: string;
}
/**
 * CreateUserAutoSignSealUrl返回参数结构体
 */
export interface CreateUserAutoSignSealUrlResponse {
    /**
     * <p>腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。</p>
     */
    AppId?: string;
    /**
     * <p>腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。</p>
     */
    AppOriginalId?: string;
    /**
     * <p>个人用户自动签的开通链接, 短链或者长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
     */
    Url?: string;
    /**
     * <p>腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。</p>
     */
    Path?: string;
    /**
     * <p>base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。</p>
     */
    QrCode?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 持有的电子印章信息
 */
export interface OccupiedSeal {
    /**
     * 电子印章编号
     */
    SealId?: string;
    /**
     * 电子印章名称
     */
    SealName?: string;
    /**
     * 电子印章授权时间戳，单位秒
     */
    CreateOn?: number;
    /**
     * 电子印章授权人的UserId
     */
    Creator?: string;
    /**
     * 电子印章策略Id
     */
    SealPolicyId?: string;
    /**
     * 印章状态，有以下六种：CHECKING（审核中）SUCCESS（已启用）FAIL（审核拒绝）CHECKING-SADM（待超管审核）DISABLE（已停用）STOPPED（已终止）
     */
    SealStatus?: string;
    /**
     * 审核失败原因
     */
    FailReason?: string;
    /**
     * 印章图片url，5分钟内有效
     */
    Url?: string;
    /**
     * 印章类型,OFFICIAL-企业公章, CONTRACT-合同专用章,ORGANIZATIONSEAL-企业印章(本地上传印章类型),LEGAL_PERSON_SEAL-法人印章
     */
    SealType?: string;
    /**
     * 用印申请是否为永久授权，true-是，false-否
     */
    IsAllTime?: boolean;
    /**
     * 授权人列表
     */
    AuthorizedUsers?: Array<AuthorizedUser>;
    /**
     * 印章扩展数据信息
     */
    ExtendScene?: ExtendScene;
    /**
     * 印章的真实宽度，单位毫米
     */
    RealWidth?: number;
    /**
     * 印章的真实高度，单位毫米
     */
    RealHeight?: number;
    /**
     * 自定义子类型印章
     */
    SubSealType?: string;
    /**
     * 自定义子类型印章名称
     */
    SubSealName?: string;
    /**
     * 印章描述
     */
    SealDescription?: string;
}
/**
 * 意愿核身点头确认模式结果详细数据
 */
export interface IntentionActionResultDetail {
    /**
     * 视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
     */
    Video?: string;
}
/**
 * CreateEmployeeQualificationSealQrCode请求参数结构体
 */
export interface CreateEmployeeQualificationSealQrCodeRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 提示信息，扫码后此信息会展示给扫描用户，用来提示用户授权操作的目的，会在授权界面下面的位置展示。
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/8436ffd78c20605e6b133ff4bc4d2ac7.png)
     */
    HintText?: string;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 2000长度。在执业章授权完成后的回调场景，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_seals#%E4%BA%8C-%E5%91%98%E5%B7%A5%E6%89%A7%E4%B8%9A%E7%AB%A0%E5%9B%9E%E8%B0%83%E9%80%9A%E7%9F%A5">回调通知</a>模块。
     */
    UserData?: string;
}
/**
 * OperateFlowRemarks请求参数结构体
 */
export interface OperateFlowRemarksRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>指定对合同备注的操作</p><p>枚举值：</p><ul><li>CREATE： 创建合同备注</li><li>UPDATE： 更新合同备注</li><li>DELETE： 删除合同备注</li></ul>
     */
    OperateType: string;
    /**
     * <p>对应的合同流程id</p><p>目标合同为合同组时此参数不填</p>
     */
    FlowId?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>对应合同组id</p><p>目标合同为单份合同时此参数不填</p>
     */
    FlowGroupId?: string;
    /**
     * <p>合同备注信息。</p><p>入参限制：当OperateType为UPDATE和DELETE时，通过该结构体进行对应备注操作，合同备注数量范围为 1 - 5个。</p>
     */
    FlowItem?: FlowRemarkItem;
    /**
     * <p>合同备注列表。</p><p>入参限制：当OperateType为CREATE时，通过该参数进行全量的合同备注创建。</p>
     */
    FlowItems?: Array<string>;
}
/**
 * 删除员工失败数据
 */
export interface FailedDeleteStaffData {
    /**
     * 员工在电子签的userId
     */
    UserId?: string;
    /**
     * 员工在第三方平台的openId
     */
    OpenId?: string;
    /**
     * 失败原因
     */
    Reason?: string;
}
/**
 * DescribeInformationExtractionTask返回参数结构体
 */
export interface DescribeInformationExtractionTaskResponse {
    /**
     * 合同信息提取字段信息
     */
    Fields?: Array<ExtractionField>;
    /**
     * 合同智能提取任务状态。
  状态如下：
  <ul>
      <li>**0** - 任务创建成功（还未执行）</li>
      <li>**1** - 排队中（等待执行）</li>
      <li>**2** - 提取中（正在执行）</li>
      <li>**3** - 提取成功</li>
      <li>**4** - 提取失败</li>
  </ul>
     */
    Status?: number;
    /**
     * 合同智能提取结果下载，文件格式为`xlsx`。
  
  注意：`链接有效期为5分钟，过期后可重新获取`
     */
    Url?: string;
    /**
     * 合同信息提取结果信息
     */
    Results?: Array<ExtractionTaskResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 合同审查任务识别出的风险结果信息
 */
export interface OutputRisk {
    /**
     * 合同审查风险结果ID
     */
    RiskId?: string;
    /**
     * 风险名称
     */
    RiskName?: string;
    /**
     * 风险描述
     */
    RiskDescription?: string;
    /**
     * 风险等级别名。
  
  等级描述如下：
  <ul>
      <li>**HIGH** - 高风险</li>
      <li>**NORMAL** - 风险</li>
  </ul>
     */
    RiskLevel?: string;
    /**
     * 风险建议
     */
    RiskAdvice?: string;
    /**
     * 风险评估
     */
    RiskPresentation?: Array<string>;
    /**
     * PDF风险原文内容
     */
    Content?: string;
    /**
     * 审查出的PDF段落位置信息
     */
    Positions?: Array<PositionInfo>;
    /**
     * 是否已修订
     */
    IsMark?: boolean;
    /**
     * 是否已忽略
     */
    IsIgnore?: boolean;
    /**
     * 审查依据
     */
    RiskBasis?: string;
    /**
     * 风险等级id。1 为最高风险等级，0 为最低风险等级，从[2,n]数字越大风险等级逐渐降低。
     */
    RiskLevelId?: number;
    /**
     * 风险标签
     */
    RiskLabels?: Array<string>;
    /**
     * 风险来源 0:模型标注的风险 1:人工标注的风险
     */
    RiskOrigin?: number;
    /**
     * 创建人
     */
    Creator?: string;
    /**
     * 创建人ID
     */
    CreatorId?: string;
    /**
     * 创建时间
     */
    CreatedOn?: number;
    /**
     * 风险等级别名
     */
    RiskLevelAliasName?: string;
}
/**
 * CreateEmployeeChangeUrl返回参数结构体
 */
export interface CreateEmployeeChangeUrlResponse {
    /**
     * <p>修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a></p>
     */
    MiniAppPath?: string;
    /**
     * <p>链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。</p>
     */
    ExpireTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateConvertTaskApi返回参数结构体
 */
export interface CreateConvertTaskApiResponse {
    /**
     * 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowSignReview请求参数结构体
 */
export interface CreateFlowSignReviewRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
  <ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
  <li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
     */
    FlowId: string;
    /**
     * 企业内部审核结果
  <ul><li>PASS: 审核通过</li>
  <li>REJECT: 审核拒绝</li>
  <li>SIGN_REJECT:拒签(流程结束)</li></ul>
     */
    ReviewType: string;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
    /**
     * 审核节点的签署人标志，用于指定当前审核的签署方
  <ul><li>**如果签署审核节点是个人， 此参数必填**。</li></ul>
     */
    RecipientId?: string;
    /**
     * 操作类型：（接口通过该字段区分不同的操作类型）
  
  <ul><li>SignReview: 签署审核（默认）</li>
  <li>CreateReview: 创建审核</li></ul>
  
  如果审核节点是个人，则操作类型只能为SignReview。
     */
    OperateType?: string;
    /**
     * 审核结果原因
  <ul><li>字符串长度不超过200</li>
  <li>当ReviewType 是拒绝（REJECT） 时此字段必填。</li>
  <li>当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。</li></ul>
  
  
     */
    ReviewMessage?: string;
}
/**
 * CreateOrganizationAuthUrl返回参数结构体
 */
export interface CreateOrganizationAuthUrlResponse {
    /**
     * <p>生成的认证链接。</p><p>注： <code>链接有效期统一30天</code></p>
     */
    AuthUrl?: string;
    /**
     * <p>链接过期时间，格式为Unix标准时间戳（秒）</p>
     */
    ExpiredTime?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeOrganizationAuthStatus请求参数结构体
 */
export interface DescribeOrganizationAuthStatusRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号()，请使用中文括号（）代替。
     */
    OrganizationName?: string;
    /**
     * 企业统一社会信用代码
  注意：OrganizationName和UniformSocialCreditCode不能同时为空
     */
    UniformSocialCreditCode?: string;
    /**
     * 法人姓名
     */
    LegalName?: string;
    /**
     * 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
  
  
  认证流 Id可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)获取
  
  注意：
  如果传递了认证流Id，则下面的参数 超管二要素不会生效
  示例值：yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY
     */
    AuthorizationInfoId?: string;
}
/**
 * CreateUserAutoSignSealUrl请求参数结构体
 */
export interface CreateUserAutoSignSealUrlRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
     */
    SceneKey: string;
    /**
     * <p>自动签开通个人用户信息, 包括名字,身份证等。</p>
     */
    UserInfo: UserThreeFactor;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。<code>如果不传，默认过期时间为当前时间往后7天。</code></p>
     */
    ExpiredTime?: number;
    /**
     * <p>要跳转的链接类型<ul><li> <strong>HTTP</strong>：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链</li><li><strong>HTTP_SHORT_URL</strong>：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li><strong>APP</strong>： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li></ul></p>
     */
    EndPoint?: string;
}
/**
 * ModifyFlowDeadline请求参数结构体
 */
export interface ModifyFlowDeadlineRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
  <ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
  <li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
     */
    FlowId: string;
    /**
     * 签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）
     */
    Deadline: number;
    /**
     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
     */
    Agent?: Agent;
    /**
     * 签署方角色编号，为32位字符串
  <ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
  <li>通过[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)发起合同，或通过[模板发起合同-创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)时，返回参数[Approvers](https://qian.tencent.com/developers/companyApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
  <li>也可通过[查询合同流程的详情信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo)接口查询签署人的RecipientId编号</li></ul>
     */
    RecipientId?: string;
}
/**
 * CreateFlowApprovers请求参数结构体
 */
export interface CreateFlowApproversRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 补充签署环节签署候选人信息。
  
  注：` 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充； 如果不指定，则使用姓名和手机号进行补充。`
     */
    Approvers: Array<FillApproverInfo>;
    /**
     * 合同流程ID，为32位字符串。
  - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
  - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
  - <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId来指定需要补充的合同id
     */
    FlowId?: string;
    /**
     * 签署人信息补充方式
  
  <ul><li>**0**: <font color="red">或签合同</font>添加签署候选人，或签支持一个节点传多个签署人，不传值默认或签。
  注: `或签只支持企业签署方`</li>
  <li>**1**: <font color="red">动态签署人合同</font>的添加签署候选人，支持企业或个人签署方。</li></ul>
     */
    FillApproverType?: number;
    /**
     * 在可定制的企业微信通知中，发起人可以根据具体需求进行自定义设置。
     */
    Initiator?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
     */
    FlowGroupId?: string;
}
/**
 * ExportContractComparisonTask请求参数结构体
 */
export interface ExportContractComparisonTaskRequest {
    /**
     * <p>执行合同审查任务的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。</p>
     */
    TaskId: string;
    /**
     * <p>导出对比结果文件类型。<br>类型如下：</p><ul><li> **0**：【PDF】以新合同文件为基础，导出带有可视化对比点标注的PDF文件。</li><li> **1**：【EXCEL】导出结构化的对比点明细表格，以列表形式罗列每一个差异点，包含改动位置、类型、标签及修改前后的完整内容。</li></ul>
     */
    ExportType?: number;
    /**
     * <p>是否忽略，适用于PDF。</p><ul><li> **true**：导出文件标注去掉忽略项。</li><li> **false**：导出文件包含所有对比点。</li></ul>
     */
    Ignore?: boolean;
}
/**
 * CreatePreparedPersonalEsign请求参数结构体
 */
export interface CreatePreparedPersonalEsignRequest {
    /**
     * <p>个人用户姓名</p>
     */
    UserName: string;
    /**
     * <p>证件号码，应符合以下规则</p><ul><li> 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    IdCardNumber: string;
    /**
     * <p>印章名称，长度1-50个字。</p>
     */
    SealName: string;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>证件类型，支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>
     */
    IdCardType?: string;
    /**
     * <p>该字段已不再使用</p>
     * @deprecated
     */
    SealImage?: string;
    /**
     * <p>是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。</p>
     */
    SealImageCompress?: boolean;
    /**
     * <p>手机号码；当需要开通自动签时，该参数必传</p>
     */
    Mobile?: string;
    /**
     * <p>该字段已不再使用</p>
     * @deprecated
     */
    EnableAutoSign?: boolean;
    /**
     * <p>印章颜色（参数ProcessSeal=true时生效）<br>默认值：BLACK黑色<br>取值:<br>BLACK 黑色,<br>RED 红色,<br>BLUE 蓝色。</p>
     */
    SealColor?: string;
    /**
     * <p>是否处理印章，默认不做印章处理。<br>取值如下：</p><ul><li>false：不做任何处理；</li><li>true：做透明化处理和颜色增强。</li></ul>
     */
    ProcessSeal?: boolean;
    /**
     * <p>印章图片文件 id<br>取值：<br>填写的FileId通过UploadFiles接口上传文件获取。</p>
     */
    FileId?: string;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减</p>
     */
    LicenseType?: number;
    /**
     * <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul><p>注: <code>不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN</code></p>
     */
    SceneKey?: string;
}
/**
 * ImportContractReviewChecklist请求参数结构体
 */
export interface ImportContractReviewChecklistRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>导入的合同审查清单名称</p>
     */
    Name: string;
    /**
     * <p>导入的合同审查清单审查点列表</p>
     */
    Categories: Array<ChecklistCategory>;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>如果传值，则更新对应的合同审查清单，否则创建新的合同审查清单</p>
     */
    ChecklistID?: string;
    /**
     * <p>设置为true则启动清单，否则禁用清单</p>
     */
    Enabled?: boolean;
}
/**
 * CreateMiniAppPrepareFlow请求参数结构体
 */
export interface CreateMiniAppPrepareFlowRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  支持填入集团子公司经办人 userId 代发合同。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 资源类型，取值有：
  <ul><li> **1**：模板</li>
  <li> **2**：文件 </li></ul>
     */
    ResourceType: number;
    /**
     * 资源id，与ResourceType相对应，取值范围：
  <ul>
  <li>文件Id（通过UploadFiles获取文件资源Id）</li>
  <li>模板Id（通过控制台创建模板后获取模板Id）</li>
  </ul>
  注意：需要同时设置 ResourceType 参数指定资源类型
     */
    ResourceId: string;
    /**
     * 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
  
  该名称还将用于合同签署完成后文件下载的默认文件名称。
     */
    FlowName: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息。
     */
    Approvers?: Array<MiniAppCreateApproverInfo>;
    /**
     * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
  
  **注：暂不支持通过NotifyType参数控制抄送人通知方式**
     */
    CcInfos?: Array<CcInfo>;
    /**
     * 合同流程的签署顺序类型：
  <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
  <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
  
  **注：仅在文件发起模式下设置有效，模板发起以模板配置为准**
     */
    Unordered?: boolean;
    /**
     * 合同发起后经过多少天截止（1-30天可选），默认7天
     */
    DeadlineAfterStartDays?: number;
    /**
     * 用户自定义合同类型Id  该id为电子签企业内的合同类型id， 可以在控制台-合同-自定义合同类型处获取
     */
    UserFlowTypeId?: string;
    /**
     * 发起合同个性化参数
  用于满足小程序合同创建的个性化要求
  具体定制化内容详见数据接口说明
     */
    FlowOption?: MiniAppCreateFlowOption;
    /**
     * 发起合同小程序页面个性化参数
  用于满足小程序合同创建页面的个性化要求 具体定制化内容详见数据接口说明
     */
    PageOption?: MiniAppCreateFlowPageOption;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000 长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
     */
    UserData?: string;
    /**
     * 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
  
  <ul><li> **0** :合同签署页面更多操作按钮</li>
  <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
  <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
  <li> **3** :签署成功页的查看详情按钮</li>
  <li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
  <li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
  
  注:  `字段为数组, 可以传值隐藏多个按钮`
     */
    Hides?: Array<number | bigint>;
}
/**
 * CreateIntegrationDepartment请求参数结构体
 */
export interface CreateIntegrationDepartmentRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得组织架构管理权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 部门名称，最大长度为50个字符。
     */
    DeptName: string;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 电子签父部门ID。
  注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
     */
    ParentDeptId?: string;
    /**
     * 第三方平台中父部门ID。
  注：`如果同时指定了ParentDeptId与ParentDeptOpenId参数，系统将优先使用ParentDeptId。当二者都未指定时，创建的新部门将自动填充至根节点部门下。`
     */
    ParentDeptOpenId?: string;
    /**
     * 客户系统部门ID，最大长度为64个字符。
     */
    DeptOpenId?: string;
    /**
     * 排序号，支持设置的数值范围为1~30000。同一父部门下，排序号越大，部门顺序越靠前。
     */
    OrderNo?: number;
}
/**
 * 成员企业信息
 */
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 AuthorizedUser {
    /**
     * 电子签系统中的用户id
     */
    UserId?: string;
}
/**
 * 视频核身意图配置，可指定问答模式或者点头模式的语音文本。

注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
 */
export interface Intention {
    /**
     * 视频认证类型，支持以下类型
  <ul><li>1 : 问答模式</li>
  <li>2 : 点头模式</li></ul>
  
  注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
     */
    IntentionType?: number;
    /**
     * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多为10轮。
  
  注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
     */
    IntentionQuestions?: Array<IntentionQuestion>;
    /**
     * 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。
  
  注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
     */
    IntentionActions?: Array<IntentionAction>;
    /**
     * 视频核身相关配置
     */
    RuleIdConfig?: RuleIdConfig;
}
/**
 * CreateFlowBlockchainEvidenceUrl返回参数结构体
 */
export interface CreateFlowBlockchainEvidenceUrlResponse {
    /**
     * 二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
     */
    QrCode?: string;
    /**
     * 查看短链，可直接点击短链查看证书。
     */
    Url?: string;
    /**
     * 二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
     */
    ExpiredOn?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDocument请求参数结构体
 */
export interface CreateDocumentRequest {
    /**
     * 本合同的发起人，<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
  
  注：支持填入集团子公司经办人 userId代发合同。
     */
    Operator: UserInfo;
    /**
     * 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
  
  [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
     */
    TemplateId: string;
    /**
     * 合同流程ID，为32位字符串。
  此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
     */
    FlowId?: string;
    /**
     * 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
     */
    FileNames?: Array<string>;
    /**
     * 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
  <ul>
  <li>支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成</li>
  <li>附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。</li>
  </ul>
  注：只有在控制台编辑模板时，<font color="red">归属给发起方</font>的填写控件（如下图）才能在创建文档的时候进行内容填充。
  ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
     */
    FormFields?: Array<FormField>;
    /**
     * 是否为预览模式，取值如下：<ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 <font color="red">注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。</font> </li></ul>注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
     */
    NeedPreview?: boolean;
    /**
     * 预览模式下产生的预览链接类型 <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>注: `1.此参数在NeedPreview 为true时有效`
     */
    PreviewType?: number;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 该字段已不再使用
     */
    ClientToken?: string;
}
/**
 * CreateContractReviewChecklistWebUrl请求参数结构体
 */
export interface CreateContractReviewChecklistWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
}
/**
 * CreateUserMobileChangeUrl请求参数结构体
 */
export interface CreateUserMobileChangeUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。  注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 如果您要修改企业员工用户ID，传递此用户ID即可，其他参数（Name，UserAccountType，IdCardType，IdCardNumber）将被忽略。如果不传此用户ID，则会使用其他参数来进行链接生成。
  
  [点击查看用户ID的获取方式](https://res.ess.tencent.cn/cdn/tsign-developer-center/assets/images/%E7%BB%84%E7%BB%87%E6%9E%B6%E6%9E%84-47eb7105dd300e6dc0c502fba22688ae.png)
     */
    UserId?: string;
    /**
     * 要修改手机号用户的类型。
  <ul><li>0：员工 （默认）</li><li>1：个人</li>
  </ul>
  如果是员工类型，<b>只能修改本方员工，而不能修改其他企业的员工</b>。
  如果是个人类型，可<b>不指定用户身份，生成的是固定的链接，当前登录电子签小程序的用户可进行换绑。</b>
  
     */
    UserAccountType?: number;
    /**
     * 要修改手机号用户的姓名，请确保填写的姓名为对方的真实姓名，而非昵称等代名。
  
  如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为<b>必填项。</b>
     */
    Name?: string;
    /**
     * 要修改手机号用户的证件类型，
  目前支持的账号类型如下：
  
  <ul><li><b>ID_CARD </b>: （默认）中国大陆居民身份证 </li>
  <li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
  <li><b>HONGKONG_MACAO_AND_TAIWAN </b>: 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
  
     */
    IdCardType?: string;
    /**
     * 要修改手机号用户的身份证号码，应符合以下规则
  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
  <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
  <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
  如果没有传递 userId且 userAccountType 是 0 或者没有传递， 此参数为<b>必填项。</b>
     */
    IdCardNumber?: string;
    /**
     * 要跳转的链接类型
  
  <ul>
  <li><b>HTTP</b>：（默认）跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li>
  <li><b>HTTP_SHORT_URL</b>：跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链</li>
  <li><b>APP</b>：第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
  </ul>
  
  
     */
    Endpoint?: string;
    /**
     * 在用户完成实名认证后，其自定义数据将通过[手机号换绑回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%B8%89-%E4%B8%AA%E4%BA%BA%E5%91%98%E5%B7%A5%E6%89%8B%E6%9C%BA%E5%8F%B7%E4%BF%AE%E6%94%B9%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
  
  请注意：
  此参数仅支持通过[获取c端用户实名链接](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口实名的用户生效。
     */
    UserData?: string;
}
/**
 * CreateEmbedWebUrl请求参数结构体
 */
export interface CreateEmbedWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * WEB嵌入资源类型，支持以下类型
  <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
  <li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
  <li>MODIFY_TEMPLATE：生成编辑模板的嵌入页面</li>
  <li>CREATE_CONTRACT_DRAFT_COOPEDIT：生成创建起草合同的嵌入页面</li>
  <li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
  <li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
  <li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
  <li>EXTEND_SERVICE：生成高级签署能力的嵌入页面</li>
  <li>PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）</li>
  <li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）</li></ul>
  
  注意：
  不同的嵌入类型，操作人需要的权限项不同（权限配置可参考[权限配置](https://qian.tencent.com/document/61355)）。
  <table  border="1">
  <thead>
  <tr><th>EmbedType</th><th>权限</th></tr>
  </thead>
  <tbody>
  <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr>
  <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr>
  <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr>
  <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr>
  <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行</br>
  模板管理-查询模板（本企业全部模板）</br>
  模板管理-查询模板（本部门全部模板）</br>
  模板管理-查询模板（本人创建模板）</th></tr>
  <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr>
  <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr>
  <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr>
  <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
  <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
  </tbody>
  </table>
     */
    EmbedType: string;
    /**
     * WEB嵌入的业务资源ID
  
  当EmbedType取值
  <ul>
  <li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li>
  <li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
  <li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li>
  <li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
  <li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li>
  </ul>
  
  注意：
   1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
  ](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
   2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。
     */
    BusinessId?: string;
    /**
     * 代理企业和员工的信息。
  <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 抄送方信息
     */
    Reviewer?: ReviewerInfo;
    /**
     * 个性化参数，用于控制页面展示内容
     */
    Option?: EmbedUrlOption;
    /**
     * <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li> <li>支持的格式：json字符串的BASE64编码字符串</li> <li>示例：<ul>                  <li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>                  <li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li> </ul> </li> </ul>
     */
    UserData?: string;
}
/**
 * ExportContractReviewMarkedRisk返回参数结构体
 */
export interface ExportContractReviewMarkedRiskResponse {
    /**
     * 导出任务 id。
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateFlowGroupByFiles返回参数结构体
 */
export interface CreateFlowGroupByFilesResponse {
    /**
     * 合同(流程)组的合同组Id
     */
    FlowGroupId?: string;
    /**
     * 合同(流程)组中子合同列表.
     */
    FlowIds?: Array<string>;
    /**
     * 合同组签署方信息。
     */
    Approvers?: Array<FlowGroupApprovers>;
    /**
     * 发起审批流id，仅在发起时指定FlowGroupOptions.FlowGroupNeedWorkflow=true时返回
     */
    WorkflowInstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteIntegrationRoleUsers请求参数结构体
 */
export interface DeleteIntegrationRoleUsersRequest {
    /**
     * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 角色id，可以通过DescribeIntegrationRoles接口获取角色信息
     */
    RoleId: string;
    /**
     * 用户信息,最多 200 个用户，并且 UserId 和 OpenId 二选一，其他字段不需要传
     */
    Users: Array<UserInfo>;
    /**
     * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * CreateFlowSignUrl请求参数结构体
 */
export interface CreateFlowSignUrlRequest {
    /**
     * <p>合同流程ID为32位字符串。</p><p>您可以登录腾讯电子签控制台，在 &quot;合同&quot; -&gt; &quot;合同中心&quot; 中查看某个合同的FlowId（在页面中展示为合同ID）。<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a>。</p>
     */
    FlowId: string;
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator?: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
     */
    FlowApproverInfos?: Array<FlowCreateApprover>;
    /**
     * <p>用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。</p>
     */
    VideoVerifyTimesLimit?: number;
    /**
     * <p>机构信息，暂未开放</p>
     * @deprecated
     */
    Organization?: OrganizationInfo;
    /**
     * <p>签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a></p>
     */
    JumpUrl?: string;
    /**
     * <p>链接类型支持以下指定类型：</p><ul><li><b>0</b>: 签署链接（默认值），进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接，进入后可以预览合同当前的样子。</li></ul><p>注：</p><ol><li>当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。</li><li>如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。</li></ol>
     */
    UrlType?: number;
    /**
     * <p>链接的有效时间，单位为秒。取值范围为 30分钟（1800）-90天（7776000）。如果不传，默认有效期为30分钟。</p><p>注意：</p><ol><li><code>出于安全性考虑，若有效期大于30分钟，同设备24小时内点击链接查看合同需要进行手机验证码校验。此校验将会扣除短信份额，不建议通过设置此值来缓存签署链接，建议在用户需要签署的时候临时生成链接。</code></li><li><code>若生成合同发起方预览链接，有效期大于30分钟，则需要进行验证码校验的手机号为发起方账号绑定的手机号。</code></li></ol>
     */
    ExpiredOn?: number;
}
/**
 * CreateIntegrationEmployees返回参数结构体
 */
export interface CreateIntegrationEmployeesResponse {
    /**
     * 创建员工的结果。包含创建成功的数据与创建失败数据。
     */
    CreateEmployeeResult?: CreateStaffResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeFileConvertTask返回参数结构体
 */
export interface DescribeFileConvertTaskResponse {
    /**
     * <p>任务Id</p>
     */
    TaskId?: string;
    /**
     * <p>任务状态，需要关注的状态</p><p>枚举值：</p><ul><li>0： NeedTranform - 任务已提交</li><li>4： Processing - 文档转换中</li><li>8： TaskEnd - 任务处理完成</li><li>-2： DownloadFailed - 下载失败</li><li>-6： ProcessFailed - 转换失败</li><li>-13： ProcessTimeout - 转换文件超时</li></ul>
     */
    TaskStatus?: number;
    /**
     * <p>状态描述，需要关注的状态</p><ul><li> **NeedTranform** : 任务已提交</li><li> **Processing** : 文档转换中</li><li> **TaskEnd** : 任务处理完成</li><li> **DownloadFailed** : 下载失败</li><li> **ProcessFailed** : 转换失败</li><li> **ProcessTimeout** : 转换文件超时</li></ul>
     */
    TaskMessage?: string;
    /**
     * <p>资源Id（即FileId），用于<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles">用PDF文件创建签署流程</a></p>
     */
    ResourceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * VerifyDigitalDataSign返回参数结构体
 */
export interface VerifyDigitalDataSignResponse {
    /**
     * 签名值验证结果；1-验证成功；2-验证失败
     */
    VerifyResult?: number;
    /**
     * 签名证书信息
     */
    Certificate?: SignCertificate;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 印章扩展信息
 */
export interface ExtendScene {
    /**
     * 印章来源类型
  印章来源类型包括下面几种：
  <ul>
  <li>CREATE-客户上传图片创建</li>
  <li>GENERATE-系统模板印章生成</li>
  <li>SIST_SEAL-深圳电子印章</li>
  </ul>
     */
    GenerateType?: string;
    /**
     * 印章来源类型描述
  
     */
    GenerateTypeDesc?: string;
    /**
     * 印章来源logo
     */
    GenerateTypeLogo?: string;
}
/**
 * CreateModifyAdminAuthorizationUrl请求参数结构体
 */
export interface CreateModifyAdminAuthorizationUrlRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 企业认证流Id，可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到
     */
    AuthorizationId?: string;
    /**
     * 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**PC**： 跳转电子签web 端控制台的链接。</li></ul>
     */
    Endpoint?: string;
}
/**
 * 合同参与者信息。
 */
export interface ApproverInfo {
    /**
     * <p>在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:<br><strong>0</strong>：企业<br><strong>1</strong>：个人<br><strong>3</strong>：企业静默签署<br>注：<code>类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。</code><br><strong>7</strong>: 个人自动签署，适用于个人自动签场景。<br>注: <code>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</code></p>
     */
    ApproverType: number;
    /**
     * <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。</p>
     */
    ApproverName?: string;
    /**
     * <p>签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此合同签署方。</p>
     */
    ApproverMobile?: string;
    /**
     * <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号()，请使用中文括号（）代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。</p>
     */
    OrganizationName?: string;
    /**
     * <p>【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li> 个人签名/印章</li><li> 企业印章</li><li> 骑缝章等签署控件</li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png" alt="image"></p>
     */
    SignComponents?: Array<Component>;
    /**
     * <p>签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a><br>&lt;ul&gt;<li>ID_CARD 中国大陆居民身份证  (默认值)</li></p><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><p>注:  港澳居民来往内地通行证 和  港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</p>
     */
    ApproverIdCardType?: string;
    /**
     * <p>签署方经办人的证件号码，应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
     */
    ApproverIdCardNumber?: string;
    /**
     * <p>通知签署方经办人的方式,  有以下途径:</p><ul><li>  **SMS**  :  (默认)短信</li><li>  **EMAIL**  :  邮箱</li><li>  **ALL**  :  短信+邮箱</li><li>   **NONE**   : 不通知</li></ul><p>注意：<br><code>如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信</code></p><p>枚举值：</p><ul><li>SMS： 短信通知</li><li>EMAIL： 邮件通知</li><li>ALL： 短信+邮件通知</li><li>NONE： 不做任何形式的通知</li></ul>
     */
    NotifyType?: string;
    /**
     * <p>收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:</p><ul><li> **1**  :收款人</li><li>   **2**   :开具人</li><li>   **3** :见证人</li></ul>注: <code>收据场景为白名单功能，使用前请联系对接的客户经理沟通。</code>
     */
    ApproverRole?: number;
    /**
     * <p>可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。</p><p>注: <code>如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的</code></p>
     */
    ApproverRoleName?: string;
    /**
     * <p><font color="red">【已不再使用】</font>签署意愿确认渠道，默认为WEIXINAPP:人脸识别</p><p>注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置</p>
     */
    VerifyChannel?: Array<string>;
    /**
     * <p>签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：</p><ul><li>合同页数少于等于2页，阅读时间为3秒；</li><li>合同页数为3到5页，阅读时间为5秒；</li><li>合同页数大于等于6页，阅读时间为10秒。</li></ul>
     */
    PreReadTime?: number;
    /**
     * <p>签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得</p><p>注：<br>如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）</p>
     */
    UserId?: string;
    /**
     * <p>在企微场景下使用，需设置参数为<strong>WEWORKAPP</strong>，以表明合同来源于企微。</p>
     */
    ApproverSource?: string;
    /**
     * <p>在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。<br>所有参与或签的人员均需具备该标识。<br>注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。<br>如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。</p>
     */
    CustomApproverTag?: string;
    /**
     * <p>可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人等。<br>详细操作可以参考开发者中心的ApproverOption结构体。</p>
     */
    ApproverOption?: ApproverOption;
    /**
     * <p>【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li><li>  **2**  : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
     */
    ApproverVerifyTypes?: Array<number | bigint>;
    /**
     * <p>【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式，可传递以下值：</p><ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li><li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li><li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）</li><li>**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）</li><li>**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）</li></ul><p>默认为：<br>1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)</p><p>注：</p><ol><li>用<font color="red">模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color="red">在创建合同重新指定无效</font></li><li>运营商三要素认证方式对手机号运营商及前缀有限制,可以参考<a href="https://qian.tencent.com/developers/company/mobile_support">运营商支持列表类</a>得到具体的支持说明</li><li>校验方式不允许只包含<font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>，至少需要再增加一种其他校验方式。</li><li><font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>只支持小程序使用，其他端暂不支持。</li></ol>
     */
    ApproverSignTypes?: Array<number | bigint>;
    /**
     * <p>此签署人（员工或者个人）签署前，是否需要发起方企业审批，取值如下：</p><ul><li>**false**：（默认）不需要审批，直接签署。</li><li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul><p>注：<code>此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
     */
    ApproverNeedSignReview?: boolean;
    /**
     * <p>【在用文件发起合同场景下才有效】<br>在调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles">用PDF文件创建签署流程</a>创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID或者印章类型）或签名方式。</p><p>注：<a href="https://qian.tencent.com/developers/company/sign_bean_tag">参考文档和使用示例</a></p>
     */
    AddSignComponentsLimits?: Array<ComponentLimit>;
    /**
     * <p>签署须知：支持传入富文本，最长字数：500个中文字符</p>
     */
    SignInstructionContent?: string;
    /**
     * <p>签署人的签署截止时间，格式为Unix标准时间戳（秒）</p><p>注: <code>若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同</code></p>
     */
    Deadline?: number;
    /**
     * <p>【在用文件发起合同场景下才有效，模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li></ul><p>具体使用说明可参考<a href="https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件">为签署方指定填写控件</a></p><p>注：<code>此参数仅在通过文件发起合同或者合同组时生效</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
     */
    Components?: Array<Component>;
    /**
     * <p>进入签署流程的限制，目前支持以下选项：</p><ul><li> <b>空值（默认）</b> :无限制，可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
     */
    SignEndpoints?: Array<string>;
    /**
     * <p>快速注册相关信息</p>
     */
    RegisterInfo?: RegisterInfo;
    /**
     * <p>是否不保存联系人<br>默认 false 保存联系人  true 不保存联系人</p><p>设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。<br>联系人查看可登录<a href="https://test.qian.tencent.cn/console/">电子签控制台</a> 进行查看。<br>如下图位置：<br><img src="https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png" alt=""></p>
     */
    NotSaveContact?: boolean;
    /**
     * <p>客户指定的邮箱信息</p>
     */
    ApproverEmail?: string;
}
/**
 * 查询过滤条件
 */
export interface Filter {
    /**
     * 查询过滤条件的Key
     */
    Key: string;
    /**
     * 查询过滤条件的Value列表
     */
    Values: Array<string>;
}
/**
 * 创建合同，若对方签署人的企业信息还未在腾讯电子签注册。则在进行引导企业注册时控制企业填写信息的个性化参数。
具体可查看[视频](https://qian.tencent.com/developers/video/?menu=scene&id=6)
 */
export interface RegisterInfoOption {
    /**
     * 是否允许编辑企业注册时的法人姓名。
  <br/>true：不允许编辑<br/>false：允许编辑（默认值）<br/>
  
  注意：
  RegisterInfo 中的LegalName值不为空的时候，才可设置为不可编辑。
     */
    LegalNameSame?: boolean;
    /**
     * 是否允许编辑企业注册时统一社会信用代码。
  <br/>true:不允许编辑。
  <br/>false:允许编辑（默认值）。
  <br/>
  
  
  注意：
  RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。
  
     * @deprecated
     */
    UnifiedSocialCreditCodeCNameSame?: boolean;
    /**
     * 是否允许编辑企业注册时的证照类型
  <br/>true:不允许编辑。
  <br/>false:允许编辑（默认值）。
  <br/>
  
  注意：
  RegisterInfo 中的OrganizationIdCardType值不为空的时候，才可设置为不可编辑。
     */
    OrganizationIdCardTypeSame?: boolean;
    /**
     * 是否允许编辑企业注册时统一社会信用代码。
  <br/>true:不允许编辑。
  <br/>false:允许编辑（默认值）。
  <br/>
  
  
  注意：
  RegisterInfo 中的UnifiedSocialCreditCode值不为空的时候，才可设置为不可编辑。
     */
    UnifiedSocialCreditCodeSame?: boolean;
}
/**
 * 动态添加签署人的结果信息
 */
export interface DynamicFlowApproverResult {
    /**
     * 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。
  
  填写控件和签署控件都与特定的角色编号关联。
  
  在进行新增签署方操作时，建议记录下该签署方的角色编号。后续可以拉取流程信息，用来判断该签署方的当前状态。
  
     */
    RecipientId?: string;
    /**
     * 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。
  
  可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
     */
    SignId?: string;
    /**
     * 签署方当前状态，会出现下面的状态
  
  2：待签署
  3：已签署
  4：已拒绝
  5：已过期
  6：已撤销
  8：待填写
  9：因为各种原因（签署人改名等）而终止
  10：填写完成
  15：已解除
  19：转他人处理
     */
    ApproverStatus?: number;
}
/**
 * DeleteOrganizationAuthorizations请求参数结构体
 */
export interface DeleteOrganizationAuthorizationsRequest {
    /**
     * 执行本接口操作的员工信息, userId 必填。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 认证流Ids数组
  认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
  
  
  认证流 Id可以通过回调 [授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83) 获取
  
  注意：
  如果传递了认证流Id，则下面的参数 超管二要素不会生效
     */
    AuthorizationIds?: Array<string>;
    /**
     * 认证人姓名，组织机构超管姓名。
  在注册流程中，必须是超管本人进行操作。
     */
    AdminName?: string;
    /**
     * 认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。
     */
    AdminMobile?: string;
    /**
     * 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 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;
}
/**
 * DescribeUserVerifyStatus返回参数结构体
 */
export interface DescribeUserVerifyStatusResponse {
    /**
     * true:表示已实名
  false：表示未实名
     */
    VerifyStatus?: boolean;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ExportContractReviewMarkedRisk请求参数结构体
 */
export interface ExportContractReviewMarkedRiskRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 开始日期。eg， "2006-01-02"
     */
    FromDate: string;
    /**
     * 结束日期。eg，"2006-02-01"
     */
    ToDate: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * 企业套餐余额情况
 */
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;
}
/**
 * DescribeArchiveFlowTask返回参数结构体
 */
export interface DescribeArchiveFlowTaskResponse {
    /**
     * <p>任务状态</p><p>枚举值：</p><ul><li>0： 待处理</li><li>1： 处理中</li><li>2： 任务完成</li><li>3： 任务完成(存在失败)</li></ul>
     */
    Status?: number;
    /**
     * <p>每条合同的处理结果，与创建任务的archive_flows列表顺序一致</p>
     */
    ArchiveFlowResults?: Array<ArchiveFlowResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 子企业套餐使用情况
 */
export interface SubOrgBillSummary {
    /**
     * 子企业名称
     */
    OrganizationName?: string;
    /**
     *
     */
    Usage?: Array<SubOrgBillUsage>;
}
/**
 * DescribeBillUsage请求参数结构体
 */
export interface DescribeBillUsageRequest {
    /**
     * <p>查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于90天</p>
     */
    StartTime: string;
    /**
     * <p>查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于90天</p>
     */
    EndTime: string;
    /**
     * <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>
     */
    QuotaType?: string;
    /**
     * <p>是否展示集团子企业的明细，默认否</p>
     */
    DisplaySubEnterprise?: boolean;
}
/**
 * ModifyApplicationCallbackInfo请求参数结构体
 */
export interface ModifyApplicationCallbackInfoRequest {
    /**
     * 执行本接口操作的员工信息。
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 操作类型：
  1-新增
  2-删除
     */
    OperateType: number;
    /**
     * 企业应用回调信息
     */
    CallbackInfo: CallbackInfo;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
}
/**
 * DescribeContractDiffTaskWebUrl请求参数结构体
 */
export interface DescribeContractDiffTaskWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 合同对比任务ID，该参数通过调用接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreateContractDiffTaskWebUrl" target="_blank">创建合同对比web页面</a>获取。
     */
    TaskId: string;
}
/**
 * StartFlow请求参数结构体
 */
export interface StartFlowRequest {
    /**
     * 本合同的发起人，<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
     */
    Operator: UserInfo;
    /**
     * 合同流程ID，为32位字符串。
  此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
     */
    FlowId: string;
    /**
     * 客户端Token，保持接口幂等性,最大长度64个字符
     * @deprecated
     */
    ClientToken?: string;
    /**
     * 代理企业和员工的信息。
  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
     */
    Agent?: Agent;
    /**
     * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
  <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
  <li> **1** : 签署完成后通知对方来查看合同</li></ul>
     */
    CcNotifyType?: number;
}
/**
 * 企业变更超管信息。
 */
export interface AdminChangeInvitationInfo {
    /**
     * 要变更的企业Id。
  使用接口进行变更，所支持的企业有两种。
  1. 集团主企业替子企业进行超管变更。
      子企业的企业 Id 可在更多-组织管理-集团组织管理处获取。如图位置![image](https://qcloudimg.tencent-cloud.cn/raw/3d4469c13ca9e66a847560fc4309c58b.png)
  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: Array<string>;
    /**
     * 组织机构要变更的超管手机号。
  跟超管变更的操作人保持一致。
  超管变更的手机号和超管变更的证件号，必须要传递一个。
     */
    NewAdminMobile?: string;
    /**
     * 组织机构要变更的超管证件类型支持以下类型
  - ID_CARD : 中国大陆居民身份证 (默认值)
  - HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
  - HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)
  
  跟超管变更的操作人保持一致。
  
     */
    NewAdminIdCardType?: string;
    /**
     * 组织机构新超管证件号。
  
  跟超管变更的操作人保持一致。
  
  超管变更的手机号和超管变更的证件号，必须要传递一个。
     */
    NewAdminIdCardNumber?: string;
}
/**
 * 签署人个性化能力信息
 */
export interface ApproverOption {
    /**
     * <p>签署方是否可以拒签</p><ul><li> **false** : ( 默认)可以拒签</li><li> **true** :不可以拒签</li></ul>
     */
    NoRefuse?: boolean;
    /**
     * <p>签署方是否可以转他人处理</p><ul><li> **false** : ( 默认)可以转他人处理</li><li> **true** :不可以转他人处理</li></ul>
     */
    NoTransfer?: boolean;
    /**
     * <p>允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑</p>
     */
    CanEditApprover?: boolean;
    /**
     * <p>签署人信息补充类型，默认无需补充。</p><ul><li> **1** :  动态签署人（可发起合同后再补充签署人信息）注：<code>企业自动签不支持动态补充</code></li></ul><p>注：</p><ol><li><code>使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关</code></li><li>此参数在嵌入式场景下无效。</li></ol>
     */
    FillType?: number;
    /**
     * <p>签署人阅读合同限制参数<br> <br>取值：</p><ul><li> LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底</li><li> LimitReadTime，阅读合同仅限制阅读时长</li><li> LimitBottom，阅读合同仅限制必须阅读到底</li><li> NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）</li></ul>
     */
    FlowReadLimit?: string;
    /**
     * <p>禁止在签署过程中添加签署日期控件<br> <br>前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）：</p><ul><li> 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件</li><li> 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件</li></ul>
     */
    ForbidAddSignDate?: boolean;
    /**
     * <p>签署人手机号传参模式</p><p>枚举值：</p><ul><li>REPLACE： 接受已有认证手机号并替换</li><li>GIVEN： 以客户入参输入手机号为主</li><li>VALIDATE： 若与认证手机号不一致则报错</li><li>&quot;&quot;： 不走手机号传参模式</li></ul><p>默认值：&quot;&quot;</p><p>会触发手机号传参模式的前提是：签署人是指定了具体身份信息的</p><ul><li>在指定签署人姓名，证件号的情况下会触发</li></ul>
     */
    ApproverMobileMode?: string;
    /**
     * <p>在嵌入式文件发起下,若合同是通过文件,当签署人控件指定了印章类型（或印章Id）,在嵌入页面上是否能修改</p>
     */
    ForbidModifySealInfos?: boolean;
}
/**
 * DeleteIntegrationEmployees返回参数结构体
 */
export interface DeleteIntegrationEmployeesResponse {
    /**
     * 员工删除结果。包含成功数据与失败数据。
  <ul><li>**成功数据**：展示员工姓名、手机号与电子签平台UserId</li>
  <li>**失败数据**：展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
     */
    DeleteEmployeeResult?: DeleteStaffsResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeContractReviewChecklistWebUrl请求参数结构体
 */
export interface DescribeContractReviewChecklistWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 清单 id
     */
    Id: string;
}
/**
 * 权限树中的权限组
 */
export interface PermissionGroup {
    /**
     * 权限组名称
     */
    GroupName?: string;
    /**
     * 权限组key
     */
    GroupKey?: string;
    /**
     * 是否隐藏分组，0否1是
     */
    Hide?: number;
    /**
     * 权限集合
     */
    Permissions?: Array<Permission>;
}
/**
 * 第三方应用下企业用户信息
 */
export interface ProxyOrganizationInfo {
    /**
     * 第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串
     */
    OrganizationOpenId: string;
    /**
     * 第三方应用平台自定义，对应第三方平台子客企业超管的唯一标识。
  
  
  注意:
  1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串
  2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
  3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
  ![image](https://qcloudimg.tencent-cloud.cn/raw/bb67fb66c926759df3a0af5838fdafd5.png)
     */
    OperatorOpenId: string;
}
/**
 * CreateFlowReminds请求参数结构体
 */
export interface CreateFlowRemindsRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>需执行催办的签署流程ID数组，最多包含100个。</p>
     */
    FlowIds: Array<string>;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <p>指定通知方式，枚举值：SMS / EMAIL；为空则按签署人原始 NotifyType 处理</p>
     */
    RemindTypes?: Array<string>;
    /**
     * <p>邮箱覆盖列表，为指定签署人使用特定邮箱发送邮件催办</p>
     */
    RemindEmailInfos?: Array<RemindEmailInfo>;
}
/**
 * DescribeDraftContractByPromptsTask请求参数结构体
 */
export interface DescribeDraftContractByPromptsTaskRequest {
    /**
     * 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
     */
    Operator: UserInfo;
    /**
     * 任务id
     */
    TaskId: string;
}
/**
 * DescribeSignFaceVideo返回参数结构体
 */
export interface DescribeSignFaceVideoResponse {
    /**
     * 核身视频结果。
     */
    VideoData?: DetectInfoVideoData;
    /**
     * 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
     */
    IntentionQuestionResult?: IntentionQuestionResult;
    /**
     * 意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    IntentionActionResult?: IntentionActionResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * VerifyPdf返回参数结构体
 */
export interface VerifyPdfResponse {
    /**
     * 验签结果代码，代码的含义如下：
  
  <ul><li>**1**：文件未被篡改，全部签名在腾讯电子签完成。</li>
  <li>**2**：文件未被篡改，部分签名在腾讯电子签完成。</li>
  <li>**3**：文件被篡改。</li>
  <li>**4**：异常：文件内没有签名域。</li>
  <li>**5**：异常：文件签名格式错误。</li></ul>
     */
    VerifyResult?: number;
    /**
     * 验签结果详情，每个签名域对应的验签结果。状态值如下
  <ul><li> **1** :验签成功，在电子签签署</li>
  <li> **2** :验签成功，在其他平台签署</li>
  <li> **3** :验签失败</li>
  <li> **4** :pdf文件没有签名域</li>
  <li> **5** :文件签名格式错误</li></ul>
     */
    PdfVerifyResults?: Array<PdfVerifyResult>;
    /**
     * 验签序列号, 为11为数组组成的字符串
     */
    VerifySerialNo?: string;
    /**
     * 合同文件MD5哈希值
     */
    PdfResourceMd5?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 删除员工结果
 */
export interface DeleteStaffsResult {
    /**
     * 删除员工的成功数据
     */
    SuccessEmployeeData?: Array<SuccessDeleteStaffData>;
    /**
     * 删除员工的失败数据
     */
    FailedEmployeeData?: Array<FailedDeleteStaffData>;
}
/**
 * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
 */
export interface FlowGroupApproverInfo {
    /**
     * 合同流程ID。
     */
    FlowId?: string;
    /**
     * 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
     */
    RecipientId?: string;
}
/**
 * DescribeBatchOrganizationRegistrationUrls返回参数结构体
 */
export interface DescribeBatchOrganizationRegistrationUrlsResponse {
    /**
     * 企业批量注册链接信息
     */
    OrganizationAuthUrls?: Array<OrganizationAuthUrl>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 扩展服务开通和授权的详细信息
 */
export interface ExtendAuthInfo {
    /**
     * 扩展服务的类型，可能是以下值：
  <ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
  <li>BATCH_SIGN：批量签署</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>PAGING_SEAL：骑缝章</li>
  <li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li></ul>
     */
    Type?: string;
    /**
     * 扩展服务的名称
     */
    Name?: string;
    /**
     * 扩展服务的开通状态：
  <ul>
  <li>ENABLE : 已开通</li>
  <li>DISABLE : 未开通</li>
  </ul>
     */
    Status?: string;
    /**
     * 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
     */
    OperatorUserId?: string;
    /**
     * 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
     */
    OperateOn?: number;
    /**
     * 该扩展服务若可以授权，此参数对应授权人员的列表
     */
    HasAuthUserList?: Array<HasAuthUser>;
}
/**
 * CreateInformationExtractionWebUrl请求参数结构体
 */
export interface CreateInformationExtractionWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
    /**
     * 需要提取的合同文件资源ID,可通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源ID。
  
  注:
  -  `word、pdf文件每个文件限制在10M以下`
  -  `png、jpg、jpeg文件每个限制在5M以下`
     */
    ResourceIds?: Array<string>;
    /**
     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。
  
  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
     */
    UserData?: string;
    /**
     * 个性化参数，用于控制页面展示内容
     */
    Option?: WebUrlOption;
}
/**
 * CreateRiskIdentificationTaskFeedback请求参数结构体
 */
export interface CreateRiskIdentificationTaskFeedbackRequest {
    /**
     * 执行合同审查任务的员工信息。
     */
    Operator: UserInfo;
    /**
     * 合同审查风险结果ID，取值如下：
  
  - 反馈风险项结果。该参数通过调用接口[获取合同审查任务详情](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/DescribeContractReviewTask)获取（取Risks.RiskId值）。
  
  - 反馈通过项结果。该参数通过调用接口[获取合同审查任务详情](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/DescribeContractReviewTask)获取（取ApprovedLists.RiskId值）
     */
    RiskId?: string;
    /**
     * 反馈结果
  
  - 1: 其他错误
  - 2: 审查错误
  - 3: 审查正确
     */
    FeedbackResult?: number;
    /**
     * 审查反馈原因
     */
    Reason?: string;
}
/**
 * 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
 */
export interface ReleasedApprover {
    /**
     * 签署人姓名，最大长度50个字。
  
     */
    Name: string;
    /**
     * 签署人手机号。
     */
    Mobile: string;
    /**
     * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
     * @deprecated
     */
    RelievedApproverReceiptId?: string;
    /**
     * 指定签署人类型，目前仅支持
  <ul><li> **ORGANIZATION**：企业（默认值）</li>
  <li> **ENTERPRISESERVER**：企业静默签</li></ul>
     */
    ApproverType?: string;
    /**
     * 签署控件类型，支持自定义企业签署方的签署控件类型
  <ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
  <li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
     */
    ApproverSignComponentType?: string;
    /**
     * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
  
  如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
  
  ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
  
     */
    ApproverSignRole?: string;
    /**
     * 印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
     */
    ApproverSignSealId?: string;
    /**
     * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
     */
    RelievedApproverRecipientId?: string;
}
/**
 * DescribeUserFlowType请求参数结构体
 */
export interface DescribeUserFlowTypeRequest {
    /**
     * <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
     */
    Operator: UserInfo;
    /**
     * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
     */
    Agent?: Agent;
    /**
     * <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>
     */
    Filters?: Array<Filter>;
    /**
     * <p>查询绑定了模板的用户合同类型 <ul> <li>false（默认值），查询用户合同类型</li> <li>true，查询绑定了模板的用户合同类型</li> </ul></p>
     */
    QueryBindTemplate?: boolean;
}
/**
 * DescribeContractReviewTaskListWebUrl请求参数结构体
 */
export interface DescribeContractReviewTaskListWebUrlRequest {
    /**
     * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
  
  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    Operator: UserInfo;
}
/**
 * 合同流程的基础信息
 */
export interface FlowBrief {
    /**
     * 合同流程ID，为32位字符串。
     */
    FlowId?: string;
    /**
     * 合同流程的名称。
     */
    FlowName?: string;
    /**
     * 合同流程描述信息。
     */
    FlowDescription?: string;
    /**
     * 合同流程的类别分类（如销售合同/入职合同等）。
  该字段将被废弃，不建议使用。	请使用 UserFlowType。
     */
    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> **16** : 已失效（签署期间有签署人改名等原因导致）</li>
  <li> **21** : 已解除</li></ul>
     */
    FlowStatus?: number;
    /**
     * 合同流程创建时间，格式为Unix标准时间戳（秒）。
     */
    CreatedOn?: number;
    /**
     * 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
     */
    FlowMessage?: string;
    /**
     *  合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
     */
    Creator?: string;
    /**
     * 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
     */
    Deadline?: number;
    /**
     * 用户合同的自定义分类。
  
  自定义合同类型的位置，在下图所示地方:
  ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
     */
    UserFlowType?: UserFlowType;
    /**
     * 发起模板时,使用的模板Id
     */
    TemplateId?: string;
}
/**
 * DescribeOrganizationGroupOrganizations返回参数结构体
 */
export interface DescribeOrganizationGroupOrganizationsResponse {
    /**
     * 符合查询条件的资源实例总数量。
     */
    Total?: number;
    /**
     * 已授权待激活的子企业总数量
     */
    JoinedTotal?: number;
    /**
     * 已加入的企业数量(废弃,请使用ActivatedTotal)
     * @deprecated
     */
    ActivedTotal?: number;
    /**
     * 如果入参Export为 true 时使用，表示导出Excel的url
     */
    ExportUrl?: string;
    /**
     * 成员企业信息列表
     */
    List?: Array<GroupOrganization>;
    /**
     * 已加入的子企业总数量
     */
    ActivatedTotal?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
 */
export interface IntentionQuestion {
    /**
     * 当选择语音问答模式时，系统自动播报的问题文本，最大长度为250个字符。
     */
    Question?: string;
    /**
     *  当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。
     */
    Answers?: Array<string>;
}