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_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Creates table cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • dto —

    Paragraph DTO.

  • 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_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password, folder, storage)
  data
end

#create_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Creates table cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • dto —

    Paragraph DTO.

  • 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
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2897

def create_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_table_cell_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_table_cell_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_table_cell_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_table_cell_paragraph"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.create_table_cell_paragraph"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.create_table_cell_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_table_cell_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'Paragraph')
  return data, status_code, headers
end

#create_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Creates table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2974
2975
2976
2977
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2974

def create_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password, folder, storage)
  data
end

#create_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Creates table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • dto —

    Portion DTO.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 2990

def create_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_table_cell_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_table_cell_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_table_cell_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_table_cell_portion"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.create_table_cell_portion"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.create_table_cell_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_table_cell_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_table_cell_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 = @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_table_row(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Inserts the table row in the specified position. If position is not specified, the row add to the end of the table.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Table row data.

  • position (defaults to: nil) —

    Position.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3070
3071
3072
3073
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3070

def create_table_row(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = create_table_row_with_http_info(name, slide_index, shape_index, dto, position, password, folder, storage)
  data
end

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

Inserts the table row in the specified position. If position is not specified, the row add to the end of the table.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • dto —

    Table row data.

  • position (defaults to: nil) —

    Position.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



3084
3085
3086
3087
3088
3089
3090
3091
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3084

def create_table_row_with_http_info(name, slide_index, shape_index, dto, position = nil, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_table_row ...'
  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_table_row"
  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_table_row"
  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_table_row"
  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_table_row"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows'
  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?

  # 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 => 'TableRow')
  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.



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

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.



3219
3220
3221
3222
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3219

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.



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

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.



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

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.



3284
3285
3286
3287
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3284

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.



3349
3350
3351
3352
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3349

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.



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3361

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.



3420
3421
3422
3423
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3420

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.



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

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.



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

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.



3432
3433
3434
3435
3436
3437
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3432

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.



3568
3569
3570
3571
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3568

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.



3579
3580
3581
3582
3583
3584
3585
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3579

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.



3632
3633
3634
3635
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3632

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.



3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3643

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.



3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3295

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.



3696
3697
3698
3699
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3696

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.



3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3707

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.



3762
3763
3764
3765
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3762

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.



3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3775

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.



3841
3842
3843
3844
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3841

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.



3855
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
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3855

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.



3925
3926
3927
3928
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3925

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.



3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 3938

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.



4001
4002
4003
4004
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4001

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.



4058
4059
4060
4061
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4058

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.



4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4067

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.



4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4012

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.



4115
4116
4117
4118
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4115

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.



4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4125

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.



4173
4174
4175
4176
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4173

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.



4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4184

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.



4237
4238
4239
4240
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4237

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.



4299
4300
4301
4302
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4299

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.



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
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4308

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.



4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4248

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



4359
4360
4361
4362
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4359

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



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

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



4412
4413
4414
4415
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4412

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



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4421

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.



4467
4468
4469
4470
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4467

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.



4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4478

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).



4534
4535
4536
4537
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4534

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).



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
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4548

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).



4615
4616
4617
4618
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4615

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).



4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4629

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).



4693
4694
4695
4696
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4693

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).



4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
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
4767
4768
4769
4770
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4708

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).



4781
4782
4783
4784
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4781

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).



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
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4796

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.



4860
4861
4862
4863
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4860

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.



4915
4916
4917
4918
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4915

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.



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

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.



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
4904
4905
4906
4907
4908
4909
4910
4911
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4870

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.



4976
4977
4978
4979
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 4976

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.



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

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.



5043
5044
5045
5046
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5043

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.



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

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).



5107
5108
5109
5110
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5107

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).



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
5168
5169
5170
5171
5172
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5120

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).



5181
5182
5183
5184
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5181

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).



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
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5194

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.



5249
5250
5251
5252
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5249

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.



5314
5315
5316
5317
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5314

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.



5379
5380
5381
5382
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5379

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.



