com.tencentcloudapi.essbasic.v20210526.models.ChannelCreateFlowByFilesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Show all versions of tencentcloud-sdk-java-essbasic 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.essbasic.v20210526.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 ChannelCreateFlowByFilesRequest extends AbstractModel {
/**
* 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
*/
@SerializedName("Agent")
@Expose
private Agent Agent;
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
*/
@SerializedName("FlowApprovers")
@Expose
private FlowApproverInfo [] FlowApprovers;
/**
* 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
@SerializedName("FileIds")
@Expose
private String [] FileIds;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 数据表格等填写控件
*/
@SerializedName("Components")
@Expose
private Component [] Components;
/**
* 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 该字段已废弃，请使用【应用号配置】中的回调地址
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
*/
@SerializedName("Unordered")
@Expose
private Boolean Unordered;
/**
* 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
- {合同名称}
- {发起方企业}
- {发起方姓名}
- {签署方N企业}
- {签署方N姓名}
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
*/
@SerializedName("CustomShowMap")
@Expose
private String CustomShowMap;
/**
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("CustomerData")
@Expose
private String CustomerData;
/**
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 签署人校验方式
VerifyCheck: 人脸识别（默认）
MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
*/
@SerializedName("ApproverVerifyType")
@Expose
private String ApproverVerifyType;
/**
* 签署方签署控件（印章/签名等）的生成方式：
- **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。
- **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。
**注**: `发起后添加控件功能不支持添加签批控件`
*/
@SerializedName("SignBeanTag")
@Expose
private Long SignBeanTag;
/**
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
@SerializedName("CcInfos")
@Expose
private CcInfo [] CcInfos;
/**
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
- **0**：合同发起时通知（默认值）
- **1**：签署完成后通知
*/
@SerializedName("CcNotifyType")
@Expose
private Long CcNotifyType;
/**
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
- **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）
- **OTHER** : 通用场景
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
*/
@SerializedName("AutoSignScene")
@Expose
private String AutoSignScene;
/**
* 操作者的信息，不用传
*/
@SerializedName("Operator")
@Expose
private UserInfo Operator;
/**
* 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
@SerializedName("FlowDisplayType")
@Expose
private Long FlowDisplayType;
/**
* Get 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
* @return Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
*/
public Agent getAgent() {
return this.Agent;
}
/**
* Set 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
* @param Agent 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
- 渠道应用标识: Agent.AppId
- 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
- 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
*/
public void setAgent(Agent Agent) {
this.Agent = Agent;
}
/**
* 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 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
* @return FlowDescription 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
public String getFlowDescription() {
return this.FlowDescription;
}
/**
* Set 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
* @param FlowDescription 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
*/
public void setFlowDescription(String FlowDescription) {
this.FlowDescription = FlowDescription;
}
/**
* Get 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
* @return FlowApprovers 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
*/
public FlowApproverInfo [] getFlowApprovers() {
return this.FlowApprovers;
}
/**
* Set 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
* @param FlowApprovers 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
*/
public void setFlowApprovers(FlowApproverInfo [] FlowApprovers) {
this.FlowApprovers = FlowApprovers;
}
/**
* Get 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
* @return FileIds 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
public String [] getFileIds() {
return this.FileIds;
}
/**
* Set 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
* @param FileIds 本合同流程需包含的PDF文件资源编号列表，通过UploadFiles接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
*/
public void setFileIds(String [] FileIds) {
this.FileIds = FileIds;
}
/**
* 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 合同流程的签署截止时间，格式为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 该字段已废弃，请使用【应用号配置】中的回调地址
* @return CallbackUrl 该字段已废弃，请使用【应用号配置】中的回调地址
* @deprecated
*/
@Deprecated
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 该字段已废弃，请使用【应用号配置】中的回调地址
* @param CallbackUrl 该字段已废弃，请使用【应用号配置】中的回调地址
* @deprecated
*/
@Deprecated
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* Get 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
* @return Unordered 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
*/
public Boolean getUnordered() {
return this.Unordered;
}
/**
* Set 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
* @param Unordered 合同流程的签署顺序类型：
- **false**：(默认)有序签署, 本合同多个参与人需要依次签署
- **true**：无序签署, 本合同多个参与人没有先后签署限制
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
*/
public void setUnordered(Boolean Unordered) {
this.Unordered = Unordered;
}
/**
* Get 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
* @return FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
* @param FlowType 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
*/
public void setFlowType(String FlowType) {
this.FlowType = FlowType;
}
/**
* 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 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @return CustomerData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getCustomerData() {
return this.CustomerData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
* @param CustomerData 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setCustomerData(String CustomerData) {
this.CustomerData = CustomerData;
}
/**
* Get 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @return NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
* @param NeedSignReview 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
- **false**：（默认）不需要审批，直接签署。
- **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
- 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
- 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* 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 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
* @return CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
public CcInfo [] getCcInfos() {
return this.CcInfos;
}
/**
* Set 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
* @param CcInfos 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
*/
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 个人自动签名的使用场景包括以下, 个人自动签署(即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 操作者的信息，不用传
* @return Operator 操作者的信息，不用传
* @deprecated
*/
@Deprecated
public UserInfo getOperator() {
return this.Operator;
}
/**
* Set 操作者的信息，不用传
* @param Operator 操作者的信息，不用传
* @deprecated
*/
@Deprecated
public void setOperator(UserInfo Operator) {
this.Operator = Operator;
}
/**
* 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 ChannelCreateFlowByFilesRequest() {
}
/**
* 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 ChannelCreateFlowByFilesRequest(ChannelCreateFlowByFilesRequest source) {
if (source.Agent != null) {
this.Agent = new Agent(source.Agent);
}
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
if (source.FlowApprovers != null) {
this.FlowApprovers = new FlowApproverInfo[source.FlowApprovers.length];
for (int i = 0; i < source.FlowApprovers.length; i++) {
this.FlowApprovers[i] = new FlowApproverInfo(source.FlowApprovers[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.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.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.Unordered != null) {
this.Unordered = new Boolean(source.Unordered);
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.CustomShowMap != null) {
this.CustomShowMap = new String(source.CustomShowMap);
}
if (source.CustomerData != null) {
this.CustomerData = new String(source.CustomerData);
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.ApproverVerifyType != null) {
this.ApproverVerifyType = new String(source.ApproverVerifyType);
}
if (source.SignBeanTag != null) {
this.SignBeanTag = new Long(source.SignBeanTag);
}
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.AutoSignScene != null) {
this.AutoSignScene = new String(source.AutoSignScene);
}
if (source.Operator != null) {
this.Operator = new UserInfo(source.Operator);
}
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 + "Agent.", this.Agent);
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamSimple(map, prefix + "FlowDescription", this.FlowDescription);
this.setParamArrayObj(map, prefix + "FlowApprovers.", this.FlowApprovers);
this.setParamArraySimple(map, prefix + "FileIds.", this.FileIds);
this.setParamArrayObj(map, prefix + "Components.", this.Components);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamSimple(map, prefix + "Unordered", this.Unordered);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamSimple(map, prefix + "CustomShowMap", this.CustomShowMap);
this.setParamSimple(map, prefix + "CustomerData", this.CustomerData);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "ApproverVerifyType", this.ApproverVerifyType);
this.setParamSimple(map, prefix + "SignBeanTag", this.SignBeanTag);
this.setParamArrayObj(map, prefix + "CcInfos.", this.CcInfos);
this.setParamSimple(map, prefix + "CcNotifyType", this.CcNotifyType);
this.setParamSimple(map, prefix + "AutoSignScene", this.AutoSignScene);
this.setParamObj(map, prefix + "Operator.", this.Operator);
this.setParamSimple(map, prefix + "FlowDisplayType", this.FlowDisplayType);
}
}