class AsposeWordsCloud::ExecuteMailMergeRequest
Request model for execute_mail_merge operation.
Attributes
The cleanup options.
Mail merge data.
The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
Original document folder.
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
The data file.
The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.
The filename of the input document.
The value indicates whether OpenType support is on.
Field
options.
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.
Original document storage.
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.
The flag indicating whether to execute Mail Merge operation with regions.
Public Class Methods
Source
# 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
Initializes a new instance. @param name The filename of the input document. @param data Mail merge data. @param options Field
options. @param folder Original document folder. @param storage Original document storage. @param load_encoding
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. @param password 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. @param encrypted_password
Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. @param open_type_support
The value indicates whether OpenType support is on. @param with_regions
The flag indicating whether to execute Mail Merge operation with regions. @param mail_merge_data_file
The data file. @param cleanup The cleanup options. @param use_whole_paragraph_as_region
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. @param merge_whole_document
The flag indicating whether fields in whole document are updated while executing of a mail merge with regions. @param dest_file_name
The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
Public Instance Methods
Source
# 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
Source
# 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
Helper method to convert first letter to downcase
Source
# File lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb, line 245 def get_response_type 'DocumentResponse' end
Get response type
Source
# 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
Creating batch part from request