5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5389

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.



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

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.



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

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.



5443
5444
5445
5446
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5443

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.



5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5454

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.



5506
5507
5508
5509
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5506

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.



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
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5520

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.



5585
5586
5587
5588
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5585

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.



5661
5662
5663
5664
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5661

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.



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
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5674

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.



5743
5744
5745
5746
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5743

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.



5826
5827
5828
5829
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5826

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.



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
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5840

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.



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
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5756

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.



5913
5914
5915
5916
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5913

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.



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
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5925

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.



5988
5989
5990
5991
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5988

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.



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

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.



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
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 5597

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).



6066
6067
6068
6069
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6066

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).



6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6081

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).



6158
6159
6160
6161
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6158

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).



6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6173

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).



6247
6248
6249
6250
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6247

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).



6263
6264
6265
6266
6267
6268
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
6327
6328
6329
6330
6331
6332
6333
6334
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6263

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).



6346
6347
6348
6349
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6346

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).



6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6362

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).



6439
6440
6441
6442
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6439

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).



6453
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
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6453

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).



6524
6525
6526
6527
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6524

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).



6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6538

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_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6606
6607
6608
6609
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6606

def delete_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password, folder, storage)
  data
end

#delete_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6621
6622
6623
6624
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
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6621

def delete_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_table_cell_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_table_cell_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_table_cell_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_table_cell_paragraph"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.delete_table_cell_paragraph"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.delete_table_cell_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_table_cell_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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(: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_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete table ell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



6699
6700
6701
6702
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6699

def delete_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password, folder, storage)
  data
end

#delete_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Delete table ell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6715

def delete_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_table_cell_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_table_cell_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_table_cell_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_table_cell_portion"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.delete_table_cell_portion"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.delete_table_cell_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_table_cell_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_table_cell_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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(: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_table_row(name, slide_index, shape_index, row_index, with_attached_rows = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Deletes the table row.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • with_attached_rows (defaults to: nil) —

    Also delete all attached rows.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6796
6797
6798
6799
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6796

def delete_table_row(name, slide_index, shape_index, row_index, with_attached_rows = nil, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = delete_table_row_with_http_info(name, slide_index, shape_index, row_index, with_attached_rows, password, folder, storage)
  data
end

#delete_table_row_with_http_info(name, slide_index, shape_index, row_index, with_attached_rows = nil, password = nil, folder = nil, storage = nil) ⇒ Object

Deletes the table row.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • with_attached_rows (defaults to: nil) —

    Also delete all attached rows.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



6810
6811
6812
6813
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
6861
6862
6863
6864
6865
6866
6867
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6810

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

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



6873
6874
6875
6876
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6873

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.



6928
6929
6930
6931
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6928

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.



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

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.



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
6921
6922
6923
6924
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6883

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.



6984
6985
6986
6987
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6984

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.



7042
7043
7044
7045
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7042

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.



7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7051

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.



6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 6995

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.



7100
7101
7102
7103
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7100

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.



7157
7158
7159
7160
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7157

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.



7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7166

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.



7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7111

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



7213
7214
7215
7216
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7213

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



7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7222

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.



7270
7271
7272
7273
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7270

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.



7344
7345
7346
7347
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7344

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.



7406
7407
7408
7409
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7406

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.



7415
7416
7417
7418
7419
7420
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7415

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.



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
7398
7399
7400
7401
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7355

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.



7467
7468
7469
7470
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7467

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.



7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7477

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.



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
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7282

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.



7539
7540
7541
7542
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7539

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.



7606
7607
7608
7609
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7606

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.



7661
7662
7663
7664
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7661

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.



7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7669

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.



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

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.



7715
7716
7717
7718
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7715

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.



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
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7724

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.



7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7550

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.



7785
7786
7787
7788
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7785

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.



7867
7868
7869
7870
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7867

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.



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
7930
7931
7932
7933
7934
7935
7936
7937
7938
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7880

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.



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
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7800

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.



7948
7949
7950
7951
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 7948

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.



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

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.



8033
8034
8035
8036
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8033

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.



8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8047

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).



8114
8115
8116
8117
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8114

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_from_dto(format, dto) ⇒ Object

Creates the shape from the DTO and returns the result in the specified format.

Parameters:

  • format —

    Export format

  • dto —

    Shape DTO.



8205
8206
8207
8208
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8205

def download_shape_from_dto(format, dto)
  data, _status_code, _headers = download_shape_from_dto_with_http_info(format, dto)
  data
end

#download_shape_from_dto_with_http_info(format, dto) ⇒ Object

Creates the shape from the DTO and returns the result in the specified format.

Parameters:

  • format —

    Export format

  • dto —

    Shape DTO.



8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8213

def download_shape_from_dto_with_http_info(format, dto)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.download_shape_from_dto ...'
  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_from_dto"
  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 'dto' is set
  if @api_client.config.client_side_validation && dto.nil?
    fail ArgumentError, "Missing the required parameter 'dto' when calling SlidesApi.download_shape_from_dto"
  end
  # resource path
  local_var_path = '/slides/shape/{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'])

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



