com.tencentcloudapi.ess.v20201111.models.CreateFlowByFilesRequest Maven / Gradle / Ivy
/*
* 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.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreateFlowByFilesRequest extends AbstractModel{
/**
* 调用方用户信息，userId 必填
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 签署流程名称,最大长度200个字符
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 签署参与者信息，最大限制50方
*/
@SerializedName("Approvers")
@Expose
private ApproverInfo [] Approvers;
/**
* 签署pdf文件的资源编号列表，通过UploadFiles接口获取
*/
@SerializedName("FileIds")
@Expose
private String [] FileIds;
/**
* 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 经办人内容控件配置
*/
@SerializedName("Components")
@Expose
private Component [] Components;
/**
* 被抄送人的信息列表。
注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
*/
@SerializedName("CcInfos")
@Expose
private CcInfo [] CcInfos;
/**
* 是否需要预览，true：预览模式，false：非预览（默认）；
预览链接有效期300秒；
*/
@SerializedName("NeedPreview")
@Expose
private Boolean NeedPreview;
/**
* 签署流程描述,最大长度1000个字符
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 发送类型：
true：无序签
false：有序签
注：默认为false（有序签）
*/
@SerializedName("Unordered")
@Expose
private Boolean Unordered;
/**
* 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
@SerializedName("CustomShowMap")
@Expose
private String CustomShowMap;
/**
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 应用号信息
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* Get 调用方用户信息，userId 必填
* @return Operator 调用方用户信息，userId 必填
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 调用方用户信息，userId 必填
* @param Operator 调用方用户信息，userId 必填
*/
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* 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 签署参与者信息，最大限制50方
* @return Approvers 签署参与者信息，最大限制50方
*/
public ApproverInfo [] getApprovers() {
return this.Approvers;
}
/**
* Set 签署参与者信息，最大限制50方
* @param Approvers 签署参与者信息，最大限制50方
*/
public void setApprovers(ApproverInfo [] Approvers) {
this.Approvers = Approvers;
}
/**
* Get 签署pdf文件的资源编号列表，通过UploadFiles接口获取
* @return FileIds 签署pdf文件的资源编号列表，通过UploadFiles接口获取
*/
public String [] getFileIds() {
return this.FileIds;
}
/**
* Set 签署pdf文件的资源编号列表，通过UploadFiles接口获取
* @param FileIds 签署pdf文件的资源编号列表，通过UploadFiles接口获取
*/
public void setFileIds(String [] FileIds) {
this.FileIds = FileIds;
}
/**
* Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
* @return FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
* @param FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
*/
public void setFlowType(String FlowType) {
this.FlowType = FlowType;
}
/**
* Get 经办人内容控件配置
* @return Components 经办人内容控件配置
*/
public Component [] getComponents() {
return this.Components;
}
/**
* Set 经办人内容控件配置
* @param Components 经办人内容控件配置
*/
public void setComponents(Component [] Components) {
this.Components = Components;
}
/**
* Get 被抄送人的信息列表。
注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
* @return CcInfos 被抄送人的信息列表。
注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
*/
public CcInfo [] getCcInfos() {
return this.CcInfos;
}
/**
* Set 被抄送人的信息列表。
注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
* @param CcInfos 被抄送人的信息列表。
注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
*/
public void setCcInfos(CcInfo [] CcInfos) {
this.CcInfos = CcInfos;
}
/**
* Get 是否需要预览，true：预览模式，false：非预览（默认）；
预览链接有效期300秒；
* @return NeedPreview 是否需要预览，true：预览模式，false：非预览（默认）；
预览链接有效期300秒；
*/
public Boolean getNeedPreview() {
return this.NeedPreview;
}
/**
* Set 是否需要预览，true：预览模式，false：非预览（默认）；
预览链接有效期300秒；
* @param NeedPreview 是否需要预览，true：预览模式，false：非预览（默认）；
预览链接有效期300秒；
*/
public void setNeedPreview(Boolean NeedPreview) {
this.NeedPreview = NeedPreview;
}
/**
* Get 签署流程描述,最大长度1000个字符
* @return FlowDescription 签署流程描述,最大长度1000个字符
*/
public String getFlowDescription() {
return this.FlowDescription;
}
/**
* Set 签署流程描述,最大长度1000个字符
* @param FlowDescription 签署流程描述,最大长度1000个字符
*/
public void setFlowDescription(String FlowDescription) {
this.FlowDescription = FlowDescription;
}
/**
* Get 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
* @return Deadline 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
* @param Deadline 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 发送类型：
true：无序签
false：有序签
注：默认为false（有序签）
* @return Unordered 发送类型：
true：无序签
false：有序签
注：默认为false（有序签）
*/
public Boolean getUnordered() {
return this.Unordered;
}
/**
* Set 发送类型：
true：无序签
false：有序签
注：默认为false（有序签）
* @param Unordered 发送类型：
true：无序签
false：有序签
注：默认为false（有序签）
*/
public void setUnordered(Boolean Unordered) {
this.Unordered = Unordered;
}
/**
* Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
* @return CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
public String getCustomShowMap() {
return this.CustomShowMap;
}
/**
* Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
* @param CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
public void setCustomShowMap(String CustomShowMap) {
this.CustomShowMap = CustomShowMap;
}
/**
* Get 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
* @return NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
* @param NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* Get 应用号信息
* @return Agent 应用号信息
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 应用号信息
* @param Agent 应用号信息
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
public CreateFlowByFilesRequest() {
}
/**
* 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 CreateFlowByFilesRequest(CreateFlowByFilesRequest source) {
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.Approvers != null) {
this.Approvers = new ApproverInfo[source.Approvers.length];
for (int i = 0; i < source.Approvers.length; i++) {
this.Approvers[i] = new ApproverInfo(source.Approvers[i]);
}
}
if (source.FileIds != null) {
this.FileIds = new String[source.FileIds.length];
for (int i = 0; i < source.FileIds.length; i++) {
this.FileIds[i] = new String(source.FileIds[i]);
}
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.Components != null) {
this.Components = new Component[source.Components.length];
for (int i = 0; i < source.Components.length; i++) {
this.Components[i] = new Component(source.Components[i]);
}
}
if (source.CcInfos != null) {
this.CcInfos = new CcInfo[source.CcInfos.length];
for (int i = 0; i < source.CcInfos.length; i++) {
this.CcInfos[i] = new CcInfo(source.CcInfos[i]);
}
}
if (source.NeedPreview != null) {
this.NeedPreview = new Boolean(source.NeedPreview);
}
if (source.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.Unordered != null) {
this.Unordered = new Boolean(source.Unordered);
}
if (source.CustomShowMap != null) {
this.CustomShowMap = new String(source.CustomShowMap);
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
}
/**
* 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 + "FlowName", this.FlowName);
this.setParamArrayObj(map, prefix + "Approvers.", this.Approvers);
this.setParamArraySimple(map, prefix + "FileIds.", this.FileIds);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamArrayObj(map, prefix + "Components.", this.Components);
this.setParamArrayObj(map, prefix + "CcInfos.", this.CcInfos);
this.setParamSimple(map, prefix + "NeedPreview", this.NeedPreview);
this.setParamSimple(map, prefix + "FlowDescription", this.FlowDescription);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "Unordered", this.Unordered);
this.setParamSimple(map, prefix + "CustomShowMap", this.CustomShowMap);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamObj(map, prefix + "Agent.", this.Agent);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy