Class: AsposeWordsCloud::BuildReportOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::BuildReportOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/build_report_online_request.rb
Overview
Request model for build_report_online operation.
Instance Attribute Summary collapse
-
#data ⇒ Object
A string providing a data to populate the specified template.
-
#document_file_name ⇒ Object
The filename of the output document, that will be used when the resulting document has a dynamic field filename.
-
#report_engine_settings ⇒ Object
An object providing a settings of report engine.
-
#template ⇒ Object
File with template.
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(template, data, report_engine_settings, document_file_name = nil) ⇒ BuildReportOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(template, data, report_engine_settings, document_file_name = nil) ⇒ BuildReportOnlineRequest
Initializes a new instance.
51 52 53 54 55 56 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 51 def initialize(template, data, report_engine_settings, document_file_name = nil) self.template = template self.data = data self.report_engine_settings = report_engine_settings self.document_file_name = document_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_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.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 42 def document_file_name @document_file_name 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_online_request.rb', line 39 def report_engine_settings @report_engine_settings end |
#template ⇒ Object
File with template.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 33 def template @template end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
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 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 113 def create_http_request(api_client) # verify the required parameter 'template' is set raise ArgumentError, 'Missing the required parameter template when calling WordsApi.build_report_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.build_report_online' 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_online' if api_client.config.client_side_validation && self.report_engine_settings.nil? # resource path local_var_path = '/words/buildReport'[1..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} 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 form_params[downcase_first_letter('ReportEngineSettings')] = self.report_engine_settings.to_body.to_json # 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
156 157 158 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 156 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
161 162 163 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 161 def get_response_type 'File' end |
#to_batch_part(api_client) ⇒ Object
Creating batch part from request
59 60 61 62 63 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 |
# File 'lib/aspose_words_cloud/models/requests/build_report_online_request.rb', line 59 def to_batch_part(api_client) # verify the required parameter 'template' is set raise ArgumentError, 'Missing the required parameter template when calling WordsApi.build_report_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.build_report_online' 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_online' if api_client.config.client_side_validation && self.report_engine_settings.nil? # resource path local_var_path = '/words/buildReport'[7..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} 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 form_params[downcase_first_letter('ReportEngineSettings')] = self.report_engine_settings.to_body.to_json # 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 |