Class: AsposeWordsCloud::ConvertDocumentRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::ConvertDocumentRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/convert_document_request.rb
Overview
Request model for convert_document operation.
Instance Attribute Summary collapse
-
#document ⇒ Object
Converting document.
-
#file_name_field_value ⇒ Object
The filename of the output document, that will be used when the resulting document has a dynamic field filename.
-
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
-
#format ⇒ Object
The format to convert.
-
#out_path ⇒ Object
The path to the output document on a local storage.
-
#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(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil) ⇒ ConvertDocumentRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil) ⇒ ConvertDocumentRequest
Initializes a new instance.
59 60 61 62 63 64 65 66 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 59 def initialize(document, format, out_path = nil, file_name_field_value = nil, storage = nil, fonts_location = nil) self.document = document self.format = format self.out_path = out_path self.file_name_field_value = file_name_field_value self.storage = storage self.fonts_location = fonts_location end |
Instance Attribute Details
#document ⇒ Object
Converting document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 33 def document @document end |
#file_name_field_value ⇒ 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 “sourceFilename” will be used instead.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 42 def file_name_field_value @file_name_field_value end |
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 48 def fonts_location @fonts_location end |
#format ⇒ Object
The format to convert.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 36 def format @format end |
#out_path ⇒ Object
The path to the output document on a local storage.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 39 def out_path @out_path end |
#storage ⇒ Object
Original document storage.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 45 def storage @storage end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
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 159 160 161 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 123 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'format' is set raise ArgumentError, 'Missing the required parameter format when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/convert'[1..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Format')] = self.format query_params[downcase_first_letter('OutPath')] = self.out_path unless self.out_path.nil? query_params[downcase_first_letter('FileNameFieldValue')] = self.file_name_field_value unless self.file_name_field_value.nil? query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil? query_params[downcase_first_letter('FontsLocation')] = self.fonts_location unless self.fonts_location.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('Document')] = self.document # 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
166 167 168 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 166 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
171 172 173 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 171 def get_response_type 'File' end |
#to_batch_part(api_client) ⇒ Object
Creating batch part from request
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 116 117 118 119 120 121 |
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 69 def to_batch_part(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.document.nil? # verify the required parameter 'format' is set raise ArgumentError, 'Missing the required parameter format when calling WordsApi.convert_document' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/convert'[7..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('Format')] = self.format query_params[downcase_first_letter('OutPath')] = self.out_path unless self.out_path.nil? query_params[downcase_first_letter('FileNameFieldValue')] = self.file_name_field_value unless self.file_name_field_value.nil? query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil? query_params[downcase_first_letter('FontsLocation')] = self.fonts_location unless self.fonts_location.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('Document')] = self.document # 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 |