Class: AsposeWordsCloud::BuildReportRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::BuildReportRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/build_report_request.rb
Overview
Request model for build_report operation.
Instance Attribute Summary collapse
-
#data ⇒ Object
A string providing a data to populate the specified template.
-
#dest_file_name ⇒ Object
The filename of the output document.
-
#encrypted_password ⇒ Object
Password of protected Word document.
-
#folder ⇒ Object
Original document folder.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The filename of the input document.
-
#password ⇒ Object
Password of protected Word document.
-
#report_engine_settings ⇒ Object
An object providing a settings of report engine.
-
#storage ⇒ Object
Original document storage.
Instance Method Summary collapse
- #create_http_request(api_client) ⇒ Object
-
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase.
-
#get_response_type ⇒ Object
Get response type.
-
#initialize(name:, data:, report_engine_settings:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil) ⇒ BuildReportRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(name:, data:, report_engine_settings:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil) ⇒ BuildReportRequest
Initializes a new instance.
71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 71 def initialize(name:, data:, report_engine_settings:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, dest_file_name: nil) self.name = name self.data = data self.report_engine_settings = report_engine_settings self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.encrypted_password = encrypted_password self.dest_file_name = dest_file_name end |
Instance Attribute Details
#data ⇒ Object
A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/build_report_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.
57 58 59 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 57 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/build_report_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/build_report_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/build_report_request.rb', line 48 def load_encoding @load_encoding end |
#name ⇒ Object
The filename of the input document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 33 def name @name 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/build_report_request.rb', line 51 def password @password end |
#report_engine_settings ⇒ Object
An object providing a settings of report engine.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 39 def report_engine_settings @report_engine_settings end |
#storage ⇒ Object
Original document storage.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 45 def storage @storage end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
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 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 160 def create_http_request(api_client) # verify the required parameter 'name' is set raise ArgumentError, 'Missing the required parameter name when calling WordsApi.build_report' if api_client.config.client_side_validation && self.name.nil? # verify the required parameter 'data' is set raise ArgumentError, 'Missing the required parameter data when calling WordsApi.build_report' if api_client.config.client_side_validation && self.data.nil? # verify the required parameter 'report_engine_settings' is set raise ArgumentError, 'Missing the required parameter report_engine_settings when calling WordsApi.build_report' if api_client.config.client_side_validation && self.report_engine_settings.nil? self.report_engine_settings.validate # resource path local_var_path = '/words/{name}/buildReport'[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('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 = [] if self.data.nil? raise "Parameter Data is required." end unless self.data.nil? form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'}) end if self.report_engine_settings.nil? raise "Parameter ReportEngineSettings is required." end unless self.report_engine_settings.nil? form_params.push({:'Name' => 'reportEngineSettings', :'Data' => self.report_engine_settings.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
218 219 220 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 218 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
223 224 225 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 223 def get_response_type 'DocumentResponse' end |
#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object
Creating batch part from request
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 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/aspose_words_cloud/models/requests/build_report_request.rb', line 84 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.build_report' if api_client.config.client_side_validation && self.name.nil? # verify the required parameter 'data' is set raise ArgumentError, 'Missing the required parameter data when calling WordsApi.build_report' if api_client.config.client_side_validation && self.data.nil? # verify the required parameter 'report_engine_settings' is set raise ArgumentError, 'Missing the required parameter report_engine_settings when calling WordsApi.build_report' if api_client.config.client_side_validation && self.report_engine_settings.nil? self.report_engine_settings.validate # resource path local_var_path = '/words/{name}/buildReport'[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('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 = [] if self.data.nil? raise "Parameter Data is required." end unless self.data.nil? form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'}) end if self.report_engine_settings.nil? raise "Parameter ReportEngineSettings is required." end unless self.report_engine_settings.nil? form_params.push({:'Name' => 'reportEngineSettings', :'Data' => self.report_engine_settings.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 |