8272
8273
8274
8275
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8272

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.



8289
8290
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
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8289

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).



8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8133

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.



8369
8370
8371
8372
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8369

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.



8454
8455
8456
8457
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8454

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.



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
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8469

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.



8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8385

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).



8544
8545
8546
8547
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8544

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).



8564
8565
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
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8564

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.



8650
8651
8652
8653
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8650

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.



8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8663

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.



8713
8714
8715
8716
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8713

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.



8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8719

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.



8759
8760
8761
8762
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8759

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.



8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8770

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.



8823
8824
8825
8826
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8823

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.



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8834

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



8883
8884
8885
8886
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8883

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



8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8890

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.



8930
8931
8932
8933
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8930

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.



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
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8940

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.



8988
8989
8990
8991
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8988

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.



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
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 8999

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



9049
9050
9051
9052
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9049

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



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
9093
9094
9095
9096
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9057

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



9100
9101
9102
9103
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9100

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



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

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.



9154
9155
9156
9157
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9154

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.



9165
9166
9167
9168
9169
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9165

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.



9217
9218
9219
9220
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9217

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.



9272
9273
9274
9275
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9272

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.



9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9280

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.



9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9227

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.



9328
9329
9330
9331
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9328

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.



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
9379
9380
9381
9382
9383
9384
9385
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9339

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.



9392
9393
9394
9395
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9392

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.



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

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.



9455
9456
9457
9458
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9455

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.



9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9465

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.



9513
9514
9515
9516
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9513

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.



9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9524

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.



9576
9577
9578
9579
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9576

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.



9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9586

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.



9634
9635
9636
9637
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9634

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.



9698
9699
9700
9701
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9698

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.



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

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.



9760
9761
9762
9763
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9760

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.



9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9769

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.



9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9645

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).



9825
9826
9827
9828
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9825

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).



9906
9907
9908
9909
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9906

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).



9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9920

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.



9986
9987
9988
9989
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9986

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.



9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9999

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).



9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 9839

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).



10064
10065
10066
10067
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10064

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).



10077
10078
10079
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
10122
10123
10124
10125
10126
10127
10128
10129
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10077

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.



10137
10138
10139
10140
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10137

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.



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
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10149

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.



10207
10208
10209
10210
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10207

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.



10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10218

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).



10275
10276
10277
10278
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10275

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).



10363
10364
10365
10366
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10363

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).



10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
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 10378

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.



10450
10451
10452
10453
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10450

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.



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
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10464

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).



10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10290

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).



10535
10536
10537
10538
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10535

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).



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
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10549

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.



10612
10613
10614
10615
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10612

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.



10669
10670
10671
10672
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10669

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.



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
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10679

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.



10727
10728
10729
10730
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10727

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.



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
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10738

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.



10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10622

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.



