Class: SlidizeCloud::SlidizeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/slidize_cloud/api/slidize_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SlidizeApi

Returns a new instance of SlidizeApi.



36
37
38
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#convert(format, documents, opts = {}) ⇒ File

Converts files provided in the request body into target format and returns conversion result.

Parameters:

  • format (ExportFormat) —

    Output file format.

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


44
45
46
47
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 44

def convert(format, documents, opts = {})
  data, _status_code, _headers = convert_with_http_info(format, documents, opts)
  data
end

#convert_to_video(document, opts = {}) ⇒ File

Converts file provided in the request body into video.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


117
118
119
120
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 117

def convert_to_video(document, opts = {})
  data, _status_code, _headers = convert_to_video_with_http_info(document, opts)
  data
end

#convert_to_video_with_http_info(document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Converts file provided in the request body into video.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 127

def convert_to_video_with_http_info(document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.convert_to_video ...'
  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 SlidizeApi.convert_to_video"
  end
  # resource path
  local_var_path = '/video'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.convert_to_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#convert_to_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#convert_with_http_info(format, documents, opts = {}) ⇒ Array<(File, Integer, Hash)>

Converts files provided in the request body into target format and returns conversion result.

Parameters:

  • format (ExportFormat) —

    Output file format.

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 54

def convert_with_http_info(format, documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.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 SlidizeApi.convert"
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling SlidizeApi.convert"
  end
  # resource path
  local_var_path = '/convert/{format}'.sub('{' + 'format' + '}', CGI.escape(format.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['documents'] = @api_client.build_collection_param(documents, :multi)

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.convert",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#convert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#image_watermark(documents, image, opts = {}) ⇒ File

Adds image watermarks and return result.

Parameters:

  • documents (Array<File>)
  • image (File)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


188
189
190
191
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 188

def image_watermark(documents, image, opts = {})
  data, _status_code, _headers = image_watermark_with_http_info(documents, image, opts)
  data
end

#image_watermark_with_http_info(documents, image, opts = {}) ⇒ Array<(File, Integer, Hash)>

Adds image watermarks and return result.

Parameters:

  • documents (Array<File>)
  • image (File)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 199

def image_watermark_with_http_info(documents, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.image_watermark ...'
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling SlidizeApi.image_watermark"
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling SlidizeApi.image_watermark"
  end
  # resource path
  local_var_path = '/watermark/image'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['documents'] = @api_client.build_collection_param(documents, :multi)
  form_params['image'] = image
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.image_watermark",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#image_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#merge(format, documents, opts = {}) ⇒ File

Merges files provided in the request and saves the merge result into target format.

Parameters:

  • format (ExportFormat) —

    Output file format.

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


265
266
267
268
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 265

def merge(format, documents, opts = {})
  data, _status_code, _headers = merge_with_http_info(format, documents, opts)
  data
end

#merge_with_http_info(format, documents, opts = {}) ⇒ Array<(File, Integer, Hash)>

Merges files provided in the request and saves the merge result into target format.

Parameters:

  • format (ExportFormat) —

    Output file format.

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 276

def merge_with_http_info(format, documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.merge ...'
  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 SlidizeApi.merge"
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling SlidizeApi.merge"
  end
  # resource path
  local_var_path = '/merge/{format}'.sub('{' + 'format' + '}', CGI.escape(format.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['documents'] = @api_client.build_collection_param(documents, :multi)
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.merge",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#protect(document, opts = {}) ⇒ File

Protects presentation with specified password and returns result.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


340
341
342
343
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 340

def protect(document, opts = {})
  data, _status_code, _headers = protect_with_http_info(document, opts)
  data
end

#protect_with_http_info(document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Protects presentation with specified password and returns result.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
396
397
398
399
400
401
402
403
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 350

def protect_with_http_info(document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.protect ...'
  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 SlidizeApi.protect"
  end
  # resource path
  local_var_path = '/lock'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.protect",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#protect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_annotations(document, opts = {}) ⇒ File

Remove annotations from presentation

Parameters:

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

    the optional parameters

Returns:

  • (File) 


409
410
411
412
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 409

def remove_annotations(document, opts = {})
  data, _status_code, _headers = remove_annotations_with_http_info(document, opts)
  data
end

#remove_annotations_with_http_info(document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Remove annotations from presentation

Parameters:

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 418

def remove_annotations_with_http_info(document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.remove_annotations ...'
  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 SlidizeApi.remove_annotations"
  end
  # resource path
  local_var_path = '/removeAnnotations'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.remove_annotations",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#remove_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_macros(document, opts = {}) ⇒ File

Remove macros from presentation

Parameters:

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

    the optional parameters

Returns:

  • (File) 


476
477
478
479
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 476

def remove_macros(document, opts = {})
  data, _status_code, _headers = remove_macros_with_http_info(document, opts)
  data
end

#remove_macros_with_http_info(document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Remove macros from presentation

Parameters:

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



485
486
487
488
489
490
491
492
493
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
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 485

def remove_macros_with_http_info(document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.remove_macros ...'
  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 SlidizeApi.remove_macros"
  end
  # resource path
  local_var_path = '/removeMacros'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.remove_macros",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#remove_macros\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_text(documents, opts = {}) ⇒ File

Replace text in presentation.

Parameters:

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


544
545
546
547
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 544

def replace_text(documents, opts = {})
  data, _status_code, _headers = replace_text_with_http_info(documents, opts)
  data
end

#replace_text_with_http_info(documents, opts = {}) ⇒ Array<(File, Integer, Hash)>

Replace text in presentation.

Parameters:

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 554

def replace_text_with_http_info(documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.replace_text ...'
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling SlidizeApi.replace_text"
  end
  # resource path
  local_var_path = '/replaceText'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['documents'] = @api_client.build_collection_param(documents, :multi)
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.replace_text",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#replace_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#split(format, document, opts = {}) ⇒ File

Splits presentation according to the specified slides range and saves result into target format.

Parameters:

  • format (ExportFormat) —

    Output file format.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


615
616
617
618
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 615

def split(format, document, opts = {})
  data, _status_code, _headers = split_with_http_info(format, document, opts)
  data
end

#split_with_http_info(format, document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Splits presentation according to the specified slides range and saves result into target format.

Parameters:

  • format (ExportFormat) —

    Output file format.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
677
678
679
680
681
682
683
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 626

def split_with_http_info(format, document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.split ...'
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SlidizeApi.split"
  end
  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling SlidizeApi.split"
  end
  # resource path
  local_var_path = '/split/{format}'.sub('{' + 'format' + '}', CGI.escape(format.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.split",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#split\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#text_watermark(documents, opts = {}) ⇒ File

Adds text watermarks and return result.

Parameters:

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


690
691
692
693
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 690

def text_watermark(documents, opts = {})
  data, _status_code, _headers = text_watermark_with_http_info(documents, opts)
  data
end

#text_watermark_with_http_info(documents, opts = {}) ⇒ Array<(File, Integer, Hash)>

Adds text watermarks and return result.

Parameters:

  • documents (Array<File>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



700
701
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
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 700

def text_watermark_with_http_info(documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.text_watermark ...'
  end
  # verify the required parameter 'documents' is set
  if @api_client.config.client_side_validation && documents.nil?
    fail ArgumentError, "Missing the required parameter 'documents' when calling SlidizeApi.text_watermark"
  end
  # resource path
  local_var_path = '/watermark/text'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['documents'] = @api_client.build_collection_param(documents, :multi)
  form_params['options'] = opts[:'options'] if !opts[:'options'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.text_watermark",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#text_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unprotect(password, document, opts = {}) ⇒ File

Removes password from the presentation and returns result.

Parameters:

  • password (String) —

    Password to remove.

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

    the optional parameters

Returns:

  • (File) 


760
761
762
763
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 760

def unprotect(password, document, opts = {})
  data, _status_code, _headers = unprotect_with_http_info(password, document, opts)
  data
end

#unprotect_with_http_info(password, document, opts = {}) ⇒ Array<(File, Integer, Hash)>

Removes password from the presentation and returns result.

Parameters:

  • password (String) —

    Password to remove.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/slidize_cloud/api/slidize_api.rb', line 770

def unprotect_with_http_info(password, document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidizeApi.unprotect ...'
  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 SlidizeApi.unprotect"
  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 SlidizeApi.unprotect"
  end
  # resource path
  local_var_path = '/unlock'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'password'] = password

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['document'] = document

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SlidizeApi.unprotect",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SlidizeApi#unprotect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end