Class: AsposeSlidesCloud::SlidesAsyncApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/api/slides_async_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration = Configuration.default) ⇒ SlidesAsyncApi

Returns a new instance of SlidesAsyncApi.



29
30
31
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 29

def initialize(configuration = Configuration.default)
  @api_client = AsposeSlidesCloud::ApiClient.new(configuration)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



27
28
29
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#download(path, storage_name = nil, version_id = nil) ⇒ Object

Parameters:

  • path
  • storage_name (defaults to: nil)
  • version_id (defaults to: nil) 


36
37
38
39
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 36

def download(path, storage_name = nil, version_id = nil)
  data, _status_code, _headers = download_with_http_info(path, storage_name, version_id)
  data
end

#download_with_http_info(path, storage_name = nil, version_id = nil) ⇒ Object

Parameters:

  • path
  • storage_name (defaults to: nil)
  • version_id (defaults to: nil) 


44
45
46
47
48
49
50
51
52
53
54
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
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 44

def download_with_http_info(path, storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.download ...'
  end

  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling SlidesAsyncApi.download"
  end
  # resource path
  local_var_path = '/slides/async/storage/file/{path}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'path', path)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = @api_client.prepare_for_query(storage_name) unless storage_name.nil?
  query_params[:'versionId'] = @api_client.prepare_for_query(version_id) unless version_id.nil?

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

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'File')
  return data, status_code, headers
end

#get_operation_result(id) ⇒ Object

Parameters:

  • id 


86
87
88
89
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 86

def get_operation_result(id)
  data, _status_code, _headers = get_operation_result_with_http_info(id)
  data
end

#get_operation_result_with_http_info(id) ⇒ Object

Parameters:

  • id 


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
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 92

def get_operation_result_with_http_info(id)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.get_operation_result ...'
  end

  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesAsyncApi.get_operation_result"
  end
  # resource path
  local_var_path = '/slides/async/{id}/result'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'id', id)

  # query parameters
  query_params = {}

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

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'File')
  return data, status_code, headers
end

#get_operation_status(id) ⇒ Object

Parameters:

  • id 


132
133
134
135
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 132

def get_operation_status(id)
  data, _status_code, _headers = get_operation_status_with_http_info(id)
  data
end

#get_operation_status_with_http_info(id) ⇒ Object

Parameters:

  • id 


138
139
140
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
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 138

def get_operation_status_with_http_info(id)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.get_operation_status ...'
  end

  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesAsyncApi.get_operation_status"
  end
  # resource path
  local_var_path = '/slides/async/{id}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'id', id)

  # query parameters
  query_params = {}

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

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'Operation')
  return data, status_code, headers
end

#start_convert(document, format, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil)
  • options (defaults to: nil) 


184
185
186
187
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 184

def start_convert(document, format, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil)
  data, _status_code, _headers = start_convert_with_http_info(document, format, password, storage, fonts_folder, slides, options)
  data
end

#start_convert_and_save(document, format, out_path, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • out_path
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil)
  • options (defaults to: nil) 


258
259
260
261
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 258

def start_convert_and_save(document, format, out_path, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil)
  data, _status_code, _headers = start_convert_and_save_with_http_info(document, format, out_path, password, storage, fonts_folder, slides, options)
  data
end

#start_convert_and_save_with_http_info(document, format, out_path, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • out_path
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil)
  • options (defaults to: nil) 


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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 271

