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, options: nil, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, with_regions: nil, mail_merge_data_file: nil, cleanup: nil, use_whole_paragraph_as_region: nil, merge_whole_document: 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.

  • options (defaults to: nil) —

    Field options.

  • 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 of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.

  • encrypted_password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

  • open_type_support (defaults to: nil) —

    The value indicates whether OpenType support is on.

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

  • merge_whole_document (defaults to: nil) —

    The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 95

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

Instance Attribute Details

#cleanup ⇒ Object

The cleanup options.



66
67
68
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 66

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.



75
76
77
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 75

def dest_file_name
  @dest_file_name
end

#encrypted_password ⇒ Object

Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.



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

def encrypted_password
  @encrypted_password
end

#folder ⇒ Object

Original document folder.



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

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.



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

def load_encoding
  @load_encoding
end

#mail_merge_data_file ⇒ Object

The data file.



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

def mail_merge_data_file
  @mail_merge_data_file
end

#merge_whole_document ⇒ Object

The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.



72
73
74
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 72

def merge_whole_document
  @merge_whole_document
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

#open_type_support ⇒ Object

The value indicates whether OpenType support is on.



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

def open_type_support
  @open_type_support
end

#options ⇒ Object

Field options.



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

def options
  @options
end

#password ⇒ Object

Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.



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

def password
  @password
end

#storage ⇒ Object

Original document storage.



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

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.



69
70
71
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 69

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.



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

def with_regions
  @with_regions
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 186

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?
  self.options&.validate
  # 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('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
  query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.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 = []
  files_content = []
  unless self.data.nil?
    form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'})
  end

  unless self.options.nil?
    form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
  end

  body = api_client.build_request_body(header_params, form_params, files_content)
  {
    '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



240
241
242
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 240

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

#get_response_type ⇒ Object

Get response type



245
246
247
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 245

def get_response_type
  'DocumentResponse'
end

#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


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
150
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
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 114

def to_batch_part(api_client, requestId, parentRequestId = nil)
  # 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?
  self.options&.validate
  # 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('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
  query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.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('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.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'])
  header_params['RequestId'] = requestId

  if parentRequestId != nil
    header_params['DependsOn'] = parentRequestId
  end

  # form parameters
  form_params = []
  files_content = []
  unless self.data.nil?
    form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'})
  end

  unless self.options.nil?
    form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
  end


  # http body (model)
  body = api_client.build_request_body_batch(header_params, form_params, files_content)
  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