10786
10787
10788
10789
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10786

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.



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
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10796

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.



10843
10844
10845
10846
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10843

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.



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
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10853

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).



10903
10904
10905
10906
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10903

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.



10976
10977
10978
10979
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10976

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.



10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10988

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).



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
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 10916

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).



11048
11049
11050
11051
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11048

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).



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
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11061

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.



11119
11120
11121
11122
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11119

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.



11183
11184
11185
11186
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11183

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.



11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11194

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.



11247
11248
11249
11250
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11247

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.



11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11258

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.



11311
11312
11313
11314
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11311

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.



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
11365
11366
11367
11368
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11322

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.



11374
11375
11376
11377
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11374

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.



11384
11385
11386
11387
11388
11389
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11384

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.



11431
11432
11433
11434
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11431

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.



11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11441

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.



11490
11491
11492
11493
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11490

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.



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
11542
11543
11544
11545
11546
11547
11548
11549
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11502

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.



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

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.



11555
11556
11557
11558
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11555

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.



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

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.



11616
11617
11618
11619
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11616

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.



11630
11631
11632
11633
11634
11635
11636
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
11684
11685
11686
11687
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11630

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).



11698
11699
11700
11701
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11698

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).



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
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11713

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).



11789
11790
11791
11792
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11789

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).



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
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11803

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).



11876
11877
11878
11879
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11876

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).



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
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11892

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).



11974
11975
11976
11977
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11974

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).



11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
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
12048
12049
12050
12051
12052
12053
12054
12055
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 11989

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).



12065
12066
12067
12068
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12065

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).



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
12135
12136
12137
12138
12139
12140
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12079

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).



12149
12150
12151
12152
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12149

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).



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
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12162

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_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12229
12230
12231
12232
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12229

def get_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password, folder, storage)
  data
end

#get_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns paragraph info.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
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
12306
12307
12308
12309
12310
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12244

def get_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_table_cell_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_table_cell_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_table_cell_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_table_cell_paragraph"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.get_table_cell_paragraph"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.get_table_cell_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_table_cell_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'Paragraph')
  return data, status_code, headers
end

#get_table_cell_paragraphs(name, slide_index, shape_index, row_index, cell_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12320
12321
12322
12323
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12320

def get_table_cell_paragraphs(name, slide_index, shape_index, row_index, cell_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_table_cell_paragraphs_with_http_info(name, slide_index, shape_index, row_index, cell_index, password, folder, storage)
  data
end

#get_table_cell_paragraphs_with_http_info(name, slide_index, shape_index, row_index, cell_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell paragraphs.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12334

def get_table_cell_paragraphs_with_http_info(name, slide_index, shape_index, row_index, cell_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_table_cell_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_table_cell_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_table_cell_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_table_cell_paragraphs"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.get_table_cell_paragraphs"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.get_table_cell_paragraphs"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'Paragraphs')
  return data, status_code, headers
end

#get_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



12407
12408
12409
12410
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12407

def get_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password, folder, storage)
  data
end

#get_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12423

def get_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_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_table_cell_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_table_cell_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_table_cell_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_table_cell_portion"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.get_table_cell_portion"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.get_table_cell_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_table_cell_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_table_cell_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'Portion')
  return data, status_code, headers
end

#get_table_cell_portions(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



12505
12506
12507
12508
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12505

def get_table_cell_portions(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = get_table_cell_portions_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password, folder, storage)
  data
end

#get_table_cell_portions_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil) ⇒ Object

Returns table cell portions.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • paragraph_index —

    Paragraph index.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



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
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12520

def get_table_cell_portions_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_table_cell_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_table_cell_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_table_cell_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_table_cell_portions"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.get_table_cell_portions"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.get_table_cell_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_table_cell_portions"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'Portions')
  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.



12593
12594
12595
12596
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12593

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.



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
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12604

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.



12656
12657
12658
12659
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12656

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.



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
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12666

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.



12719
12720
12721
12722
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12719

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.



12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12735

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.



