com.tencentcloudapi.ess.v20201111.models.CreateBatchQuickSignUrlRequest 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 CreateBatchQuickSignUrlRequest extends AbstractModel {
/**
* 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
*/
@SerializedName("FlowApproverInfo")
@Expose
private FlowCreateApprover FlowApproverInfo;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
*/
@SerializedName("FlowIds")
@Expose
private String [] FlowIds;
/**
* 合同组编号
注：`该参数和合同流程ID数组必须二选一`
*/
@SerializedName("FlowGroupId")
@Expose
private String FlowGroupId;
/**
* 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
*/
@SerializedName("JumpUrl")
@Expose
private String JumpUrl;
/**
* 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
- **2**：姓名印章
- **3**：图片印章
- **4**：系统签名
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
- 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
*/
@SerializedName("SignatureTypes")
@Expose
private Long [] SignatureTypes;
/**
* 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
*/
@SerializedName("ApproverSignTypes")
@Expose
private Long [] ApproverSignTypes;
/**
* 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
@SerializedName("SignTypeSelector")
@Expose
private Long SignTypeSelector;
/**
* 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
@SerializedName("FlowBatchUrlInfo")
@Expose
private FlowBatchUrlInfo FlowBatchUrlInfo;
/**
* Get 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
* @return FlowApproverInfo 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
*/
public FlowCreateApprover getFlowApproverInfo() {
return this.FlowApproverInfo;
}
/**
* Set 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
* @param FlowApproverInfo 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
注:
`1. ApproverType目前只支持个人类型的签署人。`
`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
*/
public void setFlowApproverInfo(FlowCreateApprover FlowApproverInfo) {
this.FlowApproverInfo = FlowApproverInfo;
}
/**
* 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 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* 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 合同组编号
注：`该参数和合同流程ID数组必须二选一`
* @return FlowGroupId 合同组编号
注：`该参数和合同流程ID数组必须二选一`
*/
public String getFlowGroupId() {
return this.FlowGroupId;
}
/**
* Set 合同组编号
注：`该参数和合同流程ID数组必须二选一`
* @param FlowGroupId 合同组编号
注：`该参数和合同流程ID数组必须二选一`
*/
public void setFlowGroupId(String FlowGroupId) {
this.FlowGroupId = FlowGroupId;
}
/**
* Get 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
* @return JumpUrl 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
*/
public String getJumpUrl() {
return this.JumpUrl;
}
/**
* Set 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
* @param JumpUrl 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
*/
public void setJumpUrl(String JumpUrl) {
this.JumpUrl = JumpUrl;
}
/**
* Get 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
- **2**：姓名印章
- **3**：图片印章
- **4**：系统签名
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
- 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
* @return SignatureTypes 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
- **2**：姓名印章
- **3**：图片印章
- **4**：系统签名
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
- 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
*/
public Long [] getSignatureTypes() {
return this.SignatureTypes;
}
/**
* Set 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
- **2**：姓名印章
- **3**：图片印章
- **4**：系统签名
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
- 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
* @param SignatureTypes 指定批量签署合同的签名类型，可传递以下值：
- **0**：手写签名(默认)
- **1**：OCR楷体
- **2**：姓名印章
- **3**：图片印章
- **4**：系统签名
注：
- 默认情况下，签名类型为手写签名
- 您可以传递多种值，表示可用多种签名类型。
- 该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数
*/
public void setSignatureTypes(Long [] SignatureTypes) {
this.SignatureTypes = SignatureTypes;
}
/**
* Get 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
* @return ApproverSignTypes 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
*/
public Long [] getApproverSignTypes() {
return this.ApproverSignTypes;
}
/**
* Set 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
* @param ApproverSignTypes 指定批量签署合同的认证校验方式，可传递以下值：
- **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
- **2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署
- **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
注：
- 默认情况下，认证校验方式为人脸和密码认证
- 您可以传递多种值，表示可用多种认证校验方式。
*/
public void setApproverSignTypes(Long [] ApproverSignTypes) {
this.ApproverSignTypes = ApproverSignTypes;
}
/**
* Get 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
* @return SignTypeSelector 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
public Long getSignTypeSelector() {
return this.SignTypeSelector;
}
/**
* Set 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
* @param SignTypeSelector 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
- **0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；
- **1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。
注：
`不指定该值时，默认为签署方自行选择。`
*/
public void setSignTypeSelector(Long SignTypeSelector) {
this.SignTypeSelector = SignTypeSelector;
}
/**
* Get 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
* @return FlowBatchUrlInfo 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
public FlowBatchUrlInfo getFlowBatchUrlInfo() {
return this.FlowBatchUrlInfo;
}
/**
* Set 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
* @param FlowBatchUrlInfo 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
*/
public void setFlowBatchUrlInfo(FlowBatchUrlInfo FlowBatchUrlInfo) {
this.FlowBatchUrlInfo = FlowBatchUrlInfo;
}
public CreateBatchQuickSignUrlRequest() {
}
/**
* 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 CreateBatchQuickSignUrlRequest(CreateBatchQuickSignUrlRequest source) {
if (source.FlowApproverInfo != null) {
this.FlowApproverInfo = new FlowCreateApprover(source.FlowApproverInfo);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
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.FlowGroupId != null) {
this.FlowGroupId = new String(source.FlowGroupId);
}
if (source.JumpUrl != null) {
this.JumpUrl = new String(source.JumpUrl);
}
if (source.SignatureTypes != null) {
this.SignatureTypes = new Long[source.SignatureTypes.length];
for (int i = 0; i < source.SignatureTypes.length; i++) {
this.SignatureTypes[i] = new Long(source.SignatureTypes[i]);
}
}
if (source.ApproverSignTypes != null) {
this.ApproverSignTypes = new Long[source.ApproverSignTypes.length];
for (int i = 0; i < source.ApproverSignTypes.length; i++) {
this.ApproverSignTypes[i] = new Long(source.ApproverSignTypes[i]);
}
}
if (source.SignTypeSelector != null) {
this.SignTypeSelector = new Long(source.SignTypeSelector);
}
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 + "FlowApproverInfo.", this.FlowApproverInfo);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamArraySimple(map, prefix + "FlowIds.", this.FlowIds);
this.setParamSimple(map, prefix + "FlowGroupId", this.FlowGroupId);
this.setParamSimple(map, prefix + "JumpUrl", this.JumpUrl);
this.setParamArraySimple(map, prefix + "SignatureTypes.", this.SignatureTypes);
this.setParamArraySimple(map, prefix + "ApproverSignTypes.", this.ApproverSignTypes);
this.setParamSimple(map, prefix + "SignTypeSelector", this.SignTypeSelector);
this.setParamObj(map, prefix + "FlowBatchUrlInfo.", this.FlowBatchUrlInfo);
}
}