com.tencentcloudapi.ess.v20201111.models.CreateMultiFlowSignQRCodeRequest 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 CreateMultiFlowSignQRCodeRequest extends AbstractModel {
/**
* 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
@SerializedName("TemplateId")
@Expose
private String TemplateId;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
*/
@SerializedName("MaxFlowNum")
@Expose
private Long MaxFlowNum;
/**
* 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
*/
@SerializedName("QrEffectiveDay")
@Expose
private Long QrEffectiveDay;
/**
* 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
*/
@SerializedName("FlowEffectiveDay")
@Expose
private Long FlowEffectiveDay;
/**
* 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
*/
@SerializedName("Restrictions")
@Expose
private ApproverRestriction [] Restrictions;
/**
* 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 限制二维码用户条件（已弃用）
*/
@SerializedName("ApproverRestrictions")
@Expose
private ApproverRestriction ApproverRestrictions;
/**
* 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
*/
@SerializedName("ApproverComponentLimitTypes")
@Expose
private ApproverComponentLimitType [] ApproverComponentLimitTypes;
/**
* 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
*/
@SerializedName("ForbidPersonalMultipleSign")
@Expose
private Boolean ForbidPersonalMultipleSign;
/**
* Get 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* Get 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
* @return TemplateId 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
public String getTemplateId() {
return this.TemplateId;
}
/**
* Set 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
* @param TemplateId 合同模板ID，为32位字符串。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
public void setTemplateId(String TemplateId) {
this.TemplateId = TemplateId;
}
/**
* Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
* @return FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
public String getFlowName() {
return this.FlowName;
}
/**
* Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
* @param FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
public void setFlowName(String FlowName) {
this.FlowName = FlowName;
}
/**
* Get 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
* @return MaxFlowNum 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
*/
public Long getMaxFlowNum() {
return this.MaxFlowNum;
}
/**
* Set 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
* @param MaxFlowNum 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
一旦发起流程数超越该限制，该二维码将自动失效。
*/
public void setMaxFlowNum(Long MaxFlowNum) {
this.MaxFlowNum = MaxFlowNum;
}
/**
* Get 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
* @return QrEffectiveDay 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
*/
public Long getQrEffectiveDay() {
return this.QrEffectiveDay;
}
/**
* Set 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
* @param QrEffectiveDay 二维码的有效期限，默认为7天，最高设定不得超过90天。
一旦超过二维码的有效期限，该二维码将自动失效。
*/
public void setQrEffectiveDay(Long QrEffectiveDay) {
this.QrEffectiveDay = QrEffectiveDay;
}
/**
* Get 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
* @return FlowEffectiveDay 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
*/
public Long getFlowEffectiveDay() {
return this.FlowEffectiveDay;
}
/**
* Set 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
* @param FlowEffectiveDay 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
最长设定期限不得超过30天。
*/
public void setFlowEffectiveDay(Long FlowEffectiveDay) {
this.FlowEffectiveDay = FlowEffectiveDay;
}
/**
* Get 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
* @return Restrictions 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
*/
public ApproverRestriction [] getRestrictions() {
return this.Restrictions;
}
/**
* Set 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
* @param Restrictions 指定签署人信息。
在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
*/
public void setRestrictions(ApproverRestriction [] Restrictions) {
this.Restrictions = Restrictions;
}
/**
* Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @return UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getUserData() {
return this.UserData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @param UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
/**
* Get 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
* @return CallbackUrl 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
* @deprecated
*/
@Deprecated
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
* @param CallbackUrl 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
* @deprecated
*/
@Deprecated
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* 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 ApproverRestrictions 限制二维码用户条件（已弃用）
* @deprecated
*/
@Deprecated
public ApproverRestriction getApproverRestrictions() {
return this.ApproverRestrictions;
}
/**
* Set 限制二维码用户条件（已弃用）
* @param ApproverRestrictions 限制二维码用户条件（已弃用）
* @deprecated
*/
@Deprecated
public void setApproverRestrictions(ApproverRestriction ApproverRestrictions) {
this.ApproverRestrictions = ApproverRestrictions;
}
/**
* Get 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
* @return ApproverComponentLimitTypes 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
*/
public ApproverComponentLimitType [] getApproverComponentLimitTypes() {
return this.ApproverComponentLimitTypes;
}
/**
* Set 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
* @param ApproverComponentLimitTypes 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
*/
public void setApproverComponentLimitTypes(ApproverComponentLimitType [] ApproverComponentLimitTypes) {
this.ApproverComponentLimitTypes = ApproverComponentLimitTypes;
}
/**
* Get 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
* @return ForbidPersonalMultipleSign 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
*/
public Boolean getForbidPersonalMultipleSign() {
return this.ForbidPersonalMultipleSign;
}
/**
* Set 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
* @param ForbidPersonalMultipleSign 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
*/
public void setForbidPersonalMultipleSign(Boolean ForbidPersonalMultipleSign) {
this.ForbidPersonalMultipleSign = ForbidPersonalMultipleSign;
}
public CreateMultiFlowSignQRCodeRequest() {
}
/**
* 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 CreateMultiFlowSignQRCodeRequest(CreateMultiFlowSignQRCodeRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.TemplateId != null) {
this.TemplateId = new String(source.TemplateId);
}
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.MaxFlowNum != null) {
this.MaxFlowNum = new Long(source.MaxFlowNum);
}
if (source.QrEffectiveDay != null) {
this.QrEffectiveDay = new Long(source.QrEffectiveDay);
}
if (source.FlowEffectiveDay != null) {
this.FlowEffectiveDay = new Long(source.FlowEffectiveDay);
}
if (source.Restrictions != null) {
this.Restrictions = new ApproverRestriction[source.Restrictions.length];
for (int i = 0; i < source.Restrictions.length; i++) {
this.Restrictions[i] = new ApproverRestriction(source.Restrictions[i]);
}
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.ApproverRestrictions != null) {
this.ApproverRestrictions = new ApproverRestriction(source.ApproverRestrictions);
}
if (source.ApproverComponentLimitTypes != null) {
this.ApproverComponentLimitTypes = new ApproverComponentLimitType[source.ApproverComponentLimitTypes.length];
for (int i = 0; i < source.ApproverComponentLimitTypes.length; i++) {
this.ApproverComponentLimitTypes[i] = new ApproverComponentLimitType(source.ApproverComponentLimitTypes[i]);
}
}
if (source.ForbidPersonalMultipleSign != null) {
this.ForbidPersonalMultipleSign = new Boolean(source.ForbidPersonalMultipleSign);
}
}
/**
* 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 + "TemplateId", this.TemplateId);
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamSimple(map, prefix + "MaxFlowNum", this.MaxFlowNum);
this.setParamSimple(map, prefix + "QrEffectiveDay", this.QrEffectiveDay);
this.setParamSimple(map, prefix + "FlowEffectiveDay", this.FlowEffectiveDay);
this.setParamArrayObj(map, prefix + "Restrictions.", this.Restrictions);
this.setParamSimple(map, prefix + "UserData", this.UserData);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamObj(map, prefix + "ApproverRestrictions.", this.ApproverRestrictions);
this.setParamArrayObj(map, prefix + "ApproverComponentLimitTypes.", this.ApproverComponentLimitTypes);
this.setParamSimple(map, prefix + "ForbidPersonalMultipleSign", this.ForbidPersonalMultipleSign);
}
}