Class: CloudmersiveConvertApiClient::ZipArchiveApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/api/zip_archive_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ZipArchiveApi

Returns a new instance of ZipArchiveApi.



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#zip_archive_zip_create(input_file1, opts = {}) ⇒ String

Compress files to create a new zip archive Create a new zip archive by compressing input files.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file2 (File) —

    Second input file to perform the operation on.

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


36
37
38
39
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 36

def zip_archive_zip_create(input_file1, opts = {})
  data, _status_code, _headers = zip_archive_zip_create_with_http_info(input_file1, opts)
  data
end

#zip_archive_zip_create_advanced(request, opts = {}) ⇒ Object

Compress files and folders to create a new zip archive with advanced options Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.

Parameters:

  • request —

    Input request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


109
110
111
112
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 109

def zip_archive_zip_create_advanced(request, opts = {})
  data, _status_code, _headers = zip_archive_zip_create_advanced_with_http_info(request, opts)
  data
end

#zip_archive_zip_create_advanced_with_http_info(request, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Compress files and folders to create a new zip archive with advanced options Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.

Parameters:

  • request —

    Input request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 119

def zip_archive_zip_create_advanced_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_create_advanced ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling ZipArchiveApi.zip_archive_zip_create_advanced"
  end
  # resource path
  local_var_path = '/convert/archive/zip/create/advanced'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_create_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_create_encrypted(password, input_file1, opts = {}) ⇒ String

Compress files to create a new, encrypted and password-protected zip archive Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.

Parameters:

  • password —

    Password to place on the Zip file; the longer the password, the more secure

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :encryption_algorithm (String) —

    Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.

  • :input_file2 (File) —

    Second input file to perform the operation on.

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (String) 


174
175
176
177
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 174

def zip_archive_zip_create_encrypted(password, input_file1, opts = {})
  data, _status_code, _headers = zip_archive_zip_create_encrypted_with_http_info(password, input_file1, opts)
  data
end

#zip_archive_zip_create_encrypted_with_http_info(password, input_file1, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Compress files to create a new, encrypted and password-protected zip archive Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip.

Parameters:

  • password —

    Password to place on the Zip file; the longer the password, the more secure

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :encryption_algorithm (String) —

    Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.

  • :input_file2 (File) —

    Second input file to perform the operation on.

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 195

