Class: TencentCloud::Ess::V20201111::CreateDocumentRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20201111/models.rb

Overview

CreateDocument请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, templateid = nil, flowid = nil, filenames = nil, formfields = nil, needpreview = nil, previewtype = nil, agent = nil, clienttoken = nil) ⇒ CreateDocumentRequest

Returns a new instance of CreateDocumentRequest.



3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
 
# File 'lib/v20201111/models.rb', line 3255

def initialize(operator=nil, templateid=nil, flowid=nil, filenames=nil, formfields=nil, needpreview=nil, previewtype=nil, agent=nil, clienttoken=nil)
  @Operator = operator
  @TemplateId = templateid
  @FlowId = flowid
  @FileNames = filenames
  @FormFields = formfields
  @NeedPreview = needpreview
  @PreviewType = previewtype
  @Agent = agent
  @ClientToken = clienttoken
end

Instance Attribute Details

#Agent ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def Agent
  @Agent
end

#ClientToken ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def ClientToken
  @ClientToken
end

#FileNames ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def FileNames
  @FileNames
end

#FlowId ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def FlowId
  @FlowId
end

#FormFields ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def FormFields
  @FormFields
end

#NeedPreview ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def NeedPreview
  @NeedPreview
end

#Operator ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def Operator
  @Operator
end

#PreviewType ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def PreviewType
  @PreviewType
end

#TemplateId ⇒ Object

点击查看模板Id在控制台上的位置 此接口的合同流程ID需要由创建签署流程接口创建得到。

  • 支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成
  • 附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。
注：只有在控制台编辑模板时，归属给发起方的填写控件（如下图）才能在创建文档的时候进行内容填充。 ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png) 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

Parameters:

  • FlowId: —

    合同流程ID，为32位字符串。

  • FileNames: —

    文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。

  • FormFields: —

    电子文档的填写控件的填充内容。具体方式可以参考FormField结构体的定义。

  • NeedPreview: —

    是否为预览模式，取值如下：

    • false：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。
    • true：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 注意： 1.以预览模式创建的合同仅供查看，因此参与方无法进行签署操作;；2.以预览模式调用该接口返回的FlowId为临时Flowld，无法用于发起和拉取信息。
    注: 当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知

  • PreviewType: —

    预览模式下产生的预览链接类型

    • 0 :(默认) 文件流 ,点开后下载预览的合同PDF文件
    • 1 :H5链接 ,点开后在浏览器中展示合同的样子。
    注: 1.此参数在NeedPreview 为true时有效

  • Agent: —

    代理企业和员工的信息。

  • ClientToken: —

    该字段已不再使用



3253
3254
3255
 
# File 'lib/v20201111/models.rb', line 3253

def TemplateId
  @TemplateId
end

Instance Method Details

#deserialize(params) ⇒ Object 



3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
 
# File 'lib/v20201111/models.rb', line 3267

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  @TemplateId = params['TemplateId']
  @FlowId = params['FlowId']
  @FileNames = params['FileNames']
  unless params['FormFields'].nil?
    @FormFields = []
    params['FormFields'].each do |i|
      formfield_tmp = FormField.new
      formfield_tmp.deserialize(i)
      @FormFields << formfield_tmp
    end
  end
  @NeedPreview = params['NeedPreview']
  @PreviewType = params['PreviewType']
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  @ClientToken = params['ClientToken']
end