tencentcloud-sdk-nodejs/tencentcloud/services/ds/v20180523/ds_models.d.ts

腾讯云 API NODEJS SDK

/**
 * SendVcode返回参数结构体
 */
export interface SendVcodeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteAccount请求参数结构体
 */
export interface DeleteAccountRequest {
    /**
     * 模块名AccountMng
     */
    Module: string;
    /**
     * 操作名DeleteAccount
     */
    Operation: string;
    /**
     * 帐号ID列表
     */
    AccountList: Array<string>;
}
/**
 * CreateSeal请求参数结构体
 */
export interface CreateSealRequest {
    /**
     * 模块名SealMng
     */
    Module: string;
    /**
     * 操作名CreateSeal
     */
    Operation: string;
    /**
     * 帐号ID
     */
    AccountResId: string;
    /**
     * 签章链接，图片必须为png格式
     */
    ImgUrl: string;
    /**
     * 图片数据，base64编码
     */
    ImgData?: string;
}
/**
 * CreateSeal返回参数结构体
 */
export interface CreateSealResponse {
    /**
     * 签章ID
     */
    SealResId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署关键字信息
 */
export interface SignKeyword {
    /**
     * 关键字
     */
    Keyword: string;
    /**
     * X轴偏移坐标
     */
    OffsetCoordX: string;
    /**
     * Y轴偏移坐标
     */
    OffsetCoordY: string;
    /**
     * 签章图片宽度
     */
    ImageWidth: string;
    /**
     * 签章图片高度
     */
    ImageHeight: string;
}
/**
 * DescribeTaskStatus返回参数结构体
 */
export interface DescribeTaskStatusResponse {
    /**
     * 任务结果
     */
    TaskResult?: string;
    /**
     * 任务类型，010代表合同上传结果，020代表合同下载结果
     */
    TaskType?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CheckVcode请求参数结构体
 */
export interface CheckVcodeRequest {
    /**
     * 模块名VerifyCode
     */
    Module: string;
    /**
     * 操作名CheckVcode
     */
    Operation: string;
    /**
     * 帐号ID
     */
    AccountResId: string;
    /**
     * 合同ID
     */
    ContractResId: string;
    /**
     * 验证码
     */
    VerifyCode: string;
}
/**
 * CheckVcode返回参数结构体
 */
export interface CheckVcodeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DownloadContract返回参数结构体
 */
export interface DownloadContractResponse {
    /**
     * 任务ID
     */
    TaskId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署坐标对象
 */
export interface SignLocation {
    /**
     * 签名域页数
     */
    SignOnPage: string;
    /**
     * 签名域左下角X轴坐标轴
     */
    SignLocationLBX: string;
    /**
     * 签名域左下角Y轴坐标轴
     */
    SignLocationLBY: string;
    /**
     * 签名域右上角X轴坐标轴
     */
    SignLocationRUX: string;
    /**
     * 签名域右上角Y轴坐标轴
     */
    SignLocationRUY: string;
}
/**
 * SignContractByKeyword返回参数结构体
 */
export interface SignContractByKeywordResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 签署人信息
 */
export interface SignInfo {
    /**
     * 账户ID
     */
    AccountResId: string;
    /**
     * 授权时间（上传合同可不传该参数）
     */
    AuthorizationTime?: string;
    /**
     * 授权IP地址（上传合同可不传该参数）
     */
    Location?: string;
    /**
     * 签章ID
     */
    SealId?: string;
    /**
     * 签名图片，优先级比SealId高
     */
    ImageData?: string;
    /**
     * 默认值：1  表示RSA证书， 2 表示国密证书， 参数不传时默认为1
     */
    CertType?: number;
    /**
     * 签名域的标签值
     */
    SignLocation?: string;
}
/**
 * DeleteSeal请求参数结构体
 */
export interface DeleteSealRequest {
    /**
     * 模块名SealMng
     */
    Module: string;
    /**
     * 操作名DeleteSeal
     */
    Operation: string;
    /**
     * 帐号ID
     */
    AccountResId: string;
    /**
     * 签章ID
     */
    SealResId: string;
}
/**
 * DownloadContract请求参数结构体
 */
export interface DownloadContractRequest {
    /**
     * 模块名ContractMng
     */
    Module: string;
    /**
     * 操作名DownloadContract
     */
    Operation: string;
    /**
     * 合同ID
     */
    ContractResId: string;
}
/**
 * CreateEnterpriseAccount返回参数结构体
 */
export interface CreateEnterpriseAccountResponse {
    /**
     * 帐号ID
     */
    AccountResId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreatePersonalAccount返回参数结构体
 */
export interface CreatePersonalAccountResponse {
    /**
     * 账号ID
     */
    AccountResId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateEnterpriseAccount请求参数结构体
 */
export interface CreateEnterpriseAccountRequest {
    /**
     * 模块名AccountMng
     */
    Module: string;
    /**
     * 操作名CreateEnterpriseAccount
     */
    Operation: string;
    /**
     * 企业用户名称
     */
    Name: string;
    /**
     * 企业用户证件类型，8代表营业执照，详情请见常见问题
     */
    IdentType: number;
    /**
     * 企业用户营业执照号码
     */
    IdentNo: string;
    /**
     * 企业联系人手机号
     */
    MobilePhone: string;
    /**
     * 经办人姓名
     */
    TransactorName: string;
    /**
     * 经办人证件类型，0代表身份证
     */
    TransactorIdentType: number;
    /**
     * 经办人证件号码
     */
    TransactorIdentNo: string;
    /**
     * 经办人手机号
     */
    TransactorPhone: string;
    /**
     * 企业联系人邮箱
     */
    Email?: string;
}
/**
 * CreateContractByUpload请求参数结构体
 */
export interface CreateContractByUploadRequest {
    /**
     * 模块名ContractMng
     */
    Module: string;
    /**
     * 操作名CreateContractByUpload
     */
    Operation: string;
    /**
     * 签署人信息
     */
    SignInfos: Array<SignInfo>;
    /**
     * 合同上传链接地址
     */
    ContractFile: string;
    /**
     * 合同名称
     */
    ContractName: string;
    /**
     * 备注
     */
    Remarks?: string;
    /**
     * 合同发起方腾讯云帐号ID（由平台自动填写）
     */
    Initiator?: string;
    /**
     * 合同长时间未签署的过期时间
     */
    ExpireTime?: string;
}
/**
 * CreateContractByUpload返回参数结构体
 */
export interface CreateContractByUploadResponse {
    /**
     * 任务ID
     */
    TaskId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteSeal返回参数结构体
 */
export interface DeleteSealResponse {
    /**
     * 签章ID
     */
    SealResId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreatePersonalAccount请求参数结构体
 */
export interface CreatePersonalAccountRequest {
    /**
     * 模块名AccountMng
     */
    Module: string;
    /**
     * 操作名CreatePersonalAccount
     */
    Operation: string;
    /**
     * 个人用户姓名
     */
    Name: string;
    /**
     * 个人用户证件类型，0代表身份证，详情请见常见问题
     */
    IdentType: number;
    /**
     * 个人用户证件号码
     */
    IdentNo: string;
    /**
     * 个人用户手机号
     */
    MobilePhone: string;
}
/**
 * DescribeTaskStatus请求参数结构体
 */
export interface DescribeTaskStatusRequest {
    /**
     * 模块名CommonMng
     */
    Module: string;
    /**
     * 操作名DescribeTaskStatus
     */
    Operation: string;
    /**
     * 任务ID
     */
    TaskId: number;
}
/**
 * SignContractByKeyword请求参数结构体
 */
export interface SignContractByKeywordRequest {
    /**
     * 模块名ContractMng
     */
    Module: string;
    /**
     * 操作名SignContractByKeyword
     */
    Operation: string;
    /**
     * 合同ID
     */
    ContractResId: string;
    /**
     * 账户ID
     */
    AccountResId: string;
    /**
     * 签署关键字，偏移坐标原点为关键字中心
     */
    SignKeyword: SignKeyword;
    /**
     * 授权时间（由平台自动填充）
     */
    AuthorizationTime?: string;
    /**
     * 授权IP地址（由平台自动填充）
     */
    Position?: string;
    /**
     * 签章ID
     */
    SealResId?: string;
    /**
     * 选用证书类型：1  表示RSA证书， 2 表示国密证书， 参数不传时默认为1
     */
    CertType?: number;
    /**
     * 签名图片，base64编码
     */
    ImageData?: string;
}
/**
 * SendVcode请求参数结构体
 */
export interface SendVcodeRequest {
    /**
     * 模块名VerifyCode
     */
    Module: string;
    /**
     * 操作名SendVcode
     */
    Operation: string;
    /**
     * 合同ID
     */
    ContractResId: string;
    /**
     * 帐号ID
     */
    AccountResId: string;
}
/**
 * SignContractByCoordinate请求参数结构体
 */
export interface SignContractByCoordinateRequest {
    /**
     * 模块名ContractMng
     */
    Module: string;
    /**
     * 操作名SignContractByCoordinate
     */
    Operation: string;
    /**
     * 合同ID
     */
    ContractResId: string;
    /**
     * 帐户ID
     */
    AccountResId: string;
    /**
     * 签署坐标，坐标原点在文件左下角，坐标单位为磅，坐标不得超过合同文件边界
     */
    SignLocations: Array<SignLocation>;
    /**
     * 授权时间（由平台自动填充）
     */
    AuthorizationTime?: string;
    /**
     * 授权IP地址（由平台自动填充）
     */
    Position?: string;
    /**
     * 签章ID
     */
    SealResId?: string;
    /**
     * 选用证书类型：1  表示RSA证书， 2 表示国密证书， 参数不传时默认为1
     */
    CertType?: number;
    /**
     * 签名图片，base64编码
     */
    ImageData?: string;
}
/**
 * SignContractByCoordinate返回参数结构体
 */
export interface SignContractByCoordinateResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteAccount返回参数结构体
 */
export interface DeleteAccountResponse {
    /**
     * 删除成功帐号ID列表
     */
    DelSuccessList?: Array<string>;
    /**
     * 删除失败帐号ID列表
     */
    DelFailedList?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}