Class: WordsRubySdk::PutExecuteTemplateOnlineRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb

Overview

Request model for put_execute_template_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template, data, cleanup = nil, use_whole_paragraph_as_region = nil, with_regions = nil, document_file_name = nil) ⇒ PutExecuteTemplateOnlineRequest

Initializes a new instance.

Parameters:

  • template —

    File with template

  • data —

    File with mailmerge data

  • cleanup (defaults to: nil) —

    Clean up options.

  • use_whole_paragraph_as_region (defaults to: nil) —

    Gets or sets a value indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.

  • with_regions (defaults to: nil) —

    Merge with regions or not. True by default

  • document_file_name (defaults to: nil) —

    This file name will be used when resulting document has dynamic field for document file name filename. If it is not setted, "template" will be used instead. Note: if withRegions == true executeTemplate updates fields only inside regions



56
57
58
59
60
61
62
63
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 56

def initialize(template, data, cleanup = nil, use_whole_paragraph_as_region = nil, with_regions = nil, document_file_name = nil)
   self.template = template
   self.data = data
   self.cleanup = cleanup
   self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
   self.with_regions = with_regions
   self.document_file_name = document_file_name
end

Instance Attribute Details

#cleanup ⇒ Object

Clean up options.



40
41
42
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 40

def cleanup
  @cleanup
end

#data ⇒ Object

File with mailmerge data



38
39
40
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 38

def data
  @data
end

#document_file_name ⇒ Object

This file name will be used when resulting document has dynamic field for document file name filename. If it is not setted, "template" will be used instead. Note: if withRegions == true executeTemplate updates fields only inside regions



46
47
48
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 46

def document_file_name
  @document_file_name
end

#template ⇒ Object

File with template



36
37
38
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 36

def template
  @template
end

#use_whole_paragraph_as_region ⇒ Object

Gets or sets a value indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.



42
43
44
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 42

def use_whole_paragraph_as_region
  @use_whole_paragraph_as_region
end

#with_regions ⇒ Object

Merge with regions or not. True by default



44
45
46
 
# File 'lib/words_ruby_sdk/models/requests/PutExecuteTemplateOnlineRequest.rb', line 44

def with_regions
  @with_regions
end