12810
12811
12812
12813
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12810

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.



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
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12826

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.



12896
12897
12898
12899
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12896

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.



12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12907

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.



12955
12956
12957
12958
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12955

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.



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
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 12966

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.



13028
13029
13030
13031
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13028

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.



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
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13046

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.



13108
13109
13110
13111
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13108

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.



13170
13171
13172
13173
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13170

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.



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

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.



13226
13227
13228
13229
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13226

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.



13235
13236
13237
13238
13239
13240
13241
13242
13243
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13235

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_table_cells(name, slide_index, shape_index, table_cell_merge_options, password = nil, folder = nil, storage = nil) ⇒ Object

Merge table cells.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • table_cell_merge_options —

    Merge settings.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13281
13282
13283
13284
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13281

def merge_table_cells(name, slide_index, shape_index, table_cell_merge_options, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = merge_table_cells_with_http_info(name, slide_index, shape_index, table_cell_merge_options, password, folder, storage)
  data
end

#merge_table_cells_with_http_info(name, slide_index, shape_index, table_cell_merge_options, password = nil, folder = nil, storage = nil) ⇒ Object

Merge table cells.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • table_cell_merge_options —

    Merge settings.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13294

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



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
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13119

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



13356
13357
13358
13359
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13356

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



13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13367

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



13418
13419
13420
13421
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13418

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



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

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.



13480
13481
13482
13483
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13480

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.



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

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.



13551
13552
13553
13554
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13551

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.



13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13563

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.



13621
13622
13623
13624
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13621

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.



13683
13684
13685
13686
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13683

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.



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

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.



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
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13632

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



13743
13744
13745
13746
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13743

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



13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13752

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.



13799
13800
13801
13802
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13799

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.



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 13810

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



13859
13860
13861
13862
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13859

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



13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13867

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.



13915
13916
13917
13918
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13915

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.



13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13927

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.



13980
13981
13982
13983
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 13980

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.



14055
14056
14057
14058
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14055

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.



14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14067

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.



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

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.



14129
14130
14131
14132
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14129

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.



14201
14202
14203
14204
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14201

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.



14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14212

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.



14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14142

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.



14274
14275
14276
14277
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14274

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.



14353
14354
14355
14356
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14353

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.



14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14365

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.



14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14288

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.



14433
14434
14435
14436
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14433

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.



14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14448

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.



14524
14525
14526
14527
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14524

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.



14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14539

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).



14611
14612
14613
14614
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14611

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.



14717
14718
14719
14720
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14717

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.



14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14735

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).



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
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14631

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.



14820
14821
14822
14823
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14820

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.



14911
14912
14913
14914
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14911

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.



14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14927

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.



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
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 14837

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).



15007
15008
15009
15010
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15007

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).



15028
15029
15030
15031
15032
15033
15034
15035
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
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15028

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.



15117
15118
15119
15120
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15117

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.



15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15129

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.



15187
15188
15189
15190
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15187

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.



15257
15258
15259
15260
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15257

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.



15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15269

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.



15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15199

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.



15330
15331
15332
15333
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15330

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.



15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15344

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.



15417
15418
15419
15420
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15417

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.



15430
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
15482
15483
15484
15485
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15430

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.



15495
15496
15497
15498
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15495

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.



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
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15509

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.



15579
15580
15581
15582
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15579

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.



15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15593

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.



15664
15665
15666
15667
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15664

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.



15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15675

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.



15728
15729
15730
15731
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15728

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.



15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15740

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.



15799
15800
15801
15802
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15799

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.



15868
15869
15870
15871
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15868

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.



15935
15936
15937
15938
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15935

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.



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

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.



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
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15880

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.



16001
16002
16003
16004
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16001

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.



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
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16012

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.



15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 15812

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.



16068
16069
16070
16071
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16068

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.



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
16127
16128
16129
16130
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16080

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.



16137
16138
16139
16140
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16137

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.



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

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.



16200
16201
16202
16203
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16200

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.



