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:, with_regions: nil, cleanup: nil, document_file_name: nil) ⇒ ExecuteMailMergeOnlineRequest

Initializes a new instance.

Parameters:

  • template —

    File with template.

  • data —

    File with mailmerge data.

  • with_regions (defaults to: nil) —

    The flag indicating whether to execute Mail Merge operation 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.



55
56
57
58
59
60
61
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 55

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

Instance Attribute Details

#cleanup ⇒ Object

The cleanup options.



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

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.



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

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



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

def with_regions
  @with_regions
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


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

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?

  # 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('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 = {}
  form_params[downcase_first_letter('Template')] = self.template
  form_params[downcase_first_letter('Data')] = self.data

  # 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



159
160
161
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 159

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

#get_response_type ⇒ Object

Get response type



164
165
166
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 164

def get_response_type
  'File'
end

#to_batch_part(api_client) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb', line 64

def to_batch_part(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?

  # 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('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'])

  # form parameters
  form_params = {}
  form_params[downcase_first_letter('Template')] = self.template
  form_params[downcase_first_letter('Data')] = self.data

  # 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