com.tencentcloudapi.ess.v20201111.models.CreateBatchSignUrlRequest 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 CreateBatchSignUrlRequest extends AbstractModel {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
*/
@SerializedName("Name")
@Expose
private String Name;
/**
* 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
*/
@SerializedName("Mobile")
@Expose
private String Mobile;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 证件类型，支持以下类型
- ID_CARD : 中国大陆居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
注：`请确保和合同中填入的一致`
*/
@SerializedName("IdCardType")
@Expose
private String IdCardType;
/**
* 证件号码，应符合以下规则
- 居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。
- 港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。
- 港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
注：`请确保和合同中填入的一致`
*/
@SerializedName("IdCardNumber")
@Expose
private String IdCardNumber;
/**
* 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
*/
@SerializedName("NotifyType")
@Expose
private String NotifyType;
/**
* 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
*/
@SerializedName("FlowIds")
@Expose
private String [] FlowIds;
/**
* 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
*/
@SerializedName("OrganizationName")
@Expose
private String OrganizationName;
/**
* 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
*/
@SerializedName("JumpToDetail")
@Expose
private Boolean JumpToDetail;
/**
* 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
@SerializedName("FlowBatchUrlInfo")
@Expose
private FlowBatchUrlInfo FlowBatchUrlInfo;
/**
* Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
* @return Name 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
*/
public String getName() {
return this.Name;
}
/**
* Set 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
* @param Name 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
*/
public void setName(String Name) {
this.Name = Name;
}
/**
* Get 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
* @return Mobile 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
*/
public String getMobile() {
return this.Mobile;
}
/**
* Set 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
* @param Mobile 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
*/
public void setMobile(String Mobile) {
this.Mobile = Mobile;
}
/**
* 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 证件类型，支持以下类型
- 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 证件号码，应符合以下规则
- 居民身份证号码应为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 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
* @return NotifyType 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
*/
public String getNotifyType() {
return this.NotifyType;
}
/**
* Set 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
* @param NotifyType 通知用户方式：
- **NONE** : 不通知（默认）
- **SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）
*/
public void setNotifyType(String NotifyType) {
this.NotifyType = NotifyType;
}
/**
* Get 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
* @return FlowIds 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
*/
public String [] getFlowIds() {
return this.FlowIds;
}
/**
* Set 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
* @param FlowIds 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
*/
public void setFlowIds(String [] FlowIds) {
this.FlowIds = FlowIds;
}
/**
* Get 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
* @return OrganizationName 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
*/
public String getOrganizationName() {
return this.OrganizationName;
}
/**
* Set 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
* @param OrganizationName 目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。
注：
- 请确认该名称与企业营业执照中注册的名称一致。
- 如果名称中包含英文括号()，请使用中文括号（）代替。
- 请确保此企业已完成腾讯电子签企业认证。
*/
public void setOrganizationName(String OrganizationName) {
this.OrganizationName = OrganizationName;
}
/**
* Get 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
* @return JumpToDetail 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
*/
public Boolean getJumpToDetail() {
return this.JumpToDetail;
}
/**
* Set 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
* @param JumpToDetail 是否直接跳转至合同内容页面进行签署
- **false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)
- **true**: 跳过合同流程列表, 直接进入合同内容页面进行签署
*/
public void setJumpToDetail(Boolean JumpToDetail) {
this.JumpToDetail = JumpToDetail;
}
/**
* Get 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
* @return FlowBatchUrlInfo 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
public FlowBatchUrlInfo getFlowBatchUrlInfo() {
return this.FlowBatchUrlInfo;
}
/**
* Set 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
* @param FlowBatchUrlInfo 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
public void setFlowBatchUrlInfo(FlowBatchUrlInfo FlowBatchUrlInfo) {
this.FlowBatchUrlInfo = FlowBatchUrlInfo;
}
public CreateBatchSignUrlRequest() {
}
/**
* 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 CreateBatchSignUrlRequest(CreateBatchSignUrlRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.Name != null) {
this.Name = new String(source.Name);
}
if (source.Mobile != null) {
this.Mobile = new String(source.Mobile);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.IdCardType != null) {
this.IdCardType = new String(source.IdCardType);
}
if (source.IdCardNumber != null) {
this.IdCardNumber = new String(source.IdCardNumber);
}
if (source.NotifyType != null) {
this.NotifyType = new String(source.NotifyType);
}
if (source.FlowIds != null) {
this.FlowIds = new String[source.FlowIds.length];
for (int i = 0; i < source.FlowIds.length; i++) {
this.FlowIds[i] = new String(source.FlowIds[i]);
}
}
if (source.OrganizationName != null) {
this.OrganizationName = new String(source.OrganizationName);
}
if (source.JumpToDetail != null) {
this.JumpToDetail = new Boolean(source.JumpToDetail);
}
if (source.FlowBatchUrlInfo != null) {
this.FlowBatchUrlInfo = new FlowBatchUrlInfo(source.FlowBatchUrlInfo);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "Name", this.Name);
this.setParamSimple(map, prefix + "Mobile", this.Mobile);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "IdCardType", this.IdCardType);
this.setParamSimple(map, prefix + "IdCardNumber", this.IdCardNumber);
this.setParamSimple(map, prefix + "NotifyType", this.NotifyType);
this.setParamArraySimple(map, prefix + "FlowIds.", this.FlowIds);
this.setParamSimple(map, prefix + "OrganizationName", this.OrganizationName);
this.setParamSimple(map, prefix + "JumpToDetail", this.JumpToDetail);
this.setParamObj(map, prefix + "FlowBatchUrlInfo.", this.FlowBatchUrlInfo);
}
}