com.tencentcloudapi.ess.v20201111.models.CreatePreparedPersonalEsignRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.ess.v20201111.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreatePreparedPersonalEsignRequest extends AbstractModel {
/**
* 个人用户姓名
*/
@SerializedName("UserName")
@Expose
private String UserName;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
@SerializedName("IdCardNumber")
@Expose
private String IdCardNumber;
/**
* 印章名称，长度1-50个字。
*/
@SerializedName("SealName")
@Expose
private String SealName;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
@SerializedName("IdCardType")
@Expose
private String IdCardType;
/**
* 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
*/
@SerializedName("SealImage")
@Expose
private String SealImage;
/**
* 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
*/
@SerializedName("SealImageCompress")
@Expose
private Boolean SealImageCompress;
/**
* 手机号码；当需要开通自动签时，该参数必传
*/
@SerializedName("Mobile")
@Expose
private String Mobile;
/**
* 是否开通自动签，该功能需联系运营工作人员开通后使用
*/
@SerializedName("EnableAutoSign")
@Expose
private Boolean EnableAutoSign;
/**
* 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
*/
@SerializedName("SealColor")
@Expose
private String SealColor;
/**
* 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
*/
@SerializedName("ProcessSeal")
@Expose
private Boolean ProcessSeal;
/**
* 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
@SerializedName("FileId")
@Expose
private String FileId;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
@SerializedName("LicenseType")
@Expose
private Long LicenseType;
/**
* 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
@SerializedName("SceneKey")
@Expose
private String SceneKey;
/**
* Get 个人用户姓名
* @return UserName 个人用户姓名
*/
public String getUserName() {
return this.UserName;
}
/**
* Set 个人用户姓名
* @param UserName 个人用户姓名
*/
public void setUserName(String UserName) {
this.UserName = UserName;
}
/**
* Get 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
* @return IdCardNumber 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
public String getIdCardNumber() {
return this.IdCardNumber;
}
/**
* Set 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
* @param IdCardNumber 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
*/
public void setIdCardNumber(String IdCardNumber) {
this.IdCardNumber = IdCardNumber;
}
/**
* Get 印章名称，长度1-50个字。
* @return SealName 印章名称，长度1-50个字。
*/
public String getSealName() {
return this.SealName;
}
/**
* Set 印章名称，长度1-50个字。
* @param SealName 印章名称，长度1-50个字。
*/
public void setSealName(String SealName) {
this.SealName = SealName;
}
/**
* Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
* @return IdCardType 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
public String getIdCardType() {
return this.IdCardType;
}
/**
* Set 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
* @param IdCardType 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
*/
public void setIdCardType(String IdCardType) {
this.IdCardType = IdCardType;
}
/**
* Get 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @return SealImage 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @deprecated
*/
@Deprecated
public String getSealImage() {
return this.SealImage;
}
/**
* Set 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @param SealImage 印章图片的base64
注：已废弃
请先通过UploadFiles接口上传文件，获取 FileId
* @deprecated
*/
@Deprecated
public void setSealImage(String SealImage) {
this.SealImage = SealImage;
}
/**
* Get 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
* @return SealImageCompress 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
*/
public Boolean getSealImageCompress() {
return this.SealImageCompress;
}
/**
* Set 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
* @param SealImageCompress 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
*/
public void setSealImageCompress(Boolean SealImageCompress) {
this.SealImageCompress = SealImageCompress;
}
/**
* Get 手机号码；当需要开通自动签时，该参数必传
* @return Mobile 手机号码；当需要开通自动签时，该参数必传
*/
public String getMobile() {
return this.Mobile;
}
/**
* Set 手机号码；当需要开通自动签时，该参数必传
* @param Mobile 手机号码；当需要开通自动签时，该参数必传
*/
public void setMobile(String Mobile) {
this.Mobile = Mobile;
}
/**
* Get 是否开通自动签，该功能需联系运营工作人员开通后使用
* @return EnableAutoSign 是否开通自动签，该功能需联系运营工作人员开通后使用
*/
public Boolean getEnableAutoSign() {
return this.EnableAutoSign;
}
/**
* Set 是否开通自动签，该功能需联系运营工作人员开通后使用
* @param EnableAutoSign 是否开通自动签，该功能需联系运营工作人员开通后使用
*/
public void setEnableAutoSign(Boolean EnableAutoSign) {
this.EnableAutoSign = EnableAutoSign;
}
/**
* Get 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
* @return SealColor 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
*/
public String getSealColor() {
return this.SealColor;
}
/**
* Set 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
* @param SealColor 印章颜色（参数ProcessSeal=true时生效）
默认值：BLACK黑色
取值:
BLACK 黑色,
RED 红色,
BLUE 蓝色。
*/
public void setSealColor(String SealColor) {
this.SealColor = SealColor;
}
/**
* Get 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
* @return ProcessSeal 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
*/
public Boolean getProcessSeal() {
return this.ProcessSeal;
}
/**
* Set 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
* @param ProcessSeal 是否处理印章，默认不做印章处理。
取值如下：
- false：不做任何处理；
- true：做透明化处理和颜色增强。
*/
public void setProcessSeal(Boolean ProcessSeal) {
this.ProcessSeal = ProcessSeal;
}
/**
* Get 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
* @return FileId 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
public String getFileId() {
return this.FileId;
}
/**
* Set 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
* @param FileId 印章图片文件 id
取值：
填写的FileId通过UploadFiles接口上传文件获取。
*/
public void setFileId(String FileId) {
this.FileId = FileId;
}
/**
* Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
* @return Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
* @param Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* Get 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
* @return LicenseType 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
public Long getLicenseType() {
return this.LicenseType;
}
/**
* Set 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
* @param LicenseType 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
*/
public void setLicenseType(Long LicenseType) {
this.LicenseType = LicenseType;
}
/**
* Get 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
* @return SceneKey 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
public String getSceneKey() {
return this.SceneKey;
}
/**
* Set 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
* @param SceneKey 自动签使用的场景值, 可以选择的场景值如下:
- **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景
- **OTHER** : 通用场景
注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
*/
public void setSceneKey(String SceneKey) {
this.SceneKey = SceneKey;
}
public CreatePreparedPersonalEsignRequest() {
}
/**
* NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
* and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
*/
public CreatePreparedPersonalEsignRequest(CreatePreparedPersonalEsignRequest source) {
if (source.UserName != null) {
this.UserName = new String(source.UserName);
}
if (source.IdCardNumber != null) {
this.IdCardNumber = new String(source.IdCardNumber);
}
if (source.SealName != null) {
this.SealName = new String(source.SealName);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.IdCardType != null) {
this.IdCardType = new String(source.IdCardType);
}
if (source.SealImage != null) {
this.SealImage = new String(source.SealImage);
}
if (source.SealImageCompress != null) {
this.SealImageCompress = new Boolean(source.SealImageCompress);
}
if (source.Mobile != null) {
this.Mobile = new String(source.Mobile);
}
if (source.EnableAutoSign != null) {
this.EnableAutoSign = new Boolean(source.EnableAutoSign);
}
if (source.SealColor != null) {
this.SealColor = new String(source.SealColor);
}
if (source.ProcessSeal != null) {
this.ProcessSeal = new Boolean(source.ProcessSeal);
}
if (source.FileId != null) {
this.FileId = new String(source.FileId);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.LicenseType != null) {
this.LicenseType = new Long(source.LicenseType);
}
if (source.SceneKey != null) {
this.SceneKey = new String(source.SceneKey);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "UserName", this.UserName);
this.setParamSimple(map, prefix + "IdCardNumber", this.IdCardNumber);
this.setParamSimple(map, prefix + "SealName", this.SealName);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "IdCardType", this.IdCardType);
this.setParamSimple(map, prefix + "SealImage", this.SealImage);
this.setParamSimple(map, prefix + "SealImageCompress", this.SealImageCompress);
this.setParamSimple(map, prefix + "Mobile", this.Mobile);
this.setParamSimple(map, prefix + "EnableAutoSign", this.EnableAutoSign);
this.setParamSimple(map, prefix + "SealColor", this.SealColor);
this.setParamSimple(map, prefix + "ProcessSeal", this.ProcessSeal);
this.setParamSimple(map, prefix + "FileId", this.FileId);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "LicenseType", this.LicenseType);
this.setParamSimple(map, prefix + "SceneKey", this.SceneKey);
}
}