Class: WordsRubySdk::PostExecuteTemplateRequest

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

Overview

Request model for post_execute_template operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, data, folder = nil, storage = nil, load_encoding = nil, password = nil, cleanup = nil, use_whole_paragraph_as_region = nil, with_regions = nil, dest_file_name = nil) ⇒ PostExecuteTemplateRequest

Initializes a new instance.

Parameters:

  • name —

    The template document name.

  • data —

    Mail merge data

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    File storage, which have to be used.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • 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

  • dest_file_name (defaults to: nil) —

    Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb', line 68

def initialize(name, data, folder = nil, storage = nil, load_encoding = nil, password = nil, cleanup = nil, use_whole_paragraph_as_region = nil, with_regions = nil, dest_file_name = nil)
   self.name = name
   self.data = data
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.cleanup = cleanup
   self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
   self.with_regions = with_regions
   self.dest_file_name = dest_file_name
end

Instance Attribute Details

#cleanup ⇒ Object

Clean up options.



48
49
50
 
# File 'lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb', line 48

def cleanup
  @cleanup
end

#data ⇒ Object

Mail merge data



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

def data
  @data
end

#dest_file_name ⇒ Object

Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.



54
55
56
 
# File 'lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb', line 54

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The template document name.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#storage ⇒ Object

File storage, which have to be used.



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

def storage
  @storage
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.



50
51
52
 
# File 'lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb', line 50

def use_whole_paragraph_as_region
  @use_whole_paragraph_as_region
end

#with_regions ⇒ Object

Merge with regions or not. True by default



52
53
54
 
# File 'lib/words_ruby_sdk/models/requests/PostExecuteTemplateRequest.rb', line 52

def with_regions
  @with_regions
end