def zip_archive_zip_create_encrypted_with_http_info(password, input_file1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_create_encrypted ...'
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling ZipArchiveApi.zip_archive_zip_create_encrypted"
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling ZipArchiveApi.zip_archive_zip_create_encrypted"
  end
  # resource path
  local_var_path = '/convert/archive/zip/create/encrypted'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'password'] = password
  header_params[:'encryptionAlgorithm'] = opts[:'encryption_algorithm'] if !opts[:'encryption_algorithm'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = opts[:'input_file2'] if !opts[:'input_file2'].nil?
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_create_encrypted\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_create_quarantine(password, input_file1, opts = {}) ⇒ Object

Create an encrypted zip file to quarantine a dangerous file Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.

Parameters:

  • password —

    Password to place on the Zip file; the longer the password, the more secure

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :encryption_algorithm (String) —

    Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.

Returns:

  • (Object) 


257
258
259
260
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 257

def zip_archive_zip_create_quarantine(password, input_file1, opts = {})
  data, _status_code, _headers = zip_archive_zip_create_quarantine_with_http_info(password, input_file1, opts)
  data
end

#zip_archive_zip_create_quarantine_with_http_info(password, input_file1, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Create an encrypted zip file to quarantine a dangerous file Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.

Parameters:

  • password —

    Password to place on the Zip file; the longer the password, the more secure

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :encryption_algorithm (String) —

    Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 269

def zip_archive_zip_create_quarantine_with_http_info(password, input_file1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_create_quarantine ...'
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling ZipArchiveApi.zip_archive_zip_create_quarantine"
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling ZipArchiveApi.zip_archive_zip_create_quarantine"
  end
  # resource path
  local_var_path = '/convert/archive/zip/create/quarantine'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'password'] = password
  header_params[:'encryptionAlgorithm'] = opts[:'encryption_algorithm'] if !opts[:'encryption_algorithm'].nil?

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_create_quarantine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_create_with_http_info(input_file1, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Compress files to create a new zip archive Create a new zip archive by compressing input files.

Parameters:

  • input_file1 —

    First input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :input_file2 (File) —

    Second input file to perform the operation on.

  • :input_file3 (File) —

    Third input file to perform the operation on.

  • :input_file4 (File) —

    Fourth input file to perform the operation on.

  • :input_file5 (File) —

    Fifth input file to perform the operation on.

  • :input_file6 (File) —

    Sixth input file to perform the operation on.

  • :input_file7 (File) —

    Seventh input file to perform the operation on.

  • :input_file8 (File) —

    Eighth input file to perform the operation on.

  • :input_file9 (File) —

    Ninth input file to perform the operation on.

  • :input_file10 (File) —

    Tenth input file to perform the operation on.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



55
56
57
58
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
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 55

def zip_archive_zip_create_with_http_info(input_file1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_create ...'
  end
  # verify the required parameter 'input_file1' is set
  if @api_client.config.client_side_validation && input_file1.nil?
    fail ArgumentError, "Missing the required parameter 'input_file1' when calling ZipArchiveApi.zip_archive_zip_create"
  end
  # resource path
  local_var_path = '/convert/archive/zip/create'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile1'] = input_file1
  form_params['inputFile2'] = opts[:'input_file2'] if !opts[:'input_file2'].nil?
  form_params['inputFile3'] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
  form_params['inputFile4'] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
  form_params['inputFile5'] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
  form_params['inputFile6'] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
  form_params['inputFile7'] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
  form_params['inputFile8'] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
  form_params['inputFile9'] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
  form_params['inputFile10'] = opts[:'input_file10'] if !opts[:'input_file10'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_decrypt(input_file, zip_password, opts = {}) ⇒ Object

Decrypt and remove password protection on a zip file Decrypts and removes password protection from an encrypted zip file with the specified password

Parameters:

  • input_file —

    Input file to perform the operation on.

  • zip_password —

    Required; Password for the input archive

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


319
320
321
322
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 319

def zip_archive_zip_decrypt(input_file, zip_password, opts = {})
  data, _status_code, _headers = zip_archive_zip_decrypt_with_http_info(input_file, zip_password, opts)
  data
end

#zip_archive_zip_decrypt_with_http_info(input_file, zip_password, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Decrypt and remove password protection on a zip file Decrypts and removes password protection from an encrypted zip file with the specified password

Parameters:

  • input_file —

    Input file to perform the operation on.

  • zip_password —

    Required; Password for the input archive

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 330

def zip_archive_zip_decrypt_with_http_info(input_file, zip_password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_decrypt ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling ZipArchiveApi.zip_archive_zip_decrypt"
  end
  # verify the required parameter 'zip_password' is set
  if @api_client.config.client_side_validation && zip_password.nil?
    fail ArgumentError, "Missing the required parameter 'zip_password' when calling ZipArchiveApi.zip_archive_zip_decrypt"
  end
  # resource path
  local_var_path = '/convert/archive/zip/decrypt'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'zipPassword'] = zip_password

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_decrypt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_encrypt_advanced(encryption_request, opts = {}) ⇒ Object

Encrypt and password protect a zip file Encrypts and password protects an existing zip file with the specified password and encryption algorithm

Parameters:

  • encryption_request —

    Encryption request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


380
381
382
383
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 380

def zip_archive_zip_encrypt_advanced(encryption_request, opts = {})
  data, _status_code, _headers = zip_archive_zip_encrypt_advanced_with_http_info(encryption_request, opts)
  data
end

#zip_archive_zip_encrypt_advanced_with_http_info(encryption_request, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Encrypt and password protect a zip file Encrypts and password protects an existing zip file with the specified password and encryption algorithm

Parameters:

  • encryption_request —

    Encryption request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 390

def zip_archive_zip_encrypt_advanced_with_http_info(encryption_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_encrypt_advanced ...'
  end
  # verify the required parameter 'encryption_request' is set
  if @api_client.config.client_side_validation && encryption_request.nil?
    fail ArgumentError, "Missing the required parameter 'encryption_request' when calling ZipArchiveApi.zip_archive_zip_encrypt_advanced"
  end
  # resource path
  local_var_path = '/convert/archive/zip/encrypt/advanced'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(encryption_request)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_encrypt_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zip_archive_zip_extract(input_file, opts = {}) ⇒ ZipExtractResponse

Extract, decompress files and folders from a zip archive Extracts a zip archive by decompressing files, and folders.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 434

def zip_archive_zip_extract(input_file, opts = {})
  data, _status_code, _headers = zip_archive_zip_extract_with_http_info(input_file, opts)
  data
end

#zip_archive_zip_extract_with_http_info(input_file, opts = {}) ⇒ Array<(ZipExtractResponse, Fixnum, Hash)>

Extract, decompress files and folders from a zip archive Extracts a zip archive by decompressing files, and folders.

Parameters:

  • input_file —

    Input file to perform the operation on.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ZipExtractResponse, Fixnum, Hash)>) —

    ZipExtractResponse data, response status code and response headers



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/cloudmersive-convert-api-client/api/zip_archive_api.rb', line 444

def zip_archive_zip_extract_with_http_info(input_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZipArchiveApi.zip_archive_zip_extract ...'
  end
  # verify the required parameter 'input_file' is set
  if @api_client.config.client_side_validation && input_file.nil?
    fail ArgumentError, "Missing the required parameter 'input_file' when calling ZipArchiveApi.zip_archive_zip_extract"
  end
  # resource path
  local_var_path = '/convert/archive/zip/extract'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['inputFile'] = input_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ZipExtractResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end