Class: AsposeWordsCloud::ConvertDocumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/convert_document_request.rb

Overview

Request model for convert_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document:, format:, out_path: nil, file_name_field_value: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, fonts_location: nil) ⇒ ConvertDocumentRequest

Initializes a new instance.

Parameters:

  • document —

    Converting document.

  • format —

    The format to convert.

  • out_path (defaults to: nil) —

    The path to the output document on a local storage.

  • file_name_field_value (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 “sourceFilename” will be used instead.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    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.

  • encrypted_password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 71

def initialize(document:, format:, out_path: nil, file_name_field_value: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: 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.load_encoding = load_encoding
  self.password = password
  self.encrypted_password = encrypted_password
  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

#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/convert_document_request.rb', line 54

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



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 57

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

#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/convert_document_request.rb', line 48

def load_encoding
  @load_encoding
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

#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/convert_document_request.rb', line 51

def password
  @password
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

Raises:

  • (ArgumentError) 


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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 152

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('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('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 = []
  files_content = []
  if self.document.nil?
    raise "Parameter Document is required."
  end
  unless self.document.nil?
    form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
  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



202
203
204
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 202

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

#get_response_type ⇒ Object

Get response type



207
208
209
 
# File 'lib/aspose_words_cloud/models/requests/convert_document_request.rb', line 207

def get_response_type
  'File'
end

#to_batch_part(api_client, requestId, parentRequestId = nil) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


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

def to_batch_part(api_client, requestId, parentRequestId = nil)
  # 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('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('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'])
  header_params['RequestId'] = requestId

  if parentRequestId != nil
    header_params['DependsOn'] = parentRequestId
  end

  # form parameters
  form_params = []
  files_content = []
  if self.document.nil?
    raise "Parameter Document is required."
  end
  unless self.document.nil?
    form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
  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