Class: AsposeSlidesCloud::SlidesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration = Configuration.default) ⇒ SlidesApi

Returns a new instance of SlidesApi.



29
30
31
 
# File 'lib/aspose_slides_cloud/api/slides_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_api.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#align_shapes(name, slide_index, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • alignment_type —

    Alignment type that will be applied to the shapes.

  • align_to_slide (defaults to: nil) —

    If true, shapes will be aligned relative to the slide edges.

  • shapes (defaults to: nil) —

    Shapes indexes.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



43
44
45
46
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 43

def align_shapes(name, slide_index, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = align_shapes_with_http_info(name, slide_index, alignment_type, align_to_slide, shapes, password, folder, storage, sub_shape)
  data
end

#align_shapes_with_http_info(name, slide_index, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • alignment_type —

    Alignment type that will be applied to the shapes.

  • align_to_slide (defaults to: nil) —

    If true, shapes will be aligned relative to the slide edges.

  • shapes (defaults to: nil) —

    Shapes indexes.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



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
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 58

def align_shapes_with_http_info(name, slide_index, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.align_shapes ...'
  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 SlidesApi.align_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.align_shapes"
  end
  # verify the required parameter 'alignment_type' is set
  if @api_client.config.client_side_validation && alignment_type.nil?
    fail ArgumentError, "Missing the required parameter 'alignment_type' when calling SlidesApi.align_shapes"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['AlignLeft', 'AlignRight', 'AlignCenter', 'AlignTop', 'AlignMiddle', 'AlignBottom', 'DistributeHorizontally', 'DistributeVertically'].any?{ |s| s.casecmp(alignment_type)==0 }
    fail ArgumentError, "Invalid value for parameter alignment_type: " + alignment_type + ". Must be one of AlignLeft, AlignRight, AlignCenter, AlignTop, AlignMiddle, AlignBottom, DistributeHorizontally, DistributeVertically"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/align/{alignmentType}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'alignmentType', alignment_type)

  # query parameters
  query_params = {}
  query_params[:'alignToSlide'] = @api_client.prepare_for_query(align_to_slide) unless align_to_slide.nil?
  query_params[:'shapes'] = @api_client.prepare_for_query(shapes) unless shapes.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # 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 => 'Shapes')
  return data, status_code, headers
end

#align_special_slide_shapes(name, slide_index, slide_type, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Changes the placement of selected shapes on the master slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • alignment_type —

    Alignment type that will be applied to the shapes.

  • align_to_slide (defaults to: nil) —

    If true, shapes will be aligned relative to the slide edges.

  • shapes (defaults to: nil) —

    Shapes indexes.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



128
129
130
131
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 128

def align_special_slide_shapes(name, slide_index, slide_type, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = align_special_slide_shapes_with_http_info(name, slide_index, slide_type, alignment_type, align_to_slide, shapes, password, folder, storage, sub_shape)
  data
end

#align_special_slide_shapes_with_http_info(name, slide_index, slide_type, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Changes the placement of selected shapes on the master slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • alignment_type —

    Alignment type that will be applied to the shapes.

  • align_to_slide (defaults to: nil) —

    If true, shapes will be aligned relative to the slide edges.

  • shapes (defaults to: nil) —

    Shapes indexes.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 144

def align_special_slide_shapes_with_http_info(name, slide_index, slide_type, alignment_type, align_to_slide = nil, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.align_special_slide_shapes ...'
  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 SlidesApi.align_special_slide_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.align_special_slide_shapes"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.align_special_slide_shapes"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'alignment_type' is set
  if @api_client.config.client_side_validation && alignment_type.nil?
    fail ArgumentError, "Missing the required parameter 'alignment_type' when calling SlidesApi.align_special_slide_shapes"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['AlignLeft', 'AlignRight', 'AlignCenter', 'AlignTop', 'AlignMiddle', 'AlignBottom', 'DistributeHorizontally', 'DistributeVertically'].any?{ |s| s.casecmp(alignment_type)==0 }
    fail ArgumentError, "Invalid value for parameter alignment_type: " + alignment_type + ". Must be one of AlignLeft, AlignRight, AlignCenter, AlignTop, AlignMiddle, AlignBottom, DistributeHorizontally, DistributeVertically"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/align/{alignmentType}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'alignmentType', alignment_type)

  # query parameters
  query_params = {}
  query_params[:'alignToSlide'] = @api_client.prepare_for_query(align_to_slide) unless align_to_slide.nil?
  query_params[:'shapes'] = @api_client.prepare_for_query(shapes) unless shapes.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # 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 => 'Shapes')
  return data, status_code, headers
end

#compress_embedded_fonts(name, password = nil, folder = nil, storage = nil) ⇒ Object

Compresses embedded fonts by removing unused characters.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



217
218
219
220
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 217

def compress_embedded_fonts(name, password = nil, folder = nil, storage = nil)
  compress_embedded_fonts_with_http_info(name, password, folder, storage)
  nil
end

#compress_embedded_fonts_online(document, password = nil) ⇒ Object

Compresses embedded fonts by removing unused characters.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



271
272
273
274
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 271

def compress_embedded_fonts_online(document, password = nil)
  data, _status_code, _headers = compress_embedded_fonts_online_with_http_info(document, password)
  data
end

#compress_embedded_fonts_online_with_http_info(document, password = nil) ⇒ Object

Compresses embedded fonts by removing unused characters.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



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

def compress_embedded_fonts_online_with_http_info(document, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.compress_embedded_fonts_online ...'
  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 SlidesApi.compress_embedded_fonts_online"
  end
  # resource path
  local_var_path = '/slides/fonts/embedded/compress'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#compress_embedded_fonts_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Compresses embedded fonts by removing unused characters.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 227

def compress_embedded_fonts_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.compress_embedded_fonts ...'
  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 SlidesApi.compress_embedded_fonts"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts/embedded/compress'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = nil

  # 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 data, status_code, headers
end

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

Convert presentation from request content to format specified.

Parameters:

  • document —

    Document data.

  • format —

    Export format.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be converted. If not specified, all slides are converted by default.

  • options (defaults to: nil) —

    Export options.



329
330
331
332
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 329

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

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

Convert presentation from request content to format specified.

Parameters:

  • document —

    Document data.

  • format —

    Export format.

  • out_path —

    Path to save result.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be converted. If not specified, all slides are converted by default.

  • options (defaults to: nil) —

    Export options.



405
406
407
408
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 405

def convert_and_save(document, format, out_path, password = nil, storage = nil, fonts_folder = nil, slides = nil, options = nil)
  convert_and_save_with_http_info(document, format, out_path, password, storage, fonts_folder, slides, options)
  nil
end

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

Convert presentation from request content to format specified.

Parameters:

  • document —

    Document data.

  • format —

    Export format.

  • out_path —

    Path to save result.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be converted. If not specified, all slides are converted by default.

  • options (defaults to: nil) —

    Export options.



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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 419

def 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: SlidesApi.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 SlidesApi.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 SlidesApi.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'].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"
  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 SlidesApi.convert_and_save"
  end
  # resource path
  local_var_path = '/slides/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 data, status_code, headers
end

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

Convert presentation from request content to format specified.

Parameters:

  • document —

    Document data.

  • format —

    Export format.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be converted. If not specified, all slides are converted by default.

  • options (defaults to: nil) —

    Export options.



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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 342

def 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: SlidesApi.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 SlidesApi.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 SlidesApi.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'].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"
  end
  # resource path
  local_var_path = '/slides/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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#copy_file(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil) ⇒ Object

Copy file

Parameters:

  • src_path —

    Source file path e.g. ‘/folder/file.ext’

  • dest_path —

    Destination file path

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name

  • version_id (defaults to: nil) —

    File version ID to copy



483
484
485
486
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 483

def copy_file(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
  copy_file_with_http_info(src_path, dest_path, src_storage_name, dest_storage_name, version_id)
  nil
end

#copy_file_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil) ⇒ Object

Copy file

Parameters:

  • src_path —

    Source file path e.g. ‘/folder/file.ext’

  • dest_path —

    Destination file path

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name

  • version_id (defaults to: nil) —

    File version ID to copy



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 494

def copy_file_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.copy_file ...'
  end

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

  # query parameters
  query_params = {}
  query_params[:'destPath'] = @api_client.prepare_for_query(dest_path) unless dest_path.nil?
  query_params[:'srcStorageName'] = @api_client.prepare_for_query(src_storage_name) unless src_storage_name.nil?
  query_params[:'destStorageName'] = @api_client.prepare_for_query(dest_storage_name) unless dest_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(['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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#copy_folder(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil) ⇒ Object

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. ‘/src’

  • dest_path —

    Destination folder path e.g. ‘/dst’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name



545
546
547
548
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 545

def copy_folder(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil)
  copy_folder_with_http_info(src_path, dest_path, src_storage_name, dest_storage_name)
  nil
end

#copy_folder_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil) ⇒ Object

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. ‘/src’

  • dest_path —

    Destination folder path e.g. ‘/dst’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name



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
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 555

def copy_folder_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.copy_folder ...'
  end

  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling SlidesApi.copy_folder"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling SlidesApi.copy_folder"
  end
  # resource path
  local_var_path = '/slides/storage/folder/copy/{srcPath}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'srcPath', src_path)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = @api_client.prepare_for_query(dest_path) unless dest_path.nil?
  query_params[:'srcStorageName'] = @api_client.prepare_for_query(src_storage_name) unless src_storage_name.nil?
  query_params[:'destStorageName'] = @api_client.prepare_for_query(dest_storage_name) unless dest_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(['application/json'])

  # http body (model)
  post_body = nil

  # 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 data, status_code, headers
end

#copy_layout_slide(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy layoutSlide from source presentation.

Parameters:

  • name —

    Document name.

  • clone_from —

    Name of the document to clone layoutSlide from.

  • clone_from_position —

    Position of cloned layout slide.

  • clone_from_password (defaults to: nil) —

    Password for the document to clone layoutSlide from.

  • clone_from_storage (defaults to: nil) —

    Storage of the document to clone layoutSlide from.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



609
610
611
612
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 609

def copy_layout_slide(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = copy_layout_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password, clone_from_storage, password, folder, storage)
  data
end

#copy_layout_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy layoutSlide from source presentation.

Parameters:

  • name —

    Document name.

  • clone_from —

    Name of the document to clone layoutSlide from.

  • clone_from_position —

    Position of cloned layout slide.

  • clone_from_password (defaults to: nil) —

    Password for the document to clone layoutSlide from.

  • clone_from_storage (defaults to: nil) —

    Storage of the document to clone layoutSlide from.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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
676
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 623

def copy_layout_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.copy_layout_slide ...'
  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 SlidesApi.copy_layout_slide"
  end
  # verify the required parameter 'clone_from' is set
  if @api_client.config.client_side_validation && clone_from.nil?
    fail ArgumentError, "Missing the required parameter 'clone_from' when calling SlidesApi.copy_layout_slide"
  end
  # verify the required parameter 'clone_from_position' is set
  if @api_client.config.client_side_validation && clone_from_position.nil?
    fail ArgumentError, "Missing the required parameter 'clone_from_position' when calling SlidesApi.copy_layout_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/layoutSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'cloneFrom'] = @api_client.prepare_for_query(clone_from) unless clone_from.nil?
  query_params[:'cloneFromPosition'] = @api_client.prepare_for_query(clone_from_position) unless clone_from_position.nil?
  query_params[:'cloneFromStorage'] = @api_client.prepare_for_query(clone_from_storage) unless clone_from_storage.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?

  # 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[:'cloneFromPassword'] = clone_from_password unless clone_from_password.nil?
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'LayoutSlide')
  return data, status_code, headers
end

#copy_master_slide(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, apply_to_all = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy masterSlide from source presentation.

Parameters:

  • name —

    Document name.

  • clone_from —

    Name of the document to clone masterSlide from.

  • clone_from_position —

    Position of cloned master slide.

  • clone_from_password (defaults to: nil) —

    Password for the document to clone masterSlide from.

  • clone_from_storage (defaults to: nil) —

    Storage of the document to clone masterSlide from.

  • apply_to_all (defaults to: nil) —

    True to apply cloned master slide to every existing slide.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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

def copy_master_slide(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, apply_to_all = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = copy_master_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password, clone_from_storage, apply_to_all, password, folder, storage)
  data
end

#copy_master_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, apply_to_all = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy masterSlide from source presentation.

Parameters:

  • name —

    Document name.

  • clone_from —

    Name of the document to clone masterSlide from.

  • clone_from_position —

    Position of cloned master slide.

  • clone_from_password (defaults to: nil) —

    Password for the document to clone masterSlide from.

  • clone_from_storage (defaults to: nil) —

    Storage of the document to clone masterSlide from.

  • apply_to_all (defaults to: nil) —

    True to apply cloned master slide to every existing slide.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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

def copy_master_slide_with_http_info(name, clone_from, clone_from_position, clone_from_password = nil, clone_from_storage = nil, apply_to_all = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.copy_master_slide ...'
  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 SlidesApi.copy_master_slide"
  end
  # verify the required parameter 'clone_from' is set
  if @api_client.config.client_side_validation && clone_from.nil?
    fail ArgumentError, "Missing the required parameter 'clone_from' when calling SlidesApi.copy_master_slide"
  end
  # verify the required parameter 'clone_from_position' is set
  if @api_client.config.client_side_validation && clone_from_position.nil?
    fail ArgumentError, "Missing the required parameter 'clone_from_position' when calling SlidesApi.copy_master_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/masterSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'cloneFrom'] = @api_client.prepare_for_query(clone_from) unless clone_from.nil?
  query_params[:'cloneFromPosition'] = @api_client.prepare_for_query(clone_from_position) unless clone_from_position.nil?
  query_params[:'cloneFromStorage'] = @api_client.prepare_for_query(clone_from_storage) unless clone_from_storage.nil?
  query_params[:'applyToAll'] = @api_client.prepare_for_query(apply_to_all) unless apply_to_all.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?

  # 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[:'cloneFromPassword'] = clone_from_password unless clone_from_password.nil?
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'MasterSlide')
  return data, status_code, headers
end

#copy_slide(name, slide_to_copy, position = nil, source = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy a slide from the current or another presentation.

Parameters:

  • name —

    Document name.

  • slide_to_copy —

    The index of the slide to be copied from the source presentation.

  • position (defaults to: nil) —

    The target position at which to copy the slide. Copy to the end by default.

  • source (defaults to: nil) —

    Name of the document to copy a slide from.

  • source_password (defaults to: nil) —

    Password for the document to copy a slide from.

  • source_storage (defaults to: nil) —

    Template storage name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



767
768
769
770
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 767

def copy_slide(name, slide_to_copy, position = nil, source = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = copy_slide_with_http_info(name, slide_to_copy, position, source, source_password, source_storage, password, folder, storage)
  data
end

#copy_slide_with_http_info(name, slide_to_copy, position = nil, source = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Copy a slide from the current or another presentation.

Parameters:

  • name —

    Document name.

  • slide_to_copy —

    The index of the slide to be copied from the source presentation.

  • position (defaults to: nil) —

    The target position at which to copy the slide. Copy to the end by default.

  • source (defaults to: nil) —

    Name of the document to copy a slide from.

  • source_password (defaults to: nil) —

    Password for the document to copy a slide from.

  • source_storage (defaults to: nil) —

    Template storage name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 782

def copy_slide_with_http_info(name, slide_to_copy, position = nil, source = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.copy_slide ...'
  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 SlidesApi.copy_slide"
  end
  # verify the required parameter 'slide_to_copy' is set
  if @api_client.config.client_side_validation && slide_to_copy.nil?
    fail ArgumentError, "Missing the required parameter 'slide_to_copy' when calling SlidesApi.copy_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/copy'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'slideToCopy'] = @api_client.prepare_for_query(slide_to_copy) unless slide_to_copy.nil?
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.nil?
  query_params[:'source'] = @api_client.prepare_for_query(source) unless source.nil?
  query_params[:'sourceStorage'] = @api_client.prepare_for_query(source_storage) unless source_storage.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?

  # 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[:'sourcePassword'] = source_password unless source_password.nil?
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'Slides')
  return data, status_code, headers
end

#create_animation_effect(name, slide_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an effect to slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



840
841
842
843
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 840

def create_animation_effect(name, slide_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_animation_effect_with_http_info(name, slide_index, effect, password, folder, storage)
  data
end

#create_animation_effect_with_http_info(name, slide_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an effect to slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 852

def create_animation_effect_with_http_info(name, slide_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_animation_effect ...'
  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 SlidesApi.create_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_animation_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.create_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/mainSequence'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_animation_interactive_sequence(name, slide_index, sequence, password = nil, folder = nil, storage = nil) ⇒ Object

Set slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence —

    Animation sequence DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



910
911
912
913
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 910

def create_animation_interactive_sequence(name, slide_index, sequence, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_animation_interactive_sequence_with_http_info(name, slide_index, sequence, password, folder, storage)
  data
end

#create_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an animation effect to a slide interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The position of the interactive sequence.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



981
982
983
984
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 981

def create_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect, password, folder, storage)
  data
end

#create_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an animation effect to a slide interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The position of the interactive sequence.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 994

def create_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_animation_interactive_sequence_effect ...'
  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 SlidesApi.create_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.create_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.create_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences/{sequenceIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_animation_interactive_sequence_with_http_info(name, slide_index, sequence, password = nil, folder = nil, storage = nil) ⇒ Object

Set slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence —

    Animation sequence DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 922

def create_animation_interactive_sequence_with_http_info(name, slide_index, sequence, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_animation_interactive_sequence ...'
  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 SlidesApi.create_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_animation_interactive_sequence"
  end
  # verify the required parameter 'sequence' is set
  if @api_client.config.client_side_validation && sequence.nil?
    fail ArgumentError, "Missing the required parameter 'sequence' when calling SlidesApi.create_animation_interactive_sequence"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(sequence)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_chart_category(name, slide_index, shape_index, category, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new category to a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category —

    Category DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1058
1059
1060
1061
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1058

def create_chart_category(name, slide_index, shape_index, category, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_chart_category_with_http_info(name, slide_index, shape_index, category, password, folder, storage)
  data
end

#create_chart_category_with_http_info(name, slide_index, shape_index, category, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new category to a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category —

    Category DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1071

def create_chart_category_with_http_info(name, slide_index, shape_index, category, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_chart_category ...'
  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 SlidesApi.create_chart_category"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_chart_category"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_chart_category"
  end
  # verify the required parameter 'category' is set
  if @api_client.config.client_side_validation && category.nil?
    fail ArgumentError, "Missing the required parameter 'category' when calling SlidesApi.create_chart_category"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/categories'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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?

  # 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(category)

  # 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 => 'Chart')
  return data, status_code, headers
end

#create_chart_data_point(name, slide_index, shape_index, series_index, data_point, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new data point to a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • data_point —

    Data point DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1136
1137
1138
1139
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1136

def create_chart_data_point(name, slide_index, shape_index, series_index, data_point, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, data_point, password, folder, storage)
  data
end

#create_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, data_point, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new data point to a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • data_point —

    Data point DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1150

def create_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, data_point, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_chart_data_point ...'
  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 SlidesApi.create_chart_data_point"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_chart_data_point"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_chart_data_point"
  end
  # verify the required parameter 'series_index' is set
  if @api_client.config.client_side_validation && series_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_index' when calling SlidesApi.create_chart_data_point"
  end
  # verify the required parameter 'data_point' is set
  if @api_client.config.client_side_validation && data_point.nil?
    fail ArgumentError, "Missing the required parameter 'data_point' when calling SlidesApi.create_chart_data_point"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series/{seriesIndex}/dataPoints'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesIndex', series_index)

  # 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?

  # 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(data_point)

  # 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 => 'Chart')
  return data, status_code, headers
end

#create_chart_series(name, slide_index, shape_index, series, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new series to a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series —

    Series DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1219
1220
1221
1222
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1219

def create_chart_series(name, slide_index, shape_index, series, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_chart_series_with_http_info(name, slide_index, shape_index, series, password, folder, storage)
  data
end

#create_chart_series_with_http_info(name, slide_index, shape_index, series, password = nil, folder = nil, storage = nil) ⇒ Object

Add a new series to a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series —

    Series DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1232

def create_chart_series_with_http_info(name, slide_index, shape_index, series, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_chart_series ...'
  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 SlidesApi.create_chart_series"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_chart_series"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_chart_series"
  end
  # verify the required parameter 'series' is set
  if @api_client.config.client_side_validation && series.nil?
    fail ArgumentError, "Missing the required parameter 'series' when calling SlidesApi.create_chart_series"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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?

  # 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(series)

  # 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 => 'Chart')
  return data, status_code, headers
end

#create_comment(name, slide_index, dto, shape_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds the comment on the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    Comment DTO.

  • shape_index (defaults to: nil) —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1296
1297
1298
1299
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1296

def create_comment(name, slide_index, dto, shape_index = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_comment_with_http_info(name, slide_index, dto, shape_index, password, folder, storage)
  data
end

#create_comment_online(document, slide_index, dto, shape_index = nil, password = nil) ⇒ Object

Adds the comment on the slide.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • dto —

    Comment DTO.

  • shape_index (defaults to: nil) —

    Shape index.

  • password (defaults to: nil) —

    Document password.



1367
1368
1369
1370
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1367

def create_comment_online(document, slide_index, dto, shape_index = nil, password = nil)
  data, _status_code, _headers = create_comment_online_with_http_info(document, slide_index, dto, shape_index, password)
  data
end

#create_comment_online_with_http_info(document, slide_index, dto, shape_index = nil, password = nil) ⇒ Object

Adds the comment on the slide.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • dto —

    Comment DTO.

  • shape_index (defaults to: nil) —

    Shape index.

  • password (defaults to: nil) —

    Document password.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1378

def create_comment_online_with_http_info(document, slide_index, dto, shape_index = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_comment_online ...'
  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 SlidesApi.create_comment_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_comment_online"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_comment_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/comments'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'shapeIndex'] = @api_client.prepare_for_query(shape_index) unless shape_index.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

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

  # 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 => 'File')
  return data, status_code, headers
end

#create_comment_with_http_info(name, slide_index, dto, shape_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds the comment on the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    Comment DTO.

  • shape_index (defaults to: nil) —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1309

def create_comment_with_http_info(name, slide_index, dto, shape_index = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_comment ...'
  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 SlidesApi.create_comment"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_comment"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_comment"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/comments'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'shapeIndex'] = @api_client.prepare_for_query(shape_index) unless shape_index.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?

  # 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(dto)

  # 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 => 'SlideComments')
  return data, status_code, headers
end

#create_folder(path, storage_name = nil) ⇒ Object

Create the folder

Parameters:

  • path —

    Folder path to create e.g. ‘folder_1/folder_2/’

  • storage_name (defaults to: nil) —

    Storage name



1433
1434
1435
1436
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1433

def create_folder(path, storage_name = nil)
  create_folder_with_http_info(path, storage_name)
  nil
end

#create_folder_with_http_info(path, storage_name = nil) ⇒ Object

Create the folder

Parameters:

  • path —

    Folder path to create e.g. ‘folder_1/folder_2/’

  • storage_name (defaults to: nil) —

    Storage name



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1441

def create_folder_with_http_info(path, storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_folder ...'
  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 SlidesApi.create_folder"
  end
  # resource path
  local_var_path = '/slides/storage/folder/{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(['application/json'])

  # http body (model)
  post_body = nil

  # 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 data, status_code, headers
end

#create_image_watermark(name, image = nil, picture_frame = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • name —

    Document name.

  • image (defaults to: nil) —

    Image data.

  • picture_frame (defaults to: nil) —

    PictureFrame DTO

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1487
1488
1489
1490
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1487

def create_image_watermark(name, image = nil, picture_frame = nil, password = nil, folder = nil, storage = nil)
  create_image_watermark_with_http_info(name, image, picture_frame, password, folder, storage)
  nil
end

#create_image_watermark_online(document, image = nil, picture_frame = nil, password = nil) ⇒ Object

Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • document —

    Document data.

  • image (defaults to: nil) —

    Image data.

  • picture_frame (defaults to: nil) —

    PictureFrame DTO.

  • password (defaults to: nil) —

    Document password.



1548
1549
1550
1551
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1548

def create_image_watermark_online(document, image = nil, picture_frame = nil, password = nil)
  data, _status_code, _headers = create_image_watermark_online_with_http_info(document, image, picture_frame, password)
  data
end

#create_image_watermark_online_with_http_info(document, image = nil, picture_frame = nil, password = nil) ⇒ Object

Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • document —

    Document data.

  • image (defaults to: nil) —

    Image data.

  • picture_frame (defaults to: nil) —

    PictureFrame DTO.

  • password (defaults to: nil) —

    Document password.



1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1558

def create_image_watermark_online_with_http_info(document, image = nil, picture_frame = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_image_watermark_online ...'
  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 SlidesApi.create_image_watermark_online"
  end
  # resource path
  local_var_path = '/slides/watermark/image'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

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

  # form parameters
  post_files = []
  if document
    post_files = post_files.push(document)
  end
  if image
    post_files = post_files.push(image)
  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 => 'File')
  return data, status_code, headers
end

#create_image_watermark_with_http_info(name, image = nil, picture_frame = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • name —

    Document name.

  • image (defaults to: nil) —

    Image data.

  • picture_frame (defaults to: nil) —

    PictureFrame DTO

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1499

def create_image_watermark_with_http_info(name, image = nil, picture_frame = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_image_watermark ...'
  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 SlidesApi.create_image_watermark"
  end
  # resource path
  local_var_path = '/slides/{name}/watermark/image'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(picture_frame)

  # form parameters
  post_files = []
  if image
    post_files = post_files.push(image)
  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 data, status_code, headers
end

#create_notes_slide(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Add new notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    A NotesSlide object with notes slide data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1610
1611
1612
1613
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1610

def create_notes_slide(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_notes_slide_with_http_info(name, slide_index, dto, password, folder, storage)
  data
end

#create_notes_slide_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Add new notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    A NotesSlide object with notes slide data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1622

def create_notes_slide_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_notes_slide ...'
  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 SlidesApi.create_notes_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_notes_slide"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_notes_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(dto)

  # 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 => 'NotesSlide')
  return data, status_code, headers
end

#create_paragraph(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Paragraph DTO.

  • position (defaults to: nil) —

    Position of the new paragraph in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



1683
1684
1685
1686
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1683

def create_paragraph(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_paragraph_with_http_info(name, slide_index, shape_index, dto, position, password, folder, storage, sub_shape)
  data
end

#create_paragraph_with_http_info(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Paragraph DTO.

  • position (defaults to: nil) —

    Position of the new paragraph in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1698

def create_paragraph_with_http_info(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_paragraph ...'
  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 SlidesApi.create_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_paragraph"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_paragraph"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Paragraph')
  return data, status_code, headers
end

#create_portion(name, slide_index, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • position (defaults to: nil) —

    Position of the new portion in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



1767
1768
1769
1770
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1767

def create_portion(name, slide_index, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_portion_with_http_info(name, slide_index, shape_index, paragraph_index, dto, position, password, folder, storage, sub_shape)
  data
end

#create_portion_with_http_info(name, slide_index, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • position (defaults to: nil) —

    Position of the new portion in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1783

def create_portion_with_http_info(name, slide_index, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_portion ...'
  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 SlidesApi.create_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_portion"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.create_portion"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # query parameters
  query_params = {}
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Portion')
  return data, status_code, headers
end

#create_presentation(name, data = nil, input_password = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation.

Parameters:

  • name —

    Document name.

  • data (defaults to: nil) —

    Source presentation binary data.

  • input_password (defaults to: nil) —

    The password for source presentation.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1853
1854
1855
1856
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1853

def create_presentation(name, data = nil, input_password = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_presentation_with_http_info(name, data, input_password, password, folder, storage)
  data
end

#create_presentation_from_source(name, source_path = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation from an existing source.

Parameters:

  • name —

    Document name.

  • source_path (defaults to: nil) —

    Source file path.

  • source_password (defaults to: nil) —

    Source file password.

  • source_storage (defaults to: nil) —

    Source storage name.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1919
1920
1921
1922
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1919

def create_presentation_from_source(name, source_path = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_presentation_from_source_with_http_info(name, source_path, source_password, source_storage, password, folder, storage)
  data
end

#create_presentation_from_source_with_http_info(name, source_path = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation from an existing source.

Parameters:

  • name —

    Document name.

  • source_path (defaults to: nil) —

    Source file path.

  • source_password (defaults to: nil) —

    Source file password.

  • source_storage (defaults to: nil) —

    Source storage name.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1932

def create_presentation_from_source_with_http_info(name, source_path = nil, source_password = nil, source_storage = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_presentation_from_source ...'
  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 SlidesApi.create_presentation_from_source"
  end
  # resource path
  local_var_path = '/slides/{name}/fromSource'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'sourcePath'] = @api_client.prepare_for_query(source_path) unless source_path.nil?
  query_params[:'sourceStorage'] = @api_client.prepare_for_query(source_storage) unless source_storage.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?

  # 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[:'sourcePassword'] = source_password unless source_password.nil?
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'Document')
  return data, status_code, headers
end

#create_presentation_from_template(name, template_path, data = nil, template_password = nil, template_storage = nil, is_image_data_embedded = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation.

Parameters:

  • name —

    Document name.

  • template_path —

    Template file path.

  • data (defaults to: nil) —

    Document input data.

  • template_password (defaults to: nil) —

    Template file password.

  • template_storage (defaults to: nil) —

    Template storage name.

  • is_image_data_embedded (defaults to: nil) —

    True if image data is embedded.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1987
1988
1989
1990
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1987

def create_presentation_from_template(name, template_path, data = nil, template_password = nil, template_storage = nil, is_image_data_embedded = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_presentation_from_template_with_http_info(name, template_path, data, template_password, template_storage, is_image_data_embedded, password, folder, storage)
  data
end

#create_presentation_from_template_with_http_info(name, template_path, data = nil, template_password = nil, template_storage = nil, is_image_data_embedded = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation.

Parameters:

  • name —

    Document name.

  • template_path —

    Template file path.

  • data (defaults to: nil) —

    Document input data.

  • template_password (defaults to: nil) —

    Template file password.

  • template_storage (defaults to: nil) —

    Template storage name.

  • is_image_data_embedded (defaults to: nil) —

    True if image data is embedded.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2002

def create_presentation_from_template_with_http_info(name, template_path, data = nil, template_password = nil, template_storage = nil, is_image_data_embedded = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_presentation_from_template ...'
  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 SlidesApi.create_presentation_from_template"
  end
  # verify the required parameter 'template_path' is set
  if @api_client.config.client_side_validation && template_path.nil?
    fail ArgumentError, "Missing the required parameter 'template_path' when calling SlidesApi.create_presentation_from_template"
  end
  # resource path
  local_var_path = '/slides/{name}/fromTemplate'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'templatePath'] = @api_client.prepare_for_query(template_path) unless template_path.nil?
  query_params[:'templateStorage'] = @api_client.prepare_for_query(template_storage) unless template_storage.nil?
  query_params[:'isImageDataEmbedded'] = @api_client.prepare_for_query(is_image_data_embedded) unless is_image_data_embedded.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?

  # 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[:'templatePassword'] = template_password unless template_password.nil?
  header_params[:'password'] = password unless password.nil?

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

  # 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 => 'Document')
  return data, status_code, headers
end

#create_presentation_with_http_info(name, data = nil, input_password = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a presentation.

Parameters:

  • name —

    Document name.

  • data (defaults to: nil) —

    Source presentation binary data.

  • input_password (defaults to: nil) —

    The password for source presentation.

  • password (defaults to: nil) —

    The document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 1865

def create_presentation_with_http_info(name, data = nil, input_password = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_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 SlidesApi.create_presentation"
  end
  # resource path
  local_var_path = '/slides/{name}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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[:'inputPassword'] = input_password unless input_password.nil?
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []
  if data
    post_files = post_files.push(data)
  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 => 'Document')
  return data, status_code, headers
end

#create_section(name, section_name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Create a section starting at a specified slide index.

Parameters:

  • name —

    Document name.

  • section_name —

    Section name.

  • slide_index —

    Slide index (one-based).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2059
2060
2061
2062
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2059

def create_section(name, section_name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_section_with_http_info(name, section_name, slide_index, password, folder, storage)
  data
end

#create_section_with_http_info(name, section_name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Create a section starting at a specified slide index.

Parameters:

  • name —

    Document name.

  • section_name —

    Section name.

  • slide_index —

    Slide index (one-based).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2071

def create_section_with_http_info(name, section_name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_section ...'
  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 SlidesApi.create_section"
  end
  # verify the required parameter 'section_name' is set
  if @api_client.config.client_side_validation && section_name.nil?
    fail ArgumentError, "Missing the required parameter 'section_name' when calling SlidesApi.create_section"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_section"
  end
  # resource path
  local_var_path = '/slides/{name}/sections'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'sectionName'] = @api_client.prepare_for_query(section_name) unless section_name.nil?
  query_params[:'slideIndex'] = @api_client.prepare_for_query(slide_index) unless slide_index.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?

  # 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 = nil

  # 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 => 'Sections')
  return data, status_code, headers
end

#create_shape(name, slide_index, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Create new shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto (defaults to: nil) —

    Shape DTO.

  • shape_to_clone (defaults to: nil) —

    Optional index for clone shape instead of adding a new one.

  • position (defaults to: nil) —

    Position of the new shape in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2133
2134
2135
2136
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2133

def create_shape(name, slide_index, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_shape_with_http_info(name, slide_index, dto, shape_to_clone, position, password, folder, storage, sub_shape)
  data
end

#create_shape_with_http_info(name, slide_index, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Create new shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto (defaults to: nil) —

    Shape DTO.

  • shape_to_clone (defaults to: nil) —

    Optional index for clone shape instead of adding a new one.

  • position (defaults to: nil) —

    Position of the new shape in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2148

def create_shape_with_http_info(name, slide_index, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_shape ...'
  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 SlidesApi.create_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'shapeToClone'] = @api_client.prepare_for_query(shape_to_clone) unless shape_to_clone.nil?
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'ShapeBase')
  return data, status_code, headers
end

#create_slide(name, layout_alias = nil, position = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a slide.

Parameters:

  • name —

    Document name.

  • layout_alias (defaults to: nil) —

    Alias of layout slide for new slide. Alias may be the type of layout, name of layout slide or index

  • position (defaults to: nil) —

    The target position at which to create the slide. Add to the end by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2205
2206
2207
2208
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2205

def create_slide(name, layout_alias = nil, position = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_slide_with_http_info(name, layout_alias, position, password, folder, storage)
  data
end

#create_slide_with_http_info(name, layout_alias = nil, position = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create a slide.

Parameters:

  • name —

    Document name.

  • layout_alias (defaults to: nil) —

    Alias of layout slide for new slide. Alias may be the type of layout, name of layout slide or index

  • position (defaults to: nil) —

    The target position at which to create the slide. Add to the end by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2217

def create_slide_with_http_info(name, layout_alias = nil, position = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_slide ...'
  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 SlidesApi.create_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'layoutAlias'] = @api_client.prepare_for_query(layout_alias) unless layout_alias.nil?
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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?

  # 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 = nil

  # 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 => 'Slides')
  return data, status_code, headers
end

#create_smart_art_node(name, slide_index, smart_art_index, sub_node = nil, text = nil, position = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Add SmartArt node

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • smart_art_index —

    Index of the object on the slide among the same type of objects.

  • sub_node (defaults to: nil) —

    Sub-node path (e.g. "3", "3/nodes/2).

  • text (defaults to: nil) —

    Node text.

  • position (defaults to: nil) —

    Position to insert a new node.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2271
2272
2273
2274
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2271

def create_smart_art_node(name, slide_index, smart_art_index, sub_node = nil, text = nil, position = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_smart_art_node_with_http_info(name, slide_index, smart_art_index, sub_node, text, position, password, folder, storage)
  data
end

#create_smart_art_node_with_http_info(name, slide_index, smart_art_index, sub_node = nil, text = nil, position = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Add SmartArt node

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • smart_art_index —

    Index of the object on the slide among the same type of objects.

  • sub_node (defaults to: nil) —

    Sub-node path (e.g. "3", "3/nodes/2).

  • text (defaults to: nil) —

    Node text.

  • position (defaults to: nil) —

    Position to insert a new node.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2286

def create_smart_art_node_with_http_info(name, slide_index, smart_art_index, sub_node = nil, text = nil, position = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_smart_art_node ...'
  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 SlidesApi.create_smart_art_node"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_smart_art_node"
  end
  # verify the required parameter 'smart_art_index' is set
  if @api_client.config.client_side_validation && smart_art_index.nil?
    fail ArgumentError, "Missing the required parameter 'smart_art_index' when calling SlidesApi.create_smart_art_node"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/smartArts/{smartArtIndex}/nodes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'smartArtIndex', smart_art_index)

  # query parameters
  query_params = {}
  query_params[:'subNode'] = @api_client.prepare_for_query(sub_node) unless sub_node.nil?
  query_params[:'text'] = @api_client.prepare_for_query(text) unless text.nil?
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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?

  # 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 = nil

  # 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 => 'SmartArt')
  return data, status_code, headers
end

#create_special_slide_animation_effect(name, slide_index, slide_type, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an effect to special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2349
2350
2351
2352
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2349

def create_special_slide_animation_effect(name, slide_index, slide_type, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect, password, folder, storage)
  data
end

#create_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an effect to special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2362

def create_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_animation_effect ...'
  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 SlidesApi.create_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_animation_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.create_special_slide_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/mainSequence'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_special_slide_animation_interactive_sequence(name, slide_index, slide_type, sequence, password = nil, folder = nil, storage = nil) ⇒ Object

Set special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence —

    Animation sequence DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2430
2431
2432
2433
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2430

def create_special_slide_animation_interactive_sequence(name, slide_index, slide_type, sequence, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence, password, folder, storage)
  data
end

#create_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an animation effect to a special slide (master, layout, notes) interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The position of the interactive sequence.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2512
2513
2514
2515
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2512

def create_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect, password, folder, storage)
  data
end

#create_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Add an animation effect to a special slide (master, layout, notes) interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The position of the interactive sequence.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2526

def create_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_animation_interactive_sequence_effect ...'
  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 SlidesApi.create_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_animation_interactive_sequence_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.create_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.create_special_slide_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences/{sequenceIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence, password = nil, folder = nil, storage = nil) ⇒ Object

Set special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence —

    Animation sequence DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2443

def create_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_animation_interactive_sequence ...'
  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 SlidesApi.create_special_slide_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_animation_interactive_sequence"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'sequence' is set
  if @api_client.config.client_side_validation && sequence.nil?
    fail ArgumentError, "Missing the required parameter 'sequence' when calling SlidesApi.create_special_slide_animation_interactive_sequence"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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(sequence)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#create_special_slide_paragraph(name, slide_index, slide_type, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • dto —

    Paragraph DTO.

  • position (defaults to: nil) —

    Position of the new paragraph in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2602
2603
2604
2605
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2602

def create_special_slide_paragraph(name, slide_index, slide_type, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, dto, position, password, folder, storage, sub_shape)
  data
end

#create_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • dto —

    Paragraph DTO.

  • position (defaults to: nil) —

    Position of the new paragraph in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2618

def create_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_paragraph ...'
  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 SlidesApi.create_special_slide_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_paragraph"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_paragraph"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_special_slide_paragraph"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_special_slide_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Paragraph')
  return data, status_code, headers
end

#create_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • position (defaults to: nil) —

    Position of the new portion in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2697
2698
2699
2700
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2697

def create_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, position, password, folder, storage, sub_shape)
  data
end

#create_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Creates new portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • position (defaults to: nil) —

    Position of the new portion in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2714

def create_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_portion ...'
  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 SlidesApi.create_special_slide_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_portion"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_portion"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.create_special_slide_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.create_special_slide_portion"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.create_special_slide_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # query parameters
  query_params = {}
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Portion')
  return data, status_code, headers
end

#create_special_slide_shape(name, slide_index, slide_type, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Create new shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • dto (defaults to: nil) —

    Shape DTO.

  • shape_to_clone (defaults to: nil) —

    Optional index for clone shape instead of adding a new one.

  • position (defaults to: nil) —

    Position of the new shape in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2797
2798
2799
2800
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2797

def create_special_slide_shape(name, slide_index, slide_type, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = create_special_slide_shape_with_http_info(name, slide_index, slide_type, dto, shape_to_clone, position, password, folder, storage, sub_shape)
  data
end

#create_special_slide_shape_with_http_info(name, slide_index, slide_type, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Create new shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • dto (defaults to: nil) —

    Shape DTO.

  • shape_to_clone (defaults to: nil) —

    Optional index for clone shape instead of adding a new one.

  • position (defaults to: nil) —

    Position of the new shape in the list. Default is at the end of the list.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2813

def create_special_slide_shape_with_http_info(name, slide_index, slide_type, dto = nil, shape_to_clone = nil, position = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_special_slide_shape ...'
  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 SlidesApi.create_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.create_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.create_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # query parameters
  query_params = {}
  query_params[:'shapeToClone'] = @api_client.prepare_for_query(shape_to_clone) unless shape_to_clone.nil?
  query_params[:'position'] = @api_client.prepare_for_query(position) unless position.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'ShapeBase')
  return data, status_code, headers
end

#create_watermark(name, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • name —

    Document name.

  • shape (defaults to: nil) —

    Shape DTO

  • font_height (defaults to: nil) —

    Watermark font height.

  • text (defaults to: nil) —

    Watermark text.

  • font_name (defaults to: nil) —

    Watermark font name.

  • font_color (defaults to: nil) —

    Watermark font color.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2882
2883
2884
2885
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2882

def create_watermark(name, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil, folder = nil, storage = nil)
  create_watermark_with_http_info(name, shape, font_height, text, font_name, font_color, password, folder, storage)
  nil
end

#create_watermark_online(document, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil) ⇒ Object

Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • document —

    Document data.

  • shape (defaults to: nil) —

    Shape DTO

  • font_height (defaults to: nil) —

    Watermark font height.

  • text (defaults to: nil) —

    Watermark text.

  • font_name (defaults to: nil) —

    Watermark font name.

  • font_color (defaults to: nil) —

    Watermark font color.

  • password (defaults to: nil) —

    Document password.



2950
2951
2952
2953
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2950

def create_watermark_online(document, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil)
  data, _status_code, _headers = create_watermark_online_with_http_info(document, shape, font_height, text, font_name, font_color, password)
  data
end

#create_watermark_online_with_http_info(document, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil) ⇒ Object

Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • document —

    Document data.

  • shape (defaults to: nil) —

    Shape DTO

  • font_height (defaults to: nil) —

    Watermark font height.

  • text (defaults to: nil) —

    Watermark text.

  • font_name (defaults to: nil) —

    Watermark font name.

  • font_color (defaults to: nil) —

    Watermark font color.

  • password (defaults to: nil) —

    Document password.



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2963

def create_watermark_online_with_http_info(document, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_watermark_online ...'
  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 SlidesApi.create_watermark_online"
  end
  # resource path
  local_var_path = '/slides/watermark'

  # query parameters
  query_params = {}
  query_params[:'fontHeight'] = @api_client.prepare_for_query(font_height) unless font_height.nil?
  query_params[:'text'] = @api_client.prepare_for_query(text) unless text.nil?
  query_params[:'fontName'] = @api_client.prepare_for_query(font_name) unless font_name.nil?
  query_params[:'fontColor'] = @api_client.prepare_for_query(font_color) unless font_color.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

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

  # 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 => 'File')
  return data, status_code, headers
end

#create_watermark_with_http_info(name, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously.

Parameters:

  • name —

    Document name.

  • shape (defaults to: nil) —

    Shape DTO

  • font_height (defaults to: nil) —

    Watermark font height.

  • text (defaults to: nil) —

    Watermark text.

  • font_name (defaults to: nil) —

    Watermark font name.

  • font_color (defaults to: nil) —

    Watermark font color.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2897

def create_watermark_with_http_info(name, shape = nil, font_height = nil, text = nil, font_name = nil, font_color = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_watermark ...'
  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 SlidesApi.create_watermark"
  end
  # resource path
  local_var_path = '/slides/{name}/watermark'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'fontHeight'] = @api_client.prepare_for_query(font_height) unless font_height.nil?
  query_params[:'text'] = @api_client.prepare_for_query(text) unless text.nil?
  query_params[:'fontName'] = @api_client.prepare_for_query(font_name) unless font_name.nil?
  query_params[:'fontColor'] = @api_client.prepare_for_query(font_color) unless font_color.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?

  # 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(shape)

  # 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 data, status_code, headers
end

#delete_animation(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove animation from a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3015
3016
3017
3018
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3015

def delete_animation(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_animation_effect(name, slide_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3080
3081
3082
3083
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3080

def delete_animation_effect(name, slide_index, effect_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_effect_with_http_info(name, slide_index, effect_index, password, folder, storage)
  data
end

#delete_animation_effect_with_http_info(name, slide_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3092

def delete_animation_effect_with_http_info(name, slide_index, effect_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation_effect ...'
  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 SlidesApi.delete_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.delete_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/mainSequence/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_animation_interactive_sequence(name, slide_index, sequence_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an interactive sequence from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The index of an interactive sequence to be deleted.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3151
3152
3153
3154
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3151

def delete_animation_interactive_sequence(name, slide_index, sequence_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_interactive_sequence_with_http_info(name, slide_index, sequence_index, password, folder, storage)
  data
end

#delete_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from slide animation interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    Interactive sequence index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3223
3224
3225
3226
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3223

def delete_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, password, folder, storage)
  data
end

#delete_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from slide animation interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    Interactive sequence index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3236

def delete_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation_interactive_sequence_effect ...'
  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 SlidesApi.delete_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.delete_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.delete_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences/{sequenceIndex}/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_animation_interactive_sequence_with_http_info(name, slide_index, sequence_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an interactive sequence from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The index of an interactive sequence to be deleted.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3163

def delete_animation_interactive_sequence_with_http_info(name, slide_index, sequence_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation_interactive_sequence ...'
  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 SlidesApi.delete_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation_interactive_sequence"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.delete_animation_interactive_sequence"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences/{sequenceIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_animation_interactive_sequences(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Clear all interactive sequences from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3299
3300
3301
3302
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3299

def delete_animation_interactive_sequences(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_interactive_sequences_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_animation_interactive_sequences_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Clear all interactive sequences from slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3310

def delete_animation_interactive_sequences_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation_interactive_sequences ...'
  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 SlidesApi.delete_animation_interactive_sequences"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation_interactive_sequences"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_animation_main_sequence(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Clear main sequence in slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3363
3364
3365
3366
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3363

def delete_animation_main_sequence(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_animation_main_sequence_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_animation_main_sequence_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Clear main sequence in slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3374

def delete_animation_main_sequence_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation_main_sequence ...'
  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 SlidesApi.delete_animation_main_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation_main_sequence"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/mainSequence'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_animation_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove animation from a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3026

def delete_animation_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_animation ...'
  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 SlidesApi.delete_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_animation"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_background(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove background from a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3427
3428
3429
3430
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3427

def delete_background(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_background_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_background_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove background from a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3438

def delete_background_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_background ...'
  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 SlidesApi.delete_background"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_background"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/background'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_chart_category(name, slide_index, shape_index, category_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a category from a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category_index —

    Category index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3493
3494
3495
3496
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3493

def delete_chart_category(name, slide_index, shape_index, category_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_chart_category_with_http_info(name, slide_index, shape_index, category_index, password, folder, storage)
  data
end

#delete_chart_category_with_http_info(name, slide_index, shape_index, category_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a category from a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category_index —

    Category index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3506

def delete_chart_category_with_http_info(name, slide_index, shape_index, category_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_chart_category ...'
  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 SlidesApi.delete_chart_category"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_chart_category"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_chart_category"
  end
  # verify the required parameter 'category_index' is set
  if @api_client.config.client_side_validation && category_index.nil?
    fail ArgumentError, "Missing the required parameter 'category_index' when calling SlidesApi.delete_chart_category"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/categories/{categoryIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'categoryIndex', category_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_chart_data_point(name, slide_index, shape_index, series_index, point_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a data point from a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • point_index —

    Data point index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3572
3573
3574
3575
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3572

def delete_chart_data_point(name, slide_index, shape_index, series_index, point_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, password, folder, storage)
  data
end

#delete_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a data point from a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • point_index —

    Data point index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3586

def delete_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_chart_data_point ...'
  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 SlidesApi.delete_chart_data_point"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_chart_data_point"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_chart_data_point"
  end
  # verify the required parameter 'series_index' is set
  if @api_client.config.client_side_validation && series_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_index' when calling SlidesApi.delete_chart_data_point"
  end
  # verify the required parameter 'point_index' is set
  if @api_client.config.client_side_validation && point_index.nil?
    fail ArgumentError, "Missing the required parameter 'point_index' when calling SlidesApi.delete_chart_data_point"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series/{seriesIndex}/dataPoints/{pointIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesIndex', series_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'pointIndex', point_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_chart_series(name, slide_index, shape_index, series_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a series from a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_index —

    Series index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3656
3657
3658
3659
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3656

def delete_chart_series(name, slide_index, shape_index, series_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_chart_series_with_http_info(name, slide_index, shape_index, series_index, password, folder, storage)
  data
end

#delete_chart_series_with_http_info(name, slide_index, shape_index, series_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a series from a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_index —

    Series index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3669

def delete_chart_series_with_http_info(name, slide_index, shape_index, series_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_chart_series ...'
  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 SlidesApi.delete_chart_series"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_chart_series"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_chart_series"
  end
  # verify the required parameter 'series_index' is set
  if @api_client.config.client_side_validation && series_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_index' when calling SlidesApi.delete_chart_series"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series/{seriesIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesIndex', series_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_comments(name, author = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed.

Parameters:

  • name —

    Document name.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3732
3733
3734
3735
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3732

def delete_comments(name, author = nil, password = nil, folder = nil, storage = nil)
  delete_comments_with_http_info(name, author, password, folder, storage)
  nil
end

#delete_comments_online(document, author = nil, password = nil) ⇒ Object

Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed.

Parameters:

  • document —

    Document data.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.



3789
3790
3791
3792
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3789

def delete_comments_online(document, author = nil, password = nil)
  data, _status_code, _headers = delete_comments_online_with_http_info(document, author, password)
  data
end

#delete_comments_online_with_http_info(document, author = nil, password = nil) ⇒ Object

Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed.

Parameters:

  • document —

    Document data.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.



3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3798

def delete_comments_online_with_http_info(document, author = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_comments_online ...'
  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 SlidesApi.delete_comments_online"
  end
  # resource path
  local_var_path = '/slides/comments/delete'

  # query parameters
  query_params = {}
  query_params[:'author'] = @api_client.prepare_for_query(author) unless author.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_comments_with_http_info(name, author = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed.

Parameters:

  • name —

    Document name.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3743

def delete_comments_with_http_info(name, author = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_comments ...'
  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 SlidesApi.delete_comments"
  end
  # resource path
  local_var_path = '/slides/{name}/comments'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'author'] = @api_client.prepare_for_query(author) unless author.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_document_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Clean document properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3846
3847
3848
3849
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3846

def delete_document_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_document_properties_with_http_info(name, password, folder, storage)
  data
end

#delete_document_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Clean document properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3856

def delete_document_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_document_properties ...'
  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 SlidesApi.delete_document_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_document_property(name, property_name, password = nil, folder = nil, storage = nil) ⇒ Object

Delete document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3904
3905
3906
3907
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3904

def delete_document_property(name, property_name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_document_property_with_http_info(name, property_name, password, folder, storage)
  data
end

#delete_document_property_with_http_info(name, property_name, password = nil, folder = nil, storage = nil) ⇒ Object

Delete document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3915

def delete_document_property_with_http_info(name, property_name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_document_property ...'
  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 SlidesApi.delete_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling SlidesApi.delete_document_property"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties/{propertyName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'propertyName', property_name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_embedded_font(name, font_name, password = nil, folder = nil, storage = nil) ⇒ Object

Removes specified embedded font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • font_name —

    Font name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3968
3969
3970
3971
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3968

def delete_embedded_font(name, font_name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_embedded_font_with_http_info(name, font_name, password, folder, storage)
  data
end

#delete_embedded_font_online(document, font_name, password = nil) ⇒ Object

Removes specified embedded font and returns presentation.

Parameters:

  • document —

    Document data.

  • font_name —

    Font name.

  • password (defaults to: nil) —

    Document password.



4030
4031
4032
4033
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4030

def delete_embedded_font_online(document, font_name, password = nil)
  data, _status_code, _headers = delete_embedded_font_online_with_http_info(document, font_name, password)
  data
end

#delete_embedded_font_online_with_http_info(document, font_name, password = nil) ⇒ Object

Removes specified embedded font and returns presentation.

Parameters:

  • document —

    Document data.

  • font_name —

    Font name.

  • password (defaults to: nil) —

    Document password.



4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4039

def delete_embedded_font_online_with_http_info(document, font_name, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_embedded_font_online ...'
  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 SlidesApi.delete_embedded_font_online"
  end
  # verify the required parameter 'font_name' is set
  if @api_client.config.client_side_validation && font_name.nil?
    fail ArgumentError, "Missing the required parameter 'font_name' when calling SlidesApi.delete_embedded_font_online"
  end
  # resource path
  local_var_path = '/slides/fonts/embedded/{fontName}/delete'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'fontName', font_name)

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_embedded_font_with_http_info(name, font_name, password = nil, folder = nil, storage = nil) ⇒ Object

Removes specified embedded font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • font_name —

    Font name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3979

def delete_embedded_font_with_http_info(name, font_name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_embedded_font ...'
  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 SlidesApi.delete_embedded_font"
  end
  # verify the required parameter 'font_name' is set
  if @api_client.config.client_side_validation && font_name.nil?
    fail ArgumentError, "Missing the required parameter 'font_name' when calling SlidesApi.delete_embedded_font"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts/embedded/{fontName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'fontName', font_name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

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

Delete file

Parameters:

  • path —

    File path e.g. ‘/folder/file.ext’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID to delete



4090
4091
4092
4093
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4090

def delete_file(path, storage_name = nil, version_id = nil)
  delete_file_with_http_info(path, storage_name, version_id)
  nil
end

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

Delete file

Parameters:

  • path —

    File path e.g. ‘/folder/file.ext’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID to delete



4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4099

def delete_file_with_http_info(path, storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_file ...'
  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 SlidesApi.delete_file"
  end
  # resource path
  local_var_path = '/slides/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(['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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#delete_folder(path, storage_name = nil, recursive = nil) ⇒ Object

Delete folder

Parameters:

  • path —

    Folder path e.g. ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name

  • recursive (defaults to: nil) —

    Enable to delete folders, subfolders and files



4143
4144
4145
4146
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4143

def delete_folder(path, storage_name = nil, recursive = nil)
  delete_folder_with_http_info(path, storage_name, recursive)
  nil
end

#delete_folder_with_http_info(path, storage_name = nil, recursive = nil) ⇒ Object

Delete folder

Parameters:

  • path —

    Folder path e.g. ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name

  • recursive (defaults to: nil) —

    Enable to delete folders, subfolders and files



4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4152

def delete_folder_with_http_info(path, storage_name = nil, recursive = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_folder ...'
  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 SlidesApi.delete_folder"
  end
  # resource path
  local_var_path = '/slides/storage/folder/{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[:'recursive'] = @api_client.prepare_for_query(recursive) unless recursive.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'])

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []

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

#delete_notes_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4198
4199
4200
4201
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4198

def delete_notes_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_notes_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_notes_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4209

def delete_notes_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_notes_slide ...'
  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 SlidesApi.delete_notes_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_notes_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_paragraph(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4265
4266
4267
4268
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4265

def delete_paragraph(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#delete_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4279

def delete_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_paragraph ...'
  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 SlidesApi.delete_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_paragraph"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_paragraphs(name, slide_index, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraphs (defaults to: nil) —

    The indices of the paragraphs to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4346
4347
4348
4349
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4346

def delete_paragraphs(name, slide_index, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_paragraphs_with_http_info(name, slide_index, shape_index, paragraphs, password, folder, storage, sub_shape)
  data
end

#delete_paragraphs_with_http_info(name, slide_index, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraphs (defaults to: nil) —

    The indices of the paragraphs to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4360

def delete_paragraphs_with_http_info(name, slide_index, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_paragraphs ...'
  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 SlidesApi.delete_paragraphs"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_paragraphs"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_paragraphs"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'paragraphs'] = @api_client.prepare_for_query(paragraphs) unless paragraphs.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_portion(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4424
4425
4426
4427
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4424

def delete_portion(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password, folder, storage, sub_shape)
  data
end

#delete_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4439

def delete_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_portion ...'
  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 SlidesApi.delete_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_portion"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.delete_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_portions(name, slide_index, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portions (defaults to: nil) —

    The indices of the portions to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4512
4513
4514
4515
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4512

def delete_portions(name, slide_index, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_portions_with_http_info(name, slide_index, shape_index, paragraph_index, portions, password, folder, storage, sub_shape)
  data
end

#delete_portions_with_http_info(name, slide_index, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portions (defaults to: nil) —

    The indices of the portions to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4527

def delete_portions_with_http_info(name, slide_index, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_portions ...'
  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 SlidesApi.delete_portions"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_portions"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_portions"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_portions"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # query parameters
  query_params = {}
  query_params[:'portions'] = @api_client.prepare_for_query(portions) unless portions.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_protection(name, password = nil, folder = nil, storage = nil) ⇒ Object

Resets all presentation protection settings.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Presentation password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4591
4592
4593
4594
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4591

def delete_protection(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_protection_with_http_info(name, password, folder, storage)
  data
end

#delete_protection_online(document, password) ⇒ Object

Resets all presentation protection settings.

Parameters:

  • document —

    Document data.

  • password —

    Presentation password.



4646
4647
4648
4649
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4646

def delete_protection_online(document, password)
  data, _status_code, _headers = delete_protection_online_with_http_info(document, password)
  data
end

#delete_protection_online_with_http_info(document, password) ⇒ Object

Resets all presentation protection settings.

Parameters:

  • document —

    Document data.

  • password —

    Presentation password.



4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4654

def delete_protection_online_with_http_info(document, password)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_protection_online ...'
  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 SlidesApi.delete_protection_online"
  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 SlidesApi.delete_protection_online"
  end
  # resource path
  local_var_path = '/slides/protection/delete'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_protection_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Resets all presentation protection settings.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Presentation password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4601

def delete_protection_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_protection ...'
  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 SlidesApi.delete_protection"
  end
  # resource path
  local_var_path = '/slides/{name}/protection'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_section(name, section_index, with_slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a presentation section.

Parameters:

  • name —

    Document name.

  • section_index —

    Section index.

  • with_slides (defaults to: nil) —

    True to delete the slides related to the deleted section; move them to the remaining sections otherwise.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4707
4708
4709
4710
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4707

def delete_section(name, section_index, with_slides = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_section_with_http_info(name, section_index, with_slides, password, folder, storage)
  data
end

#delete_section_with_http_info(name, section_index, with_slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a presentation section.

Parameters:

  • name —

    Document name.

  • section_index —

    Section index.

  • with_slides (defaults to: nil) —

    True to delete the slides related to the deleted section; move them to the remaining sections otherwise.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4719

def delete_section_with_http_info(name, section_index, with_slides = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_section ...'
  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 SlidesApi.delete_section"
  end
  # verify the required parameter 'section_index' is set
  if @api_client.config.client_side_validation && section_index.nil?
    fail ArgumentError, "Missing the required parameter 'section_index' when calling SlidesApi.delete_section"
  end
  # resource path
  local_var_path = '/slides/{name}/sections/{sectionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sectionIndex', section_index)

  # query parameters
  query_params = {}
  query_params[:'withSlides'] = @api_client.prepare_for_query(with_slides) unless with_slides.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_sections(name, sections = nil, with_slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete presentation sections.

Parameters:

  • name —

    Document name.

  • sections (defaults to: nil) —

    The indices of the sections to be deleted; delete all by default.

  • with_slides (defaults to: nil) —

    True to delete the slides related to the deleted sections; move them to the remaining sections otherwise.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4774
4775
4776
4777
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4774

def delete_sections(name, sections = nil, with_slides = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_sections_with_http_info(name, sections, with_slides, password, folder, storage)
  data
end

#delete_sections_with_http_info(name, sections = nil, with_slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete presentation sections.

Parameters:

  • name —

    Document name.

  • sections (defaults to: nil) —

    The indices of the sections to be deleted; delete all by default.

  • with_slides (defaults to: nil) —

    True to delete the slides related to the deleted sections; move them to the remaining sections otherwise.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4786

def delete_sections_with_http_info(name, sections = nil, with_slides = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_sections ...'
  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 SlidesApi.delete_sections"
  end
  # resource path
  local_var_path = '/slides/{name}/sections'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'sections'] = @api_client.prepare_for_query(sections) unless sections.nil?
  query_params[:'withSlides'] = @api_client.prepare_for_query(with_slides) unless with_slides.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_shape(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4838
4839
4840
4841
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4838

def delete_shape(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_shape_with_http_info(name, slide_index, shape_index, password, folder, storage, sub_shape)
  data
end

#delete_shape_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4851

def delete_shape_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_shape ...'
  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 SlidesApi.delete_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_shape"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_shapes(name, slide_index, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of shapes.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shapes (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4912
4913
4914
4915
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4912

def delete_shapes(name, slide_index, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_shapes_with_http_info(name, slide_index, shapes, password, folder, storage, sub_shape)
  data
end

#delete_shapes_with_http_info(name, slide_index, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of shapes.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shapes (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4925

def delete_shapes_with_http_info(name, slide_index, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_shapes ...'
  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 SlidesApi.delete_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_shapes"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'shapes'] = @api_client.prepare_for_query(shapes) unless shapes.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a presentation slide by index.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4980
4981
4982
4983
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4980

def delete_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#delete_slide_comments(name, slide_index, author = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes comments of the specified author from the slide. If author value is not provided all comments will be removed.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5045
5046
5047
5048
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5045

def delete_slide_comments(name, slide_index, author = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_slide_comments_with_http_info(name, slide_index, author, password, folder, storage)
  data
end

#delete_slide_comments_online(document, slide_index, author = nil, password = nil) ⇒ Object

Removes comments of the specified author from the slide. If author value is not provided all comments will be removed.

Parameters:

  • document —

    Document data.

  • slide_index
  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.



5110
5111
5112
5113
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5110

def delete_slide_comments_online(document, slide_index, author = nil, password = nil)
  data, _status_code, _headers = delete_slide_comments_online_with_http_info(document, slide_index, author, password)
  data
end

#delete_slide_comments_online_with_http_info(document, slide_index, author = nil, password = nil) ⇒ Object

Removes comments of the specified author from the slide. If author value is not provided all comments will be removed.

Parameters:

  • document —

    Document data.

  • slide_index
  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.



5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5120

def delete_slide_comments_online_with_http_info(document, slide_index, author = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slide_comments_online ...'
  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 SlidesApi.delete_slide_comments_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_slide_comments_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/comments/delete'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'author'] = @api_client.prepare_for_query(author) unless author.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_slide_comments_with_http_info(name, slide_index, author = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes comments of the specified author from the slide. If author value is not provided all comments will be removed.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • author (defaults to: nil) —

    Author of comments.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5057

def delete_slide_comments_with_http_info(name, slide_index, author = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slide_comments ...'
  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 SlidesApi.delete_slide_comments"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_slide_comments"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/comments'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'author'] = @api_client.prepare_for_query(author) unless author.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete a presentation slide by index.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4991

def delete_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slide ...'
  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 SlidesApi.delete_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_slides(name, slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete presentation slides.

Parameters:

  • name —

    Document name.

  • slides (defaults to: nil) —

    The indices of the slides to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5174
5175
5176
5177
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5174

def delete_slides(name, slides = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_slides_with_http_info(name, slides, password, folder, storage)
  data
end

#delete_slides_with_http_info(name, slides = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete presentation slides.

Parameters:

  • name —

    Document name.

  • slides (defaults to: nil) —

    The indices of the slides to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5185

def delete_slides_with_http_info(name, slides = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slides ...'
  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 SlidesApi.delete_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/slides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'slides'] = @api_client.prepare_for_query(slides) unless slides.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_smart_art_node(name, slide_index, smart_art_index, node_index, sub_node = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete SmartArt node

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • smart_art_index —

    Index of the object on the slide among the same type of objects.

  • node_index —

    Root level node index.

  • sub_node (defaults to: nil) —

    Sub-node path (e.g. "3", "3/nodes/2).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5237
5238
5239
5240
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5237

def delete_smart_art_node(name, slide_index, smart_art_index, node_index, sub_node = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_smart_art_node_with_http_info(name, slide_index, smart_art_index, node_index, sub_node, password, folder, storage)
  data
end

#delete_smart_art_node_with_http_info(name, slide_index, smart_art_index, node_index, sub_node = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Delete SmartArt node

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • smart_art_index —

    Index of the object on the slide among the same type of objects.

  • node_index —

    Root level node index.

  • sub_node (defaults to: nil) —

    Sub-node path (e.g. "3", "3/nodes/2).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5251

def delete_smart_art_node_with_http_info(name, slide_index, smart_art_index, node_index, sub_node = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_smart_art_node ...'
  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 SlidesApi.delete_smart_art_node"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_smart_art_node"
  end
  # verify the required parameter 'smart_art_index' is set
  if @api_client.config.client_side_validation && smart_art_index.nil?
    fail ArgumentError, "Missing the required parameter 'smart_art_index' when calling SlidesApi.delete_smart_art_node"
  end
  # verify the required parameter 'node_index' is set
  if @api_client.config.client_side_validation && node_index.nil?
    fail ArgumentError, "Missing the required parameter 'node_index' when calling SlidesApi.delete_smart_art_node"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/smartArts/{smartArtIndex}/nodes/{nodeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'smartArtIndex', smart_art_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'nodeIndex', node_index)

  # query parameters
  query_params = {}
  query_params[:'subNode'] = @api_client.prepare_for_query(sub_node) unless sub_node.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Remove animation from a special slide (master, layout, notes).

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5316
5317
5318
5319
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5316

def delete_special_slide_animation(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_with_http_info(name, slide_index, slide_type, password, folder, storage)
  data
end

#delete_special_slide_animation_effect(name, slide_index, slide_type, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5392
5393
5394
5395
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5392

def delete_special_slide_animation_effect(name, slide_index, slide_type, effect_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, password, folder, storage)
  data
end

#delete_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5405

def delete_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation_effect ...'
  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 SlidesApi.delete_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.delete_special_slide_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/mainSequence/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation_interactive_sequence(name, slide_index, slide_type, sequence_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an interactive sequence from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The index of an interactive sequence to be deleted.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5474
5475
5476
5477
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5474

def delete_special_slide_animation_interactive_sequence(name, slide_index, slide_type, sequence_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence_index, password, folder, storage)
  data
end

#delete_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from special slide (master, layout, notes) animation interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    Interactive sequence index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5557
5558
5559
5560
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5557

def delete_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, password, folder, storage)
  data
end

#delete_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an effect from special slide (master, layout, notes) animation interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    Interactive sequence index.

  • effect_index —

    Index of the effect to be removed.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5571

def delete_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation_interactive_sequence_effect ...'
  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 SlidesApi.delete_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation_interactive_sequence_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences/{sequenceIndex}/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence_index, password = nil, folder = nil, storage = nil) ⇒ Object

Remove an interactive sequence from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The index of an interactive sequence to be deleted.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5487

def delete_special_slide_animation_interactive_sequence_with_http_info(name, slide_index, slide_type, sequence_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation_interactive_sequence ...'
  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 SlidesApi.delete_special_slide_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequence"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation_interactive_sequence"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequence"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences/{sequenceIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation_interactive_sequences(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Clear all interactive sequences from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5644
5645
5646
5647
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5644

def delete_special_slide_animation_interactive_sequences(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_interactive_sequences_with_http_info(name, slide_index, slide_type, password, folder, storage)
  data
end

#delete_special_slide_animation_interactive_sequences_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Clear all interactive sequences from special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5656

def delete_special_slide_animation_interactive_sequences_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation_interactive_sequences ...'
  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 SlidesApi.delete_special_slide_animation_interactive_sequences"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation_interactive_sequences"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation_interactive_sequences"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation_main_sequence(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Clear main sequence in special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5719
5720
5721
5722
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5719

def delete_special_slide_animation_main_sequence(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_special_slide_animation_main_sequence_with_http_info(name, slide_index, slide_type, password, folder, storage)
  data
end

#delete_special_slide_animation_main_sequence_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Clear main sequence in special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5731

def delete_special_slide_animation_main_sequence_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation_main_sequence ...'
  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 SlidesApi.delete_special_slide_animation_main_sequence"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation_main_sequence"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation_main_sequence"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/mainSequence'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_animation_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil) ⇒ Object

Remove animation from a special slide (master, layout, notes).

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5328

def delete_special_slide_animation_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_animation ...'
  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 SlidesApi.delete_special_slide_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_animation"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_animation"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5797
5798
5799
5800
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5797

def delete_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5812

def delete_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_paragraph ...'
  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 SlidesApi.delete_special_slide_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_paragraph"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_paragraph"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_special_slide_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_special_slide_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_paragraphs(name, slide_index, slide_type, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraphs (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5889
5890
5891
5892
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5889

def delete_special_slide_paragraphs(name, slide_index, slide_type, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, paragraphs, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraphs (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5904

def delete_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, paragraphs = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_paragraphs ...'
  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 SlidesApi.delete_special_slide_paragraphs"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_paragraphs"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_paragraphs"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_special_slide_paragraphs"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'paragraphs'] = @api_client.prepare_for_query(paragraphs) unless paragraphs.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5978
5979
5980
5981
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5978

def delete_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5994

def delete_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_portion ...'
  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 SlidesApi.delete_special_slide_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_portion"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_portion"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_special_slide_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_special_slide_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.delete_special_slide_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_portions(name, slide_index, slide_type, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portions (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6077
6078
6079
6080
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6077

def delete_special_slide_portions(name, slide_index, slide_type, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portions, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portions (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6093

def delete_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portions = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_portions ...'
  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 SlidesApi.delete_special_slide_portions"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_portions"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_portions"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_special_slide_portions"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.delete_special_slide_portions"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # query parameters
  query_params = {}
  query_params[:'portions'] = @api_client.prepare_for_query(portions) unless portions.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_shape(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6170
6171
6172
6173
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6170

def delete_special_slide_shape(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a shape.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6184

def delete_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_shape ...'
  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 SlidesApi.delete_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.delete_special_slide_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_special_slide_shapes(name, slide_index, slide_type, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of shapes.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shapes (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6255
6256
6257
6258
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6255

def delete_special_slide_shapes(name, slide_index, slide_type, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = delete_special_slide_shapes_with_http_info(name, slide_index, slide_type, shapes, password, folder, storage, sub_shape)
  data
end

#delete_special_slide_shapes_with_http_info(name, slide_index, slide_type, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Remove a range of shapes.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shapes (defaults to: nil) —

    The indices of the shapes to be deleted; delete all by default.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6269

def delete_special_slide_shapes_with_http_info(name, slide_index, slide_type, shapes = nil, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_special_slide_shapes ...'
  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 SlidesApi.delete_special_slide_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.delete_special_slide_shapes"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.delete_special_slide_shapes"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # query parameters
  query_params = {}
  query_params[:'shapes'] = @api_client.prepare_for_query(shapes) unless shapes.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = nil

  # form parameters
  post_files = []

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

#delete_unused_layout_slides(name, password = nil, folder = nil, storage = nil) ⇒ Object

Removes unused layout slides.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6332
6333
6334
6335
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6332

def delete_unused_layout_slides(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_unused_layout_slides_with_http_info(name, password, folder, storage)
  data
end

#delete_unused_layout_slides_online(document, password = nil) ⇒ Object

Removes unused layout slides.

Parameters:

  • document —

    Document data

  • password (defaults to: nil) —

    Document password.



6387
6388
6389
6390
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6387

def delete_unused_layout_slides_online(document, password = nil)
  data, _status_code, _headers = delete_unused_layout_slides_online_with_http_info(document, password)
  data
end

#delete_unused_layout_slides_online_with_http_info(document, password = nil) ⇒ Object

Removes unused layout slides.

Parameters:

  • document —

    Document data

  • password (defaults to: nil) —

    Document password.



6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6395

def delete_unused_layout_slides_online_with_http_info(document, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_unused_layout_slides_online ...'
  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 SlidesApi.delete_unused_layout_slides_online"
  end
  # resource path
  local_var_path = '/slides/layoutSlides/delete'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_unused_layout_slides_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Removes unused layout slides.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6342

def delete_unused_layout_slides_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_unused_layout_slides ...'
  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 SlidesApi.delete_unused_layout_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/layoutSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_unused_master_slides(name, ignore_preserve_field = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes unused master slides.

Parameters:

  • name —

    Document name.

  • ignore_preserve_field (defaults to: nil) —

    Determines, whether this method should remove unused master even if its preserve property is set to true.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6443
6444
6445
6446
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6443

def delete_unused_master_slides(name, ignore_preserve_field = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_unused_master_slides_with_http_info(name, ignore_preserve_field, password, folder, storage)
  data
end

#delete_unused_master_slides_online(document, ignore_preserve_field = nil, password = nil) ⇒ Object

Removes unused master slides.

Parameters:

  • document —

    Document data

  • ignore_preserve_field (defaults to: nil) —

    Determines, whether this method should remove unused master even if its preserve property is set to true.

  • password (defaults to: nil) —

    Document password.



6501
6502
6503
6504
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6501

def delete_unused_master_slides_online(document, ignore_preserve_field = nil, password = nil)
  data, _status_code, _headers = delete_unused_master_slides_online_with_http_info(document, ignore_preserve_field, password)
  data
end

#delete_unused_master_slides_online_with_http_info(document, ignore_preserve_field = nil, password = nil) ⇒ Object

Removes unused master slides.

Parameters:

  • document —

    Document data

  • ignore_preserve_field (defaults to: nil) —

    Determines, whether this method should remove unused master even if its preserve property is set to true.

  • password (defaults to: nil) —

    Document password.



6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6510

def delete_unused_master_slides_online_with_http_info(document, ignore_preserve_field = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_unused_master_slides_online ...'
  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 SlidesApi.delete_unused_master_slides_online"
  end
  # resource path
  local_var_path = '/slides/masterSlides/delete'

  # query parameters
  query_params = {}
  query_params[:'ignorePreserveField'] = @api_client.prepare_for_query(ignore_preserve_field) unless ignore_preserve_field.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_unused_master_slides_with_http_info(name, ignore_preserve_field = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes unused master slides.

Parameters:

  • name —

    Document name.

  • ignore_preserve_field (defaults to: nil) —

    Determines, whether this method should remove unused master even if its preserve property is set to true.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6454

def delete_unused_master_slides_with_http_info(name, ignore_preserve_field = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_unused_master_slides ...'
  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 SlidesApi.delete_unused_master_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/masterSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'ignorePreserveField'] = @api_client.prepare_for_query(ignore_preserve_field) unless ignore_preserve_field.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?

  # 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 = nil

  # form parameters
  post_files = []

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

#delete_watermark(name, shape_name = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes shapes with name "watermark" from the presentation.

Parameters:

  • name —

    Document name.

  • shape_name (defaults to: nil) —

    Name of the watermark shape. If null, default value "watermark"is used.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6559
6560
6561
6562
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6559

def delete_watermark(name, shape_name = nil, password = nil, folder = nil, storage = nil)
  delete_watermark_with_http_info(name, shape_name, password, folder, storage)
  nil
end

#delete_watermark_online(document, shape_name = nil, password = nil) ⇒ Object

Removes shapes with name "watermark" from the presentation.

Parameters:

  • document —

    Document data.

  • shape_name (defaults to: nil) —

    Name of the watermark shape. If null, default value "watermark"is used.

  • password (defaults to: nil) —

    Document password.



6616
6617
6618
6619
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6616

def delete_watermark_online(document, shape_name = nil, password = nil)
  data, _status_code, _headers = delete_watermark_online_with_http_info(document, shape_name, password)
  data
end

#delete_watermark_online_with_http_info(document, shape_name = nil, password = nil) ⇒ Object

Removes shapes with name "watermark" from the presentation.

Parameters:

  • document —

    Document data.

  • shape_name (defaults to: nil) —

    Name of the watermark shape. If null, default value "watermark"is used.

  • password (defaults to: nil) —

    Document password.



6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6625

def delete_watermark_online_with_http_info(document, shape_name = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_watermark_online ...'
  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 SlidesApi.delete_watermark_online"
  end
  # resource path
  local_var_path = '/slides/watermark/delete'

  # query parameters
  query_params = {}
  query_params[:'shapeName'] = @api_client.prepare_for_query(shape_name) unless shape_name.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#delete_watermark_with_http_info(name, shape_name = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Removes shapes with name "watermark" from the presentation.

Parameters:

  • name —

    Document name.

  • shape_name (defaults to: nil) —

    Name of the watermark shape. If null, default value "watermark"is used.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6570

def delete_watermark_with_http_info(name, shape_name = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_watermark ...'
  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 SlidesApi.delete_watermark"
  end
  # resource path
  local_var_path = '/slides/{name}/watermark/delete'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'shapeName'] = @api_client.prepare_for_query(shape_name) unless shape_name.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?

  # 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 = nil

  # form parameters
  post_files = []

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

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

Download file

Parameters:

  • path —

    File path e.g. ‘/folder/file.ext’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID to download



6672
6673
6674
6675
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6672

def download_file(path, storage_name = nil, version_id = nil)
  data, _status_code, _headers = download_file_with_http_info(path, storage_name, version_id)
  data
end

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

Download file

Parameters:

  • path —

    File path e.g. ‘/folder/file.ext’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID to download



6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6681

def download_file_with_http_info(path, storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_file ...'
  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 SlidesApi.download_file"
  end
  # resource path
  local_var_path = '/slides/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

#download_image(name, index, format, password = nil, folder = nil, storage = nil) ⇒ Object

Get image in specified format.

Parameters:

  • name —

    Document name.

  • index —

    Image index.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6729
6730
6731
6732
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6729

def download_image(name, index, format, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = download_image_with_http_info(name, index, format, password, folder, storage)
  data
end

#download_image_default_format(name, index, password = nil, folder = nil, storage = nil) ⇒ Object

Get image binary data.

Parameters:

  • name —

    Document name.

  • index —

    Image index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6803
6804
6805
6806
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6803

def download_image_default_format(name, index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = download_image_default_format_with_http_info(name, index, password, folder, storage)
  data
end

#download_image_default_format_online(document, index, password = nil) ⇒ Object

Get image binary data.

Parameters:

  • document —

    Document data.

  • index —

    Image index.

  • password (defaults to: nil) —

    Document password.



6865
6866
6867
6868
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6865

def download_image_default_format_online(document, index, password = nil)
  data, _status_code, _headers = download_image_default_format_online_with_http_info(document, index, password)
  data
end

#download_image_default_format_online_with_http_info(document, index, password = nil) ⇒ Object

Get image binary data.

Parameters:

  • document —

    Document data.

  • index —

    Image index.

  • password (defaults to: nil) —

    Document password.



6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6874

def download_image_default_format_online_with_http_info(document, index, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_image_default_format_online ...'
  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 SlidesApi.download_image_default_format_online"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling SlidesApi.download_image_default_format_online"
  end
  # resource path
  local_var_path = '/slides/images/{index}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'index', index)

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_image_default_format_with_http_info(name, index, password = nil, folder = nil, storage = nil) ⇒ Object

Get image binary data.

Parameters:

  • name —

    Document name.

  • index —

    Image index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6814

def download_image_default_format_with_http_info(name, index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_image_default_format ...'
  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 SlidesApi.download_image_default_format"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling SlidesApi.download_image_default_format"
  end
  # resource path
  local_var_path = '/slides/{name}/images/{index}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'index', index)

  # 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?

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # 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

#download_image_online(document, index, format, password = nil) ⇒ Object

Get image in specified format.

Parameters:

  • document —

    Document data.

  • index —

    Image index.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.



6926
6927
6928
6929
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6926

def download_image_online(document, index, format, password = nil)
  data, _status_code, _headers = download_image_online_with_http_info(document, index, format, password)
  data
end

#download_image_online_with_http_info(document, index, format, password = nil) ⇒ Object

Get image in specified format.

Parameters:

  • document —

    Document data.

  • index —

    Image index.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.



6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6936

def download_image_online_with_http_info(document, index, format, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_image_online ...'
  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 SlidesApi.download_image_online"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling SlidesApi.download_image_online"
  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 SlidesApi.download_image_online"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff"
  end
  # resource path
  local_var_path = '/slides/images/{index}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'index', index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_image_with_http_info(name, index, format, password = nil, folder = nil, storage = nil) ⇒ Object

Get image in specified format.

Parameters:

  • name —

    Document name.

  • index —

    Image index.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6741

def download_image_with_http_info(name, index, format, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_image ...'
  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 SlidesApi.download_image"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling SlidesApi.download_image"
  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 SlidesApi.download_image"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff"
  end
  # resource path
  local_var_path = '/slides/{name}/images/{index}/{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, 'index', index)
  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?

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # 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

#download_images(name, format, password = nil, folder = nil, storage = nil) ⇒ Object

Get all presentation images in specified format.

Parameters:

  • name
  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6998
6999
7000
7001
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6998

def download_images(name, format, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = download_images_with_http_info(name, format, password, folder, storage)
  data
end

#download_images_default_format(name, password = nil, folder = nil, storage = nil) ⇒ Object

Get all presentation images.

Parameters:

  • name
  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



7065
7066
7067
7068
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7065

def download_images_default_format(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = download_images_default_format_with_http_info(name, password, folder, storage)
  data
end

#download_images_default_format_online(document, password = nil) ⇒ Object

Get all presentation images.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



7120
7121
7122
7123
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7120

def download_images_default_format_online(document, password = nil)
  data, _status_code, _headers = download_images_default_format_online_with_http_info(document, password)
  data
end

#download_images_default_format_online_with_http_info(document, password = nil) ⇒ Object

Get all presentation images.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7128

def download_images_default_format_online_with_http_info(document, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_images_default_format_online ...'
  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 SlidesApi.download_images_default_format_online"
  end
  # resource path
  local_var_path = '/slides/images/download'

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_images_default_format_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Get all presentation images.

Parameters:

  • name
  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7075

def download_images_default_format_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_images_default_format ...'
  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 SlidesApi.download_images_default_format"
  end
  # resource path
  local_var_path = '/slides/{name}/images/download'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_images_online(document, format, password = nil) ⇒ Object

Get all presentation images in specified format.

Parameters:

  • document —

    Document data.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.



7174
7175
7176
7177
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7174

def download_images_online(document, format, password = nil)
  data, _status_code, _headers = download_images_online_with_http_info(document, format, password)
  data
end

#download_images_online_with_http_info(document, format, password = nil) ⇒ Object

Get all presentation images in specified format.

Parameters:

  • document —

    Document data.

  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.



7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7183

def download_images_online_with_http_info(document, format, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_images_online ...'
  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 SlidesApi.download_images_online"
  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 SlidesApi.download_images_online"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff"
  end
  # resource path
  local_var_path = '/slides/images/download/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_images_with_http_info(name, format, password = nil, folder = nil, storage = nil) ⇒ Object

Get all presentation images in specified format.

Parameters:

  • name
  • format —

    Export format (png, jpg, gif).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7009

def download_images_with_http_info(name, format, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_images ...'
  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 SlidesApi.download_images"
  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 SlidesApi.download_images"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff"
  end
  # resource path
  local_var_path = '/slides/{name}/images/download/{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?

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_notes_slide(name, slide_index, format, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Convert notes slide to the specified image format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format.

  • height (defaults to: nil) —

    The height of the slide representation in the output format

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7244
7245
7246
7247
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7244

def download_notes_slide(name, slide_index, format, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = download_notes_slide_with_http_info(name, slide_index, format, width, height, password, folder, storage, fonts_folder)
  data
end

#download_notes_slide_online(document, slide_index, format, width = nil, height = nil, password = nil, fonts_folder = nil) ⇒ Object

Convert notes slide to the specified image format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format.

  • height (defaults to: nil) —

    The height of the slide representation in the output format.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7326
7327
7328
7329
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7326

def download_notes_slide_online(document, slide_index, format, width = nil, height = nil, password = nil, fonts_folder = nil)
  data, _status_code, _headers = download_notes_slide_online_with_http_info(document, slide_index, format, width, height, password, fonts_folder)
  data
end

#download_notes_slide_online_with_http_info(document, slide_index, format, width = nil, height = nil, password = nil, fonts_folder = nil) ⇒ Object

Convert notes slide to the specified image format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format.

  • height (defaults to: nil) —

    The height of the slide representation in the output format.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7339

def download_notes_slide_online_with_http_info(document, slide_index, format, width = nil, height = nil, password = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_notes_slide_online ...'
  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 SlidesApi.download_notes_slide_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_notes_slide_online"
  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 SlidesApi.download_notes_slide_online"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/notesSlide/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  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[:'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(['multipart/form-data'])
  # 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 = nil

  # 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 => 'File')
  return data, status_code, headers
end

#download_notes_slide_with_http_info(name, slide_index, format, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Convert notes slide to the specified image format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format.

  • height (defaults to: nil) —

    The height of the slide representation in the output format

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7259

def download_notes_slide_with_http_info(name, slide_index, format, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_notes_slide ...'
  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 SlidesApi.download_notes_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_notes_slide"
  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 SlidesApi.download_notes_slide"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide/{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, 'slideIndex', slide_index)
  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[:'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(['multipart/form-data'])
  # 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 = 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

#download_portion_as_math_ml(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Convert Mathematical Text to MathML Format

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



7407
7408
7409
7410
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7407

def download_portion_as_math_ml(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = download_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password, folder, storage)
  data
end

#download_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Convert Mathematical Text to MathML Format

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7421

def download_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_portion_as_math_ml ...'
  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 SlidesApi.download_portion_as_math_ml"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_portion_as_math_ml"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.download_portion_as_math_ml"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.download_portion_as_math_ml"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.download_portion_as_math_ml"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}/mathml'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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?

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

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

Save a presentation to a specified format.

Parameters:

  • name —

    Document name.

  • format —

    Export format.

  • options (defaults to: nil) —

    Export options.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be saved. If not specified, all slides are saved by default.



7492
7493
7494
7495
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7492

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

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

Save a presentation to a specified format.

Parameters:

  • name —

    Document name.

  • format —

    Export format.

  • options (defaults to: nil) —

    Export options.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be saved. If not specified, all slides are saved by default.



7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7506

def 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: SlidesApi.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 SlidesApi.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 SlidesApi.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'].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"
  end
  # resource path
  local_var_path = '/slides/{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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#download_shape(name, slide_index, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



7573
7574
7575
7576
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7573

def download_shape(name, slide_index, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  data, _status_code, _headers = download_shape_with_http_info(name, slide_index, shape_index, format, options, scale_x, scale_y, bounds, password, folder, storage, fonts_folder, sub_shape)
  data
end

#download_shape_online(document, slide_index, shape_index, format, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • options (defaults to: nil) —

    Export options.



7673
7674
7675
7676
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7673

def download_shape_online(document, slide_index, shape_index, format, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  data, _status_code, _headers = download_shape_online_with_http_info(document, slide_index, shape_index, format, scale_x, scale_y, bounds, password, storage, fonts_folder, options)
  data
end

#download_shape_online_with_http_info(document, slide_index, shape_index, format, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • options (defaults to: nil) —

    Export options.



7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7690

def download_shape_online_with_http_info(document, slide_index, shape_index, format, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_shape_online ...'
  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 SlidesApi.download_shape_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_shape_online"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.download_shape_online"
  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 SlidesApi.download_shape_online"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/shapes/{shapeIndex}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#download_shape_with_http_info(name, slide_index, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7592

def download_shape_with_http_info(name, slide_index, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_shape ...'
  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 SlidesApi.download_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_shape"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.download_shape"
  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 SlidesApi.download_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/{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, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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'])
  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 => 'File')
  return data, status_code, headers
end

#download_slide(name, slide_index, format, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • options (defaults to: nil) —

    Export options.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7770
7771
7772
7773
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7770

def download_slide(name, slide_index, format, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = download_slide_with_http_info(name, slide_index, format, options, width, height, password, folder, storage, fonts_folder)
  data
end

#download_slide_online(document, slide_index, format, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.

  • options (defaults to: nil) —

    Export options.



7855
7856
7857
7858
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7855

def download_slide_online(document, slide_index, format, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  data, _status_code, _headers = download_slide_online_with_http_info(document, slide_index, format, width, height, password, storage, fonts_folder, options)
  data
end

#download_slide_online_with_http_info(document, slide_index, format, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.

  • options (defaults to: nil) —

    Export options.



7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7870

def download_slide_online_with_http_info(document, slide_index, format, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_slide_online ...'
  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 SlidesApi.download_slide_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_slide_online"
  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 SlidesApi.download_slide_online"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  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[:'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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#download_slide_with_http_info(name, slide_index, format, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • options (defaults to: nil) —

    Export options.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7786

def download_slide_with_http_info(name, slide_index, format, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_slide ...'
  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 SlidesApi.download_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_slide"
  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 SlidesApi.download_slide"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{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, 'slideIndex', slide_index)
  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[:'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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#download_special_slide_shape(name, slide_index, slide_type, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • options (defaults to: nil) —

    Export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



7945
7946
7947
7948
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7945

def download_special_slide_shape(name, slide_index, slide_type, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  data, _status_code, _headers = download_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, options, scale_x, scale_y, bounds, password, folder, storage, fonts_folder, sub_shape)
  data
end

#download_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • options (defaults to: nil) —

    Export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7965

def download_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_special_slide_shape ...'
  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 SlidesApi.download_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.download_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.download_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.download_special_slide_shape"
  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 SlidesApi.download_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/{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, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'format', format)

  # query parameters
  query_params = {}
  query_params[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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'])
  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 => 'File')
  return data, status_code, headers
end

#get_animation(name, slide_index, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide animation effects.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index (defaults to: nil) —

    Shape index. If specified, only effects related to that shape are returned.

  • paragraph_index (defaults to: nil) —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8051
8052
8053
8054
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8051

def get_animation(name, slide_index, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_animation_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage)
  data
end

#get_animation_with_http_info(name, slide_index, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide animation effects.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index (defaults to: nil) —

    Shape index. If specified, only effects related to that shape are returned.

  • paragraph_index (defaults to: nil) —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8064

def get_animation_with_http_info(name, slide_index, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_animation ...'
  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 SlidesApi.get_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_animation"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'shapeIndex'] = @api_client.prepare_for_query(shape_index) unless shape_index.nil?
  query_params[:'paragraphIndex'] = @api_client.prepare_for_query(paragraph_index) unless paragraph_index.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?

  # 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 = 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 => 'SlideAnimation')
  return data, status_code, headers
end

#get_api_info ⇒ Object

Get API info.



8114
8115
8116
8117
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8114

def get_api_info()
  data, _status_code, _headers = get_api_info_with_http_info
  data
end

#get_api_info_with_http_info ⇒ Object

Get API info.



8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8120

def get_api_info_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_api_info ...'
  end

  # resource path
  local_var_path = '/slides/info'

  # 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 => 'ApiInfo')
  return data, status_code, headers
end

#get_background(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide background info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8160
8161
8162
8163
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8160

def get_background(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_background_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_background_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide background info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8171

def get_background_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_background ...'
  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 SlidesApi.get_background"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_background"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/background'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'SlideBackground')
  return data, status_code, headers
end

#get_color_scheme(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme color scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8224
8225
8226
8227
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8224

def get_color_scheme(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_color_scheme_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_color_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme color scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8235

def get_color_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_color_scheme ...'
  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 SlidesApi.get_color_scheme"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_color_scheme"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/theme/colorScheme'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'ColorScheme')
  return data, status_code, headers
end

#get_disc_usage(storage_name = nil) ⇒ Object

Get disc usage

Parameters:

  • storage_name (defaults to: nil) —

    Storage name



8284
8285
8286
8287
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8284

def get_disc_usage(storage_name = nil)
  data, _status_code, _headers = get_disc_usage_with_http_info(storage_name)
  data
end

#get_disc_usage_with_http_info(storage_name = nil) ⇒ Object

Get disc usage

Parameters:

  • storage_name (defaults to: nil) —

    Storage name



8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8291

def get_disc_usage_with_http_info(storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_disc_usage ...'
  end

  # resource path
  local_var_path = '/slides/storage/disc'

  # 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(['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 => 'DiscUsage')
  return data, status_code, headers
end

#get_document_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation document properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8331
8332
8333
8334
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8331

def get_document_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_document_properties_with_http_info(name, password, folder, storage)
  data
end

#get_document_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation document properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8341

def get_document_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_document_properties ...'
  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 SlidesApi.get_document_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'DocumentProperties')
  return data, status_code, headers
end

#get_document_property(name, property_name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8389
8390
8391
8392
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8389

def get_document_property(name, property_name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_document_property_with_http_info(name, property_name, password, folder, storage)
  data
end

#get_document_property_with_http_info(name, property_name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8400

def get_document_property_with_http_info(name, property_name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_document_property ...'
  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 SlidesApi.get_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling SlidesApi.get_document_property"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties/{propertyName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'propertyName', property_name)

  # 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?

  # 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 = 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 => 'DocumentProperty')
  return data, status_code, headers
end

#get_file_versions(path, storage_name = nil) ⇒ Object

Get file versions

Parameters:

  • path —

    File path e.g. ‘/file.ext’

  • storage_name (defaults to: nil) —

    Storage name



8450
8451
8452
8453
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8450

def get_file_versions(path, storage_name = nil)
  data, _status_code, _headers = get_file_versions_with_http_info(path, storage_name)
  data
end

#get_file_versions_with_http_info(path, storage_name = nil) ⇒ Object

Get file versions

Parameters:

  • path —

    File path e.g. ‘/file.ext’

  • storage_name (defaults to: nil) —

    Storage name



8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8458

def get_file_versions_with_http_info(path, storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_file_versions ...'
  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 SlidesApi.get_file_versions"
  end
  # resource path
  local_var_path = '/slides/storage/version/{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(['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 => 'FileVersions')
  return data, status_code, headers
end

#get_files_list(path, storage_name = nil) ⇒ Object

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name



8501
8502
8503
8504
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8501

def get_files_list(path, storage_name = nil)
  data, _status_code, _headers = get_files_list_with_http_info(path, storage_name)
  data
end

#get_files_list_with_http_info(path, storage_name = nil) ⇒ Object

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name



8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8509

def get_files_list_with_http_info(path, storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_files_list ...'
  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 SlidesApi.get_files_list"
  end
  # resource path
  local_var_path = '/slides/storage/folder/{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(['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 => 'FilesList')
  return data, status_code, headers
end

#get_font_scheme(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme font scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8555
8556
8557
8558
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8555

def get_font_scheme(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_font_scheme_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_font_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme font scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8566

def get_font_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_font_scheme ...'
  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 SlidesApi.get_font_scheme"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_font_scheme"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/theme/fontScheme'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'FontScheme')
  return data, status_code, headers
end

#get_fonts(name, password = nil, folder = nil, storage = nil) ⇒ Object

Returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8618
8619
8620
8621
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8618

def get_fonts(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_fonts_with_http_info(name, password, folder, storage)
  data
end

#get_fonts_online(document, password = nil) ⇒ Object

Returns presentation fonts info.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



8673
8674
8675
8676
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8673

def get_fonts_online(document, password = nil)
  data, _status_code, _headers = get_fonts_online_with_http_info(document, password)
  data
end

#get_fonts_online_with_http_info(document, password = nil) ⇒ Object

Returns presentation fonts info.

Parameters:

  • document —

    Document data.

  • password (defaults to: nil) —

    Document password.



8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8681

def get_fonts_online_with_http_info(document, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_fonts_online ...'
  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 SlidesApi.get_fonts_online"
  end
  # resource path
  local_var_path = '/slides/fonts'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'FontsData')
  return data, status_code, headers
end

#get_fonts_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8628

def get_fonts_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_fonts ...'
  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 SlidesApi.get_fonts"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'FontsData')
  return data, status_code, headers
end

#get_format_scheme(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme format scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8729
8730
8731
8732
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8729

def get_format_scheme(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_format_scheme_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_format_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme format scheme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8740

def get_format_scheme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_format_scheme ...'
  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 SlidesApi.get_format_scheme"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_format_scheme"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/theme/formatScheme'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'FormatScheme')
  return data, status_code, headers
end

#get_layout_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation layoutSlide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8793
8794
8795
8796
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8793

def get_layout_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_layout_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_layout_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation layoutSlide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8804

def get_layout_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_layout_slide ...'
  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 SlidesApi.get_layout_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_layout_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/layoutSlides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'LayoutSlide')
  return data, status_code, headers
end

#get_layout_slides(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation layoutSlides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8856
8857
8858
8859
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8856

def get_layout_slides(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_layout_slides_with_http_info(name, password, folder, storage)
  data
end

#get_layout_slides_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation layoutSlides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8866

def get_layout_slides_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_layout_slides ...'
  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 SlidesApi.get_layout_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/layoutSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'LayoutSlides')
  return data, status_code, headers
end

#get_master_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation masterSlide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8914
8915
8916
8917
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8914

def get_master_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_master_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_master_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation masterSlide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8925

def get_master_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_master_slide ...'
  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 SlidesApi.get_master_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_master_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/masterSlides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'MasterSlide')
  return data, status_code, headers
end

#get_master_slides(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation masterSlides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8977
8978
8979
8980
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8977

def get_master_slides(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_master_slides_with_http_info(name, password, folder, storage)
  data
end

#get_master_slides_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation masterSlides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8987

def get_master_slides_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_master_slides ...'
  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 SlidesApi.get_master_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/masterSlides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'MasterSlides')
  return data, status_code, headers
end

#get_notes_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read notes slide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9035
9036
9037
9038
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9035

def get_notes_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_notes_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_notes_slide_header_footer(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get header/footer info for the notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9099
9100
9101
9102
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9099

def get_notes_slide_header_footer(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_notes_slide_header_footer_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_notes_slide_header_footer_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get header/footer info for the notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9110

def get_notes_slide_header_footer_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_notes_slide_header_footer ...'
  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 SlidesApi.get_notes_slide_header_footer"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_notes_slide_header_footer"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide/headerFooter'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'NotesSlideHeaderFooter')
  return data, status_code, headers
end

#get_notes_slide_online(document, slide_index, password = nil) ⇒ Object

Read notes slide info.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.



9161
9162
9163
9164
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9161

def get_notes_slide_online(document, slide_index, password = nil)
  data, _status_code, _headers = get_notes_slide_online_with_http_info(document, slide_index, password)
  data
end

#get_notes_slide_online_with_http_info(document, slide_index, password = nil) ⇒ Object

Read notes slide info.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.



9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9170

def get_notes_slide_online_with_http_info(document, slide_index, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_notes_slide_online ...'
  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 SlidesApi.get_notes_slide_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_notes_slide_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/notesSlide'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'NotesSlide')
  return data, status_code, headers
end

#get_notes_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read notes slide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9046

def get_notes_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_notes_slide ...'
  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 SlidesApi.get_notes_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_notes_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'NotesSlide')
  return data, status_code, headers
end

#get_paragraph(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9226
9227
9228
9229
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9226

def get_paragraph(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#get_paragraph_effective(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read effective paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9307
9308
9309
9310
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9307

def get_paragraph_effective(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_paragraph_effective_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#get_paragraph_effective_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read effective paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9321

def get_paragraph_effective_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_paragraph_effective ...'
  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 SlidesApi.get_paragraph_effective"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_paragraph_effective"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_paragraph_effective"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_paragraph_effective"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/effective'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Paragraph')
  return data, status_code, headers
end

#get_paragraph_rectangle(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9387
9388
9389
9390
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9387

def get_paragraph_rectangle(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_paragraph_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage)
  data
end

#get_paragraph_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9400

def get_paragraph_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_paragraph_rectangle ...'
  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 SlidesApi.get_paragraph_rectangle"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_paragraph_rectangle"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_paragraph_rectangle"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_paragraph_rectangle"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/bounds'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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?

  # 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 = 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 => 'TextBounds')
  return data, status_code, headers
end

#get_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9240

def get_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_paragraph ...'
  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 SlidesApi.get_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_paragraph"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Paragraph')
  return data, status_code, headers
end

#get_paragraphs(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraphs info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9465
9466
9467
9468
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9465

def get_paragraphs(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_paragraphs_with_http_info(name, slide_index, shape_index, password, folder, storage, sub_shape)
  data
end

#get_paragraphs_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraphs info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9478

def get_paragraphs_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_paragraphs ...'
  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 SlidesApi.get_paragraphs"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_paragraphs"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_paragraphs"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Paragraphs')
  return data, status_code, headers
end

#get_placeholder(name, slide_index, placeholder_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide placeholder info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • placeholder_index —

    Placeholder index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9538
9539
9540
9541
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9538

def get_placeholder(name, slide_index, placeholder_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_placeholder_with_http_info(name, slide_index, placeholder_index, password, folder, storage)
  data
end

#get_placeholder_with_http_info(name, slide_index, placeholder_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide placeholder info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • placeholder_index —

    Placeholder index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9550

def get_placeholder_with_http_info(name, slide_index, placeholder_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_placeholder ...'
  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 SlidesApi.get_placeholder"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_placeholder"
  end
  # verify the required parameter 'placeholder_index' is set
  if @api_client.config.client_side_validation && placeholder_index.nil?
    fail ArgumentError, "Missing the required parameter 'placeholder_index' when calling SlidesApi.get_placeholder"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/placeholders/{placeholderIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'placeholderIndex', placeholder_index)

  # 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?

  # 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 = 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 => 'Placeholder')
  return data, status_code, headers
end

#get_placeholders(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide placeholders info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9608
9609
9610
9611
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9608

def get_placeholders(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_placeholders_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_placeholders_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide placeholders info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9619

def get_placeholders_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_placeholders ...'
  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 SlidesApi.get_placeholders"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_placeholders"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/placeholders'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'Placeholders')
  return data, status_code, headers
end

#get_portion(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9676
9677
9678
9679
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9676

def get_portion(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password, folder, storage, sub_shape)
  data
end

#get_portion_effective(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read effective portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9764
9765
9766
9767
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9764

def get_portion_effective(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_portion_effective_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password, folder, storage, sub_shape)
  data
end

#get_portion_effective_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read effective portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9779

def get_portion_effective_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_portion_effective ...'
  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 SlidesApi.get_portion_effective"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_portion_effective"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_portion_effective"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_portion_effective"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.get_portion_effective"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}/effective'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Portion')
  return data, status_code, headers
end

#get_portion_rectangle(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9851
9852
9853
9854
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9851

def get_portion_rectangle(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_portion_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password, folder, storage)
  data
end

#get_portion_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Return coordinates of rect that bounds paragraph. The rect includes all the lines of text in paragraph, including empty ones.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9865

def get_portion_rectangle_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_portion_rectangle ...'
  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 SlidesApi.get_portion_rectangle"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_portion_rectangle"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_portion_rectangle"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_portion_rectangle"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.get_portion_rectangle"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}/bounds'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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?

  # 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 = 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 => 'TextBounds')
  return data, status_code, headers
end

#get_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9691

def get_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_portion ...'
  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 SlidesApi.get_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_portion"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.get_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Portion')
  return data, status_code, headers
end

#get_portions(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portions info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9936
9937
9938
9939
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9936

def get_portions(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_portions_with_http_info(name, slide_index, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#get_portions_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portions info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9950

def get_portions_with_http_info(name, slide_index, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_portions ...'
  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 SlidesApi.get_portions"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_portions"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_portions"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_portions"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Portions')
  return data, status_code, headers
end

#get_presentation(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10013
10014
10015
10016
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10013

def get_presentation(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_presentation_with_http_info(name, password, folder, storage)
  data
end

#get_presentation_images(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation images info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10070
10071
10072
10073
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10070

def get_presentation_images(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_presentation_images_with_http_info(name, password, folder, storage)
  data
end

#get_presentation_images_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation images info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10080

def get_presentation_images_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_presentation_images ...'
  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 SlidesApi.get_presentation_images"
  end
  # resource path
  local_var_path = '/slides/{name}/images'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'Images')
  return data, status_code, headers
end

#get_presentation_text_items(name, with_empty = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Extract presentation text items.

Parameters:

  • name —

    Document name.

  • with_empty (defaults to: nil) —

    True to incude empty items.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10128
10129
10130
10131
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10128

def get_presentation_text_items(name, with_empty = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_presentation_text_items_with_http_info(name, with_empty, password, folder, storage)
  data
end

#get_presentation_text_items_with_http_info(name, with_empty = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Extract presentation text items.

Parameters:

  • name —

    Document name.

  • with_empty (defaults to: nil) —

    True to incude empty items.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10139

def get_presentation_text_items_with_http_info(name, with_empty = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_presentation_text_items ...'
  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 SlidesApi.get_presentation_text_items"
  end
  # resource path
  local_var_path = '/slides/{name}/textItems'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = @api_client.prepare_for_query(with_empty) unless with_empty.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?

  # 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 = 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 => 'TextItems')
  return data, status_code, headers
end

#get_presentation_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10023

def get_presentation_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_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 SlidesApi.get_presentation"
  end
  # resource path
  local_var_path = '/slides/{name}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'Document')
  return data, status_code, headers
end

#get_protection_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation protection properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10187
10188
10189
10190
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10187

def get_protection_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_protection_properties_with_http_info(name, password, folder, storage)
  data
end

#get_protection_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation protection properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10197

def get_protection_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_protection_properties ...'
  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 SlidesApi.get_protection_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/protection'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'ProtectionProperties')
  return data, status_code, headers
end

#get_sections(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation sections info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10244
10245
10246
10247
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10244

def get_sections(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_sections_with_http_info(name, password, folder, storage)
  data
end

#get_sections_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation sections info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10254

def get_sections_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_sections ...'
  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 SlidesApi.get_sections"
  end
  # resource path
  local_var_path = '/slides/{name}/sections'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'Sections')
  return data, status_code, headers
end

#get_shape(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read slide shape info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



10304
10305
10306
10307
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10304

def get_shape(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_shape_with_http_info(name, slide_index, shape_index, password, folder, storage, sub_shape)
  data
end

#get_shape_geometry_path(name, slide_index, shape_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns geometry path of the shape

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10377
10378
10379
10380
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10377

def get_shape_geometry_path(name, slide_index, shape_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_shape_geometry_path_with_http_info(name, slide_index, shape_index, password, folder, storage)
  data
end

#get_shape_geometry_path_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns geometry path of the shape

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10389

def get_shape_geometry_path_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_shape_geometry_path ...'
  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 SlidesApi.get_shape_geometry_path"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_shape_geometry_path"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_shape_geometry_path"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/geometryPath'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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?

  # 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 = 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 => 'GeometryPaths')
  return data, status_code, headers
end

#get_shape_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read slide shape info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10317

def get_shape_with_http_info(name, slide_index, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_shape ...'
  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 SlidesApi.get_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_shape"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'ShapeBase')
  return data, status_code, headers
end

#get_shapes(name, slide_index, password = nil, folder = nil, storage = nil, shape_type = nil, sub_shape = nil) ⇒ Object

Read slide shapes info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • shape_type (defaults to: nil) —

    Shape type.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



10449
10450
10451
10452
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10449

def get_shapes(name, slide_index, password = nil, folder = nil, storage = nil, shape_type = nil, sub_shape = nil)
  data, _status_code, _headers = get_shapes_with_http_info(name, slide_index, password, folder, storage, shape_type, sub_shape)
  data
end

#get_shapes_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil, shape_type = nil, sub_shape = nil) ⇒ Object

Read slide shapes info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • shape_type (defaults to: nil) —

    Shape type.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10462

def get_shapes_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil, shape_type = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_shapes ...'
  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 SlidesApi.get_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_shapes"
  end
  if @api_client.config.client_side_validation && shape_type && !['Shape', 'Chart', 'Table', 'PictureFrame', 'VideoFrame', 'AudioFrame', 'SmartArt', 'OleObjectFrame', 'GroupShape', 'GraphicalObject', 'Connector', 'SmartArtShape', 'ZoomFrame', 'SectionZoomFrame', 'SummaryZoomFrame', 'SummaryZoomSection'].any?{ |s| s.casecmp(shape_type)==0 }
    fail ArgumentError, "Invalid value for parameter shape_type: " + shape_type + ". Must be one of Shape, Chart, Table, PictureFrame, VideoFrame, AudioFrame, SmartArt, OleObjectFrame, GroupShape, GraphicalObject, Connector, SmartArtShape, ZoomFrame, SectionZoomFrame, SummaryZoomFrame, SummaryZoomSection"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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[:'shapeType'] = @api_client.prepare_for_query(shape_type) unless shape_type.nil?
  query_params[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Shapes')
  return data, status_code, headers
end

#get_slide(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10520
10521
10522
10523
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10520

def get_slide(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_slide_comments(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide comments.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10584
10585
10586
10587
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10584

def get_slide_comments(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_comments_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_slide_comments_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide comments.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10595

def get_slide_comments_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_comments ...'
  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 SlidesApi.get_slide_comments"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_slide_comments"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/comments'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'SlideComments')
  return data, status_code, headers
end

#get_slide_header_footer(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get footer info for the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10648
10649
10650
10651
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10648

def get_slide_header_footer(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_header_footer_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_slide_header_footer_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get footer info for the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10659

def get_slide_header_footer_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_header_footer ...'
  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 SlidesApi.get_slide_header_footer"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_slide_header_footer"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/headerFooter'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'HeaderFooter')
  return data, status_code, headers
end

#get_slide_images(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide images info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10712
10713
10714
10715
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10712

def get_slide_images(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_images_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_slide_images_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide images info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10723

def get_slide_images_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_images ...'
  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 SlidesApi.get_slide_images"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_slide_images"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/images'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'Images')
  return data, status_code, headers
end

#get_slide_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10775
10776
10777
10778
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10775

def get_slide_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_properties_with_http_info(name, password, folder, storage)
  data
end

#get_slide_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10785

def get_slide_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_properties ...'
  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 SlidesApi.get_slide_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/slideProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'SlideProperties')
  return data, status_code, headers
end

#get_slide_show_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide show properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10832
10833
10834
10835
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10832

def get_slide_show_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_show_properties_with_http_info(name, password, folder, storage)
  data
end

#get_slide_show_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide show properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10842

def get_slide_show_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_show_properties ...'
  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 SlidesApi.get_slide_show_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/slideShowProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'SlideShowProperties')
  return data, status_code, headers
end

#get_slide_text_items(name, slide_index, with_empty = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Extract slide text items.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • with_empty (defaults to: nil) —

    True to include empty items.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10891
10892
10893
10894
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10891

def get_slide_text_items(name, slide_index, with_empty = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slide_text_items_with_http_info(name, slide_index, with_empty, password, folder, storage)
  data
end

#get_slide_text_items_with_http_info(name, slide_index, with_empty = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Extract slide text items.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • with_empty (defaults to: nil) —

    True to include empty items.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10903

def get_slide_text_items_with_http_info(name, slide_index, with_empty = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_text_items ...'
  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 SlidesApi.get_slide_text_items"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_slide_text_items"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/textItems'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = @api_client.prepare_for_query(with_empty) unless with_empty.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?

  # 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 = 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 => 'TextItems')
  return data, status_code, headers
end

#get_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slide info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10531

def get_slide_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide ...'
  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 SlidesApi.get_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'Slide')
  return data, status_code, headers
end

#get_slides(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10956
10957
10958
10959
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10956

def get_slides(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_slides_with_http_info(name, password, folder, storage)
  data
end

#get_slides_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation slides info.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10966

def get_slides_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slides ...'
  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 SlidesApi.get_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/slides'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'Slides')
  return data, status_code, headers
end

#get_special_slide_animation(name, slide_index, slide_type, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Read special slide (master, layout, notes) animation effects.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index (defaults to: nil) —

    Shape index. If specified, only effects related to that shape are returned.

  • paragraph_index (defaults to: nil) —

    Paragraph index. If specified, only effects related to that paragraph are returned.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11017
11018
11019
11020
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11017

def get_special_slide_animation(name, slide_index, slide_type, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_special_slide_animation_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password, folder, storage)
  data
end

#get_special_slide_animation_with_http_info(name, slide_index, slide_type, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Read special slide (master, layout, notes) animation effects.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index (defaults to: nil) —

    Shape index. If specified, only effects related to that shape are returned.

  • paragraph_index (defaults to: nil) —

    Paragraph index. If specified, only effects related to that paragraph are returned.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11031

def get_special_slide_animation_with_http_info(name, slide_index, slide_type, shape_index = nil, paragraph_index = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_animation ...'
  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 SlidesApi.get_special_slide_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_animation"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_animation"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # query parameters
  query_params = {}
  query_params[:'shapeIndex'] = @api_client.prepare_for_query(shape_index) unless shape_index.nil?
  query_params[:'paragraphIndex'] = @api_client.prepare_for_query(paragraph_index) unless paragraph_index.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?

  # 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 = 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 => 'SlideAnimation')
  return data, status_code, headers
end

#get_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11099
11100
11101
11102
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11099

def get_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#get_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read shape paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11114

def get_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_paragraph ...'
  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 SlidesApi.get_special_slide_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_paragraph"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_paragraph"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_special_slide_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_special_slide_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Paragraph')
  return data, status_code, headers
end

#get_special_slide_paragraphs(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special shape paragraphs info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11190
11191
11192
11193
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11190

def get_special_slide_paragraphs(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, password, folder, storage, sub_shape)
  data
end

#get_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special shape paragraphs info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11204

def get_special_slide_paragraphs_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_paragraphs ...'
  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 SlidesApi.get_special_slide_paragraphs"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_paragraphs"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_paragraphs"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_special_slide_paragraphs"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Paragraphs')
  return data, status_code, headers
end

#get_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11277
11278
11279
11280
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11277

def get_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password, folder, storage, sub_shape)
  data
end

#get_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portion info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11293

def get_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_portion ...'
  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 SlidesApi.get_special_slide_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_portion"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_portion"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_special_slide_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_special_slide_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.get_special_slide_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Portion')
  return data, status_code, headers
end

#get_special_slide_portions(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portions info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11375
11376
11377
11378
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11375

def get_special_slide_portions(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password, folder, storage, sub_shape)
  data
end

#get_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read paragraph portions info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11390

def get_special_slide_portions_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_portions ...'
  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 SlidesApi.get_special_slide_portions"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_portions"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_portions"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_special_slide_portions"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.get_special_slide_portions"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Portions')
  return data, status_code, headers
end

#get_special_slide_shape(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special slide shape info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11466
11467
11468
11469
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11466

def get_special_slide_shape(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password, folder, storage, sub_shape)
  data
end

#get_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special slide shape info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11480

def get_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_shape ...'
  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 SlidesApi.get_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.get_special_slide_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'ShapeBase')
  return data, status_code, headers
end

#get_special_slide_shapes(name, slide_index, slide_type, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special slide shapes info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11550
11551
11552
11553
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11550

def get_special_slide_shapes(name, slide_index, slide_type, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = get_special_slide_shapes_with_http_info(name, slide_index, slide_type, password, folder, storage, sub_shape)
  data
end

#get_special_slide_shapes_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Read special slide shapes info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11563

def get_special_slide_shapes_with_http_info(name, slide_index, slide_type, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_special_slide_shapes ...'
  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 SlidesApi.get_special_slide_shapes"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_special_slide_shapes"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.get_special_slide_shapes"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 = 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 => 'Shapes')
  return data, status_code, headers
end

#get_theme(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11626
11627
11628
11629
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11626

def get_theme(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_theme_with_http_info(name, slide_index, password, folder, storage)
  data
end

#get_theme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Read slide theme info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11637

def get_theme_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_theme ...'
  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 SlidesApi.get_theme"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.get_theme"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/theme'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'Theme')
  return data, status_code, headers
end

#get_view_properties(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation view properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11689
11690
11691
11692
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11689

def get_view_properties(name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_view_properties_with_http_info(name, password, folder, storage)
  data
end

#get_view_properties_with_http_info(name, password = nil, folder = nil, storage = nil) ⇒ Object

Read presentation view properties.

Parameters:

  • name —

    Document name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11699

def get_view_properties_with_http_info(name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_view_properties ...'
  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 SlidesApi.get_view_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/viewProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = 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 => 'ViewProperties')
  return data, status_code, headers
end

#highlight_shape_regex(name, slide_index, shape_index, regex, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Highlight all matches of sample in text frame text using specified color.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • regex —

    Regular expression.

  • color —

    Highlighting color.

  • whole_words_only (defaults to: nil) —

    Match only whole words.

  • ignore_case (defaults to: nil) —

    True to search ignoring char case.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11752
11753
11754
11755
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11752

def highlight_shape_regex(name, slide_index, shape_index, regex, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = highlight_shape_regex_with_http_info(name, slide_index, shape_index, regex, color, whole_words_only, ignore_case, password, folder, storage)
  data
end

#highlight_shape_regex_with_http_info(name, slide_index, shape_index, regex, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Highlight all matches of sample in text frame text using specified color.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • regex —

    Regular expression.

  • color —

    Highlighting color.

  • whole_words_only (defaults to: nil) —

    Match only whole words.

  • ignore_case (defaults to: nil) —

    True to search ignoring char case.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11768

def highlight_shape_regex_with_http_info(name, slide_index, shape_index, regex, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.highlight_shape_regex ...'
  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 SlidesApi.highlight_shape_regex"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.highlight_shape_regex"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.highlight_shape_regex"
  end
  # verify the required parameter 'regex' is set
  if @api_client.config.client_side_validation && regex.nil?
    fail ArgumentError, "Missing the required parameter 'regex' when calling SlidesApi.highlight_shape_regex"
  end
  # verify the required parameter 'color' is set
  if @api_client.config.client_side_validation && color.nil?
    fail ArgumentError, "Missing the required parameter 'color' when calling SlidesApi.highlight_shape_regex"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/highlightRegex'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'regex'] = @api_client.prepare_for_query(regex) unless regex.nil?
  query_params[:'color'] = @api_client.prepare_for_query(color) unless color.nil?
  query_params[:'wholeWordsOnly'] = @api_client.prepare_for_query(whole_words_only) unless whole_words_only.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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?

  # 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 = nil

  # 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 => 'Shape')
  return data, status_code, headers
end

#highlight_shape_text(name, slide_index, shape_index, text, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Highlight all matches of sample in text frame text using specified color.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • text —

    Text sample to highlight.

  • color —

    Highlighting color.

  • whole_words_only (defaults to: nil) —

    Match only whole words.

  • ignore_case (defaults to: nil) —

    True to search ignoring char case.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11843
11844
11845
11846
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11843

def highlight_shape_text(name, slide_index, shape_index, text, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = highlight_shape_text_with_http_info(name, slide_index, shape_index, text, color, whole_words_only, ignore_case, password, folder, storage)
  data
end

#highlight_shape_text_with_http_info(name, slide_index, shape_index, text, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Highlight all matches of sample in text frame text using specified color.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • text —

    Text sample to highlight.

  • color —

    Highlighting color.

  • whole_words_only (defaults to: nil) —

    Match only whole words.

  • ignore_case (defaults to: nil) —

    True to search ignoring char case.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11859

def highlight_shape_text_with_http_info(name, slide_index, shape_index, text, color, whole_words_only = nil, ignore_case = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.highlight_shape_text ...'
  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 SlidesApi.highlight_shape_text"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.highlight_shape_text"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.highlight_shape_text"
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling SlidesApi.highlight_shape_text"
  end
  # verify the required parameter 'color' is set
  if @api_client.config.client_side_validation && color.nil?
    fail ArgumentError, "Missing the required parameter 'color' when calling SlidesApi.highlight_shape_text"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/highlightText'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # query parameters
  query_params = {}
  query_params[:'text'] = @api_client.prepare_for_query(text) unless text.nil?
  query_params[:'color'] = @api_client.prepare_for_query(color) unless color.nil?
  query_params[:'wholeWordsOnly'] = @api_client.prepare_for_query(whole_words_only) unless whole_words_only.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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?

  # 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 = nil

  # 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 => 'Shape')
  return data, status_code, headers
end

#import_from_html(name, html = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create presentation document from html.

Parameters:

  • name —

    Document name.

  • html (defaults to: nil) —

    HTML data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11929
11930
11931
11932
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11929

def import_from_html(name, html = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = import_from_html_with_http_info(name, html, password, folder, storage)
  data
end

#import_from_html_with_http_info(name, html = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Create presentation document from html.

Parameters:

  • name —

    Document name.

  • html (defaults to: nil) —

    HTML data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11940

def import_from_html_with_http_info(name, html = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.import_from_html ...'
  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 SlidesApi.import_from_html"
  end
  # resource path
  local_var_path = '/slides/{name}/fromHtml'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(html)

  # 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 => 'Document')
  return data, status_code, headers
end

#import_from_pdf(name, pdf, password = nil, folder = nil, storage = nil) ⇒ Object

Create presentation document from pdf or append pdf to an existing presentation.

Parameters:

  • name —

    Document name.

  • pdf —

    PDF data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11988
11989
11990
11991
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11988

def import_from_pdf(name, pdf, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = import_from_pdf_with_http_info(name, pdf, password, folder, storage)
  data
end

#import_from_pdf_with_http_info(name, pdf, password = nil, folder = nil, storage = nil) ⇒ Object

Create presentation document from pdf or append pdf to an existing presentation.

Parameters:

  • name —

    Document name.

  • pdf —

    PDF data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11999

def import_from_pdf_with_http_info(name, pdf, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.import_from_pdf ...'
  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 SlidesApi.import_from_pdf"
  end
  # verify the required parameter 'pdf' is set
  if @api_client.config.client_side_validation && pdf.nil?
    fail ArgumentError, "Missing the required parameter 'pdf' when calling SlidesApi.import_from_pdf"
  end
  # resource path
  local_var_path = '/slides/{name}/fromPdf'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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 = nil

  # form parameters
  post_files = []
  if pdf
    post_files = post_files.push(pdf)
  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 => 'Document')
  return data, status_code, headers
end

#import_shapes_from_svg(name, slide_index, image = nil, x = nil, y = nil, width = nil, height = nil, shapes = nil, group = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Imports shapes from SVG file.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • image (defaults to: nil) —

    SVG image data.

  • x (defaults to: nil) —

    The X coordinate of the imported group of shapes (0 is default if not specified).

  • y (defaults to: nil) —

    The Y coordinate of the imported group of shapes (0 is default if not specified).

  • width (defaults to: nil) —

    The width of the imported group of shapes (default is SVG image width).

  • height (defaults to: nil) —

    The height of the imported group of shapes (default is SVG image width).

  • shapes (defaults to: nil) —

    Indexes of shapes to import. All shapes are imported if not specified.

  • group (defaults to: nil) —

    If true, the set of shapes will be imported as a one group shape.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.



12061
12062
12063
12064
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12061

def import_shapes_from_svg(name, slide_index, image = nil, x = nil, y = nil, width = nil, height = nil, shapes = nil, group = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = import_shapes_from_svg_with_http_info(name, slide_index, image, x, y, width, height, shapes, group, password, folder, storage)
  data
end

#import_shapes_from_svg_with_http_info(name, slide_index, image = nil, x = nil, y = nil, width = nil, height = nil, shapes = nil, group = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Imports shapes from SVG file.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • image (defaults to: nil) —

    SVG image data.

  • x (defaults to: nil) —

    The X coordinate of the imported group of shapes (0 is default if not specified).

  • y (defaults to: nil) —

    The Y coordinate of the imported group of shapes (0 is default if not specified).

  • width (defaults to: nil) —

    The width of the imported group of shapes (default is SVG image width).

  • height (defaults to: nil) —

    The height of the imported group of shapes (default is SVG image width).

  • shapes (defaults to: nil) —

    Indexes of shapes to import. All shapes are imported if not specified.

  • group (defaults to: nil) —

    If true, the set of shapes will be imported as a one group shape.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.



12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12079

def import_shapes_from_svg_with_http_info(name, slide_index, image = nil, x = nil, y = nil, width = nil, height = nil, shapes = nil, group = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.import_shapes_from_svg ...'
  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 SlidesApi.import_shapes_from_svg"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.import_shapes_from_svg"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/fromSvg'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'x'] = @api_client.prepare_for_query(x) unless x.nil?
  query_params[:'y'] = @api_client.prepare_for_query(y) unless y.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[:'shapes'] = @api_client.prepare_for_query(shapes) unless shapes.nil?
  query_params[:'group'] = @api_client.prepare_for_query(group) unless group.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?

  # 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 = nil

  # form parameters
  post_files = []
  if image
    post_files = post_files.push(image)
  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 => 'Shapes')
  return data, status_code, headers
end

#merge(name, request, password = nil, folder = nil, storage = nil) ⇒ Object

Merge the presentation with other presentations specified in the request parameter.

Parameters:

  • name —

    Document name.

  • request —

    PresentationsMergeRequest with a list of presentations to merge.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12141
12142
12143
12144
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12141

def merge(name, request, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = merge_with_http_info(name, request, password, folder, storage)
  data
end

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

Merges presentations or some of their slides specified in the request parameter. Result will be save in the storage.

Parameters:

  • out_path —

    Path to save result.

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil) —

    Merge request.

  • storage (defaults to: nil) —

    Document storage.



12203
12204
12205
12206
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12203

def merge_and_save_online(out_path, files = nil, request = nil, storage = nil)
  merge_and_save_online_with_http_info(out_path, files, request, storage)
  nil
end

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

Merges presentations or some of their slides specified in the request parameter. Result will be save in the storage.

Parameters:

  • out_path —

    Path to save result.

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil) —

    Merge request.

  • storage (defaults to: nil) —

    Document storage.



12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12213

def merge_and_save_online_with_http_info(out_path, files = nil, request = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.merge_and_save_online ...'
  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 SlidesApi.merge_and_save_online"
  end
  # resource path
  local_var_path = '/slides/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 data, status_code, headers
end

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

Merges presentations or some of their slides specified in the request parameter. Returns result file in the response.

Parameters:

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil) —

    Merge request.

  • storage (defaults to: nil) —

    Document storage.



12259
12260
12261
12262
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12259

def merge_online(files = nil, request = nil, storage = nil)
  data, _status_code, _headers = merge_online_with_http_info(files, request, storage)
  data
end

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

Merges presentations or some of their slides specified in the request parameter. Returns result file in the response.

Parameters:

  • files (defaults to: nil) —

    Files to merge

  • request (defaults to: nil) —

    Merge request.

  • storage (defaults to: nil) —

    Document storage.



12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12268

def merge_online_with_http_info(files = nil, request = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.merge_online ...'
  end

  # resource path
  local_var_path = '/slides/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(['multipart/form-data'])
  # 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 => 'File')
  return data, status_code, headers
end

#merge_with_http_info(name, request, password = nil, folder = nil, storage = nil) ⇒ Object

Merge the presentation with other presentations specified in the request parameter.

Parameters:

  • name —

    Document name.

  • request —

    PresentationsMergeRequest with a list of presentations to merge.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12152

def merge_with_http_info(name, request, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.merge ...'
  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 SlidesApi.merge"
  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 SlidesApi.merge"
  end
  # resource path
  local_var_path = '/slides/{name}/merge'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(request)

  # 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 => 'Document')
  return data, status_code, headers
end

#move_file(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil) ⇒ Object

Move file

Parameters:

  • src_path —

    Source file path e.g. ‘/src.ext’

  • dest_path —

    Destination file path e.g. ‘/dest.ext’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name

  • version_id (defaults to: nil) —

    File version ID to move



12312
12313
12314
12315
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12312

def move_file(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
  move_file_with_http_info(src_path, dest_path, src_storage_name, dest_storage_name, version_id)
  nil
end

#move_file_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil) ⇒ Object

Move file

Parameters:

  • src_path —

    Source file path e.g. ‘/src.ext’

  • dest_path —

    Destination file path e.g. ‘/dest.ext’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name

  • version_id (defaults to: nil) —

    File version ID to move



12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12323

def move_file_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.move_file ...'
  end

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

  # query parameters
  query_params = {}
  query_params[:'destPath'] = @api_client.prepare_for_query(dest_path) unless dest_path.nil?
  query_params[:'srcStorageName'] = @api_client.prepare_for_query(src_storage_name) unless src_storage_name.nil?
  query_params[:'destStorageName'] = @api_client.prepare_for_query(dest_storage_name) unless dest_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(['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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#move_folder(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil) ⇒ Object

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. ‘/folder’

  • dest_path —

    Destination folder path to move to e.g ‘/dst’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name



12374
12375
12376
12377
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12374

def move_folder(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil)
  move_folder_with_http_info(src_path, dest_path, src_storage_name, dest_storage_name)
  nil
end

#move_folder_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil) ⇒ Object

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. ‘/folder’

  • dest_path —

    Destination folder path to move to e.g ‘/dst’

  • src_storage_name (defaults to: nil) —

    Source storage name

  • dest_storage_name (defaults to: nil) —

    Destination storage name



12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12384

def move_folder_with_http_info(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.move_folder ...'
  end

  # verify the required parameter 'src_path' is set
  if @api_client.config.client_side_validation && src_path.nil?
    fail ArgumentError, "Missing the required parameter 'src_path' when calling SlidesApi.move_folder"
  end
  # verify the required parameter 'dest_path' is set
  if @api_client.config.client_side_validation && dest_path.nil?
    fail ArgumentError, "Missing the required parameter 'dest_path' when calling SlidesApi.move_folder"
  end
  # resource path
  local_var_path = '/slides/storage/folder/move/{srcPath}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'srcPath', src_path)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = @api_client.prepare_for_query(dest_path) unless dest_path.nil?
  query_params[:'srcStorageName'] = @api_client.prepare_for_query(src_storage_name) unless src_storage_name.nil?
  query_params[:'destStorageName'] = @api_client.prepare_for_query(dest_storage_name) unless dest_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(['application/json'])

  # http body (model)
  post_body = nil

  # 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 data, status_code, headers
end

#move_section(name, section_index, new_position, password = nil, folder = nil, storage = nil) ⇒ Object

Move presentation section to a specified position.

Parameters:

  • name —

    Document name.

  • section_index —

    The position of the section to be reordered.

  • new_position —

    The new position of the reordered section.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12436
12437
12438
12439
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12436

def move_section(name, section_index, new_position, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = move_section_with_http_info(name, section_index, new_position, password, folder, storage)
  data
end

#move_section_with_http_info(name, section_index, new_position, password = nil, folder = nil, storage = nil) ⇒ Object

Move presentation section to a specified position.

Parameters:

  • name —

    Document name.

  • section_index —

    The position of the section to be reordered.

  • new_position —

    The new position of the reordered section.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12448

def move_section_with_http_info(name, section_index, new_position, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.move_section ...'
  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 SlidesApi.move_section"
  end
  # verify the required parameter 'section_index' is set
  if @api_client.config.client_side_validation && section_index.nil?
    fail ArgumentError, "Missing the required parameter 'section_index' when calling SlidesApi.move_section"
  end
  # verify the required parameter 'new_position' is set
  if @api_client.config.client_side_validation && new_position.nil?
    fail ArgumentError, "Missing the required parameter 'new_position' when calling SlidesApi.move_section"
  end
  # resource path
  local_var_path = '/slides/{name}/sections/{sectionIndex}/move'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sectionIndex', section_index)

  # query parameters
  query_params = {}
  query_params[:'newPosition'] = @api_client.prepare_for_query(new_position) unless new_position.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?

  # 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 = nil

  # 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 => 'Sections')
  return data, status_code, headers
end

#move_slide(name, slide_index, new_position, password = nil, folder = nil, storage = nil) ⇒ Object

Reorder presentation slide position.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • new_position —

    The new position of the reordered slide.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12507
12508
12509
12510
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12507

def move_slide(name, slide_index, new_position, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = move_slide_with_http_info(name, slide_index, new_position, password, folder, storage)
  data
end

#move_slide_with_http_info(name, slide_index, new_position, password = nil, folder = nil, storage = nil) ⇒ Object

Reorder presentation slide position.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • new_position —

    The new position of the reordered slide.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12519

def move_slide_with_http_info(name, slide_index, new_position, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.move_slide ...'
  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 SlidesApi.move_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.move_slide"
  end
  # verify the required parameter 'new_position' is set
  if @api_client.config.client_side_validation && new_position.nil?
    fail ArgumentError, "Missing the required parameter 'new_position' when calling SlidesApi.move_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/move'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'newPosition'] = @api_client.prepare_for_query(new_position) unless new_position.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?

  # 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 = nil

  # 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 => 'Slides')
  return data, status_code, headers
end

#notes_slide_exists(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get info whether a notes slide exists.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12577
12578
12579
12580
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12577

def notes_slide_exists(name, slide_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = notes_slide_exists_with_http_info(name, slide_index, password, folder, storage)
  data
end

#notes_slide_exists_online(document, slide_index, password = nil) ⇒ Object

Get info whether a notes slide exists.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.



12639
12640
12641
12642
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12639

def notes_slide_exists_online(document, slide_index, password = nil)
  data, _status_code, _headers = notes_slide_exists_online_with_http_info(document, slide_index, password)
  data
end

#notes_slide_exists_online_with_http_info(document, slide_index, password = nil) ⇒ Object

Get info whether a notes slide exists.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.



12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12648

def notes_slide_exists_online_with_http_info(document, slide_index, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.notes_slide_exists_online ...'
  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 SlidesApi.notes_slide_exists_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.notes_slide_exists_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/notesSlide/exist'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'EntityExists')
  return data, status_code, headers
end

#notes_slide_exists_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil) ⇒ Object

Get info whether a notes slide exists.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12588

def notes_slide_exists_with_http_info(name, slide_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.notes_slide_exists ...'
  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 SlidesApi.notes_slide_exists"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.notes_slide_exists"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide/exist'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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 = 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 => 'EntityExists')
  return data, status_code, headers
end

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

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. ‘/file.ext’ or ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID



12699
12700
12701
12702
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12699

def object_exists(path, storage_name = nil, version_id = nil)
  data, _status_code, _headers = object_exists_with_http_info(path, storage_name, version_id)
  data
end

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

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. ‘/file.ext’ or ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name

  • version_id (defaults to: nil) —

    File version ID



12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12708

def object_exists_with_http_info(path, storage_name = nil, version_id = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.object_exists ...'
  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 SlidesApi.object_exists"
  end
  # resource path
  local_var_path = '/slides/storage/exist/{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(['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 => 'ObjectExist')
  return data, status_code, headers
end

#ordered_merge(name, request, password = nil, folder = nil, storage = nil) ⇒ Object

Merge the presentation with other presentations or some of their slides specified in the request parameter.

Parameters:

  • name —

    Document name.

  • request —

    OrderedMergeRequest with a list of presentations and slide indices to merge.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12755
12756
12757
12758
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12755

def ordered_merge(name, request, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = ordered_merge_with_http_info(name, request, password, folder, storage)
  data
end

#ordered_merge_with_http_info(name, request, password = nil, folder = nil, storage = nil) ⇒ Object

Merge the presentation with other presentations or some of their slides specified in the request parameter.

Parameters:

  • name —

    Document name.

  • request —

    OrderedMergeRequest with a list of presentations and slide indices to merge.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12766

def ordered_merge_with_http_info(name, request, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.ordered_merge ...'
  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 SlidesApi.ordered_merge"
  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 SlidesApi.ordered_merge"
  end
  # resource path
  local_var_path = '/slides/{name}/merge'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(request)

  # 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 => 'Document')
  return data, status_code, headers
end

#pipeline(pipeline, files = nil) ⇒ Object

Performs slides pipeline.

Parameters:

  • pipeline —

    A Pipeline object.

  • files (defaults to: nil) —

    Files to upload with the pipeline



12815
12816
12817
12818
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12815

def pipeline(pipeline, files = nil)
  data, _status_code, _headers = pipeline_with_http_info(pipeline, files)
  data
end

#pipeline_with_http_info(pipeline, files = nil) ⇒ Object

Performs slides pipeline.

Parameters:

  • pipeline —

    A Pipeline object.

  • files (defaults to: nil) —

    Files to upload with the pipeline



12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12823

def pipeline_with_http_info(pipeline, files = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.pipeline ...'
  end

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

  # 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(['multipart/form-data'])

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

  # 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 => 'File')
  return data, status_code, headers
end

#reorder_slides(name, old_positions = nil, new_positions = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Reorder presentation slides positions.

Parameters:

  • name —

    Document name.

  • old_positions (defaults to: nil) —

    A comma separated array of positions of slides to be reordered.

  • new_positions (defaults to: nil) —

    A comma separated array of new slide positions.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12871
12872
12873
12874
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12871

def reorder_slides(name, old_positions = nil, new_positions = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = reorder_slides_with_http_info(name, old_positions, new_positions, password, folder, storage)
  data
end

#reorder_slides_with_http_info(name, old_positions = nil, new_positions = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Reorder presentation slides positions.

Parameters:

  • name —

    Document name.

  • old_positions (defaults to: nil) —

    A comma separated array of positions of slides to be reordered.

  • new_positions (defaults to: nil) —

    A comma separated array of new slide positions.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12883

def reorder_slides_with_http_info(name, old_positions = nil, new_positions = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.reorder_slides ...'
  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 SlidesApi.reorder_slides"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/reorder'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'oldPositions'] = @api_client.prepare_for_query(old_positions) unless old_positions.nil?
  query_params[:'newPositions'] = @api_client.prepare_for_query(new_positions) unless new_positions.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?

  # 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 = nil

  # 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 => 'Slides')
  return data, status_code, headers
end

#replace_font(name, source_font, target_font, embed = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Replaces specified font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • source_font —

    Source font name.

  • target_font —

    Target font name.

  • embed (defaults to: nil) —

    Embed target font.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



12936
12937
12938
12939
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12936

def replace_font(name, source_font, target_font, embed = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = replace_font_with_http_info(name, source_font, target_font, embed, password, folder, storage, fonts_folder)
  data
end

#replace_font_online(document, source_font, target_font, embed = nil, password = nil, fonts_folder = nil) ⇒ Object

Replaces specified font and returns presentation.

Parameters:

  • document —

    Document data.

  • source_font —

    Source font name.

  • target_font —

    Target font name.

  • embed (defaults to: nil) —

    Embed target font.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



13011
13012
13013
13014
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13011

def replace_font_online(document, source_font, target_font, embed = nil, password = nil, fonts_folder = nil)
  data, _status_code, _headers = replace_font_online_with_http_info(document, source_font, target_font, embed, password, fonts_folder)
  data
end

#replace_font_online_with_http_info(document, source_font, target_font, embed = nil, password = nil, fonts_folder = nil) ⇒ Object

Replaces specified font and returns presentation.

Parameters:

  • document —

    Document data.

  • source_font —

    Source font name.

  • target_font —

    Target font name.

  • embed (defaults to: nil) —

    Embed target font.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13023

def replace_font_online_with_http_info(document, source_font, target_font, embed = nil, password = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_font_online ...'
  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 SlidesApi.replace_font_online"
  end
  # verify the required parameter 'source_font' is set
  if @api_client.config.client_side_validation && source_font.nil?
    fail ArgumentError, "Missing the required parameter 'source_font' when calling SlidesApi.replace_font_online"
  end
  # verify the required parameter 'target_font' is set
  if @api_client.config.client_side_validation && target_font.nil?
    fail ArgumentError, "Missing the required parameter 'target_font' when calling SlidesApi.replace_font_online"
  end
  # resource path
  local_var_path = '/slides/fonts/{sourceFont}/replace/{targetFont}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sourceFont', source_font)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'targetFont', target_font)

  # query parameters
  query_params = {}
  query_params[:'embed'] = @api_client.prepare_for_query(embed) unless embed.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(['multipart/form-data'])
  # 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 = nil

  # 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 => 'File')
  return data, status_code, headers
end

#replace_font_with_http_info(name, source_font, target_font, embed = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Replaces specified font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • source_font —

    Source font name.

  • target_font —

    Target font name.

  • embed (defaults to: nil) —

    Embed target font.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12950

def replace_font_with_http_info(name, source_font, target_font, embed = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_font ...'
  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 SlidesApi.replace_font"
  end
  # verify the required parameter 'source_font' is set
  if @api_client.config.client_side_validation && source_font.nil?
    fail ArgumentError, "Missing the required parameter 'source_font' when calling SlidesApi.replace_font"
  end
  # verify the required parameter 'target_font' is set
  if @api_client.config.client_side_validation && target_font.nil?
    fail ArgumentError, "Missing the required parameter 'target_font' when calling SlidesApi.replace_font"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts/{sourceFont}/replace/{targetFont}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sourceFont', source_font)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'targetFont', target_font)

  # query parameters
  query_params = {}
  query_params[:'embed'] = @api_client.prepare_for_query(embed) unless embed.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 = nil

  # 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 => 'FontsData')
  return data, status_code, headers
end

#replace_presentation_text(name, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • name —

    Document name.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13085
13086
13087
13088
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13085

def replace_presentation_text(name, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = replace_presentation_text_with_http_info(name, old_value, new_value, ignore_case, password, folder, storage)
  data
end

#replace_presentation_text_online(document, old_value, new_value, ignore_case = nil, password = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • document —

    Document data.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.



13157
13158
13159
13160
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13157

def replace_presentation_text_online(document, old_value, new_value, ignore_case = nil, password = nil)
  data, _status_code, _headers = replace_presentation_text_online_with_http_info(document, old_value, new_value, ignore_case, password)
  data
end

#replace_presentation_text_online_with_http_info(document, old_value, new_value, ignore_case = nil, password = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • document —

    Document data.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.



13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13168

def replace_presentation_text_online_with_http_info(document, old_value, new_value, ignore_case = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_presentation_text_online ...'
  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 SlidesApi.replace_presentation_text_online"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling SlidesApi.replace_presentation_text_online"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling SlidesApi.replace_presentation_text_online"
  end
  # resource path
  local_var_path = '/slides/replaceText'

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = @api_client.prepare_for_query(old_value) unless old_value.nil?
  query_params[:'newValue'] = @api_client.prepare_for_query(new_value) unless new_value.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#replace_presentation_text_with_http_info(name, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • name —

    Document name.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13098

def replace_presentation_text_with_http_info(name, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_presentation_text ...'
  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 SlidesApi.replace_presentation_text"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling SlidesApi.replace_presentation_text"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling SlidesApi.replace_presentation_text"
  end
  # resource path
  local_var_path = '/slides/{name}/replaceText'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = @api_client.prepare_for_query(old_value) unless old_value.nil?
  query_params[:'newValue'] = @api_client.prepare_for_query(new_value) unless new_value.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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?

  # 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 = nil

  # 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 => 'DocumentReplaceResult')
  return data, status_code, headers
end

#replace_slide_text(name, slide_index, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13230
13231
13232
13233
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13230

def replace_slide_text(name, slide_index, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = replace_slide_text_with_http_info(name, slide_index, old_value, new_value, ignore_case, password, folder, storage)
  data
end

#replace_slide_text_online(document, slide_index, old_value, new_value, ignore_case = nil, password = nil) ⇒ Object

Replace slide text with a new value.

Parameters:

  • document —

    Document data.

  • slide_index —

    Index of target slide.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.



13309
13310
13311
13312
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13309

def replace_slide_text_online(document, slide_index, old_value, new_value, ignore_case = nil, password = nil)
  data, _status_code, _headers = replace_slide_text_online_with_http_info(document, slide_index, old_value, new_value, ignore_case, password)
  data
end

#replace_slide_text_online_with_http_info(document, slide_index, old_value, new_value, ignore_case = nil, password = nil) ⇒ Object

Replace slide text with a new value.

Parameters:

  • document —

    Document data.

  • slide_index —

    Index of target slide.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.



13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13321

def replace_slide_text_online_with_http_info(document, slide_index, old_value, new_value, ignore_case = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_slide_text_online ...'
  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 SlidesApi.replace_slide_text_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.replace_slide_text_online"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling SlidesApi.replace_slide_text_online"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling SlidesApi.replace_slide_text_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/replaceText'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = @api_client.prepare_for_query(old_value) unless old_value.nil?
  query_params[:'newValue'] = @api_client.prepare_for_query(new_value) unless new_value.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # 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 => 'File')
  return data, status_code, headers
end

#replace_slide_text_with_http_info(name, slide_index, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Replace text with a new value.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • old_value —

    Text value to be replaced.

  • new_value —

    Text value to replace with.

  • ignore_case (defaults to: nil) —

    True if character case must be ignored.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13244

def replace_slide_text_with_http_info(name, slide_index, old_value, new_value, ignore_case = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.replace_slide_text ...'
  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 SlidesApi.replace_slide_text"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.replace_slide_text"
  end
  # verify the required parameter 'old_value' is set
  if @api_client.config.client_side_validation && old_value.nil?
    fail ArgumentError, "Missing the required parameter 'old_value' when calling SlidesApi.replace_slide_text"
  end
  # verify the required parameter 'new_value' is set
  if @api_client.config.client_side_validation && new_value.nil?
    fail ArgumentError, "Missing the required parameter 'new_value' when calling SlidesApi.replace_slide_text"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/replaceText'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'oldValue'] = @api_client.prepare_for_query(old_value) unless old_value.nil?
  query_params[:'newValue'] = @api_client.prepare_for_query(new_value) unless new_value.nil?
  query_params[:'ignoreCase'] = @api_client.prepare_for_query(ignore_case) unless ignore_case.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?

  # 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 = nil

  # 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 => 'SlideReplaceResult')
  return data, status_code, headers
end

#save_portion_as_math_ml(name, slide_index, shape_index, paragraph_index, portion_index, out_path, password = nil, folder = nil, storage = nil) ⇒ Object

Convert Mathematical Text to MathML Format and saves result to the storage

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • out_path —

    Path to save result.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.



13389
13390
13391
13392
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13389

def save_portion_as_math_ml(name, slide_index, shape_index, paragraph_index, portion_index, out_path, password = nil, folder = nil, storage = nil)
  save_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, out_path, password, folder, storage)
  nil
end

#save_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, out_path, password = nil, folder = nil, storage = nil) ⇒ Object

Convert Mathematical Text to MathML Format and saves result to the storage

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • out_path —

    Path to save result.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.



13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13404

def save_portion_as_math_ml_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, out_path, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_portion_as_math_ml ...'
  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 SlidesApi.save_portion_as_math_ml"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_portion_as_math_ml"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.save_portion_as_math_ml"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.save_portion_as_math_ml"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.save_portion_as_math_ml"
  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 SlidesApi.save_portion_as_math_ml"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}/mathml'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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?

  # 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 = nil

  # 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 data, status_code, headers
end

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

Save a presentation to a specified format.

Parameters:

  • name —

    Document name.

  • format —

    Export format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    Export options.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be saved. If not specified, all slides are saved by default.



13480
13481
13482
13483
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13480

def save_presentation(name, format, out_path, options = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, slides = nil)
  save_presentation_with_http_info(name, format, out_path, options, password, folder, storage, fonts_folder, slides)
  nil
end

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

Save a presentation to a specified format.

Parameters:

  • name —

    Document name.

  • format —

    Export format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    Export options.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.

  • slides (defaults to: nil) —

    The indices of the slides to be saved. If not specified, all slides are saved by default.



13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13495

def 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: SlidesApi.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 SlidesApi.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 SlidesApi.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'].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"
  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 SlidesApi.save_presentation"
  end
  # resource path
  local_var_path = '/slides/{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 data, status_code, headers
end

#save_shape(name, slide_index, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



13567
13568
13569
13570
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13567

def save_shape(name, slide_index, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  save_shape_with_http_info(name, slide_index, shape_index, format, out_path, options, scale_x, scale_y, bounds, password, folder, storage, fonts_folder, sub_shape)
  nil
end

#save_shape_online(document, slide_index, shape_index, format, out_path, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Path to save result.

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • options (defaults to: nil) —

    Export options.



13673
13674
13675
13676
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13673

def save_shape_online(document, slide_index, shape_index, format, out_path, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  save_shape_online_with_http_info(document, slide_index, shape_index, format, out_path, scale_x, scale_y, bounds, password, storage, fonts_folder, options)
  nil
end

#save_shape_online_with_http_info(document, slide_index, shape_index, format, out_path, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Path to save result.

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • options (defaults to: nil) —

    Export options.



13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13691

def save_shape_online_with_http_info(document, slide_index, shape_index, format, out_path, scale_x = nil, scale_y = nil, bounds = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_shape_online ...'
  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 SlidesApi.save_shape_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_shape_online"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.save_shape_online"
  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 SlidesApi.save_shape_online"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  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 SlidesApi.save_shape_online"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/shapes/{shapeIndex}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  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[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#save_shape_with_http_info(name, slide_index, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Slide index.

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13587

def save_shape_with_http_info(name, slide_index, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_shape ...'
  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 SlidesApi.save_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_shape"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.save_shape"
  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 SlidesApi.save_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  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 SlidesApi.save_shape"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/{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, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  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[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 data, status_code, headers
end

#save_slide(name, slide_index, format, out_path, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • out_path —

    Path to upload the output file to.

  • options (defaults to: nil) —

    Export options.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



13776
13777
13778
13779
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13776

def save_slide(name, slide_index, format, out_path, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  save_slide_with_http_info(name, slide_index, format, out_path, options, width, height, password, folder, storage, fonts_folder)
  nil
end

#save_slide_online(document, slide_index, format, out_path, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • out_path —

    Path to save result.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.

  • options (defaults to: nil) —

    Export options.



13867
13868
13869
13870
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13867

def save_slide_online(document, slide_index, format, out_path, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  save_slide_online_with_http_info(document, slide_index, format, out_path, width, height, password, storage, fonts_folder, options)
  nil
end

#save_slide_online_with_http_info(document, slide_index, format, out_path, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • document —

    Document data.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • out_path —

    Path to save result.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.

  • options (defaults to: nil) —

    Export options.



13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13883

def save_slide_online_with_http_info(document, slide_index, format, out_path, width = nil, height = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_slide_online ...'
  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 SlidesApi.save_slide_online"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_slide_online"
  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 SlidesApi.save_slide_online"
  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'].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"
  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 SlidesApi.save_slide_online"
  end
  # resource path
  local_var_path = '/slides/slides/{slideIndex}/{format}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  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[:'width'] = @api_client.prepare_for_query(width) unless width.nil?
  query_params[:'height'] = @api_client.prepare_for_query(height) unless height.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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#save_slide_with_http_info(name, slide_index, format, out_path, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Save a slide to a specified format.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • format —

    Output file format.

  • out_path —

    Path to upload the output file to.

  • options (defaults to: nil) —

    Export options.

  • width (defaults to: nil) —

    The width of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • height (defaults to: nil) —

    The height of the slide representation in the output format; 0 to not adjust the size. Default is 0.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Storage folder containing custom fonts to be used with the document.



13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13793

def save_slide_with_http_info(name, slide_index, format, out_path, options = nil, width = nil, height = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_slide ...'
  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 SlidesApi.save_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_slide"
  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 SlidesApi.save_slide"
  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'].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"
  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 SlidesApi.save_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{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, 'slideIndex', slide_index)
  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[:'width'] = @api_client.prepare_for_query(width) unless width.nil?
  query_params[:'height'] = @api_client.prepare_for_query(height) unless height.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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names)
  return data, status_code, headers
end

#save_special_slide_shape(name, slide_index, slide_type, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



13963
13964
13965
13966
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13963

def save_special_slide_shape(name, slide_index, slide_type, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  save_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, out_path, options, scale_x, scale_y, bounds, password, folder, storage, fonts_folder, sub_shape)
  nil
end

#save_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil) ⇒ Object

Render shape to specified picture format.

Parameters:

  • name —

    Presentation name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Index of shape starting from 1

  • format —

    Export picture format.

  • out_path —

    Output path.

  • options (defaults to: nil) —

    export options

  • scale_x (defaults to: nil) —

    X scale ratio.

  • scale_y (defaults to: nil) —

    Y scale ratio.

  • bounds (defaults to: nil) —

    Shape thumbnail bounds type.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Presentation folder.

  • storage (defaults to: nil) —

    Presentation storage.

  • fonts_folder (defaults to: nil) —

    Fonts folder.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13984

def save_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, format, out_path, options = nil, scale_x = nil, scale_y = nil, bounds = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.save_special_slide_shape ...'
  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 SlidesApi.save_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.save_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.save_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.save_special_slide_shape"
  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 SlidesApi.save_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Svg'].any?{ |s| s.casecmp(format)==0 }
    fail ArgumentError, "Invalid value for parameter format: " + format + ". Must be one of Jpeg, Png, Gif, Bmp, Tiff, Svg"
  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 SlidesApi.save_special_slide_shape"
  end
  if @api_client.config.client_side_validation && bounds && !['Slide', 'Shape', 'Appearance'].any?{ |s| s.casecmp(bounds)==0 }
    fail ArgumentError, "Invalid value for parameter bounds: " + bounds + ". Must be one of Slide, Shape, Appearance"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/{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, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  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[:'scaleX'] = @api_client.prepare_for_query(scale_x) unless scale_x.nil?
  query_params[:'scaleY'] = @api_client.prepare_for_query(scale_y) unless scale_y.nil?
  query_params[:'bounds'] = @api_client.prepare_for_query(bounds) unless bounds.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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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 data, status_code, headers
end

#set_animation(name, slide_index, animation, password = nil, folder = nil, storage = nil) ⇒ Object

Set slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • animation —

    Animation DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14073
14074
14075
14076
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14073

def set_animation(name, slide_index, animation, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_animation_with_http_info(name, slide_index, animation, password, folder, storage)
  data
end

#set_animation_with_http_info(name, slide_index, animation, password = nil, folder = nil, storage = nil) ⇒ Object

Set slide animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • animation —

    Animation DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14085

def set_animation_with_http_info(name, slide_index, animation, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_animation ...'
  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 SlidesApi.set_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_animation"
  end
  # verify the required parameter 'animation' is set
  if @api_client.config.client_side_validation && animation.nil?
    fail ArgumentError, "Missing the required parameter 'animation' when calling SlidesApi.set_animation"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(animation)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#set_background(name, slide_index, background, password = nil, folder = nil, storage = nil) ⇒ Object

Set background for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • background —

    Slide background update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14143
14144
14145
14146
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14143

def set_background(name, slide_index, background, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_background_with_http_info(name, slide_index, background, password, folder, storage)
  data
end

#set_background_color(name, slide_index, color, password = nil, folder = nil, storage = nil) ⇒ Object

Set background color for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • color —

    Slide background target color in RRGGBB format.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14213
14214
14215
14216
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14213

def set_background_color(name, slide_index, color, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_background_color_with_http_info(name, slide_index, color, password, folder, storage)
  data
end

#set_background_color_with_http_info(name, slide_index, color, password = nil, folder = nil, storage = nil) ⇒ Object

Set background color for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • color —

    Slide background target color in RRGGBB format.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14225

def set_background_color_with_http_info(name, slide_index, color, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_background_color ...'
  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 SlidesApi.set_background_color"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_background_color"
  end
  # verify the required parameter 'color' is set
  if @api_client.config.client_side_validation && color.nil?
    fail ArgumentError, "Missing the required parameter 'color' when calling SlidesApi.set_background_color"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/backgroundColor'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # query parameters
  query_params = {}
  query_params[:'color'] = @api_client.prepare_for_query(color) unless color.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?

  # 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 = nil

  # 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 => 'SlideBackground')
  return data, status_code, headers
end

#set_background_with_http_info(name, slide_index, background, password = nil, folder = nil, storage = nil) ⇒ Object

Set background for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • background —

    Slide background update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14155

def set_background_with_http_info(name, slide_index, background, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_background ...'
  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 SlidesApi.set_background"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_background"
  end
  # verify the required parameter 'background' is set
  if @api_client.config.client_side_validation && background.nil?
    fail ArgumentError, "Missing the required parameter 'background' when calling SlidesApi.set_background"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/background'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(background)

  # 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 => 'SlideBackground')
  return data, status_code, headers
end

#set_chart_axis(name, slide_index, shape_index, axis_type, axis, password = nil, folder = nil, storage = nil) ⇒ Object

Set chart axis.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • axis_type —

    Axis type. Horizontal, Vertical, SecondaryHorizontal or SecondaryVertical.

  • axis —

    Axis DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14286
14287
14288
14289
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14286

def set_chart_axis(name, slide_index, shape_index, axis_type, axis, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_chart_axis_with_http_info(name, slide_index, shape_index, axis_type, axis, password, folder, storage)
  data
end

#set_chart_axis_with_http_info(name, slide_index, shape_index, axis_type, axis, password = nil, folder = nil, storage = nil) ⇒ Object

Set chart axis.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • axis_type —

    Axis type. Horizontal, Vertical, SecondaryHorizontal or SecondaryVertical.

  • axis —

    Axis DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14300

def set_chart_axis_with_http_info(name, slide_index, shape_index, axis_type, axis, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_chart_axis ...'
  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 SlidesApi.set_chart_axis"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_chart_axis"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.set_chart_axis"
  end
  # verify the required parameter 'axis_type' is set
  if @api_client.config.client_side_validation && axis_type.nil?
    fail ArgumentError, "Missing the required parameter 'axis_type' when calling SlidesApi.set_chart_axis"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['HorizontalAxis', 'VerticalAxis', 'SecondaryHorizontalAxis', 'SecondaryVerticalAxis'].any?{ |s| s.casecmp(axis_type)==0 }
    fail ArgumentError, "Invalid value for parameter axis_type: " + axis_type + ". Must be one of HorizontalAxis, VerticalAxis, SecondaryHorizontalAxis, SecondaryVerticalAxis"
  end
  # verify the required parameter 'axis' is set
  if @api_client.config.client_side_validation && axis.nil?
    fail ArgumentError, "Missing the required parameter 'axis' when calling SlidesApi.set_chart_axis"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/{axisType}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'axisType', axis_type)

  # 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?

  # 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(axis)

  # 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 => 'Axis')
  return data, status_code, headers
end

#set_chart_legend(name, slide_index, shape_index, legend, password = nil, folder = nil, storage = nil) ⇒ Object

Set chart axis.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • legend —

    Chart legend DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14373
14374
14375
14376
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14373

def set_chart_legend(name, slide_index, shape_index, legend, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_chart_legend_with_http_info(name, slide_index, shape_index, legend, password, folder, storage)
  data
end

#set_chart_legend_with_http_info(name, slide_index, shape_index, legend, password = nil, folder = nil, storage = nil) ⇒ Object

Set chart axis.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • legend —

    Chart legend DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14386

def set_chart_legend_with_http_info(name, slide_index, shape_index, legend, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_chart_legend ...'
  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 SlidesApi.set_chart_legend"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_chart_legend"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.set_chart_legend"
  end
  # verify the required parameter 'legend' is set
  if @api_client.config.client_side_validation && legend.nil?
    fail ArgumentError, "Missing the required parameter 'legend' when calling SlidesApi.set_chart_legend"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/legend'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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?

  # 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(legend)

  # 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 => 'Legend')
  return data, status_code, headers
end

#set_chart_series_group(name, slide_index, shape_index, series_group_index, series_group, password = nil, folder = nil, storage = nil) ⇒ Object

Set a series group in a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_group_index —

    Series group index.

  • series_group —

    Series group DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14451
14452
14453
14454
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14451

def set_chart_series_group(name, slide_index, shape_index, series_group_index, series_group, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_chart_series_group_with_http_info(name, slide_index, shape_index, series_group_index, series_group, password, folder, storage)
  data
end

#set_chart_series_group_with_http_info(name, slide_index, shape_index, series_group_index, series_group, password = nil, folder = nil, storage = nil) ⇒ Object

Set a series group in a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_group_index —

    Series group index.

  • series_group —

    Series group DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14465

def set_chart_series_group_with_http_info(name, slide_index, shape_index, series_group_index, series_group, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_chart_series_group ...'
  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 SlidesApi.set_chart_series_group"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_chart_series_group"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.set_chart_series_group"
  end
  # verify the required parameter 'series_group_index' is set
  if @api_client.config.client_side_validation && series_group_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_group_index' when calling SlidesApi.set_chart_series_group"
  end
  # verify the required parameter 'series_group' is set
  if @api_client.config.client_side_validation && series_group.nil?
    fail ArgumentError, "Missing the required parameter 'series_group' when calling SlidesApi.set_chart_series_group"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/seriesGroup/{seriesGroupIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesGroupIndex', series_group_index)

  # 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?

  # 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(series_group)

  # 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 => 'Chart')
  return data, status_code, headers
end

#set_chart_wall(name, slide_index, shape_index, chart_wall_type, chart_wall, password = nil, folder = nil, storage = nil) ⇒ Object

Set 3D chart wall.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • chart_wall_type —

    Chart wall type: floor, sideWall or backWall.

  • chart_wall —

    Chart wall DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14535
14536
14537
14538
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14535

def set_chart_wall(name, slide_index, shape_index, chart_wall_type, chart_wall, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_chart_wall_with_http_info(name, slide_index, shape_index, chart_wall_type, chart_wall, password, folder, storage)
  data
end

#set_chart_wall_with_http_info(name, slide_index, shape_index, chart_wall_type, chart_wall, password = nil, folder = nil, storage = nil) ⇒ Object

Set 3D chart wall.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • chart_wall_type —

    Chart wall type: floor, sideWall or backWall.

  • chart_wall —

    Chart wall DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14549

def set_chart_wall_with_http_info(name, slide_index, shape_index, chart_wall_type, chart_wall, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_chart_wall ...'
  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 SlidesApi.set_chart_wall"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_chart_wall"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.set_chart_wall"
  end
  # verify the required parameter 'chart_wall_type' is set
  if @api_client.config.client_side_validation && chart_wall_type.nil?
    fail ArgumentError, "Missing the required parameter 'chart_wall_type' when calling SlidesApi.set_chart_wall"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Floor', 'SideWall', 'BackWall'].any?{ |s| s.casecmp(chart_wall_type)==0 }
    fail ArgumentError, "Invalid value for parameter chart_wall_type: " + chart_wall_type + ". Must be one of Floor, SideWall, BackWall"
  end
  # verify the required parameter 'chart_wall' is set
  if @api_client.config.client_side_validation && chart_wall.nil?
    fail ArgumentError, "Missing the required parameter 'chart_wall' when calling SlidesApi.set_chart_wall"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/{chartWallType}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'chartWallType', chart_wall_type)

  # 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?

  # 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(chart_wall)

  # 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 => 'ChartWall')
  return data, status_code, headers
end

#set_document_properties(name, properties, password = nil, folder = nil, storage = nil) ⇒ Object

Set document properties.

Parameters:

  • name —

    Document name.

  • properties —

    New properties.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14620
14621
14622
14623
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14620

def set_document_properties(name, properties, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_document_properties_with_http_info(name, properties, password, folder, storage)
  data
end

#set_document_properties_with_http_info(name, properties, password = nil, folder = nil, storage = nil) ⇒ Object

Set document properties.

Parameters:

  • name —

    Document name.

  • properties —

    New properties.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14631

def set_document_properties_with_http_info(name, properties, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_document_properties ...'
  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 SlidesApi.set_document_properties"
  end
  # verify the required parameter 'properties' is set
  if @api_client.config.client_side_validation && properties.nil?
    fail ArgumentError, "Missing the required parameter 'properties' when calling SlidesApi.set_document_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(properties)

  # 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 => 'DocumentProperties')
  return data, status_code, headers
end

#set_document_property(name, property_name, property, password = nil, folder = nil, storage = nil) ⇒ Object

Set document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • property —

    Property with the value.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14684
14685
14686
14687
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14684

def set_document_property(name, property_name, property, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_document_property_with_http_info(name, property_name, property, password, folder, storage)
  data
end

#set_document_property_with_http_info(name, property_name, property, password = nil, folder = nil, storage = nil) ⇒ Object

Set document property.

Parameters:

  • name —

    Document name.

  • property_name —

    The property name.

  • property —

    Property with the value.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14696

def set_document_property_with_http_info(name, property_name, property, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_document_property ...'
  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 SlidesApi.set_document_property"
  end
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling SlidesApi.set_document_property"
  end
  # verify the required parameter 'property' is set
  if @api_client.config.client_side_validation && property.nil?
    fail ArgumentError, "Missing the required parameter 'property' when calling SlidesApi.set_document_property"
  end
  # resource path
  local_var_path = '/slides/{name}/documentproperties/{propertyName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'propertyName', property_name)

  # 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?

  # 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(property)

  # 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 => 'DocumentProperty')
  return data, status_code, headers
end

#set_embedded_font(name, font_name, only_used = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Embeds specified font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • font_name —

    Font name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



14755
14756
14757
14758
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14755

def set_embedded_font(name, font_name, only_used = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = set_embedded_font_with_http_info(name, font_name, only_used, password, folder, storage, fonts_folder)
  data
end

#set_embedded_font_from_request(font, name, only_used = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Embeds font from request and returns presentation fonts info.

Parameters:

  • font —

    Font data.

  • name —

    Document name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14824
14825
14826
14827
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14824

def set_embedded_font_from_request(font, name, only_used = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_embedded_font_from_request_with_http_info(font, name, only_used, password, folder, storage)
  data
end

#set_embedded_font_from_request_online(document, font, only_used = nil, password = nil) ⇒ Object

Embeds font from request and returns presentation.

Parameters:

  • document —

    Document data.

  • font —

    Font data.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.



14891
14892
14893
14894
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14891

def set_embedded_font_from_request_online(document, font, only_used = nil, password = nil)
  data, _status_code, _headers = set_embedded_font_from_request_online_with_http_info(document, font, only_used, password)
  data
end

#set_embedded_font_from_request_online_with_http_info(document, font, only_used = nil, password = nil) ⇒ Object

Embeds font from request and returns presentation.

Parameters:

  • document —

    Document data.

  • font —

    Font data.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.



14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14901

def set_embedded_font_from_request_online_with_http_info(document, font, only_used = nil, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_embedded_font_from_request_online ...'
  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 SlidesApi.set_embedded_font_from_request_online"
  end
  # verify the required parameter 'font' is set
  if @api_client.config.client_side_validation && font.nil?
    fail ArgumentError, "Missing the required parameter 'font' when calling SlidesApi.set_embedded_font_from_request_online"
  end
  # resource path
  local_var_path = '/slides/fonts/embedded'

  # query parameters
  query_params = {}
  query_params[:'onlyUsed'] = @api_client.prepare_for_query(only_used) unless only_used.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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

  # http body (model)
  post_body = nil

  # form parameters
  post_files = []
  if document
    post_files = post_files.push(document)
  end
  if font
    post_files = post_files.push(font)
  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 => 'File')
  return data, status_code, headers
end

#set_embedded_font_from_request_with_http_info(font, name, only_used = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Embeds font from request and returns presentation fonts info.

Parameters:

  • font —

    Font data.

  • name —

    Document name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14836

def set_embedded_font_from_request_with_http_info(font, name, only_used = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_embedded_font_from_request ...'
  end

  # verify the required parameter 'font' is set
  if @api_client.config.client_side_validation && font.nil?
    fail ArgumentError, "Missing the required parameter 'font' when calling SlidesApi.set_embedded_font_from_request"
  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 SlidesApi.set_embedded_font_from_request"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts/embedded'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'onlyUsed'] = @api_client.prepare_for_query(only_used) unless only_used.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?

  # 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 = nil

  # form parameters
  post_files = []
  if font
    post_files = post_files.push(font)
  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 => 'FontsData')
  return data, status_code, headers
end

#set_embedded_font_online(document, font_name, only_used = nil, password = nil, fonts_folder = nil) ⇒ Object

Embeds specified font and returns presentation.

Parameters:

  • document —

    Document data.

  • font_name —

    Font name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



14957
14958
14959
14960
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14957

def set_embedded_font_online(document, font_name, only_used = nil, password = nil, fonts_folder = nil)
  data, _status_code, _headers = set_embedded_font_online_with_http_info(document, font_name, only_used, password, fonts_folder)
  data
end

#set_embedded_font_online_with_http_info(document, font_name, only_used = nil, password = nil, fonts_folder = nil) ⇒ Object

Embeds specified font and returns presentation.

Parameters:

  • document —

    Document data.

  • font_name —

    Font name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14968

def set_embedded_font_online_with_http_info(document, font_name, only_used = nil, password = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_embedded_font_online ...'
  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 SlidesApi.set_embedded_font_online"
  end
  # verify the required parameter 'font_name' is set
  if @api_client.config.client_side_validation && font_name.nil?
    fail ArgumentError, "Missing the required parameter 'font_name' when calling SlidesApi.set_embedded_font_online"
  end
  # resource path
  local_var_path = '/slides/fonts/embedded/{fontName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'fontName', font_name)

  # query parameters
  query_params = {}
  query_params[:'onlyUsed'] = @api_client.prepare_for_query(only_used) unless only_used.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(['multipart/form-data'])
  # 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 = nil

  # 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 => 'File')
  return data, status_code, headers
end

#set_embedded_font_with_http_info(name, font_name, only_used = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil) ⇒ Object

Embeds specified font and returns presentation fonts info.

Parameters:

  • name —

    Document name.

  • font_name —

    Font name.

  • only_used (defaults to: nil) —

    Only used characters will be embedded.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14768

def set_embedded_font_with_http_info(name, font_name, only_used = nil, password = nil, folder = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_embedded_font ...'
  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 SlidesApi.set_embedded_font"
  end
  # verify the required parameter 'font_name' is set
  if @api_client.config.client_side_validation && font_name.nil?
    fail ArgumentError, "Missing the required parameter 'font_name' when calling SlidesApi.set_embedded_font"
  end
  # resource path
  local_var_path = '/slides/{name}/fonts/embedded/{fontName}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'fontName', font_name)

  # query parameters
  query_params = {}
  query_params[:'onlyUsed'] = @api_client.prepare_for_query(only_used) unless only_used.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 = nil

  # 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 => 'FontsData')
  return data, status_code, headers
end

#set_notes_slide_header_footer(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set header/footer the notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    Header/footer to set.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15024
15025
15026
15027
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15024

def set_notes_slide_header_footer(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_notes_slide_header_footer_with_http_info(name, slide_index, dto, password, folder, storage)
  data
end

#set_notes_slide_header_footer_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set header/footer the notes slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    Header/footer to set.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15036

def set_notes_slide_header_footer_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_notes_slide_header_footer ...'
  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 SlidesApi.set_notes_slide_header_footer"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_notes_slide_header_footer"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_notes_slide_header_footer"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide/headerFooter'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(dto)

  # 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 => 'NotesSlideHeaderFooter')
  return data, status_code, headers
end

#set_presentation_header_footer(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set footers for all slides in a presentation.

Parameters:

  • name —

    Document name.

  • dto —

    HeaderFooter instance.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15093
15094
15095
15096
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15093

def set_presentation_header_footer(name, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_presentation_header_footer_with_http_info(name, dto, password, folder, storage)
  data
end

#set_presentation_header_footer_with_http_info(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set footers for all slides in a presentation.

Parameters:

  • name —

    Document name.

  • dto —

    HeaderFooter instance.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15104

def set_presentation_header_footer_with_http_info(name, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_presentation_header_footer ...'
  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 SlidesApi.set_presentation_header_footer"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_presentation_header_footer"
  end
  # resource path
  local_var_path = '/slides/{name}/headerFooter'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(dto)

  # 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 => 'Document')
  return data, status_code, headers
end

#set_protection(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates presentation protection properties.

Parameters:

  • name —

    Document name.

  • dto —

    Protection properties.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15156
15157
15158
15159
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15156

def set_protection(name, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_protection_with_http_info(name, dto, password, folder, storage)
  data
end

#set_protection_online(document, dto, password = nil) ⇒ Object

Sets presentation protection options.

Parameters:

  • document —

    Document data.

  • dto —

    Protection properties.

  • password (defaults to: nil) —

    Document password.



15217
15218
15219
15220
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15217

def set_protection_online(document, dto, password = nil)
  data, _status_code, _headers = set_protection_online_with_http_info(document, dto, password)
  data
end

#set_protection_online_with_http_info(document, dto, password = nil) ⇒ Object

Sets presentation protection options.

Parameters:

  • document —

    Document data.

  • dto —

    Protection properties.

  • password (defaults to: nil) —

    Document password.



15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15226

def set_protection_online_with_http_info(document, dto, password = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_protection_online ...'
  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 SlidesApi.set_protection_online"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_protection_online"
  end
  # resource path
  local_var_path = '/slides/protection'

  # 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(['multipart/form-data'])
  header_params[:'password'] = password unless password.nil?

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

  # 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 => 'File')
  return data, status_code, headers
end

#set_protection_with_http_info(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates presentation protection properties.

Parameters:

  • name —

    Document name.

  • dto —

    Protection properties.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15167

def set_protection_with_http_info(name, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_protection ...'
  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 SlidesApi.set_protection"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_protection"
  end
  # resource path
  local_var_path = '/slides/{name}/protection'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(dto)

  # 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 => 'ProtectionProperties')
  return data, status_code, headers
end

#set_sections(name, sections, password = nil, folder = nil, storage = nil) ⇒ Object

Replace existing presentation sections with the ones provided in the sections DTO.

Parameters:

  • name —

    Document name.

  • sections —

    Sections DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15278
15279
15280
15281
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15278

def set_sections(name, sections, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_sections_with_http_info(name, sections, password, folder, storage)
  data
end

#set_sections_with_http_info(name, sections, password = nil, folder = nil, storage = nil) ⇒ Object

Replace existing presentation sections with the ones provided in the sections DTO.

Parameters:

  • name —

    Document name.

  • sections —

    Sections DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15289

def set_sections_with_http_info(name, sections, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_sections ...'
  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 SlidesApi.set_sections"
  end
  # verify the required parameter 'sections' is set
  if @api_client.config.client_side_validation && sections.nil?
    fail ArgumentError, "Missing the required parameter 'sections' when calling SlidesApi.set_sections"
  end
  # resource path
  local_var_path = '/slides/{name}/sections'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(sections)

  # 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 => 'Sections')
  return data, status_code, headers
end

#set_shape_geometry_path(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Sets geometry path to the shape

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Geometry paths DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15343
15344
15345
15346
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15343

def set_shape_geometry_path(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_shape_geometry_path_with_http_info(name, slide_index, shape_index, dto, password, folder, storage)
  data
end

#set_shape_geometry_path_with_http_info(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Sets geometry path to the shape

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Geometry paths DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15356

def set_shape_geometry_path_with_http_info(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_shape_geometry_path ...'
  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 SlidesApi.set_shape_geometry_path"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_shape_geometry_path"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.set_shape_geometry_path"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_shape_geometry_path"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/geometryPath'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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?

  # 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(dto)

  # 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 => 'ShapeBase')
  return data, status_code, headers
end

#set_slide_header_footer(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set footer the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • dto —

    Footer to set.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15419
15420
15421
15422
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15419

def set_slide_header_footer(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_slide_header_footer_with_http_info(name, slide_index, dto, password, folder, storage)
  data
end

#set_slide_header_footer_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Set footer the slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    The position of the slide to be reordered.

  • dto —

    Footer to set.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15431

def set_slide_header_footer_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_slide_header_footer ...'
  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 SlidesApi.set_slide_header_footer"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_slide_header_footer"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_slide_header_footer"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/headerFooter'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(dto)

  # 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 => 'HeaderFooter')
  return data, status_code, headers
end

#set_slide_properties(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation slide properties.

Parameters:

  • name —

    Document name.

  • dto —

    The view properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15488
15489
15490
15491
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15488

def set_slide_properties(name, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_slide_properties_with_http_info(name, dto, password, folder, storage)
  data
end

#set_slide_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation slide properties.

Parameters:

  • name —

    Document name.

  • dto —

    The view properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15499

def set_slide_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_slide_properties ...'
  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 SlidesApi.set_slide_properties"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_slide_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/slideProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(dto)

  # 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 => 'SlideProperties')
  return data, status_code, headers
end

#set_slide_show_properties(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation slide show properties.

Parameters:

  • name —

    Document name.

  • dto —

    The slide show properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15551
15552
15553
15554
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15551

def set_slide_show_properties(name, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_slide_show_properties_with_http_info(name, dto, password, folder, storage)
  data
end

#set_slide_show_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation slide show properties.

Parameters:

  • name —

    Document name.

  • dto —

    The slide show properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15562

def set_slide_show_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_slide_show_properties ...'
  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 SlidesApi.set_slide_show_properties"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_slide_show_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/slideShowProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(dto)

  # 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 => 'SlideShowProperties')
  return data, status_code, headers
end

#set_special_slide_animation(name, slide_index, slide_type, animation, password = nil, folder = nil, storage = nil) ⇒ Object

Set special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • animation —

    Animation DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15616
15617
15618
15619
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15616

def set_special_slide_animation(name, slide_index, slide_type, animation, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_special_slide_animation_with_http_info(name, slide_index, slide_type, animation, password, folder, storage)
  data
end

#set_special_slide_animation_with_http_info(name, slide_index, slide_type, animation, password = nil, folder = nil, storage = nil) ⇒ Object

Set special slide (master, layout, notes) animation.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • animation —

    Animation DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15629

def set_special_slide_animation_with_http_info(name, slide_index, slide_type, animation, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_special_slide_animation ...'
  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 SlidesApi.set_special_slide_animation"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.set_special_slide_animation"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.set_special_slide_animation"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'animation' is set
  if @api_client.config.client_side_validation && animation.nil?
    fail ArgumentError, "Missing the required parameter 'animation' when calling SlidesApi.set_special_slide_animation"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)

  # 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?

  # 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(animation)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#set_view_properties(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation view properties.

Parameters:

  • name —

    Document name.

  • dto —

    The view properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15695
15696
15697
15698
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15695

def set_view_properties(name, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = set_view_properties_with_http_info(name, dto, password, folder, storage)
  data
end

#set_view_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update presentation view properties.

Parameters:

  • name —

    Document name.

  • dto —

    The view properties data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15706

def set_view_properties_with_http_info(name, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.set_view_properties ...'
  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 SlidesApi.set_view_properties"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.set_view_properties"
  end
  # resource path
  local_var_path = '/slides/{name}/viewProperties'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # 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?

  # 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(dto)

  # 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 => 'ViewProperties')
  return data, status_code, headers
end

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

Splitting presentations. Create one image per slide.

Parameters:

  • name —

    Document name.

  • options (defaults to: nil) —

    Export options.

  • format (defaults to: nil) —

    Export format. Default value is jpeg.

  • width (defaults to: nil) —

    The width of created images.

  • height (defaults to: nil) —

    The height of created images.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • dest_folder (defaults to: nil) —

    Folder on storage where images are going to be uploaded. If not specified then images are uploaded to same folder as presentation.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15765
15766
15767
15768
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15765

def split(name, options = nil, format = 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 = split_with_http_info(name, options, format, width, height, from, to, dest_folder, password, folder, storage, fonts_folder)
  data
end

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

Splits PowerPoint presentation slides from the specified range into separate files and exports them in the specified file format. If the range is not provided all slides will be processed.

Parameters:

  • document —

    Document data.

  • format —

    ExportFormat

  • dest_folder (defaults to: nil) —

    Folder on storage where images are going to be uploaded. If not specified then images are uploaded to the root folder.

  • width (defaults to: nil) —

    Slide width.

  • height (defaults to: nil) —

    Slide height.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15846
15847
15848
15849
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15846

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

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

Splits PowerPoint presentation slides from the specified range into separate files and exports them in the specified file format. If the range is not provided all slides will be processed.

Parameters:

  • document —

    Document data.

  • format —

    ExportFormat

  • dest_folder (defaults to: nil) —

    Folder on storage where images are going to be uploaded. If not specified then images are uploaded to the root folder.

  • width (defaults to: nil) —

    Slide width.

  • height (defaults to: nil) —

    Slide height.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15862

def split_and_save_online_with_http_info(document, format, dest_folder = nil, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.split_and_save_online ...'
  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 SlidesApi.split_and_save_online"
  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 SlidesApi.split_and_save_online"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/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 = nil

  # 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 => 'SplitDocumentResult')
  return data, status_code, headers
end

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

Splits PowerPoint presentation slides from the specified range into separate files and exports them in the specified file format. If the range is not provided all slides will be processed.

Parameters:

  • document —

    Document data.

  • format —

    ExportFormat

  • width (defaults to: nil) —

    Slide width.

  • height (defaults to: nil) —

    Slide height.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15930
15931
15932
15933
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15930

def split_online(document, format, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil)
  data, _status_code, _headers = split_online_with_http_info(document, format, width, height, from, to, password, storage, fonts_folder)
  data
end

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

Splits PowerPoint presentation slides from the specified range into separate files and exports them in the specified file format. If the range is not provided all slides will be processed.

Parameters:

  • document —

    Document data.

  • format —

    ExportFormat

  • width (defaults to: nil) —

    Slide width.

  • height (defaults to: nil) —

    Slide height.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • password (defaults to: nil) —

    Document password.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15945

def split_online_with_http_info(document, format, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.split_online ...'
  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 SlidesApi.split_online"
  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 SlidesApi.split_online"
  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'].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"
  end
  # resource path
  local_var_path = '/slides/split/{format}'
  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[:'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(['multipart/form-data'])
  # 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 = nil

  # 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 => 'File')
  return data, status_code, headers
end

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

Splitting presentations. Create one image per slide.

Parameters:

  • name —

    Document name.

  • options (defaults to: nil) —

    Export options.

  • format (defaults to: nil) —

    Export format. Default value is jpeg.

  • width (defaults to: nil) —

    The width of created images.

  • height (defaults to: nil) —

    The height of created images.

  • from (defaults to: nil) —

    The start slide number for splitting, if is not specified splitting starts from the first slide of the presentation.

  • to (defaults to: nil) —

    The last slide number for splitting, if is not specified splitting ends at the last slide of the document.

  • dest_folder (defaults to: nil) —

    Folder on storage where images are going to be uploaded. If not specified then images are uploaded to same folder as presentation.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • fonts_folder (defaults to: nil) —

    Custom fonts folder.



15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15783

def split_with_http_info(name, options = nil, format = 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: SlidesApi.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 SlidesApi.split"
  end
  if @api_client.config.client_side_validation && format && !['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Html', 'Pdf', 'Xps', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Potx', 'Pot', 'Potm', 'Svg', 'Fodp', 'Xaml', 'Html5'].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"
  end
  # resource path
  local_var_path = '/slides/{name}/split'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)

  # query parameters
  query_params = {}
  query_params[:'format'] = @api_client.prepare_for_query(format) unless format.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[:'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 => 'SplitDocumentResult')
  return data, status_code, headers
end

#storage_exists(storage_name) ⇒ Object

Check if storage exists

Parameters:

  • storage_name —

    Storage name



16004
16005
16006
16007
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16004

def storage_exists(storage_name)
  data, _status_code, _headers = storage_exists_with_http_info(storage_name)
  data
end

#storage_exists_with_http_info(storage_name) ⇒ Object

Check if storage exists

Parameters:

  • storage_name —

    Storage name



16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16011

def storage_exists_with_http_info(storage_name)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.storage_exists ...'
  end

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

  # 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 => 'StorageExist')
  return data, status_code, headers
end

#update_animation_effect(name, slide_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16058
16059
16060
16061
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16058

def update_animation_effect(name, slide_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_animation_effect_with_http_info(name, slide_index, effect_index, effect, password, folder, storage)
  data
end

#update_animation_effect_with_http_info(name, slide_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16071

def update_animation_effect_with_http_info(name, slide_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_animation_effect ...'
  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 SlidesApi.update_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_animation_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.update_animation_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.update_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/mainSequence/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#update_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a slide interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The position of the interactive sequence.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16136
16137
16138
16139
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16136

def update_animation_interactive_sequence_effect(name, slide_index, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, effect, password, folder, storage)
  data
end

#update_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a slide interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • sequence_index —

    The position of the interactive sequence.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16150

def update_animation_interactive_sequence_effect_with_http_info(name, slide_index, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_animation_interactive_sequence_effect ...'
  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 SlidesApi.update_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.update_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.update_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.update_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/animation/interactiveSequences/{sequenceIndex}/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#update_chart_category(name, slide_index, shape_index, category_index, category, password = nil, folder = nil, storage = nil) ⇒ Object

Update a chart category.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category_index —

    Category index.

  • category —

    Category DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16220
16221
16222
16223
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16220

def update_chart_category(name, slide_index, shape_index, category_index, category, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_chart_category_with_http_info(name, slide_index, shape_index, category_index, category, password, folder, storage)
  data
end

#update_chart_category_with_http_info(name, slide_index, shape_index, category_index, category, password = nil, folder = nil, storage = nil) ⇒ Object

Update a chart category.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • category_index —

    Category index.

  • category —

    Category DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16234

def update_chart_category_with_http_info(name, slide_index, shape_index, category_index, category, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_chart_category ...'
  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 SlidesApi.update_chart_category"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_chart_category"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_chart_category"
  end
  # verify the required parameter 'category_index' is set
  if @api_client.config.client_side_validation && category_index.nil?
    fail ArgumentError, "Missing the required parameter 'category_index' when calling SlidesApi.update_chart_category"
  end
  # verify the required parameter 'category' is set
  if @api_client.config.client_side_validation && category.nil?
    fail ArgumentError, "Missing the required parameter 'category' when calling SlidesApi.update_chart_category"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/categories/{categoryIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'categoryIndex', category_index)

  # 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?

  # 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(category)

  # 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 => 'Chart')
  return data, status_code, headers
end

#update_chart_data_point(name, slide_index, shape_index, series_index, point_index, data_point, password = nil, folder = nil, storage = nil) ⇒ Object

Update a data point in a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • point_index —

    Data point index.

  • data_point —

    Data point DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16305
16306
16307
16308
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16305

def update_chart_data_point(name, slide_index, shape_index, series_index, point_index, data_point, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, data_point, password, folder, storage)
  data
end

#update_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, data_point, password = nil, folder = nil, storage = nil) ⇒ Object

Update a data point in a chart series.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • series_index —

    Series index.

  • point_index —

    Data point index.

  • data_point —

    Data point DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16320

def update_chart_data_point_with_http_info(name, slide_index, shape_index, series_index, point_index, data_point, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_chart_data_point ...'
  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 SlidesApi.update_chart_data_point"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_chart_data_point"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_chart_data_point"
  end
  # verify the required parameter 'series_index' is set
  if @api_client.config.client_side_validation && series_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_index' when calling SlidesApi.update_chart_data_point"
  end
  # verify the required parameter 'point_index' is set
  if @api_client.config.client_side_validation && point_index.nil?
    fail ArgumentError, "Missing the required parameter 'point_index' when calling SlidesApi.update_chart_data_point"
  end
  # verify the required parameter 'data_point' is set
  if @api_client.config.client_side_validation && data_point.nil?
    fail ArgumentError, "Missing the required parameter 'data_point' when calling SlidesApi.update_chart_data_point"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series/{seriesIndex}/dataPoints/{pointIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesIndex', series_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'pointIndex', point_index)

  # 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?

  # 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(data_point)

  # 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 => 'Chart')
  return data, status_code, headers
end

#update_chart_series(name, slide_index, shape_index, series_index, series, password = nil, folder = nil, storage = nil) ⇒ Object

Update a series in a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_index —

    Series index.

  • series —

    Series DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16395
16396
16397
16398
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16395

def update_chart_series(name, slide_index, shape_index, series_index, series, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_chart_series_with_http_info(name, slide_index, shape_index, series_index, series, password, folder, storage)
  data
end

#update_chart_series_with_http_info(name, slide_index, shape_index, series_index, series, password = nil, folder = nil, storage = nil) ⇒ Object

Update a series in a chart.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index (must be a chart).

  • series_index —

    Series index.

  • series —

    Series DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16409

def update_chart_series_with_http_info(name, slide_index, shape_index, series_index, series, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_chart_series ...'
  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 SlidesApi.update_chart_series"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_chart_series"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_chart_series"
  end
  # verify the required parameter 'series_index' is set
  if @api_client.config.client_side_validation && series_index.nil?
    fail ArgumentError, "Missing the required parameter 'series_index' when calling SlidesApi.update_chart_series"
  end
  # verify the required parameter 'series' is set
  if @api_client.config.client_side_validation && series.nil?
    fail ArgumentError, "Missing the required parameter 'series' when calling SlidesApi.update_chart_series"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/series/{seriesIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'seriesIndex', series_index)

  # 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?

  # 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(series)

  # 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 => 'Chart')
  return data, status_code, headers
end

#update_layout_slide(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update a layoutSlide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • slide_dto —

    Slide update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16477
16478
16479
16480
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16477

def update_layout_slide(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_layout_slide_with_http_info(name, slide_index, slide_dto, password, folder, storage)
  data
end

#update_layout_slide_with_http_info(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update a layoutSlide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • slide_dto —

    Slide update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16489

def update_layout_slide_with_http_info(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_layout_slide ...'
  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 SlidesApi.update_layout_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_layout_slide"
  end
  # verify the required parameter 'slide_dto' is set
  if @api_client.config.client_side_validation && slide_dto.nil?
    fail ArgumentError, "Missing the required parameter 'slide_dto' when calling SlidesApi.update_layout_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/layoutSlides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(slide_dto)

  # 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 => 'LayoutSlide')
  return data, status_code, headers
end

#update_notes_slide(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update notes slide properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    A NotesSlide object with notes slide data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16547
16548
16549
16550
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16547

def update_notes_slide(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_notes_slide_with_http_info(name, slide_index, dto, password, folder, storage)
  data
end

#update_notes_slide_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update notes slide properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • dto —

    A NotesSlide object with notes slide data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16559

def update_notes_slide_with_http_info(name, slide_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_notes_slide ...'
  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 SlidesApi.update_notes_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_notes_slide"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_notes_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/notesSlide'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(dto)

  # 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 => 'NotesSlide')
  return data, status_code, headers
end

#update_paragraph(name, slide_index, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update paragraph properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Paragraph DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16620
16621
16622
16623
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16620

def update_paragraph(name, slide_index, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, dto, password, folder, storage, sub_shape)
  data
end

#update_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update paragraph properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Paragraph DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16635

def update_paragraph_with_http_info(name, slide_index, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_paragraph ...'
  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 SlidesApi.update_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_paragraph"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.update_paragraph"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Paragraph')
  return data, status_code, headers
end

#update_portion(name, slide_index, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update portion properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16708
16709
16710
16711
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16708

def update_portion(name, slide_index, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, dto, password, folder, storage, sub_shape)
  data
end

#update_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update portion properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16724

def update_portion_with_http_info(name, slide_index, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_portion ...'
  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 SlidesApi.update_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_portion"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.update_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.update_portion"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Portion')
  return data, status_code, headers
end

#update_section(name, section_index, section_name, password = nil, folder = nil, storage = nil) ⇒ Object

Update section name.

Parameters:

  • name —

    Document name.

  • section_index —

    The position of the section to be updated.

  • section_name —

    Section name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16798
16799
16800
16801
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16798

def update_section(name, section_index, section_name, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_section_with_http_info(name, section_index, section_name, password, folder, storage)
  data
end

#update_section_with_http_info(name, section_index, section_name, password = nil, folder = nil, storage = nil) ⇒ Object

Update section name.

Parameters:

  • name —

    Document name.

  • section_index —

    The position of the section to be updated.

  • section_name —

    Section name.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16810

def update_section_with_http_info(name, section_index, section_name, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_section ...'
  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 SlidesApi.update_section"
  end
  # verify the required parameter 'section_index' is set
  if @api_client.config.client_side_validation && section_index.nil?
    fail ArgumentError, "Missing the required parameter 'section_index' when calling SlidesApi.update_section"
  end
  # verify the required parameter 'section_name' is set
  if @api_client.config.client_side_validation && section_name.nil?
    fail ArgumentError, "Missing the required parameter 'section_name' when calling SlidesApi.update_section"
  end
  # resource path
  local_var_path = '/slides/{name}/sections/{sectionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sectionIndex', section_index)

  # query parameters
  query_params = {}
  query_params[:'sectionName'] = @api_client.prepare_for_query(section_name) unless section_name.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?

  # 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 = nil

  # 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 => 'Sections')
  return data, status_code, headers
end

#update_shape(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update shape properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Shape DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16871
16872
16873
16874
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16871

def update_shape(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_shape_with_http_info(name, slide_index, shape_index, dto, password, folder, storage, sub_shape)
  data
end

#update_shape_with_http_info(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update shape properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Shape DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16885

def update_shape_with_http_info(name, slide_index, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_shape ...'
  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 SlidesApi.update_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_shape"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_shape"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'ShapeBase')
  return data, status_code, headers
end

#update_slide(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • slide_dto —

    Slide update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16949
16950
16951
16952
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16949

def update_slide(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_slide_with_http_info(name, slide_index, slide_dto, password, folder, storage)
  data
end

#update_slide_with_http_info(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update a slide.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • slide_dto —

    Slide update data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16961

def update_slide_with_http_info(name, slide_index, slide_dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_slide ...'
  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 SlidesApi.update_slide"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_slide"
  end
  # verify the required parameter 'slide_dto' is set
  if @api_client.config.client_side_validation && slide_dto.nil?
    fail ArgumentError, "Missing the required parameter 'slide_dto' when calling SlidesApi.update_slide"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)

  # 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?

  # 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(slide_dto)

  # 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 => 'Slide')
  return data, status_code, headers
end

#update_special_slide_animation_effect(name, slide_index, slide_type, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a special slide (master, layout, notes).

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17021
17022
17023
17024
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17021

def update_special_slide_animation_effect(name, slide_index, slide_type, effect_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, effect, password, folder, storage)
  data
end

#update_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a special slide (master, layout, notes).

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17035

def update_special_slide_animation_effect_with_http_info(name, slide_index, slide_type, effect_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_special_slide_animation_effect ...'
  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 SlidesApi.update_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_special_slide_animation_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.update_special_slide_animation_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.update_special_slide_animation_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.update_special_slide_animation_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/mainSequence/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#update_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a special slide (master, layout, notes) interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The position of the interactive sequence.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17110
17111
17112
17113
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17110

def update_special_slide_animation_interactive_sequence_effect(name, slide_index, slide_type, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, effect, password, folder, storage)
  data
end

#update_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil) ⇒ Object

Modify an animation effect for a special slide (master, layout, notes) interactive sequence.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • sequence_index —

    The position of the interactive sequence.

  • effect_index —

    The position of the effect to be modified.

  • effect —

    Animation effect DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17125

def update_special_slide_animation_interactive_sequence_effect_with_http_info(name, slide_index, slide_type, sequence_index, effect_index, effect, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_special_slide_animation_interactive_sequence_effect ...'
  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 SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'sequence_index' is set
  if @api_client.config.client_side_validation && sequence_index.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_index' when calling SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect_index' is set
  if @api_client.config.client_side_validation && effect_index.nil?
    fail ArgumentError, "Missing the required parameter 'effect_index' when calling SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # verify the required parameter 'effect' is set
  if @api_client.config.client_side_validation && effect.nil?
    fail ArgumentError, "Missing the required parameter 'effect' when calling SlidesApi.update_special_slide_animation_interactive_sequence_effect"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/animation/interactiveSequences/{sequenceIndex}/{effectIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'sequenceIndex', sequence_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'effectIndex', effect_index)

  # 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?

  # 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(effect)

  # 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 => 'SlideAnimation')
  return data, status_code, headers
end

#update_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update paragraph properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Paragraph DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17206
17207
17208
17209
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17206

def update_special_slide_paragraph(name, slide_index, slide_type, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, password, folder, storage, sub_shape)
  data
end

#update_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update paragraph properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Paragraph DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17222

def update_special_slide_paragraph_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_special_slide_paragraph ...'
  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 SlidesApi.update_special_slide_paragraph"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_special_slide_paragraph"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.update_special_slide_paragraph"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_special_slide_paragraph"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.update_special_slide_paragraph"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_special_slide_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Paragraph')
  return data, status_code, headers
end

#update_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update portion properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17305
17306
17307
17308
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17305

def update_special_slide_portion(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, dto, password, folder, storage, sub_shape)
  data
end

#update_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update portion properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • paragraph_index —

    Paragraph index.

  • portion_index —

    Portion index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17322

def update_special_slide_portion_with_http_info(name, slide_index, slide_type, shape_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_special_slide_portion ...'
  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 SlidesApi.update_special_slide_portion"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_special_slide_portion"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.update_special_slide_portion"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_special_slide_portion"
  end
  # verify the required parameter 'paragraph_index' is set
  if @api_client.config.client_side_validation && paragraph_index.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph_index' when calling SlidesApi.update_special_slide_portion"
  end
  # verify the required parameter 'portion_index' is set
  if @api_client.config.client_side_validation && portion_index.nil?
    fail ArgumentError, "Missing the required parameter 'portion_index' when calling SlidesApi.update_special_slide_portion"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_special_slide_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'paragraphIndex', paragraph_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'portionIndex', portion_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'Portion')
  return data, status_code, headers
end

#update_special_slide_shape(name, slide_index, slide_type, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update shape properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • dto —

    Shape DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17408
17409
17410
17411
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17408

def update_special_slide_shape(name, slide_index, slide_type, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  data, _status_code, _headers = update_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, dto, password, folder, storage, sub_shape)
  data
end

#update_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil) ⇒ Object

Update shape properties.

Parameters:

  • name —

    Document name.

  • slide_index —

    Parent slide index.

  • slide_type —

    Slide type (master, layout or notes).

  • shape_index —

    Shape index.

  • dto —

    Shape DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.

  • sub_shape (defaults to: nil) —

    Sub-shape path (e.g. "3", "3/shapes/2).



17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17423

def update_special_slide_shape_with_http_info(name, slide_index, slide_type, shape_index, dto, password = nil, folder = nil, storage = nil, sub_shape = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_special_slide_shape ...'
  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 SlidesApi.update_special_slide_shape"
  end
  # verify the required parameter 'slide_index' is set
  if @api_client.config.client_side_validation && slide_index.nil?
    fail ArgumentError, "Missing the required parameter 'slide_index' when calling SlidesApi.update_special_slide_shape"
  end
  # verify the required parameter 'slide_type' is set
  if @api_client.config.client_side_validation && slide_type.nil?
    fail ArgumentError, "Missing the required parameter 'slide_type' when calling SlidesApi.update_special_slide_shape"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['MasterSlide', 'LayoutSlide', 'NotesSlide'].any?{ |s| s.casecmp(slide_type)==0 }
    fail ArgumentError, "Invalid value for parameter slide_type: " + slide_type + ". Must be one of MasterSlide, LayoutSlide, NotesSlide"
  end
  # verify the required parameter 'shape_index' is set
  if @api_client.config.client_side_validation && shape_index.nil?
    fail ArgumentError, "Missing the required parameter 'shape_index' when calling SlidesApi.update_special_slide_shape"
  end
  # verify the required parameter 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.update_special_slide_shape"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}'
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'name', name)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideIndex', slide_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'slideType', slide_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'shapeIndex', shape_index)

  # 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[:'subShape'] = @api_client.prepare_for_query(sub_shape) unless sub_shape.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(dto)

  # 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 => 'ShapeBase')
  return data, status_code, headers
end

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

Upload file

Parameters:

  • path —

    Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.

  • file —

    File to upload

  • storage_name (defaults to: nil) —

    Storage name



17493
17494
17495
17496
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17493

def upload_file(path, file, storage_name = nil)
  data, _status_code, _headers = upload_file_with_http_info(path, file, storage_name)
  data
end

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

Upload file

Parameters:

  • path —

    Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.

  • file —

    File to upload

  • storage_name (defaults to: nil) —

    Storage name



17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17502

def upload_file_with_http_info(path, file, storage_name = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.upload_file ...'
  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 SlidesApi.upload_file"
  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 SlidesApi.upload_file"
  end
  # resource path
  local_var_path = '/slides/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