Class: AsposeWordsCloud::SplitDocumentOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::SplitDocumentOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/split_document_online_request.rb
Overview
Request model for split_document_online operation.
Instance Attribute Summary collapse
-
#dest_file_name ⇒ Object
Result path of the document after the operation.
-
#document ⇒ Object
The document.
-
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
-
#format ⇒ Object
The format to split.
-
#from ⇒ Object
The start page.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#to ⇒ Object
The end page.
-
#zip_output ⇒ Object
The flag indicating whether to ZIP the output.
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:, load_encoding: nil, password: nil, dest_file_name: nil, from: nil, to: nil, zip_output: nil, fonts_location: nil) ⇒ SplitDocumentOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document:, format:, load_encoding: nil, password: nil, dest_file_name: nil, from: nil, to: nil, zip_output: nil, fonts_location: nil) ⇒ SplitDocumentOnlineRequest
Initializes a new instance.
71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 71 def initialize(document:, format:, load_encoding: nil, password: nil, dest_file_name: nil, from: nil, to: nil, zip_output: nil, fonts_location: nil) self.document = document self.format = format self.load_encoding = load_encoding self.password = password self.dest_file_name = dest_file_name self.from = from self.to = to self.zip_output = zip_output self.fonts_location = fonts_location end |
Instance Attribute Details
#dest_file_name ⇒ Object
Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 45 def dest_file_name @dest_file_name end |
#document ⇒ Object
The document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 33 def document @document end |
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
57 58 59 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 57 def fonts_location @fonts_location end |
#format ⇒ Object
The format to split.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 36 def format @format end |
#from ⇒ Object
The start page.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 48 def from @from end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 39 def load_encoding @load_encoding end |
#password ⇒ Object
Password for opening an encrypted document.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 42 def password @password end |
#to ⇒ Object
The end page.
51 52 53 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 51 def to @to end |
#zip_output ⇒ Object
The flag indicating whether to ZIP the output.
54 55 56 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 54 def zip_output @zip_output end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
141 142 143 144 145 146 147 148 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 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 141 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.split_document_online' 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.split_document_online' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/online/put/split'[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('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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('From')] = self.from unless self.from.nil? query_params[downcase_first_letter('To')] = self.to unless self.to.nil? query_params[downcase_first_letter('ZipOutput')] = self.zip_output unless self.zip_output.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
187 188 189 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 187 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
192 193 194 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 192 def get_response_type 'SplitDocumentOnlineResponse' end |
#to_batch_part(api_client) ⇒ 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 |
# File 'lib/aspose_words_cloud/models/requests/split_document_online_request.rb', line 84 def to_batch_part(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.split_document_online' 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.split_document_online' if api_client.config.client_side_validation && self.format.nil? # resource path local_var_path = '/words/online/put/split'[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('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('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil? query_params[downcase_first_letter('From')] = self.from unless self.from.nil? query_params[downcase_first_letter('To')] = self.to unless self.to.nil? query_params[downcase_first_letter('ZipOutput')] = self.zip_output unless self.zip_output.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 |