def start_convert_and_save_with_http_info(document, format, out_path, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_convert_and_save ...'
  end

  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling SlidesAsyncApi.start_convert_and_save"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_convert_and_save"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Pdf', 'Xps', 'Tiff', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Pot', 'Potx', 'Potm', 'Html', 'Html5', 'Swf', 'Svg', 'Jpeg', 'Png', 'Gif', 'Bmp', 'Fodp', 'Xaml', 'Mpeg4', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Pdf, Xps, Tiff, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Pot, Potx, Potm, Html, Html5, Swf, Svg, Jpeg, Png, Gif, Bmp, Fodp, Xaml, Mpeg4, Md, Xml"
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling SlidesAsyncApi.start_convert_and_save"
  end
  # resource path
  local_var_path = '/slides/async/convert/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = @api_client.prepare_for_query(out_path) unless out_path.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?
  query_params[:'slides'] = @api_client.prepare_for_query(slides) unless slides.nil?

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

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []
  if document
    post_files = post_files.push(document)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_convert_with_http_info(document, format, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil)
  • options (defaults to: nil) 


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/aspose_slides_cloud/api/slides_async_api.rb', line 196

def start_convert_with_http_info(document, format, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_convert ...'
  end

  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling SlidesAsyncApi.start_convert"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_convert"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Pdf', 'Xps', 'Tiff', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Pot', 'Potx', 'Potm', 'Html', 'Html5', 'Swf', 'Svg', 'Jpeg', 'Png', 'Gif', 'Bmp', 'Fodp', 'Xaml', 'Mpeg4', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Pdf, Xps, Tiff, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Pot, Potx, Potm, Html, Html5, Swf, Svg, Jpeg, Png, Gif, Bmp, Fodp, Xaml, Mpeg4, Md, Xml"
  end
  # resource path
  local_var_path = '/slides/async/convert/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?
  query_params[:'slides'] = @api_client.prepare_for_query(slides) unless slides.nil?

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

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []
  if document
    post_files = post_files.push(document)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_download_presentation(name, format, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil) ⇒ Object

Parameters:

  • name
  • format
  • options (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil) 


338
339
340
341
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 338

def start_download_presentation(name, format, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil)
  data, _status_code, _headers = start_download_presentation_with_http_info(name, format, options, password, folder, storage, fonts_folder, slides)
  data
end

#start_download_presentation_with_http_info(name, format, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil) ⇒ Object

Parameters:

  • name
  • format
  • options (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 351

def start_download_presentation_with_http_info(name, format, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_download_presentation ...'
  end

  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SlidesAsyncApi.start_download_presentation"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_download_presentation"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Pdf', 'Xps', 'Tiff', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Pot', 'Potx', 'Potm', 'Html', 'Html5', 'Swf', 'Svg', 'Jpeg', 'Png', 'Gif', 'Bmp', 'Fodp', 'Xaml', 'Mpeg4', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Pdf, Xps, Tiff, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Pot, Potx, Potm, Html, Html5, Swf, Svg, Jpeg, Png, Gif, Bmp, Fodp, Xaml, Mpeg4, Md, Xml"
  end
  # resource path
  local_var_path = '/slides/async/{name}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'folder'] = @api_client.prepare_for_query(folder) unless folder.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?
  query_params[:'slides'] = @api_client.prepare_for_query(slides) unless slides.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_merge(files = nil, request = nil, storage = nil) ⇒ Object

Parameters:

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil)
  • storage (defaults to: nil) 


407
408
409
410
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 407

def start_merge(files = nil, request = nil, storage = nil)
  data, _status_code, _headers = start_merge_with_http_info(files, request, storage)
  data
end

#start_merge_and_save(out_path, files = nil, request = nil, storage = nil) ⇒ Object

Parameters:

  • out_path
  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil)
  • storage (defaults to: nil) 


457
458
459
460
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 457

def start_merge_and_save(out_path, files = nil, request = nil, storage = nil)
  data, _status_code, _headers = start_merge_and_save_with_http_info(out_path, files, request, storage)
  data
end

#start_merge_and_save_with_http_info(out_path, files = nil, request = nil, storage = nil) ⇒ Object

Parameters:

  • out_path
  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil)
  • storage (defaults to: nil) 


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 466

def start_merge_and_save_with_http_info(out_path, files = nil, request = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_merge_and_save ...'
  end

  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling SlidesAsyncApi.start_merge_and_save"
  end
  # resource path
  local_var_path = '/slides/async/merge'

  # query parameters
  query_params = {}
  query_params[:'outPath'] = @api_client.prepare_for_query(out_path) unless out_path.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?

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

  # http body (model)
  post_body = @api_client.object_to_http_body(request)

  # form parameters
  post_files = []
  if files
    post_files = post_files.concat(files)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_merge_with_http_info(files = nil, request = nil, storage = nil) ⇒ Object

Parameters:

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil)
  • storage (defaults to: nil) 


415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 415

def start_merge_with_http_info(files = nil, request = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_merge ...'
  end

  # resource path
  local_var_path = '/slides/async/merge'

  # query parameters
  query_params = {}
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?

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

  # http body (model)
  post_body = @api_client.object_to_http_body(request)

  # form parameters
  post_files = []
  if files
    post_files = post_files.concat(files)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_save_presentation(name, format, out_path, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil) ⇒ Object

Parameters:

  • name
  • format
  • out_path
  • options (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil) 


518
519
520
521
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 518

def start_save_presentation(name, format, out_path, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil)
  data, _status_code, _headers = start_save_presentation_with_http_info(name, format, out_path, options, password, folder, storage, fonts_folder, slides)
  data
end

#start_save_presentation_with_http_info(name, format, out_path, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil) ⇒ Object

Parameters:

  • name
  • format
  • out_path
  • options (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • slides (defaults to: nil) 


532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 532

def start_save_presentation_with_http_info(name, format, out_path, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_save_presentation ...'
  end

  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SlidesAsyncApi.start_save_presentation"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_save_presentation"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Pdf', 'Xps', 'Tiff', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Pot', 'Potx', 'Potm', 'Html', 'Html5', 'Swf', 'Svg', 'Jpeg', 'Png', 'Gif', 'Bmp', 'Fodp', 'Xaml', 'Mpeg4', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Pdf, Xps, Tiff, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Pot, Potx, Potm, Html, Html5, Swf, Svg, Jpeg, Png, Gif, Bmp, Fodp, Xaml, Mpeg4, Md, Xml"
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling SlidesAsyncApi.start_save_presentation"
  end
  # resource path
  local_var_path = '/slides/async/{name}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = @api_client.prepare_for_query(out_path) unless out_path.nil?
  query_params[:'folder'] = @api_client.prepare_for_query(folder) unless folder.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?
  query_params[:'slides'] = @api_client.prepare_for_query(slides) unless slides.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_split(name, format, options = nil, width = nil, height = nil, from = nil, to = nil, dest_folder = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Parameters:

  • name
  • format
  • options (defaults to: nil)
  • width (defaults to: nil)
  • height (defaults to: nil)
  • from (defaults to: nil)
  • to (defaults to: nil)
  • dest_folder (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil) 


602
603
604
605
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 602

def start_split(name, format, options = nil, width = nil, height = nil, from = nil, to = nil, dest_folder = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = start_split_with_http_info(name, format, options, width, height, from, to, dest_folder, password, folder, storage, fonts_folder)
  data
end

#start_split_with_http_info(name, format, options = nil, width = nil, height = nil, from = nil, to = nil, dest_folder = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Parameters:

  • name
  • format
  • options (defaults to: nil)
  • width (defaults to: nil)
  • height (defaults to: nil)
  • from (defaults to: nil)
  • to (defaults to: nil)
  • dest_folder (defaults to: nil)
  • password (defaults to: nil)
  • folder (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil) 


619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 619

def start_split_with_http_info(name, format, options = nil, width = nil, height = nil, from = nil, to = nil, dest_folder = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_split ...'
  end

  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling SlidesAsyncApi.start_split"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_split"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Html', 'Pdf', 'Xps', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Potx', 'Pot', 'Potm', 'Svg', 'Fodp', 'Xaml', 'Html5', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Html, Pdf, Xps, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Potx, Pot, Potm, Svg, Fodp, Xaml, Html5, Md, Xml"
  end
  # resource path
  local_var_path = '/slides/async/{name}/split/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'width'] = @api_client.prepare_for_query(width) unless width.nil?
  query_params[:'height'] = @api_client.prepare_for_query(height) unless height.nil?
  query_params[:'from'] = @api_client.prepare_for_query(from) unless from.nil?
  query_params[:'to'] = @api_client.prepare_for_query(to) unless to.nil?
  query_params[:'destFolder'] = @api_client.prepare_for_query(dest_folder) unless dest_folder.nil?
  query_params[:'folder'] = @api_client.prepare_for_query(folder) unless folder.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#start_upload_and_split(document, format, dest_folder = nil, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • dest_folder (defaults to: nil)
  • width (defaults to: nil)
  • height (defaults to: nil)
  • from (defaults to: nil)
  • to (defaults to: nil)
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • options (defaults to: nil) 


687
688
689
690
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 687

def start_upload_and_split(document, format, dest_folder = nil, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  data, _status_code, _headers = start_upload_and_split_with_http_info(document, format, dest_folder, width, height, from, to, password, storage, fonts_folder, options)
  data
end

#start_upload_and_split_with_http_info(document, format, dest_folder = nil, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Parameters:

  • document —

    Document data.

  • format
  • dest_folder (defaults to: nil)
  • width (defaults to: nil)
  • height (defaults to: nil)
  • from (defaults to: nil)
  • to (defaults to: nil)
  • password (defaults to: nil)
  • storage (defaults to: nil)
  • fonts_folder (defaults to: nil)
  • options (defaults to: nil) 


703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 703

def start_upload_and_split_with_http_info(document, format, dest_folder = nil, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.start_upload_and_split ...'
  end

  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling SlidesAsyncApi.start_upload_and_split"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidesAsyncApi.start_upload_and_split"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Html', 'Pdf', 'Xps', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Potx', 'Pot', 'Potm', 'Svg', 'Fodp', 'Xaml', 'Html5', 'Md', 'Xml'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Html, Pdf, Xps, Pptx, Odp, Otp, Ppt, Pps, Ppsx, Pptm, Ppsm, Potx, Pot, Potm, Svg, Fodp, Xaml, Html5, Md, Xml"
  end
  # resource path
  local_var_path = '/slides/async/split/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'destFolder'] = @api_client.prepare_for_query(dest_folder) unless dest_folder.nil?
  query_params[:'width'] = @api_client.prepare_for_query(width) unless width.nil?
  query_params[:'height'] = @api_client.prepare_for_query(height) unless height.nil?
  query_params[:'from'] = @api_client.prepare_for_query(from) unless from.nil?
  query_params[:'to'] = @api_client.prepare_for_query(to) unless to.nil?
  query_params[:'storage'] = @api_client.prepare_for_query(storage) unless storage.nil?
  query_params[:'fontsFolder'] = @api_client.prepare_for_query(fonts_folder) unless fonts_folder.nil?

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

  # http body (model)
  post_body = @api_client.object_to_http_body(options)

  # form parameters
  post_files = []
  if document
    post_files = post_files.push(document)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'String')
  return data, status_code, headers
end

#upload(path, file, storage_name = nil) ⇒ Object

Parameters:

  • path
  • file —

    File to upload

  • storage_name (defaults to: nil) 


764
765
766
767
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 764

def upload(path, file, storage_name = nil)
  data, _status_code, _headers = upload_with_http_info(path, file, storage_name)
  data
end

#upload_with_http_info(path, file, storage_name = nil) ⇒ Object

Parameters:

  • path
  • file —

    File to upload

  • storage_name (defaults to: nil) 


772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/aspose_slides_cloud/api/slides_async_api.rb', line 772

def upload_with_http_info(path, file, storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesAsyncApi.upload ...'
  end

  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling SlidesAsyncApi.upload"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling SlidesAsyncApi.upload"
  end
  # resource path
  local_var_path = '/slides/async/storage/file/{path}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'path', path)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = @api_client.prepare_for_query(storage_name) unless storage_name.nil?

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

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []
  if file
    post_files = post_files.push(file)
  end

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => 'FilesUploadResult')
  return data, status_code, headers
end