16261
16262
16263
16264
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16261

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.



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
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16270

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.



16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16211

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.



16322
16323
16324
16325
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16322

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.



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

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.



16387
16388
16389
16390
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16387

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.



16400
16401
16402
16403
16404
16405
16406
16407
16408
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16400

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.



16463
16464
16465
16466
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16463

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.



16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16475

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.



16532
16533
16534
16535
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16532

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.



16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16543

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.



16595
16596
16597
16598
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16595

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.



16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16606

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.



16660
16661
16662
16663
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16660

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.



16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16673

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.



16739
16740
16741
16742
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16739

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.



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
16791
16792
16793
16794
16795
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16750

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.



16809
16810
16811
16812
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16809

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, options = 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.

  • options (defaults to: nil) —

    Export options.



16891
16892
16893
16894
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16891

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, options = nil)
  data, _status_code, _headers = split_and_save_online_with_http_info(document, format, dest_folder, width, height, from, to, password, storage, fonts_folder, options)
  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, options = 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.

  • options (defaults to: nil) —

    Export options.



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
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16908

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, options = 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 = @api_client.object_to_http_body(options)

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

  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :files => post_files,
    :auth_names => auth_names,
    :return_type => '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, options = 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.

  • options (defaults to: nil) —

    Export options.



16977
16978
16979
16980
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16977

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

#split_online_with_http_info(document, format, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = 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.

  • options (defaults to: nil) —

    Export options.



16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16993

def split_online_with_http_info(document, format, width = nil, height = nil, from = nil, to = nil, password = nil, storage = nil, fonts_folder = nil, options = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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 = @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

#split_table_cell(name, slide_index, shape_index, row_index, cell_index, split_type, value, password = nil, folder = nil, storage = nil) ⇒ Object

Split table cell.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • split_type —

    Table cell split type (SplitByWidth, SplitByHeight,SplitByColSpan or SplitByRowSpan).

  • value —

    Split value. In case of splitting by column or row span, the value must be an integer number.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17061
17062
17063
17064
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17061

def split_table_cell(name, slide_index, shape_index, row_index, cell_index, split_type, value, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = split_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, split_type, value, password, folder, storage)
  data
end

#split_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, split_type, value, password = nil, folder = nil, storage = nil) ⇒ Object

Split table cell.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • split_type —

    Table cell split type (SplitByWidth, SplitByHeight,SplitByColSpan or SplitByRowSpan).

  • value —

    Split value. In case of splitting by column or row span, the value must be an integer number.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17077

def split_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, split_type, value, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.split_table_cell ...'
  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_table_cell"
  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.split_table_cell"
  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.split_table_cell"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.split_table_cell"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.split_table_cell"
  end
  # verify the required parameter 'split_type' is set
  if @api_client.config.client_side_validation && split_type.nil?
    fail ArgumentError, "Missing the required parameter 'split_type' when calling SlidesApi.split_table_cell"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['SplitByWidth', 'SplitByHeight', 'SplitByColSpan', 'SplitByRowSpan'].any?{ |s| s.casecmp(split_type)==0 }
    fail ArgumentError, "Invalid value for parameter split_type: " + split_type + ". Must be one of SplitByWidth, SplitByHeight, SplitByColSpan, SplitByRowSpan"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling SlidesApi.split_table_cell"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/{splitType}/{value}'
  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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'splitType', split_type)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'value', value)

  # 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_type => 'Table')
  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.



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
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 16827

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



17155
17156
17157
17158
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17155

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



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
17195
17196
17197
17198
17199
17200
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17162

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.



17209
17210
17211
17212
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17209

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.



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

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.



17287
17288
17289
17290
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17287

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.



17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17301

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.



17371
17372
17373
17374
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17371

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.



17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17385

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.



17456
17457
17458
17459
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17456

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.



17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
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
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17471

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.



17546
17547
17548
17549
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17546

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.



17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17560

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.



17628
17629
17630
17631
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17628

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.



17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17640

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.



