com.tencentcloudapi.ess.v20201111.models.CreateEmbedWebUrlRequest 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
Tencent Cloud Open API SDK for Java
The newest version!
/*
 * 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 CreateEmbedWebUrlRequest extends AbstractModel {

    /**
    * 执行本接口操作的员工信息。

注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
    @SerializedName("Operator")
    @Expose
    private UserInfo Operator;

    /**
    * WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
    */
    @SerializedName("EmbedType")
    @Expose
    private String EmbedType;

    /**
    * WEB嵌入的业务资源ID

当EmbedType取值

为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。


注意：
 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
    */
    @SerializedName("BusinessId")
    @Expose
    private String BusinessId;

    /**
    * 代理企业和员工的信息。

在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
    @SerializedName("Agent")
    @Expose
    private Agent Agent;

    /**
    * 抄送方信息
    */
    @SerializedName("Reviewer")
    @Expose
    private ReviewerInfo Reviewer;

    /**
    * 个性化参数，用于控制页面展示内容
    */
    @SerializedName("Option")
    @Expose
    private EmbedUrlOption Option;

    /**
    *  目前仅支持EmbedType=CREATE_TEMPLATE时传入
 指定后，创建，编辑，删除模板时，回调都会携带该userData
 支持的格式：json字符串的BASE64编码字符串
 示例：                  json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
                  eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
 
 
 
    */
    @SerializedName("UserData")
    @Expose
    private String UserData;

    /**
     * Get 执行本接口操作的员工信息。

注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` 
     * @return Operator 执行本接口操作的员工信息。

注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    public UserInfo getOperator() {
        return this.Operator;
    }

    /**
     * Set 执行本接口操作的员工信息。

注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     * @param Operator 执行本接口操作的员工信息。

注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
     */
    public void setOperator(UserInfo Operator) {
        this.Operator = Operator;
    }

    /**
     * Get WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端） 
     * @return EmbedType WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
     */
    public String getEmbedType() {
        return this.EmbedType;
    }

    /**
     * Set WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
     * @param EmbedType WEB嵌入资源类型，支持以下类型
CREATE_SEAL: 生成创建印章的嵌入页面
CREATE_TEMPLATE：生成创建模板的嵌入页面
MODIFY_TEMPLATE：生成编辑模板的嵌入页面
PREVIEW_TEMPLATE：生成预览模板的嵌入页面
PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
EXTEND_SERVICE：生成拓展服务的嵌入页面
PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）
PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）
     */
    public void setEmbedType(String EmbedType) {
        this.EmbedType = EmbedType;
    }

    /**
     * Get WEB嵌入的业务资源ID

当EmbedType取值

为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。


注意：
 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。 
     * @return BusinessId WEB嵌入的业务资源ID

当EmbedType取值

为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。


注意：
 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
     */
    public String getBusinessId() {
        return this.BusinessId;
    }

    /**
     * Set WEB嵌入的业务资源ID

当EmbedType取值

为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。


注意：
 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
     * @param BusinessId WEB嵌入的业务资源ID

当EmbedType取值

为PREVIEW_SEAL_DETAIL，必填，取值为印章id。
为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*
为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。
为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。


注意：
 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
     */
    public void setBusinessId(String BusinessId) {
        this.BusinessId = BusinessId;
    }

    /**
     * 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 Reviewer 抄送方信息
     */
    public ReviewerInfo getReviewer() {
        return this.Reviewer;
    }

    /**
     * Set 抄送方信息
     * @param Reviewer 抄送方信息
     */
    public void setReviewer(ReviewerInfo Reviewer) {
        this.Reviewer = Reviewer;
    }

    /**
     * Get 个性化参数，用于控制页面展示内容 
     * @return Option 个性化参数，用于控制页面展示内容
     */
    public EmbedUrlOption getOption() {
        return this.Option;
    }

    /**
     * Set 个性化参数，用于控制页面展示内容
     * @param Option 个性化参数，用于控制页面展示内容
     */
    public void setOption(EmbedUrlOption Option) {
        this.Option = Option;
    }

    /**
     * Get  目前仅支持EmbedType=CREATE_TEMPLATE时传入
 指定后，创建，编辑，删除模板时，回调都会携带该userData
 支持的格式：json字符串的BASE64编码字符串
 示例：                  json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
                  eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
 
 
  
     * @return UserData  目前仅支持EmbedType=CREATE_TEMPLATE时传入
 指定后，创建，编辑，删除模板时，回调都会携带该userData
 支持的格式：json字符串的BASE64编码字符串
 示例：                  json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
                  eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
 
 
 
     */
    public String getUserData() {
        return this.UserData;
    }

    /**
     * Set  目前仅支持EmbedType=CREATE_TEMPLATE时传入
 指定后，创建，编辑，删除模板时，回调都会携带该userData
 支持的格式：json字符串的BASE64编码字符串
 示例：                  json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
                  eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
 
 
 
     * @param UserData  目前仅支持EmbedType=CREATE_TEMPLATE时传入
 指定后，创建，编辑，删除模板时，回调都会携带该userData
 支持的格式：json字符串的BASE64编码字符串
 示例：                  json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9
                  eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式
 
 
 
     */
    public void setUserData(String UserData) {
        this.UserData = UserData;
    }

    public CreateEmbedWebUrlRequest() {
    }

    /**
     * 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 CreateEmbedWebUrlRequest(CreateEmbedWebUrlRequest source) {
        if (source.Operator != null) {
            this.Operator = new UserInfo(source.Operator);
        }
        if (source.EmbedType != null) {
            this.EmbedType = new String(source.EmbedType);
        }
        if (source.BusinessId != null) {
            this.BusinessId = new String(source.BusinessId);
        }
        if (source.Agent != null) {
            this.Agent = new Agent(source.Agent);
        }
        if (source.Reviewer != null) {
            this.Reviewer = new ReviewerInfo(source.Reviewer);
        }
        if (source.Option != null) {
            this.Option = new EmbedUrlOption(source.Option);
        }
        if (source.UserData != null) {
            this.UserData = new String(source.UserData);
        }
    }


    /**
     * 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 + "EmbedType", this.EmbedType);
        this.setParamSimple(map, prefix + "BusinessId", this.BusinessId);
        this.setParamObj(map, prefix + "Agent.", this.Agent);
        this.setParamObj(map, prefix + "Reviewer.", this.Reviewer);
        this.setParamObj(map, prefix + "Option.", this.Option);
        this.setParamSimple(map, prefix + "UserData", this.UserData);

    }
}