com.tencentcloudapi.ess.v20201111.models.CreateFlowByFilesRequest 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 CreateFlowByFilesRequest extends AbstractModel {
/**
* 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 自定义的合同流程的名称，长度不能超过200个字符，只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及（,）、（;）、（.）、(&)、（+）组成。
该名称还将用于合同签署完成后文件下载的默认文件名称。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
@SerializedName("Approvers")
@Expose
private ApproverInfo [] Approvers;
/**
* 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
@SerializedName("FileIds")
@Expose
private String [] FileIds;
/**
* 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 水印控件
- 动态表格等填写控件
*/
@SerializedName("Components")
@Expose
private Component [] Components;
/**
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
@SerializedName("CcInfos")
@Expose
private CcInfo [] CcInfos;
/**
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
*/
@SerializedName("CcNotifyType")
@Expose
private Long CcNotifyType;
/**
* 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
*/
@SerializedName("NeedPreview")
@Expose
private Boolean NeedPreview;
/**
* 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
@SerializedName("PreviewType")
@Expose
private Long PreviewType;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
*/
@SerializedName("Unordered")
@Expose
private Boolean Unordered;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
@SerializedName("RemindedOn")
@Expose
private Long RemindedOn;
/**
* 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
*/
@SerializedName("ApproverVerifyType")
@Expose
private String ApproverVerifyType;
/**
* 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
*/
@SerializedName("SignBeanTag")
@Expose
private Long SignBeanTag;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
@SerializedName("CustomShowMap")
@Expose
private String CustomShowMap;
/**
* 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
@SerializedName("AutoSignScene")
@Expose
private String AutoSignScene;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
@SerializedName("FlowDisplayType")
@Expose
private Long FlowDisplayType;
/**
* Get 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @return Operator 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
*/
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
* @param Operator 执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 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个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
* @return Approvers 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
public ApproverInfo [] getApprovers() {
return this.Approvers;
}
/**
* Set 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
* @param Approvers 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序，请确保列表中参与人的顺序符合实际签署顺序。
*/
public void setApprovers(ApproverInfo [] Approvers) {
this.Approvers = Approvers;
}
/**
* Get 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
* @return FileIds 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
public String [] getFileIds() {
return this.FileIds;
}
/**
* Set 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
* @param FileIds 本合同流程需包含的PDF文件资源编号列表，通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
public void setFileIds(String [] FileIds) {
this.FileIds = FileIds;
}
/**
* 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 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
* @return FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
* @param FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
*/
public void setFlowType(String FlowType) {
this.FlowType = FlowType;
}
/**
* Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 水印控件
- 动态表格等填写控件
* @return Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 水印控件
- 动态表格等填写控件
*/
public Component [] getComponents() {
return this.Components;
}
/**
* Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 水印控件
- 动态表格等填写控件
* @param Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 水印控件
- 动态表格等填写控件
*/
public void setComponents(Component [] Components) {
this.Components = Components;
}
/**
* Get 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
* @return CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
public CcInfo [] getCcInfos() {
return this.CcInfos;
}
/**
* Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
* @param CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
*/
public void setCcInfos(CcInfo [] CcInfos) {
this.CcInfos = CcInfos;
}
/**
* Get 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
* @return CcNotifyType 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
*/
public Long getCcNotifyType() {
return this.CcNotifyType;
}
/**
* Set 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
* @param CcNotifyType 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
*/
public void setCcNotifyType(Long CcNotifyType) {
this.CcNotifyType = CcNotifyType;
}
/**
* Get 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
* @return NeedPreview 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
*/
public Boolean getNeedPreview() {
return this.NeedPreview;
}
/**
* Set 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
* @param NeedPreview 是否为预览模式，取值如下：
- **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
- **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。
*/
public void setNeedPreview(Boolean NeedPreview) {
this.NeedPreview = NeedPreview;
}
/**
* Get 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
* @return PreviewType 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
public Long getPreviewType() {
return this.PreviewType;
}
/**
* Set 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
* @param PreviewType 预览模式下产生的预览链接类型
- **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件
- **1** :H5链接 ,点开后在浏览器中展示合同的样子
注: `此参数在NeedPreview 为true时有效`
*/
public void setPreviewType(Long PreviewType) {
this.PreviewType = PreviewType;
}
/**
* Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
* @return Deadline 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
* @param Deadline 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
* @return Unordered 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
*/
public Boolean getUnordered() {
return this.Unordered;
}
/**
* Set 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
* @param Unordered 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
*/
public void setUnordered(Boolean Unordered) {
this.Unordered = Unordered;
}
/**
* Get 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
* @return UserData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
*/
public String getUserData() {
return this.UserData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
* @param UserData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
/**
* Get 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
* @return RemindedOn 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
public Long getRemindedOn() {
return this.RemindedOn;
}
/**
* Set 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
* @param RemindedOn 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
*/
public void setRemindedOn(Long RemindedOn) {
this.RemindedOn = RemindedOn;
}
/**
* Get 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
* @return ApproverVerifyType 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
*/
public String getApproverVerifyType() {
return this.ApproverVerifyType;
}
/**
* Set 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
* @param ApproverVerifyType 指定个人签署方查看合同的校验方式
- **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容
- **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
*/
public void setApproverVerifyType(String ApproverVerifyType) {
this.ApproverVerifyType = ApproverVerifyType;
}
/**
* Get 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
* @return SignBeanTag 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
*/
public Long getSignBeanTag() {
return this.SignBeanTag;
}
/**
* Set 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
* @param SignBeanTag 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
*/
public void setSignBeanTag(Long SignBeanTag) {
this.SignBeanTag = SignBeanTag;
}
/**
* Get 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
* @return CustomShowMap 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
public String getCustomShowMap() {
return this.CustomShowMap;
}
/**
* Set 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
* @param CustomShowMap 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
public void setCustomShowMap(String CustomShowMap) {
this.CustomShowMap = CustomShowMap;
}
/**
* 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 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
* @return AutoSignScene 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
public String getAutoSignScene() {
return this.AutoSignScene;
}
/**
* Set 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
* @param AutoSignScene 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
public void setAutoSignScene(String AutoSignScene) {
this.AutoSignScene = AutoSignScene;
}
/**
* Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @return NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @param NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
* @return FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
public Long getFlowDisplayType() {
return this.FlowDisplayType;
}
/**
* Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
* @param FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
public void setFlowDisplayType(Long FlowDisplayType) {
this.FlowDisplayType = FlowDisplayType;
}
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.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
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.CcNotifyType != null) {
this.CcNotifyType = new Long(source.CcNotifyType);
}
if (source.NeedPreview != null) {
this.NeedPreview = new Boolean(source.NeedPreview);
}
if (source.PreviewType != null) {
this.PreviewType = new Long(source.PreviewType);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.Unordered != null) {
this.Unordered = new Boolean(source.Unordered);
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
if (source.RemindedOn != null) {
this.RemindedOn = new Long(source.RemindedOn);
}
if (source.ApproverVerifyType != null) {
this.ApproverVerifyType = new String(source.ApproverVerifyType);
}
if (source.SignBeanTag != null) {
this.SignBeanTag = new Long(source.SignBeanTag);
}
if (source.CustomShowMap != null) {
this.CustomShowMap = new String(source.CustomShowMap);
}
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.AutoSignScene != null) {
this.AutoSignScene = new String(source.AutoSignScene);
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.FlowDisplayType != null) {
this.FlowDisplayType = new Long(source.FlowDisplayType);
}
}
/**
* 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 + "FlowDescription", this.FlowDescription);
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 + "CcNotifyType", this.CcNotifyType);
this.setParamSimple(map, prefix + "NeedPreview", this.NeedPreview);
this.setParamSimple(map, prefix + "PreviewType", this.PreviewType);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "Unordered", this.Unordered);
this.setParamSimple(map, prefix + "UserData", this.UserData);
this.setParamSimple(map, prefix + "RemindedOn", this.RemindedOn);
this.setParamSimple(map, prefix + "ApproverVerifyType", this.ApproverVerifyType);
this.setParamSimple(map, prefix + "SignBeanTag", this.SignBeanTag);
this.setParamSimple(map, prefix + "CustomShowMap", this.CustomShowMap);
this.setParamObj(map, prefix + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "AutoSignScene", this.AutoSignScene);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "FlowDisplayType", this.FlowDisplayType);
}
}