Class: AsposeWordsCloud::ExecuteMailMergeRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb

Overview

Request model for execute_mail_merge operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, data: nil, folder: nil, storage: nil, load_encoding: nil, password: nil, with_regions: nil, mail_merge_data_file: nil, cleanup: nil, use_whole_paragraph_as_region: nil, dest_file_name: nil) ⇒ ExecuteMailMergeRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • data (defaults to: nil) —

    Mail merge data.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • 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.

  • with_regions (defaults to: nil) —

    The flag indicating whether to execute Mail Merge operation with regions.

  • mail_merge_data_file (defaults to: nil) —

    The data file.

  • cleanup (defaults to: nil) —

    The cleanup options.

  • use_whole_paragraph_as_region (defaults to: nil) —

    The flag 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.

  • dest_file_name (defaults to: nil) —

    The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 79

def initialize(name:, data: nil, folder: nil, storage: nil, load_encoding: nil, password: nil, with_regions: nil, mail_merge_data_file: nil, cleanup: nil, use_whole_paragraph_as_region: 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.with_regions = with_regions
  self.mail_merge_data_file = mail_merge_data_file
  self.cleanup = cleanup
  self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
  self.dest_file_name = dest_file_name
end

Instance Attribute Details

#cleanup ⇒ Object

The cleanup options.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 57

def cleanup
  @cleanup
end

#data ⇒ Object

Mail merge data.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 36

def data
  @data
end

#dest_file_name ⇒ Object

The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.



63
64
65
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 63

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 39

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.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 45

def load_encoding
  @load_encoding
end

#mail_merge_data_file ⇒ Object

The data file.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 54

def mail_merge_data_file
  @mail_merge_data_file
end

#name ⇒ Object

The filename of the input document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 33

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 48

def password
  @password
end

#storage ⇒ Object

Original document storage.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 42

def storage
  @storage
end

#use_whole_paragraph_as_region ⇒ Object

The flag 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.



60
61
62
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 60

def use_whole_paragraph_as_region
  @use_whole_paragraph_as_region
end

#with_regions ⇒ Object

The flag indicating whether to execute Mail Merge operation with regions.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 51

def with_regions
  @with_regions
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 151

def create_http_request(api_client)
  # verify the required parameter 'name' is set
  raise ArgumentError, 'Missing the required parameter name when calling WordsApi.execute_mail_merge' if api_client.config.client_side_validation && self.name.nil?

  # resource path
  local_var_path = '/words/{name}/MailMerge'[1..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
  query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
  query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
  query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
  query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
  query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
  query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
  query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
  query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params[downcase_first_letter('Data')] = self.data unless self.data.nil?

  # http body (model)
  post_body = nil
  body = api_client.build_request_body(header_params, form_params, post_body)
  {
    'method': :PUT,
    'path': local_var_path,
    'header_params': header_params,
    'query_params': query_params,
    'body': body,
    'auth_names': ['JWT']
  }
end

#downcase_first_letter(str) ⇒ Object

Helper method to convert first letter to downcase



197
198
199
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 197

def downcase_first_letter(str)
  str[0].downcase + str[1..-1]
end

#get_response_type ⇒ Object

Get response type



202
203
204
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 202

def get_response_type
  'DocumentResponse'
end

#to_batch_part(api_client) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 94

def to_batch_part(api_client)
  # verify the required parameter 'name' is set
  raise ArgumentError, 'Missing the required parameter name when calling WordsApi.execute_mail_merge' if api_client.config.client_side_validation && self.name.nil?

  # resource path
  local_var_path = '/words/{name}/MailMerge'[7..-1]
  local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
  query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
  query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
  query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
  query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
  query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
  query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
  query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
  query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?

  if query_params
    query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
  end

  header_params = {}
  # header parameters
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params[downcase_first_letter('Data')] = self.data unless self.data.nil?

  # http body (model)
  post_body = nil
  body = api_client.build_request_body_batch(header_params, form_params, post_body)
  part = ""
  part.concat("PUT".force_encoding('UTF-8'))
  part.concat(" ".force_encoding('UTF-8'))
  part.concat(local_var_path.force_encoding('UTF-8'))
  part.concat(" \r\n".force_encoding('UTF-8'))

  header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
  part.concat("\r\n".force_encoding('UTF-8'))
  if body
    if body.is_a?(Hash)
      body.each do |key, value|
      part.concat(value, "\r\n")
    end
    else
      part.concat(body)
    end
  end
 part
end