Class: AsposeWordsCloud::ExecuteMailMergeOnlineRequest

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

Overview

Request model for execute_mail_merge_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template:, data:, options: nil, with_regions: nil, merge_whole_document: nil, cleanup: nil, document_file_name: nil) ⇒ ExecuteMailMergeOnlineRequest

Initializes a new instance.

Parameters:

  • template —

    File with template.

  • data —

    File with mailmerge data.

  • options (defaults to: nil) —

    Field options.

  • with_regions (defaults to: nil) —

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

  • merge_whole_document (defaults to: nil) —

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

  • cleanup (defaults to: nil) —

    The cleanup options.

  • document_file_name (defaults to: nil) —

    The filename of the output document, that will be used when the resulting document has a dynamic field filename. If it is not set, the “template” will be used instead.



63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 63

def initialize(template:, data:, options: nil, with_regions: nil, merge_whole_document: nil, cleanup: nil, document_file_name: nil)
  self.template = template
  self.data = data
  self.options = options
  self.with_regions = with_regions
  self.merge_whole_document = merge_whole_document
  self.cleanup = cleanup
  self.document_file_name = document_file_name
end

Instance Attribute Details

#cleanup ⇒ Object

The cleanup options.



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

def cleanup
  @cleanup
end

#data ⇒ Object

File with mailmerge data.



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

def data
  @data
end

#document_file_name ⇒ Object

The filename of the output document, that will be used when the resulting document has a dynamic field filename. If it is not set, the “template” will be used instead.



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

def document_file_name
  @document_file_name
end

#merge_whole_document ⇒ Object

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



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

def merge_whole_document
  @merge_whole_document
end

#options ⇒ Object

Field options.



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

def options
  @options
end

#template ⇒ Object

File with template.



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

def template
  @template
end

#with_regions ⇒ Object

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



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

def with_regions
  @with_regions
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 149

def create_http_request(api_client)
  # verify the required parameter 'template' is set
  raise ArgumentError, 'Missing the required parameter template when calling WordsApi.execute_mail_merge_online' if api_client.config.client_side_validation && self.template.nil?
  # verify the required parameter 'data' is set
  raise ArgumentError, 'Missing the required parameter data when calling WordsApi.execute_mail_merge_online' if api_client.config.client_side_validation && self.data.nil?
  self.options&.validate
  # resource path
  local_var_path = '/words/MailMerge'[1..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
  query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
  query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
  query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_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 = []
  if self.template.nil?
    raise "Parameter Template is required."
  end
  unless self.template.nil?
    form_params.push({:'Name' => 'template', :'Data' => self.template, :'MimeType' =>'application/octet-stream'})
  end

  if self.data.nil?
    raise "Parameter Data is required."
  end
  unless self.data.nil?
    form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'application/octet-stream'})
  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



206
207
208
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 206

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

#get_response_type ⇒ Object

Get response type



211
212
213
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 211

def get_response_type
  'File'
end

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

Creating batch part from request

Raises:

  • (ArgumentError) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 74

def to_batch_part(api_client, requestId, parentRequestId = nil)
  # verify the required parameter 'template' is set
  raise ArgumentError, 'Missing the required parameter template when calling WordsApi.execute_mail_merge_online' if api_client.config.client_side_validation && self.template.nil?
  # verify the required parameter 'data' is set
  raise ArgumentError, 'Missing the required parameter data when calling WordsApi.execute_mail_merge_online' if api_client.config.client_side_validation && self.data.nil?
  self.options&.validate
  # resource path
  local_var_path = '/words/MailMerge'[7..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
  query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
  query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
  query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_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 = []
  if self.template.nil?
    raise "Parameter Template is required."
  end
  unless self.template.nil?
    form_params.push({:'Name' => 'template', :'Data' => self.template, :'MimeType' =>'application/octet-stream'})
  end

  if self.data.nil?
    raise "Parameter Data is required."
  end
  unless self.data.nil?
    form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'application/octet-stream'})
  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