17698
17699
17700
17701
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17698

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.



17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17710

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).



17771
17772
17773
17774
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17771

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).



17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17786

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).



17859
17860
17861
17862
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17859

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).



17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17875

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.



17949
17950
17951
17952
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17949

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.



17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 17961

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).



18022
18023
18024
18025
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18022

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).



18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18036

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.



18100
18101
18102
18103
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18100

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.



18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18112

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.



18172
18173
18174
18175
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18172

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.



18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18186

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.



18261
18262
18263
18264
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18261

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.



18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18276

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).



18357
18358
18359
18360
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18357

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).



18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18373

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).



18456
18457
18458
18459
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18456

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).



18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18473

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).



18559
18560
18561
18562
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18559

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).



18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18574

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

#update_table_cell(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update the table cell.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • dto —

    Table cell data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



18650
18651
18652
18653
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18650

def update_table_cell(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password, folder, storage)
  data
end

#update_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates table cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



18742
18743
18744
18745
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18742

def update_table_cell_paragraph(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password, folder, storage)
  data
end

#update_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates table cell paragraph.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18758

def update_table_cell_paragraph_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_table_cell_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_table_cell_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_table_cell_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_table_cell_paragraph"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.update_table_cell_paragraph"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.update_table_cell_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_table_cell_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_table_cell_paragraph"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 = @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_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



18841
18842
18843
18844
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18841

def update_table_cell_portion(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, dto, password, folder, storage)
  data
end

#update_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Updates table cell portion.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell 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.



18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18858

def update_table_cell_portion_with_http_info(name, slide_index, shape_index, row_index, cell_index, paragraph_index, portion_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_table_cell_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_table_cell_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_table_cell_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_table_cell_portion"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.update_table_cell_portion"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.update_table_cell_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_table_cell_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_table_cell_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_table_cell_portion"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}/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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 = @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_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil) ⇒ Object

Update the table cell.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • cell_index —

    Table cell index.

  • dto —

    Table cell data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18665

def update_table_cell_with_http_info(name, slide_index, shape_index, row_index, cell_index, dto, password = nil, folder = nil, storage = nil)
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_table_cell ...'
  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_table_cell"
  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_table_cell"
  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_table_cell"
  end
  # verify the required parameter 'row_index' is set
  if @api_client.config.client_side_validation && row_index.nil?
    fail ArgumentError, "Missing the required parameter 'row_index' when calling SlidesApi.update_table_cell"
  end
  # verify the required parameter 'cell_index' is set
  if @api_client.config.client_side_validation && cell_index.nil?
    fail ArgumentError, "Missing the required parameter 'cell_index' when calling SlidesApi.update_table_cell"
  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_table_cell"
  end
  # resource path
  local_var_path = '/slides/{name}/slides/{slideIndex}/shapes/{shapeIndex}/rows/{rowIndex}/cells/{cellIndex}'
  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, 'rowIndex', row_index)
  local_var_path = @api_client.replace_path_parameter(local_var_path, 'cellIndex', cell_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 => 'TableCell')
  return data, status_code, headers
end

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

Update the table row.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • dto —

    Table cell data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



18943
18944
18945
18946
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18943

def update_table_row(name, slide_index, shape_index, row_index, dto, password = nil, folder = nil, storage = nil)
  data, _status_code, _headers = update_table_row_with_http_info(name, slide_index, shape_index, row_index, dto, password, folder, storage)
  data
end

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

Update the table row.

Parameters:

  • name —

    Document name.

  • slide_index —

    Slide index.

  • shape_index —

    Shape index.

  • row_index —

    Row index.

  • dto —

    Table cell data.

  • password (defaults to: nil) —

    Document password.

  • folder (defaults to: nil) —

    Document folder.

  • storage (defaults to: nil) —

    Document storage.



18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 18957

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



19022
19023
19024
19025
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 19022

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



19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
 
# File 'lib/aspose_slides_cloud/api/slides_api.rb', line 19031

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