Class: AsposePdfCloud::PdfApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/api/pdf_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_secret, client_id, host = "", self_host = false, api_client = ApiClient.default) ⇒ PdfApi

Returns a new instance of PdfApi.



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28

def initialize(client_secret, client_id, host = "", self_host = false, api_client = ApiClient.default)
  @api_client = api_client
  @api_client.config.self_host = self_host
  @api_client.config.client_secret = client_secret
  @api_client.config.client_id = client_id
  if host != ""
    if @api_client.config.self_host
      @api_client.config.self_host_url = host
    else
      @api_client.config.host = host
    end
  end
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



26
27
28
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26

def api_client
  @api_client
end

Instance Method Details

#copy_file(src_path, dest_path, opts = {}) ⇒ nil

Copy file

Parameters:

  • src_path —

    Source file path e.g. '/folder/file.ext'

  • dest_path —

    Destination file path

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to copy

Returns:

  • (nil) 


52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 52

def copy_file(src_path, dest_path, opts = {})
  @api_client.request_token_if_needed
  copy_file_with_http_info(src_path, dest_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      copy_file_with_http_info(src_path, dest_path, opts)
    else
      raise
    end
  return nil
end

#copy_file_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Copy file

Parameters:

  • src_path —

    Source file path e.g. &#39;/folder/file.ext&#39;

  • dest_path —

    Destination file path

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to copy

Returns:

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

    nil, response status code and response headers



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
117
118
119
120
121
122
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 74

def copy_file_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.copy_file"
  end
  # resource path
  local_var_path = "/pdf/storage/file/copy/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#copy_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_folder(src_path, dest_path, opts = {}) ⇒ nil

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. &#39;/src&#39;

  • dest_path —

    Destination folder path e.g. &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

  • (nil) 


132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 132

def copy_folder(src_path, dest_path, opts = {})
  @api_client.request_token_if_needed
  copy_folder_with_http_info(src_path, dest_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      copy_folder_with_http_info(src_path, dest_path, opts)
    else
      raise
    end
  return nil
end

#copy_folder_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Copy folder

Parameters:

  • src_path —

    Source folder path e.g. &#39;/src&#39;

  • dest_path —

    Destination folder path e.g. &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 153

def copy_folder_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.copy_folder"
  end
  # resource path
  local_var_path = "/pdf/storage/folder/copy/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#copy_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_folder(path, opts = {}) ⇒ nil

Create the folder

Parameters:

  • path —

    Folder path to create e.g. &#39;folder_1/folder_2/&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

  • (nil) 


208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 208

def create_folder(path, opts = {})
  @api_client.request_token_if_needed
  create_folder_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      create_folder_with_http_info(path, opts)
    else
      raise
    end
  return nil
end

#create_folder_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create the folder

Parameters:

  • path —

    Folder path to create e.g. &#39;folder_1/folder_2/&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    nil, response status code and response headers



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
268
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 227

def create_folder_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.create_folder"
  end
  # resource path
  local_var_path = "/pdf/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_annotation(name, annotation_id, opts = {}) ⇒ AsposeResponse

Delete document annotation by ID

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 278

def delete_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#delete_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document annotation by ID

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 299

def delete_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.delete_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bookmark(name, bookmark_path, opts = {}) ⇒ AsposeResponse

Delete document bookmark by ID.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 357

def delete_bookmark(name, bookmark_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_bookmark_with_http_info(name, bookmark_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_bookmark_with_http_info(name, bookmark_path, opts)
    else
      raise
    end
  return data
end

#delete_bookmark_with_http_info(name, bookmark_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document bookmark by ID.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    AsposeResponse data, response status code and response headers



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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 379

def delete_bookmark_with_http_info(name, bookmark_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_bookmark ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_bookmark"
  end
  # verify the required parameter 'bookmark_path' is set
  if @api_client.config.client_side_validation && bookmark_path.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark_path' when calling PdfApi.delete_bookmark"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/bookmark/{bookmarkPath}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'bookmarkPath' + '}', bookmark_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_annotations(name, opts = {}) ⇒ AsposeResponse

Delete all annotations from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 436

def delete_document_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_document_annotations_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all annotations from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 456

def delete_document_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_bookmarks(name, opts = {}) ⇒ AsposeResponse

Delete all document bookmarks.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 509

def delete_document_bookmarks(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_bookmarks_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_bookmarks_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_document_bookmarks_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all document bookmarks.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    AsposeResponse data, response status code and response headers



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 530

def delete_document_bookmarks_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_bookmarks ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_bookmarks"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/tree".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_bookmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_layer(name, page_number, layer_id, opts = {}) ⇒ AsposeResponse

Remove document layer.

Parameters:

  • name —

    The document name.

  • page_number —

    Layer page.

  • layer_id —

    Layer Id.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 586

def delete_document_layer(name, page_number, layer_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_layer_with_http_info(name, page_number, layer_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_layer_with_http_info(name, page_number, layer_id, opts)
    else
      raise
    end
  return data
end

#delete_document_layer_with_http_info(name, page_number, layer_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Remove document layer.

Parameters:

  • name —

    The document name.

  • page_number —

    Layer page.

  • layer_id —

    Layer Id.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

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

    AsposeResponse data, response status code and response headers



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 609

def delete_document_layer_with_http_info(name, page_number, layer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_layer ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_layer"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_document_layer"
  end
  # verify the required parameter 'layer_id' is set
  if @api_client.config.client_side_validation && layer_id.nil?
    fail ArgumentError, "Missing the required parameter 'layer_id' when calling PdfApi.delete_document_layer"
  end
  # resource path
  local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = page_number
  query_params[:'layerId'] = layer_id
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_layer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_link_annotations(name, opts = {}) ⇒ AsposeResponse

Delete all link annotations from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 672

def delete_document_link_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_link_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_link_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_document_link_annotations_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all link annotations from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



692
693
694
695
696
697
698
699
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 692

def delete_document_link_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_link_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_link_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/links".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_link_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_stamps(name, opts = {}) ⇒ AsposeResponse

Delete all stamps from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 745

def delete_document_stamps(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_stamps_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_stamps_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_document_stamps_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all stamps from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



766
767
768
769
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 766

def delete_document_stamps_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_stamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_document_tables(name, opts = {}) ⇒ AsposeResponse

Delete all tables from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 819

def delete_document_tables(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_document_tables_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_document_tables_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_document_tables_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all tables from the document

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



839
840
841
842
843
844
845
846
847
848
849
850
851
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 839

def delete_document_tables_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_document_tables ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_document_tables"
  end
  # resource path
  local_var_path = "/pdf/{name}/tables".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_document_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_field(name, field_name, opts = {}) ⇒ AsposeResponse

Delete document field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name/

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 892

def delete_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#delete_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name/

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



913
914
915
916
917
918
919
920
921
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 913

def delete_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.delete_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_file(path, opts = {}) ⇒ nil

Delete file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to delete

Returns:

  • (nil) 


969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 969

def delete_file(path, opts = {})
  @api_client.request_token_if_needed
  delete_file_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      delete_file_with_http_info(path, opts)
    else
      raise
    end
  return nil
end

#delete_file_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to delete

Returns:

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

    nil, response status code and response headers



989
990
991
992
993
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 989

def delete_file_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.delete_file"
  end
  # resource path
  local_var_path = "/pdf/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_folder(path, opts = {}) ⇒ nil

Delete folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :recursive (BOOLEAN) —

    Enable to delete folders, subfolders and files (default to false)

Returns:

  • (nil) 


1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1040

def delete_folder(path, opts = {})
  @api_client.request_token_if_needed
  delete_folder_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      delete_folder_with_http_info(path, opts)
    else
      raise
    end
  return nil
end

#delete_folder_with_http_info(path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :recursive (BOOLEAN) —

    Enable to delete folders, subfolders and files

Returns:

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

    nil, response status code and response headers



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1060

def delete_folder_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.delete_folder"
  end
  # resource path
  local_var_path = "/pdf/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'recursive'] = opts[:'recursive'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_image(name, image_id, opts = {}) ⇒ AsposeResponse

Delete image from document page.

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1112

def delete_image(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_image_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_image_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#delete_image_with_http_info(name, image_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete image from document page.

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1133

def delete_image_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_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 PdfApi.delete_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.delete_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_link_annotation(name, link_id, opts = {}) ⇒ AsposeResponse

Delete document page link annotation by ID

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1190

def delete_link_annotation(name, link_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_link_annotation_with_http_info(name, link_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_link_annotation_with_http_info(name, link_id, opts)
    else
      raise
    end
  return data
end

#delete_link_annotation_with_http_info(name, link_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document page link annotation by ID

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1211

def delete_link_annotation_with_http_info(name, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_link_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_link_annotation"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling PdfApi.delete_link_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/links/{linkId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'linkId' + '}', link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_link_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_page(name, page_number, opts = {}) ⇒ AsposeResponse

Delete document page by its number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1268

def delete_page(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_page_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_page_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#delete_page_annotations(name, page_number, opts = {}) ⇒ AsposeResponse

Delete all annotations from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1346

def delete_page_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_page_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_page_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#delete_page_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all annotations from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1367

def delete_page_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_page_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_page_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_page_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_page_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_page_link_annotations(name, page_number, opts = {}) ⇒ AsposeResponse

Delete all link annotations from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1424

def delete_page_link_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_page_link_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_page_link_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#delete_page_link_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all link annotations from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1445

def delete_page_link_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_page_link_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_page_link_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_page_link_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/links".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_page_link_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_page_stamps(name, page_number, opts = {}) ⇒ AsposeResponse

Delete all stamps from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1503

def delete_page_stamps(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_page_stamps_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_page_stamps_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#delete_page_stamps_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all stamps from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1525

def delete_page_stamps_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_page_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_page_stamps"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_page_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamps".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_page_stamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_page_tables(name, page_number, opts = {}) ⇒ AsposeResponse

Delete all tables from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1583

def delete_page_tables(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_page_tables_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_page_tables_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#delete_page_tables_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete all tables from the page

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1604

def delete_page_tables_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_page_tables ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_page_tables"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_page_tables"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/tables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_page_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_page_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document page by its number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1289

def delete_page_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_page"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_properties(name, opts = {}) ⇒ AsposeResponse

Delete custom document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1661

def delete_properties(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_properties_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_properties_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#delete_properties_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete custom document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:

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

    AsposeResponse data, response status code and response headers



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1682

def delete_properties_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_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 PdfApi.delete_properties"
  end
  # resource path
  local_var_path = "/pdf/{name}/documentproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_property(name, property_name, opts = {}) ⇒ AsposeResponse

Delete document property.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1737

def delete_property(name, property_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_property_with_http_info(name, property_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_property_with_http_info(name, property_name, opts)
    else
      raise
    end
  return data
end

#delete_property_with_http_info(name, property_name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document property.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:

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

    AsposeResponse data, response status code and response headers



1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1759

def delete_property_with_http_info(name, property_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_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 PdfApi.delete_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 PdfApi.delete_property"
  end
  # resource path
  local_var_path = "/pdf/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_stamp(name, stamp_id, opts = {}) ⇒ AsposeResponse

Delete document stamp by ID

Parameters:

  • name —

    The document name.

  • stamp_id —

    The stamp ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1818

def delete_stamp(name, stamp_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_stamp_with_http_info(name, stamp_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_stamp_with_http_info(name, stamp_id, opts)
    else
      raise
    end
  return data
end

#delete_stamp_with_http_info(name, stamp_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document stamp by ID

Parameters:

  • name —

    The document name.

  • stamp_id —

    The stamp ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1840

def delete_stamp_with_http_info(name, stamp_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_stamp ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_stamp"
  end
  # verify the required parameter 'stamp_id' is set
  if @api_client.config.client_side_validation && stamp_id.nil?
    fail ArgumentError, "Missing the required parameter 'stamp_id' when calling PdfApi.delete_stamp"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/{stampId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'stampId' + '}', stamp_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_stamp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_table(name, table_id, opts = {}) ⇒ AsposeResponse

Delete document table by ID

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1898

def delete_table(name, table_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = delete_table_with_http_info(name, table_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = delete_table_with_http_info(name, table_id, opts)
    else
      raise
    end
  return data
end

#delete_table_with_http_info(name, table_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Delete document table by ID

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1919

def delete_table_with_http_info(name, table_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.delete_table ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.delete_table"
  end
  # verify the required parameter 'table_id' is set
  if @api_client.config.client_side_validation && table_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_id' when calling PdfApi.delete_table"
  end
  # resource path
  local_var_path = "/pdf/{name}/tables/{tableId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'tableId' + '}', table_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#delete_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_file(path, opts = {}) ⇒ File

Download file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to download

Returns:

  • (File) 


1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1975

def download_file(path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = download_file_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = download_file_with_http_info(path, opts)
    else
      raise
    end
  return data
end

#download_file_with_http_info(path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Download file

Parameters:

  • path —

    File path e.g. &#39;/folder/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID to download

Returns:

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

    File data, response status code and response headers



1995
1996
1997
1998
1999
2000
2001
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 1995

def download_file_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.download_file"
  end
  # resource path
  local_var_path = "/pdf/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#download_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bookmark(name, bookmark_path, opts = {}) ⇒ BookmarkResponse

Read document bookmark.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2049

def get_bookmark(name, bookmark_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_bookmark_with_http_info(name, bookmark_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_bookmark_with_http_info(name, bookmark_path, opts)
    else
      raise
    end
  return data
end

#get_bookmark_with_http_info(name, bookmark_path, opts = {}) ⇒ Array<(BookmarkResponse, Fixnum, Hash)>

Read document bookmark.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    BookmarkResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2071

def get_bookmark_with_http_info(name, bookmark_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_bookmark ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_bookmark"
  end
  # verify the required parameter 'bookmark_path' is set
  if @api_client.config.client_side_validation && bookmark_path.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark_path' when calling PdfApi.get_bookmark"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/bookmark/{bookmarkPath}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'bookmarkPath' + '}', bookmark_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BookmarkResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bookmarks(name, bookmark_path, opts = {}) ⇒ BookmarksResponse

Read document bookmarks node list.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2130

def get_bookmarks(name, bookmark_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_bookmarks_with_http_info(name, bookmark_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_bookmarks_with_http_info(name, bookmark_path, opts)
    else
      raise
    end
  return data
end

#get_bookmarks_with_http_info(name, bookmark_path, opts = {}) ⇒ Array<(BookmarksResponse, Fixnum, Hash)>

Read document bookmarks node list.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    BookmarksResponse data, response status code and response headers



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
2198
2199
2200
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2152

def get_bookmarks_with_http_info(name, bookmark_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_bookmarks ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_bookmarks"
  end
  # verify the required parameter 'bookmark_path' is set
  if @api_client.config.client_side_validation && bookmark_path.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark_path' when calling PdfApi.get_bookmarks"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/list/{bookmarkPath}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'bookmarkPath' + '}', bookmark_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BookmarksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_bookmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_caret_annotation(name, annotation_id, opts = {}) ⇒ CaretAnnotationResponse

Read document page caret annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2210

def get_caret_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_caret_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_caret_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_caret_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(CaretAnnotationResponse, Fixnum, Hash)>

Read document page caret annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CaretAnnotationResponse data, response status code and response headers



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
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2231

def get_caret_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_caret_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_caret_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_caret_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/caret/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CaretAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_caret_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_check_box_field(name, field_name, opts = {}) ⇒ CheckBoxFieldResponse

Read document checkbox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2288

def get_check_box_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_check_box_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_check_box_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_check_box_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(CheckBoxFieldResponse, Fixnum, Hash)>

Read document checkbox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CheckBoxFieldResponse data, response status code and response headers



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
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2309

def get_check_box_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_check_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_check_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_check_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/checkbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_check_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_circle_annotation(name, annotation_id, opts = {}) ⇒ CircleAnnotationResponse

Read document page circle annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2366

def get_circle_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_circle_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_circle_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_circle_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(CircleAnnotationResponse, Fixnum, Hash)>

Read document page circle annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CircleAnnotationResponse data, response status code and response headers



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
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2387

def get_circle_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_circle_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_circle_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_circle_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/circle/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CircleAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_circle_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_combo_box_field(name, field_name, opts = {}) ⇒ ComboBoxFieldResponse

Read document combobox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2444

def get_combo_box_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_combo_box_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_combo_box_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_combo_box_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(ComboBoxFieldResponse, Fixnum, Hash)>

Read document combobox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ComboBoxFieldResponse data, response status code and response headers



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
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2465

def get_combo_box_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_combo_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_combo_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_combo_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/combobox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ComboBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_combo_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_disc_usage(opts = {}) ⇒ DiscUsage

Get disc usage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2519

def get_disc_usage(opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_disc_usage_with_http_info(opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_disc_usage_with_http_info(opts)
    else
      raise
    end
  return data
end

#get_disc_usage_with_http_info(opts = {}) ⇒ Array<(DiscUsage, Fixnum, Hash)>

Get disc usage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    DiscUsage data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2537

def get_disc_usage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_disc_usage ..."
  end
  # resource path
  local_var_path = "/pdf/storage/disc"

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DiscUsage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_disc_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document(name, opts = {}) ⇒ DocumentResponse

Read common document info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2585

def get_document(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_annotations(name, opts = {}) ⇒ AnnotationsInfoResponse

Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2659

def get_document_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_annotations_with_http_info(name, opts = {}) ⇒ Array<(AnnotationsInfoResponse, Fixnum, Hash)>

Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AnnotationsInfoResponse data, response status code and response headers



2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2679

def get_document_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AnnotationsInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_attachment_by_index(name, attachment_index, opts = {}) ⇒ AttachmentResponse

Read document attachment info by its index.

Parameters:

  • name —

    The document name.

  • attachment_index —

    The attachment index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2732

def get_document_attachment_by_index(name, attachment_index, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_attachment_by_index_with_http_info(name, attachment_index, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_attachment_by_index_with_http_info(name, attachment_index, opts)
    else
      raise
    end
  return data
end

#get_document_attachment_by_index_with_http_info(name, attachment_index, opts = {}) ⇒ Array<(AttachmentResponse, Fixnum, Hash)>

Read document attachment info by its index.

Parameters:

  • name —

    The document name.

  • attachment_index —

    The attachment index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AttachmentResponse data, response status code and response headers



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
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2753

def get_document_attachment_by_index_with_http_info(name, attachment_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_attachment_by_index ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_attachment_by_index"
  end
  # verify the required parameter 'attachment_index' is set
  if @api_client.config.client_side_validation && attachment_index.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_index' when calling PdfApi.get_document_attachment_by_index"
  end
  # resource path
  local_var_path = "/pdf/{name}/attachments/{attachmentIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'attachmentIndex' + '}', attachment_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttachmentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_attachment_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_attachments(name, opts = {}) ⇒ AttachmentsResponse

Read document attachments info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2809

def get_document_attachments(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_attachments_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_attachments_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_attachments_with_http_info(name, opts = {}) ⇒ Array<(AttachmentsResponse, Fixnum, Hash)>

Read document attachments info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AttachmentsResponse data, response status code and response headers



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
2872
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2829

def get_document_attachments_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_attachments ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_attachments"
  end
  # resource path
  local_var_path = "/pdf/{name}/attachments".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttachmentsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_bookmarks(name, opts = {}) ⇒ BookmarksResponse

Read document bookmarks tree.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2882

def get_document_bookmarks(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_bookmarks_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_bookmarks_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_bookmarks_with_http_info(name, opts = {}) ⇒ Array<(BookmarksResponse, Fixnum, Hash)>

Read document bookmarks tree.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    BookmarksResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2903

def get_document_bookmarks_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_bookmarks ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_bookmarks"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/tree".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BookmarksResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_bookmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_caret_annotations(name, opts = {}) ⇒ CaretAnnotationsResponse

Read document caret annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2956

def get_document_caret_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_caret_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_caret_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_caret_annotations_with_http_info(name, opts = {}) ⇒ Array<(CaretAnnotationsResponse, Fixnum, Hash)>

Read document caret annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CaretAnnotationsResponse data, response status code and response headers



2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2976

def get_document_caret_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_caret_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_caret_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/caret".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CaretAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_caret_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_check_box_fields(name, opts = {}) ⇒ CheckBoxFieldsResponse

Read document checkbox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3028

def get_document_check_box_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_check_box_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_check_box_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_check_box_fields_with_http_info(name, opts = {}) ⇒ Array<(CheckBoxFieldsResponse, Fixnum, Hash)>

Read document checkbox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CheckBoxFieldsResponse data, response status code and response headers



3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3048

def get_document_check_box_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_check_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_check_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/checkbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_check_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_circle_annotations(name, opts = {}) ⇒ CircleAnnotationsResponse

Read document circle annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3100

def get_document_circle_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_circle_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_circle_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_circle_annotations_with_http_info(name, opts = {}) ⇒ Array<(CircleAnnotationsResponse, Fixnum, Hash)>

Read document circle annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CircleAnnotationsResponse data, response status code and response headers



3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3120

def get_document_circle_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_circle_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_circle_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/circle".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CircleAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_circle_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_combo_box_fields(name, opts = {}) ⇒ ComboBoxFieldsResponse

Read document combobox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3172

def get_document_combo_box_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_combo_box_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_combo_box_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_combo_box_fields_with_http_info(name, opts = {}) ⇒ Array<(ComboBoxFieldsResponse, Fixnum, Hash)>

Read document combobox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ComboBoxFieldsResponse data, response status code and response headers



3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3192

def get_document_combo_box_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_combo_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_combo_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/combobox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ComboBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_combo_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_display_properties(name, opts = {}) ⇒ DisplayPropertiesResponse

Read document display properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:



3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3244

def get_document_display_properties(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_display_properties_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_display_properties_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_display_properties_with_http_info(name, opts = {}) ⇒ Array<(DisplayPropertiesResponse, Fixnum, Hash)>

Read document display properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:

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

    DisplayPropertiesResponse data, response status code and response headers



3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3264

def get_document_display_properties_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_display_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 PdfApi.get_document_display_properties"
  end
  # resource path
  local_var_path = "/pdf/{name}/displayproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DisplayPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_display_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_file_attachment_annotations(name, opts = {}) ⇒ FileAttachmentAnnotationsResponse

Read document FileAttachment annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3316

def get_document_file_attachment_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_file_attachment_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_file_attachment_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_file_attachment_annotations_with_http_info(name, opts = {}) ⇒ Array<(FileAttachmentAnnotationsResponse, Fixnum, Hash)>

Read document FileAttachment annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3336

def get_document_file_attachment_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_file_attachment_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_file_attachment_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/fileattachment".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileAttachmentAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_file_attachment_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_free_text_annotations(name, opts = {}) ⇒ FreeTextAnnotationsResponse

Read document free text annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3388

def get_document_free_text_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_free_text_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_free_text_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_free_text_annotations_with_http_info(name, opts = {}) ⇒ Array<(FreeTextAnnotationsResponse, Fixnum, Hash)>

Read document free text annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3408

def get_document_free_text_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_free_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_free_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/freetext".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FreeTextAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_free_text_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_highlight_annotations(name, opts = {}) ⇒ HighlightAnnotationsResponse

Read document highlight annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3460

def get_document_highlight_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_highlight_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_highlight_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_highlight_annotations_with_http_info(name, opts = {}) ⇒ Array<(HighlightAnnotationsResponse, Fixnum, Hash)>

Read document highlight annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3480

def get_document_highlight_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_highlight_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_highlight_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/highlight".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HighlightAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_highlight_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_ink_annotations(name, opts = {}) ⇒ InkAnnotationsResponse

Read document ink annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3532

def get_document_ink_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_ink_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_ink_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_ink_annotations_with_http_info(name, opts = {}) ⇒ Array<(InkAnnotationsResponse, Fixnum, Hash)>

Read document ink annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    InkAnnotationsResponse data, response status code and response headers



3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3552

def get_document_ink_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_ink_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_ink_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/ink".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InkAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_ink_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_layers(name, opts = {}) ⇒ DocumentLayers

Gets document layers.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3605

def get_document_layers(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_layers_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_layers_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_layers_with_http_info(name, opts = {}) ⇒ Array<(DocumentLayers, Fixnum, Hash)>

Gets document layers.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

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

    DocumentLayers data, response status code and response headers



3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3626

def get_document_layers_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_layers ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_layers"
  end
  # resource path
  local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentLayers')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_layers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_line_annotations(name, opts = {}) ⇒ LineAnnotationsResponse

Read document line annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3679

def get_document_line_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_line_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_line_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_line_annotations_with_http_info(name, opts = {}) ⇒ Array<(LineAnnotationsResponse, Fixnum, Hash)>

Read document line annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LineAnnotationsResponse data, response status code and response headers



3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3699

def get_document_line_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/line".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_line_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_list_box_fields(name, opts = {}) ⇒ ListBoxFieldsResponse

Read document listbox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3751

def get_document_list_box_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_list_box_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_list_box_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_list_box_fields_with_http_info(name, opts = {}) ⇒ Array<(ListBoxFieldsResponse, Fixnum, Hash)>

Read document listbox fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ListBoxFieldsResponse data, response status code and response headers



3771
3772
3773
3774
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3771

def get_document_list_box_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_list_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_list_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/listbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_list_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_movie_annotations(name, opts = {}) ⇒ MovieAnnotationsResponse

Read document movie annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3823

def get_document_movie_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_movie_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_movie_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_movie_annotations_with_http_info(name, opts = {}) ⇒ Array<(MovieAnnotationsResponse, Fixnum, Hash)>

Read document movie annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    MovieAnnotationsResponse data, response status code and response headers



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3843

def get_document_movie_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_movie_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_movie_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/movie".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MovieAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_movie_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_poly_line_annotations(name, opts = {}) ⇒ PolyLineAnnotationsResponse

Read document polyline annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3895

def get_document_poly_line_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_poly_line_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_poly_line_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_poly_line_annotations_with_http_info(name, opts = {}) ⇒ Array<(PolyLineAnnotationsResponse, Fixnum, Hash)>

Read document polyline annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



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

def get_document_poly_line_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_poly_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_poly_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polyline".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolyLineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_poly_line_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_polygon_annotations(name, opts = {}) ⇒ PolygonAnnotationsResponse

Read document polygon annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3967

def get_document_polygon_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_polygon_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_polygon_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_polygon_annotations_with_http_info(name, opts = {}) ⇒ Array<(PolygonAnnotationsResponse, Fixnum, Hash)>

Read document polygon annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PolygonAnnotationsResponse data, response status code and response headers



3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 3987

def get_document_polygon_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_polygon_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_polygon_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polygon".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolygonAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_polygon_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_popup_annotations(name, opts = {}) ⇒ PopupAnnotationsResponse

Read document popup annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4039

def get_document_popup_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_popup_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_popup_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_popup_annotations_by_parent(name, annotation_id, opts = {}) ⇒ PopupAnnotationsResponse

Read document popup annotations by parent id.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The parent annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4112

def get_document_popup_annotations_by_parent(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(PopupAnnotationsResponse, Fixnum, Hash)>

Read document popup annotations by parent id.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The parent annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PopupAnnotationsResponse data, response status code and response headers



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
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4133

def get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_popup_annotations_by_parent ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_popup_annotations_by_parent"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_document_popup_annotations_by_parent"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/{annotationId}/popup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PopupAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_popup_annotations_by_parent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_popup_annotations_with_http_info(name, opts = {}) ⇒ Array<(PopupAnnotationsResponse, Fixnum, Hash)>

Read document popup annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PopupAnnotationsResponse data, response status code and response headers



4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4059

def get_document_popup_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_popup_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_popup_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/popup".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PopupAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_popup_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_properties(name, opts = {}) ⇒ DocumentPropertiesResponse

Read document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:



4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4190

def get_document_properties(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_properties_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_properties_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_properties_with_http_info(name, opts = {}) ⇒ Array<(DocumentPropertiesResponse, Fixnum, Hash)>

Read document properties.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:

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

    DocumentPropertiesResponse data, response status code and response headers



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

def get_document_properties_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.get_document_properties"
  end
  # resource path
  local_var_path = "/pdf/{name}/documentproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_property(name, property_name, opts = {}) ⇒ DocumentPropertyResponse

Read document property by name.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:



4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4266

def get_document_property(name, property_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_property_with_http_info(name, property_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_property_with_http_info(name, property_name, opts)
    else
      raise
    end
  return data
end

#get_document_property_with_http_info(name, property_name, opts = {}) ⇒ Array<(DocumentPropertyResponse, Fixnum, Hash)>

Read document property by name.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:

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

    DocumentPropertyResponse data, response status code and response headers



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

def get_document_property_with_http_info(name, property_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.get_document_property"
  end
  # resource path
  local_var_path = "/pdf/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPropertyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_radio_button_fields(name, opts = {}) ⇒ RadioButtonFieldsResponse

Read document radiobutton fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4345

def get_document_radio_button_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_radio_button_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_radio_button_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_radio_button_fields_with_http_info(name, opts = {}) ⇒ Array<(RadioButtonFieldsResponse, Fixnum, Hash)>

Read document radiobutton fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    RadioButtonFieldsResponse data, response status code and response headers



4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4365

def get_document_radio_button_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_radio_button_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_radio_button_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RadioButtonFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_redaction_annotations(name, opts = {}) ⇒ RedactionAnnotationsResponse

Read document redaction annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4417

def get_document_redaction_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_redaction_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_redaction_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_redaction_annotations_with_http_info(name, opts = {}) ⇒ Array<(RedactionAnnotationsResponse, Fixnum, Hash)>

Read document redaction annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4437

def get_document_redaction_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_redaction_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_redaction_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/redaction".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RedactionAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_redaction_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_screen_annotations(name, opts = {}) ⇒ ScreenAnnotationsResponse

Read document screen annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4489

def get_document_screen_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_screen_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_screen_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_screen_annotations_with_http_info(name, opts = {}) ⇒ Array<(ScreenAnnotationsResponse, Fixnum, Hash)>

Read document screen annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ScreenAnnotationsResponse data, response status code and response headers



4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4509

def get_document_screen_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_screen_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_screen_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/screen".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_screen_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_signature_fields(name, opts = {}) ⇒ SignatureFieldsResponse

Read document signature fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4561

def get_document_signature_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_signature_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_signature_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_signature_fields_with_http_info(name, opts = {}) ⇒ Array<(SignatureFieldsResponse, Fixnum, Hash)>

Read document signature fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SignatureFieldsResponse data, response status code and response headers



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
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4581

def get_document_signature_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_signature_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_signature_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/signature".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_signature_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_sound_annotations(name, opts = {}) ⇒ SoundAnnotationsResponse

Read document sound annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4633

def get_document_sound_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_sound_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_sound_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_sound_annotations_with_http_info(name, opts = {}) ⇒ Array<(SoundAnnotationsResponse, Fixnum, Hash)>

Read document sound annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SoundAnnotationsResponse data, response status code and response headers



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
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4653

def get_document_sound_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_sound_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_sound_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/sound".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SoundAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_sound_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_square_annotations(name, opts = {}) ⇒ SquareAnnotationsResponse

Read document square annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4705

def get_document_square_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_square_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_square_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_square_annotations_with_http_info(name, opts = {}) ⇒ Array<(SquareAnnotationsResponse, Fixnum, Hash)>

Read document square annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SquareAnnotationsResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4725

def get_document_square_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_square_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_square_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/square".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquareAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_square_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_squiggly_annotations(name, opts = {}) ⇒ SquigglyAnnotationsResponse

Read document squiggly annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4777

def get_document_squiggly_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_squiggly_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_squiggly_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_squiggly_annotations_with_http_info(name, opts = {}) ⇒ Array<(SquigglyAnnotationsResponse, Fixnum, Hash)>

Read document squiggly annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4797

def get_document_squiggly_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_squiggly_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_squiggly_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/squiggly".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquigglyAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_squiggly_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_stamp_annotations(name, opts = {}) ⇒ StampAnnotationsResponse

Read document stamp annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4849

def get_document_stamp_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_stamp_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_stamp_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_stamp_annotations_with_http_info(name, opts = {}) ⇒ Array<(StampAnnotationsResponse, Fixnum, Hash)>

Read document stamp annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    StampAnnotationsResponse data, response status code and response headers



4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4869

def get_document_stamp_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_stamp_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_stamp_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/stamp".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_stamps(name, opts = {}) ⇒ StampsInfoResponse

Read document stamps.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4921

def get_document_stamps(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_stamps_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_stamps_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_stamps_with_http_info(name, opts = {}) ⇒ Array<(StampsInfoResponse, Fixnum, Hash)>

Read document stamps.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    StampsInfoResponse data, response status code and response headers



4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4941

def get_document_stamps_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampsInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_stamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_strike_out_annotations(name, opts = {}) ⇒ StrikeOutAnnotationsResponse

Read document StrikeOut annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 4993

def get_document_strike_out_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_strike_out_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_strike_out_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_strike_out_annotations_with_http_info(name, opts = {}) ⇒ Array<(StrikeOutAnnotationsResponse, Fixnum, Hash)>

Read document StrikeOut annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5013

def get_document_strike_out_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_strike_out_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_strike_out_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/strikeout".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StrikeOutAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_strike_out_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_tables(name, opts = {}) ⇒ TablesRecognizedResponse

Read document tables.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:



5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5065

def get_document_tables(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_tables_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_tables_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_tables_with_http_info(name, opts = {}) ⇒ Array<(TablesRecognizedResponse, Fixnum, Hash)>

Read document tables.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:

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

    TablesRecognizedResponse data, response status code and response headers



5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5085

def get_document_tables_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_tables ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_tables"
  end
  # resource path
  local_var_path = "/pdf/{name}/tables".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TablesRecognizedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_text_annotations(name, opts = {}) ⇒ TextAnnotationsResponse

Read document text annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5137

def get_document_text_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_text_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_text_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_text_annotations_with_http_info(name, opts = {}) ⇒ Array<(TextAnnotationsResponse, Fixnum, Hash)>

Read document text annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextAnnotationsResponse data, response status code and response headers



5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5157

def get_document_text_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_text_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_text_box_fields(name, opts = {}) ⇒ TextBoxFieldsResponse

Read document text box fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5209

def get_document_text_box_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_text_box_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_text_box_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_text_box_fields_with_http_info(name, opts = {}) ⇒ Array<(TextBoxFieldsResponse, Fixnum, Hash)>

Read document text box fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextBoxFieldsResponse data, response status code and response headers



5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5229

def get_document_text_box_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_text_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_text_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/textbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_underline_annotations(name, opts = {}) ⇒ UnderlineAnnotationsResponse

Read document underline annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5281

def get_document_underline_annotations(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_document_underline_annotations_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_document_underline_annotations_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_document_underline_annotations_with_http_info(name, opts = {}) ⇒ Array<(UnderlineAnnotationsResponse, Fixnum, Hash)>

Read document underline annotations.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5301

def get_document_underline_annotations_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document_underline_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_underline_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/underline".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnderlineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document_underline_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_document_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Read common document info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    DocumentResponse data, response status code and response headers



2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 2606

def get_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document"
  end
  # resource path
  local_var_path = "/pdf/{name}".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_download_document_attachment_by_index(name, attachment_index, opts = {}) ⇒ File

Download document attachment content by its index.

Parameters:

  • name —

    The document name.

  • attachment_index —

    The attachment index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5354

def get_download_document_attachment_by_index(name, attachment_index, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_download_document_attachment_by_index_with_http_info(name, attachment_index, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_download_document_attachment_by_index_with_http_info(name, attachment_index, opts)
    else
      raise
    end
  return data
end

#get_download_document_attachment_by_index_with_http_info(name, attachment_index, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Download document attachment content by its index.

Parameters:

  • name —

    The document name.

  • attachment_index —

    The attachment index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5375

def get_download_document_attachment_by_index_with_http_info(name, attachment_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_download_document_attachment_by_index ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_download_document_attachment_by_index"
  end
  # verify the required parameter 'attachment_index' is set
  if @api_client.config.client_side_validation && attachment_index.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_index' when calling PdfApi.get_download_document_attachment_by_index"
  end
  # resource path
  local_var_path = "/pdf/{name}/attachments/{attachmentIndex}/download".sub('{' + 'name' + '}', name.to_s).sub('{' + 'attachmentIndex' + '}', attachment_index.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_download_document_attachment_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_epub_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert EPUB file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.epub)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5430

def get_epub_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_epub_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_epub_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_epub_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert EPUB file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.epub)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



5449
5450
5451
5452
5453
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5449

def get_epub_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_epub_in_storage_to_pdf ..."
  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 PdfApi.get_epub_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/epub"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_epub_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_export_fields_from_pdf_to_fdf_in_storage(name, opts = {}) ⇒ File

Export fields from from PDF in storage to FDF file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5501

def get_export_fields_from_pdf_to_fdf_in_storage(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Export fields from from PDF in storage to FDF file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5521

def get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_fdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_fdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/fdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_export_fields_from_pdf_to_xfdf_in_storage(name, opts = {}) ⇒ File

Export fields from from PDF in storage to XFDF file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5573

def get_export_fields_from_pdf_to_xfdf_in_storage(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Export fields from from PDF in storage to XFDF file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5593

def get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_xfdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_xfdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/xfdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_export_fields_from_pdf_to_xml_in_storage(name, opts = {}) ⇒ File

Export fields from from PDF in storage to XML file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5645

def get_export_fields_from_pdf_to_xml_in_storage(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Export fields from from PDF in storage to XML file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5665

def get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_export_fields_from_pdf_to_xml_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_export_fields_from_pdf_to_xml_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_export_fields_from_pdf_to_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_field(name, field_name, opts = {}) ⇒ FieldResponse

Get document field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name (name should be encoded).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5718

def get_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(FieldResponse, Fixnum, Hash)>

Get document field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name (name should be encoded).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    FieldResponse data, response status code and response headers



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

def get_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fields(name, opts = {}) ⇒ FieldsResponse

Get document fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5795

def get_fields(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_fields_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_fields_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_fields_with_http_info(name, opts = {}) ⇒ Array<(FieldsResponse, Fixnum, Hash)>

Get document fields.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    FieldsResponse data, response status code and response headers



5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5815

def get_fields_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_attachment_annotation(name, annotation_id, opts = {}) ⇒ FileAttachmentAnnotationResponse

Read document page FileAttachment annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5868

def get_file_attachment_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_file_attachment_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_file_attachment_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_file_attachment_annotation_data(name, annotation_id, opts = {}) ⇒ File

Read document page FileAttachment annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5946

def get_file_attachment_annotation_data(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_file_attachment_annotation_data_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_file_attachment_annotation_data_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_file_attachment_annotation_data_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read document page FileAttachment annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5967

def get_file_attachment_annotation_data_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_file_attachment_annotation_data ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_file_attachment_annotation_data"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_file_attachment_annotation_data"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/fileattachment/{annotationId}/data".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_file_attachment_annotation_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_attachment_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(FileAttachmentAnnotationResponse, Fixnum, Hash)>

Read document page FileAttachment annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 5889

def get_file_attachment_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_file_attachment_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_file_attachment_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_file_attachment_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/fileattachment/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileAttachmentAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_file_attachment_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file_versions(path, opts = {}) ⇒ FileVersions

Get file versions

Parameters:

  • path —

    File path e.g. &#39;/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6022

def get_file_versions(path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_file_versions_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_file_versions_with_http_info(path, opts)
    else
      raise
    end
  return data
end

#get_file_versions_with_http_info(path, opts = {}) ⇒ Array<(FileVersions, Fixnum, Hash)>

Get file versions

Parameters:

  • path —

    File path e.g. &#39;/file.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    FileVersions data, response status code and response headers



6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6041

def get_file_versions_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.get_file_versions"
  end
  # resource path
  local_var_path = "/pdf/storage/version/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileVersions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_file_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_files_list(path, opts = {}) ⇒ FilesList

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6091

def get_files_list(path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_files_list_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_files_list_with_http_info(path, opts)
    else
      raise
    end
  return data
end

#get_files_list_with_http_info(path, opts = {}) ⇒ Array<(FilesList, Fixnum, Hash)>

Get all files and folders within a folder

Parameters:

  • path —

    Folder path e.g. &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

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

    FilesList data, response status code and response headers



6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6110

def get_files_list_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.get_files_list"
  end
  # resource path
  local_var_path = "/pdf/storage/folder/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FilesList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_files_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_free_text_annotation(name, annotation_id, opts = {}) ⇒ FreeTextAnnotationResponse

Read document page free text annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6162

def get_free_text_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_free_text_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_free_text_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_free_text_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(FreeTextAnnotationResponse, Fixnum, Hash)>

Read document page free text annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    FreeTextAnnotationResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6183

def get_free_text_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_free_text_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_free_text_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_free_text_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/freetext/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FreeTextAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_free_text_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_highlight_annotation(name, annotation_id, opts = {}) ⇒ HighlightAnnotationResponse

Read document page highlight annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6240

def get_highlight_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_highlight_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_highlight_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_highlight_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(HighlightAnnotationResponse, Fixnum, Hash)>

Read document page highlight annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



6261
6262
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6261

def get_highlight_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_highlight_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_highlight_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_highlight_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/highlight/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HighlightAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_highlight_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_html_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert HTML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.zip)

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

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6324

def get_html_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_html_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_html_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_html_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert HTML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.zip)

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

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6351

def get_html_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_html_in_storage_to_pdf ..."
  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 PdfApi.get_html_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/html"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'htmlFileName'] = opts[:'html_file_name'] if !opts[:'html_file_name'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_html_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image(name, image_id, opts = {}) ⇒ ImageResponse

Read document image by ID.

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6412

def get_image(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_image_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_image_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#get_image_extract_as_gif(name, image_id, opts = {}) ⇒ File

Extract document image in GIF format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6492

def get_image_extract_as_gif(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_image_extract_as_gif_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_image_extract_as_gif_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#get_image_extract_as_gif_with_http_info(name, image_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Extract document image in GIF format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6515

def get_image_extract_as_gif_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_gif ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_gif"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_gif"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/gif".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_gif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image_extract_as_jpeg(name, image_id, opts = {}) ⇒ File

Extract document image in JPEG format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6576

def get_image_extract_as_jpeg(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_image_extract_as_jpeg_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_image_extract_as_jpeg_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#get_image_extract_as_jpeg_with_http_info(name, image_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Extract document image in JPEG format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6599

def get_image_extract_as_jpeg_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_jpeg ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_jpeg"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_jpeg"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/jpeg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_jpeg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image_extract_as_png(name, image_id, opts = {}) ⇒ File

Extract document image in PNG format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6660

def get_image_extract_as_png(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_image_extract_as_png_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_image_extract_as_png_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#get_image_extract_as_png_with_http_info(name, image_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Extract document image in PNG format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6683

def get_image_extract_as_png_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_png ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_png"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_png"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image_extract_as_tiff(name, image_id, opts = {}) ⇒ File

Extract document image in TIFF format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6744

def get_image_extract_as_tiff(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_image_extract_as_tiff_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#get_image_extract_as_tiff_with_http_info(name, image_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Extract document image in TIFF format

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6767

def get_image_extract_as_tiff_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_image_extract_as_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_image_extract_as_tiff"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image_extract_as_tiff"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_image_extract_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image_with_http_info(name, image_id, opts = {}) ⇒ Array<(ImageResponse, Fixnum, Hash)>

Read document image by ID.

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ImageResponse data, response status code and response headers



6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6433

def get_image_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_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 PdfApi.get_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.get_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_images(name, page_number, opts = {}) ⇒ ImagesResponse

Read document images.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6826

def get_images(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_images_extract_svg(name, page_number, opts = {}) ⇒ SvgImages

Extract SVG images from document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6905

def get_images_extract_svg(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_images_extract_svg_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_images_extract_svg_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_images_extract_svg_with_http_info(name, page_number, opts = {}) ⇒ Array<(SvgImages, Fixnum, Hash)>

Extract SVG images from document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

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

    SvgImages data, response status code and response headers



6927
6928
6929
6930
6931
6932
6933
6934
6935
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6927

def get_images_extract_svg_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_images_extract_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 PdfApi.get_images_extract_svg"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_images_extract_svg"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/extract/svg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SvgImages')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_images_extract_svg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_images_with_http_info(name, page_number, opts = {}) ⇒ Array<(ImagesResponse, Fixnum, Hash)>

Read document images.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ImagesResponse data, response status code and response headers



6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6847

def get_images_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_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 PdfApi.get_images"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_images"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {}) ⇒ File

Update fields from FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_file_path —

    The Fdf file path.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 6985

def get_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
    else
      raise
    end
  return data
end

#get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Update fields from FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_file_path —

    The Fdf file path.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



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
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7006

def get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_fdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_fdf_in_storage"
  end
  # verify the required parameter 'fdf_file_path' is set
  if @api_client.config.client_side_validation && fdf_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'fdf_file_path' when calling PdfApi.get_import_fields_from_fdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fdfFilePath'] = fdf_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {}) ⇒ File

Update fields from XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_file_path —

    The XFDF file path.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7064

def get_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
    else
      raise
    end
  return data
end

#get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Update fields from XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_file_path —

    The XFDF file path.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7085

def get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_xfdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_xfdf_in_storage"
  end
  # verify the required parameter 'xfdf_file_path' is set
  if @api_client.config.client_side_validation && xfdf_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xfdf_file_path' when calling PdfApi.get_import_fields_from_xfdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xfdfFilePath'] = xfdf_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_fields_from_xml_in_storage(name, xml_file_path, opts = {}) ⇒ File

Import from XML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • name —

    The document name.

  • xml_file_path —

    Full source filename (ex. /folder1/folder2/template.xml)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7143

def get_import_fields_from_xml_in_storage(name, xml_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
    else
      raise
    end
  return data
end

#get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Import from XML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • name —

    The document name.

  • xml_file_path —

    Full source filename (ex. /folder1/folder2/template.xml)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



7164
7165
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
7209
7210
7211
7212
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7164

def get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_import_fields_from_xml_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_import_fields_from_xml_in_storage"
  end
  # verify the required parameter 'xml_file_path' is set
  if @api_client.config.client_side_validation && xml_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xml_file_path' when calling PdfApi.get_import_fields_from_xml_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xmlFilePath'] = xml_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_import_fields_from_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ink_annotation(name, annotation_id, opts = {}) ⇒ InkAnnotationResponse

Read document page ink annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7222

def get_ink_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_ink_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_ink_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_ink_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(InkAnnotationResponse, Fixnum, Hash)>

Read document page ink annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    InkAnnotationResponse data, response status code and response headers



7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7243

def get_ink_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_ink_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_ink_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_ink_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/ink/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InkAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_ink_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_line_annotation(name, annotation_id, opts = {}) ⇒ LineAnnotationResponse

Read document page line annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7300

def get_line_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_line_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_line_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_line_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(LineAnnotationResponse, Fixnum, Hash)>

Read document page line annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LineAnnotationResponse data, response status code and response headers



7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7321

def get_line_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_line_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_line_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_line_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/line/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_line_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_link_annotation(name, link_id, opts = {}) ⇒ LinkAnnotationResponse

Read document link annotation by ID.

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7378

def get_link_annotation(name, link_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_link_annotation_with_http_info(name, link_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_link_annotation_with_http_info(name, link_id, opts)
    else
      raise
    end
  return data
end

#get_link_annotation_with_http_info(name, link_id, opts = {}) ⇒ Array<(LinkAnnotationResponse, Fixnum, Hash)>

Read document link annotation by ID.

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LinkAnnotationResponse data, response status code and response headers



7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7399

def get_link_annotation_with_http_info(name, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_link_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_link_annotation"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling PdfApi.get_link_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/links/{linkId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'linkId' + '}', link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LinkAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_link_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_list_box_field(name, field_name, opts = {}) ⇒ ListBoxFieldResponse

Read document listbox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7456

def get_list_box_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_list_box_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_list_box_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_list_box_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(ListBoxFieldResponse, Fixnum, Hash)>

Read document listbox field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ListBoxFieldResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7477

def get_list_box_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_list_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_list_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_list_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/listbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_list_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markdown_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert MD file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.md)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7532

def get_markdown_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_markdown_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_markdown_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_markdown_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert MD file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.md)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7551

def get_markdown_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_markdown_in_storage_to_pdf ..."
  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 PdfApi.get_markdown_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/markdown"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_markdown_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mht_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert MHT file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.mht)

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7608

def get_mht_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_mht_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_mht_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_mht_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert MHT file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.mht)

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7633

def get_mht_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_mht_in_storage_to_pdf ..."
  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 PdfApi.get_mht_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/mht"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_mht_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_movie_annotation(name, annotation_id, opts = {}) ⇒ MovieAnnotationResponse

Read document page movie annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7692

def get_movie_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_movie_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_movie_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_movie_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(MovieAnnotationResponse, Fixnum, Hash)>

Read document page movie annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    MovieAnnotationResponse data, response status code and response headers



7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7713

def get_movie_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_movie_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_movie_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_movie_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/movie/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MovieAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_movie_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(name, page_number, opts = {}) ⇒ DocumentPageResponse

Read document page info.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7770

def get_page(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_annotations(name, page_number, opts = {}) ⇒ AnnotationsInfoResponse

Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7848

def get_page_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(AnnotationsInfoResponse, Fixnum, Hash)>

Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AnnotationsInfoResponse data, response status code and response headers



7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7869

def get_page_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AnnotationsInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_caret_annotations(name, page_number, opts = {}) ⇒ CaretAnnotationsResponse

Read document page caret annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7926

def get_page_caret_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_caret_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_caret_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_caret_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(CaretAnnotationsResponse, Fixnum, Hash)>

Read document page caret annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CaretAnnotationsResponse data, response status code and response headers



7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7947

def get_page_caret_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_caret_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_caret_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_caret_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/caret".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CaretAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_caret_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_check_box_fields(name, page_number, opts = {}) ⇒ CheckBoxFieldsResponse

Read document page checkbox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8004

def get_page_check_box_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_check_box_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_check_box_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_check_box_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(CheckBoxFieldsResponse, Fixnum, Hash)>

Read document page checkbox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CheckBoxFieldsResponse data, response status code and response headers



8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8025

def get_page_check_box_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_check_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_check_box_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_check_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/checkbox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_check_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_circle_annotations(name, page_number, opts = {}) ⇒ CircleAnnotationsResponse

Read document page circle annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8082

def get_page_circle_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_circle_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_circle_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_circle_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(CircleAnnotationsResponse, Fixnum, Hash)>

Read document page circle annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    CircleAnnotationsResponse data, response status code and response headers



8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8103

def get_page_circle_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_circle_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_circle_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_circle_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/circle".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CircleAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_circle_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_combo_box_fields(name, page_number, opts = {}) ⇒ ComboBoxFieldsResponse

Read document page combobox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8160

def get_page_combo_box_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_combo_box_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_combo_box_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_combo_box_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(ComboBoxFieldsResponse, Fixnum, Hash)>

Read document page combobox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ComboBoxFieldsResponse data, response status code and response headers



8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8181

def get_page_combo_box_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_combo_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_combo_box_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_combo_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/combobox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ComboBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_combo_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_bmp(name, page_number, opts = {}) ⇒ File

Convert document page to Bmp image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8241

def get_page_convert_to_bmp(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_bmp_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_bmp_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_bmp_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Bmp image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8265

def get_page_convert_to_bmp_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_bmp ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_bmp"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_bmp"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/bmp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_bmp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_emf(name, page_number, opts = {}) ⇒ File

Convert document page to Emf image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8328

def get_page_convert_to_emf(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_emf_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_emf_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_emf_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Emf image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8352

def get_page_convert_to_emf_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_emf ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_emf"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_emf"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/emf".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_emf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_gif(name, page_number, opts = {}) ⇒ File

Convert document page to Gif image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8415

def get_page_convert_to_gif(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_gif_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_gif_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_gif_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Gif image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8439

def get_page_convert_to_gif_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_gif ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_gif"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_gif"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/gif".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_gif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_jpeg(name, page_number, opts = {}) ⇒ File

Convert document page to Jpeg image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8502

def get_page_convert_to_jpeg(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_jpeg_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_jpeg_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_jpeg_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Jpeg image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8526

def get_page_convert_to_jpeg_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_jpeg ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_jpeg"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_jpeg"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/jpeg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_jpeg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_png(name, page_number, opts = {}) ⇒ File

Convert document page to Png image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8589

def get_page_convert_to_png(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_png_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_png_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_png_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Png image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



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
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8613

def get_page_convert_to_png_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_png ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_png"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_png"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_convert_to_tiff(name, page_number, opts = {}) ⇒ File

Convert document page to Tiff image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8676

def get_page_convert_to_tiff(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_convert_to_tiff_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_convert_to_tiff_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_convert_to_tiff_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert document page to Tiff image and return resulting file in response.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8700

def get_page_convert_to_tiff_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_convert_to_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_convert_to_tiff"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_convert_to_tiff"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_convert_to_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_file_attachment_annotations(name, page_number, opts = {}) ⇒ FileAttachmentAnnotationsResponse

Read document page FileAttachment annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8760

def get_page_file_attachment_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_file_attachment_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_file_attachment_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_file_attachment_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(FileAttachmentAnnotationsResponse, Fixnum, Hash)>

Read document page FileAttachment annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



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
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8781

def get_page_file_attachment_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_file_attachment_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_file_attachment_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_file_attachment_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/fileattachment".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileAttachmentAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_file_attachment_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_free_text_annotations(name, page_number, opts = {}) ⇒ FreeTextAnnotationsResponse

Read document page free text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8838

def get_page_free_text_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_free_text_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_free_text_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_free_text_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(FreeTextAnnotationsResponse, Fixnum, Hash)>

Read document page free text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8859

def get_page_free_text_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_free_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_free_text_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_free_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/freetext".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FreeTextAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_free_text_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_highlight_annotations(name, page_number, opts = {}) ⇒ HighlightAnnotationsResponse

Read document page highlight annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8916

def get_page_highlight_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_highlight_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_highlight_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_highlight_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(HighlightAnnotationsResponse, Fixnum, Hash)>

Read document page highlight annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8937

def get_page_highlight_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_highlight_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_highlight_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_highlight_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/highlight".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HighlightAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_highlight_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_ink_annotations(name, page_number, opts = {}) ⇒ InkAnnotationsResponse

Read document page ink annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 8994

def get_page_ink_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_ink_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_ink_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_ink_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(InkAnnotationsResponse, Fixnum, Hash)>

Read document page ink annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    InkAnnotationsResponse data, response status code and response headers



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
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9015

def get_page_ink_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_ink_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_ink_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_ink_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/ink".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InkAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_ink_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_line_annotations(name, page_number, opts = {}) ⇒ LineAnnotationsResponse

Read document page line annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9072

def get_page_line_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_line_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_line_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_line_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(LineAnnotationsResponse, Fixnum, Hash)>

Read document page line annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LineAnnotationsResponse data, response status code and response headers



9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9093

def get_page_line_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_line_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/line".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_line_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_link_annotation(name, page_number, link_id, opts = {}) ⇒ LinkAnnotationResponse

Read document page link annotation by ID.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9151

def get_page_link_annotation(name, page_number, link_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_link_annotation_with_http_info(name, page_number, link_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_link_annotation_with_http_info(name, page_number, link_id, opts)
    else
      raise
    end
  return data
end

#get_page_link_annotation_with_http_info(name, page_number, link_id, opts = {}) ⇒ Array<(LinkAnnotationResponse, Fixnum, Hash)>

Read document page link annotation by ID.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • link_id —

    The link ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LinkAnnotationResponse data, response status code and response headers



9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9173

def get_page_link_annotation_with_http_info(name, page_number, link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_link_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_link_annotation"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_link_annotation"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling PdfApi.get_page_link_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/links/{linkId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'linkId' + '}', link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LinkAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_link_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_link_annotations(name, page_number, opts = {}) ⇒ LinkAnnotationsResponse

Read document page link annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9234

def get_page_link_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_link_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_link_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_link_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(LinkAnnotationsResponse, Fixnum, Hash)>

Read document page link annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    LinkAnnotationsResponse data, response status code and response headers



9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9255

def get_page_link_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_link_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_link_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_link_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/links".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LinkAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_link_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_list_box_fields(name, page_number, opts = {}) ⇒ ListBoxFieldsResponse

Read document page listbox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9312

def get_page_list_box_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_list_box_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_list_box_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_list_box_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(ListBoxFieldsResponse, Fixnum, Hash)>

Read document page listbox fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ListBoxFieldsResponse data, response status code and response headers



9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9333

def get_page_list_box_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_list_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_list_box_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_list_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/listbox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_list_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_movie_annotations(name, page_number, opts = {}) ⇒ MovieAnnotationsResponse

Read document page movie annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9390

def get_page_movie_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_movie_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_movie_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_movie_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(MovieAnnotationsResponse, Fixnum, Hash)>

Read document page movie annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    MovieAnnotationsResponse data, response status code and response headers



9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9411

def get_page_movie_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_movie_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_movie_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_movie_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/movie".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MovieAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_movie_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_poly_line_annotations(name, page_number, opts = {}) ⇒ PolyLineAnnotationsResponse

Read document page polyline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9468

def get_page_poly_line_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_poly_line_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_poly_line_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_poly_line_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(PolyLineAnnotationsResponse, Fixnum, Hash)>

Read document page polyline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9489

def get_page_poly_line_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_poly_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_poly_line_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_poly_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/polyline".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolyLineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_poly_line_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_polygon_annotations(name, page_number, opts = {}) ⇒ PolygonAnnotationsResponse

Read document page polygon annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9546

def get_page_polygon_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_polygon_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_polygon_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_polygon_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(PolygonAnnotationsResponse, Fixnum, Hash)>

Read document page polygon annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PolygonAnnotationsResponse data, response status code and response headers



9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9567

def get_page_polygon_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_polygon_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_polygon_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_polygon_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/polygon".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolygonAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_polygon_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_popup_annotations(name, page_number, opts = {}) ⇒ PopupAnnotationsResponse

Read document page popup annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9624

def get_page_popup_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_popup_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_popup_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_popup_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(PopupAnnotationsResponse, Fixnum, Hash)>

Read document page popup annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PopupAnnotationsResponse data, response status code and response headers



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
9692
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9645

def get_page_popup_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_popup_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_popup_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_popup_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/popup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PopupAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_popup_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_radio_button_fields(name, page_number, opts = {}) ⇒ RadioButtonFieldsResponse

Read document page radiobutton fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9702

def get_page_radio_button_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_radio_button_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_radio_button_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_radio_button_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(RadioButtonFieldsResponse, Fixnum, Hash)>

Read document page radiobutton fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    RadioButtonFieldsResponse data, response status code and response headers



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
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9723

def get_page_radio_button_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_radio_button_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_radio_button_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_radio_button_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RadioButtonFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_redaction_annotations(name, page_number, opts = {}) ⇒ RedactionAnnotationsResponse

Read document page redaction annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9780

def get_page_redaction_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_redaction_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_redaction_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_redaction_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(RedactionAnnotationsResponse, Fixnum, Hash)>

Read document page redaction annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9801

def get_page_redaction_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_redaction_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_redaction_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_redaction_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/redaction".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RedactionAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_redaction_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_screen_annotations(name, page_number, opts = {}) ⇒ ScreenAnnotationsResponse

Read document page screen annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9858

def get_page_screen_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_screen_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_screen_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_screen_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(ScreenAnnotationsResponse, Fixnum, Hash)>

Read document page screen annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ScreenAnnotationsResponse data, response status code and response headers



9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9879

def get_page_screen_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_screen_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_screen_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_screen_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/screen".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_screen_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_signature_fields(name, page_number, opts = {}) ⇒ SignatureFieldsResponse

Read document page signature fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9936

def get_page_signature_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_signature_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_signature_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_signature_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(SignatureFieldsResponse, Fixnum, Hash)>

Read document page signature fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SignatureFieldsResponse data, response status code and response headers



9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 9957

def get_page_signature_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_signature_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_signature_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_signature_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/signature".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_signature_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_sound_annotations(name, page_number, opts = {}) ⇒ SoundAnnotationsResponse

Read document page sound annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10014

def get_page_sound_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_sound_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_sound_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_sound_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(SoundAnnotationsResponse, Fixnum, Hash)>

Read document page sound annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SoundAnnotationsResponse data, response status code and response headers



10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10035

def get_page_sound_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_sound_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_sound_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_sound_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/sound".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SoundAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_sound_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_square_annotations(name, page_number, opts = {}) ⇒ SquareAnnotationsResponse

Read document page square annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10092

def get_page_square_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_square_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_square_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_square_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(SquareAnnotationsResponse, Fixnum, Hash)>

Read document page square annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SquareAnnotationsResponse data, response status code and response headers



10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10113

def get_page_square_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_square_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_square_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_square_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/square".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquareAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_square_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_squiggly_annotations(name, page_number, opts = {}) ⇒ SquigglyAnnotationsResponse

Read document page squiggly annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10170

def get_page_squiggly_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_squiggly_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_squiggly_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_squiggly_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(SquigglyAnnotationsResponse, Fixnum, Hash)>

Read document page squiggly annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10191

def get_page_squiggly_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_squiggly_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_squiggly_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_squiggly_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/squiggly".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquigglyAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_squiggly_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_stamp_annotations(name, page_number, opts = {}) ⇒ StampAnnotationsResponse

Read document page stamp annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10248

def get_page_stamp_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_stamp_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_stamp_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_stamp_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(StampAnnotationsResponse, Fixnum, Hash)>

Read document page stamp annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    StampAnnotationsResponse data, response status code and response headers



10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10269

def get_page_stamp_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_stamp_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_stamp_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_stamp_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/stamp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_stamps(name, page_number, opts = {}) ⇒ StampsInfoResponse

Read page document stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10327

def get_page_stamps(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_stamps_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_stamps_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_stamps_with_http_info(name, page_number, opts = {}) ⇒ Array<(StampsInfoResponse, Fixnum, Hash)>

Read page document stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    StampsInfoResponse data, response status code and response headers



10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10349

def get_page_stamps_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_stamps"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamps".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampsInfoResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_stamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_strike_out_annotations(name, page_number, opts = {}) ⇒ StrikeOutAnnotationsResponse

Read document page StrikeOut annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10407

def get_page_strike_out_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_strike_out_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_strike_out_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(StrikeOutAnnotationsResponse, Fixnum, Hash)>

Read document page StrikeOut annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10428

def get_page_strike_out_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_strike_out_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_strike_out_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_strike_out_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/strikeout".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StrikeOutAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_strike_out_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_tables(name, page_number, opts = {}) ⇒ TablesRecognizedResponse

Read document page tables.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:



10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10485

def get_page_tables(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_tables_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_tables_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_tables_with_http_info(name, page_number, opts = {}) ⇒ Array<(TablesRecognizedResponse, Fixnum, Hash)>

Read document page tables.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:

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

    TablesRecognizedResponse data, response status code and response headers



10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10506

def get_page_tables_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_tables ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_tables"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_tables"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/tables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TablesRecognizedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_text(name, page_number, llx, lly, urx, ury, opts = {}) ⇒ TextRectsResponse

Read page text items.

Parameters:

  • name —

    The document name.

  • page_number —

    Number of page (starting from 1).

  • llx —

    X-coordinate of lower - left corner.

  • lly —

    Y - coordinate of lower-left corner.

  • urx —

    X - coordinate of upper-right corner.

  • ury —

    Y - coordinate of upper-right corner.

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

    the optional parameters

Options Hash (opts):

  • :format (Array<String>) —

    List of formats for search.

  • :regex (String) —

    Formats are specified as a regular expression.

  • :split_rects (BOOLEAN) —

    Split result fragments (default is true). (default to true)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10570

def get_page_text(name, page_number, llx, lly, urx, ury, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts)
    else
      raise
    end
  return data
end

#get_page_text_annotations(name, page_number, opts = {}) ⇒ TextAnnotationsResponse

Read document page text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10678

def get_page_text_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_text_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_text_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_text_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(TextAnnotationsResponse, Fixnum, Hash)>

Read document page text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextAnnotationsResponse data, response status code and response headers



10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10699

def get_page_text_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_text_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_text_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_text_box_fields(name, page_number, opts = {}) ⇒ TextBoxFieldsResponse

Read document page text box fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10756

def get_page_text_box_fields(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_text_box_fields_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_text_box_fields_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_text_box_fields_with_http_info(name, page_number, opts = {}) ⇒ Array<(TextBoxFieldsResponse, Fixnum, Hash)>

Read document page text box fields.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextBoxFieldsResponse data, response status code and response headers



10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10777

def get_page_text_box_fields_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_text_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_text_box_fields"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_text_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/page/{pageNumber}/fields/textbox".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextBoxFieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts = {}) ⇒ Array<(TextRectsResponse, Fixnum, Hash)>

Read page text items.

Parameters:

  • name —

    The document name.

  • page_number —

    Number of page (starting from 1).

  • llx —

    X-coordinate of lower - left corner.

  • lly —

    Y - coordinate of lower-left corner.

  • urx —

    X - coordinate of upper-right corner.

  • ury —

    Y - coordinate of upper-right corner.

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

    the optional parameters

Options Hash (opts):

  • :format (Array<String>) —

    List of formats for search.

  • :regex (String) —

    Formats are specified as a regular expression.

  • :split_rects (BOOLEAN) —

    Split result fragments (default is true).

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    TextRectsResponse data, response status code and response headers



10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10598

def get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_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 PdfApi.get_page_text"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_text"
  end
  # verify the required parameter 'llx' is set
  if @api_client.config.client_side_validation && llx.nil?
    fail ArgumentError, "Missing the required parameter 'llx' when calling PdfApi.get_page_text"
  end
  # verify the required parameter 'lly' is set
  if @api_client.config.client_side_validation && lly.nil?
    fail ArgumentError, "Missing the required parameter 'lly' when calling PdfApi.get_page_text"
  end
  # verify the required parameter 'urx' is set
  if @api_client.config.client_side_validation && urx.nil?
    fail ArgumentError, "Missing the required parameter 'urx' when calling PdfApi.get_page_text"
  end
  # verify the required parameter 'ury' is set
  if @api_client.config.client_side_validation && ury.nil?
    fail ArgumentError, "Missing the required parameter 'ury' when calling PdfApi.get_page_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'LLX'] = llx
  query_params[:'LLY'] = lly
  query_params[:'URX'] = urx
  query_params[:'URY'] = ury
  query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :multi) if !opts[:'format'].nil?
  query_params[:'regex'] = opts[:'regex'] if !opts[:'regex'].nil?
  query_params[:'splitRects'] = opts[:'split_rects'] if !opts[:'split_rects'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextRectsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_underline_annotations(name, page_number, opts = {}) ⇒ UnderlineAnnotationsResponse

Read document page underline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10834

def get_page_underline_annotations(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_page_underline_annotations_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_page_underline_annotations_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#get_page_underline_annotations_with_http_info(name, page_number, opts = {}) ⇒ Array<(UnderlineAnnotationsResponse, Fixnum, Hash)>

Read document page underline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



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
10895
10896
10897
10898
10899
10900
10901
10902
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10855

def get_page_underline_annotations_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_underline_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_underline_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_underline_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/underline".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnderlineAnnotationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_underline_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_with_http_info(name, page_number, opts = {}) ⇒ Array<(DocumentPageResponse, Fixnum, Hash)>

Read document page info.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    DocumentPageResponse data, response status code and response headers



7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 7791

def get_page_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pages(name, opts = {}) ⇒ DocumentPagesResponse

Read document pages info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10911

def get_pages(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pages_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pages_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pages_with_http_info(name, opts = {}) ⇒ Array<(DocumentPagesResponse, Fixnum, Hash)>

Read document pages info.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    DocumentPagesResponse data, response status code and response headers



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
10969
10970
10971
10972
10973
10974
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10931

def get_pages_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pages ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pages"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pcl_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert PCL file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pcl)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 10982

def get_pcl_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pcl_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pcl_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_pcl_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert PCL file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pcl)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
11040
11041
11042
11043
11044
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11001

def get_pcl_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pcl_in_storage_to_pdf ..."
  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 PdfApi.get_pcl_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/pcl"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pcl_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_a_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert PDFA file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pdf)

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

    the optional parameters

Options Hash (opts):

  • :dont_optimize (BOOLEAN) —

    If set, document resources will not be optimized.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11053

def get_pdf_a_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_a_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_a_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_pdf_a_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert PDFA file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pdf)

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

    the optional parameters

Options Hash (opts):

  • :dont_optimize (BOOLEAN) —

    If set, document resources will not be optimized.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
11113
11114
11115
11116
11117
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11073

def get_pdf_a_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_a_in_storage_to_pdf ..."
  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 PdfApi.get_pdf_a_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/pdfa"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dontOptimize'] = opts[:'dont_optimize'] if !opts[:'dont_optimize'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_a_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_doc(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to DOC format and returns resulting file in response content.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11135

def get_pdf_in_storage_to_doc(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_doc_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_doc_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_doc_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to DOC format and returns resulting file in response content.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11164

def get_pdf_in_storage_to_doc_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_doc ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_doc"
  end
  if @api_client.config.client_side_validation && opts[:'format'] && !['Doc', 'DocX'].include?(opts[:'format'])
    fail ArgumentError, 'invalid value for "format", must be one of Doc, DocX'
  end
  if @api_client.config.client_side_validation && opts[:'mode'] && !['Textbox', 'Flow', 'EnhancedFlow'].include?(opts[:'mode'])
    fail ArgumentError, 'invalid value for "mode", must be one of Textbox, Flow, EnhancedFlow'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/doc".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'addReturnToLineEnd'] = opts[:'add_return_to_line_end'] if !opts[:'add_return_to_line_end'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'imageResolutionX'] = opts[:'image_resolution_x'] if !opts[:'image_resolution_x'].nil?
  query_params[:'imageResolutionY'] = opts[:'image_resolution_y'] if !opts[:'image_resolution_y'].nil?
  query_params[:'maxDistanceBetweenTextLines'] = opts[:'max_distance_between_text_lines'] if !opts[:'max_distance_between_text_lines'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?
  query_params[:'recognizeBullets'] = opts[:'recognize_bullets'] if !opts[:'recognize_bullets'].nil?
  query_params[:'relativeHorizontalProximity'] = opts[:'relative_horizontal_proximity'] if !opts[:'relative_horizontal_proximity'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_epub(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to EPUB format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11232

def get_pdf_in_storage_to_epub(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_epub_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_epub_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_epub_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to EPUB format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



11253
11254
11255
11256
11257
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11253

def get_pdf_in_storage_to_epub_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_epub ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_epub"
  end
  if @api_client.config.client_side_validation && opts[:'content_recognition_mode'] && !['Flow', 'PdfFlow', 'Fixed'].include?(opts[:'content_recognition_mode'])
    fail ArgumentError, 'invalid value for "content_recognition_mode", must be one of Flow, PdfFlow, Fixed'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/epub".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'contentRecognitionMode'] = opts[:'content_recognition_mode'] if !opts[:'content_recognition_mode'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_epub\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_html(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to Html format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

Returns:

  • (File) 


11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11338

def get_pdf_in_storage_to_html(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_html_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_html_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_html_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to Html format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

Returns:

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

    File data, response status code and response headers



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
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
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
11483
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11387

def get_pdf_in_storage_to_html_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_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 PdfApi.get_pdf_in_storage_to_html"
  end
  if @api_client.config.client_side_validation && opts[:'document_type'] && !['Xhtml', 'Html5'].include?(opts[:'document_type'])
    fail ArgumentError, 'invalid value for "document_type", must be one of Xhtml, Html5'
  end
  if @api_client.config.client_side_validation && opts[:'antialiasing_processing'] && !['NoAdditionalProcessing', 'TryCorrectResultHtml'].include?(opts[:'antialiasing_processing'])
    fail ArgumentError, 'invalid value for "antialiasing_processing", must be one of NoAdditionalProcessing, TryCorrectResultHtml'
  end
  if @api_client.config.client_side_validation && opts[:'font_encoding_strategy'] && !['Default', 'DecreaseToUnicodePriorityLevel'].include?(opts[:'font_encoding_strategy'])
    fail ArgumentError, 'invalid value for "font_encoding_strategy", must be one of Default, DecreaseToUnicodePriorityLevel'
  end
  if @api_client.config.client_side_validation && opts[:'font_saving_mode'] && !['AlwaysSaveAsWOFF', 'AlwaysSaveAsTTF', 'AlwaysSaveAsEOT', 'SaveInAllFormats'].include?(opts[:'font_saving_mode'])
    fail ArgumentError, 'invalid value for "font_saving_mode", must be one of AlwaysSaveAsWOFF, AlwaysSaveAsTTF, AlwaysSaveAsEOT, SaveInAllFormats'
  end
  if @api_client.config.client_side_validation && opts[:'html_markup_generation_mode'] && !['WriteAllHtml', 'WriteOnlyBodyContent'].include?(opts[:'html_markup_generation_mode'])
    fail ArgumentError, 'invalid value for "html_markup_generation_mode", must be one of WriteAllHtml, WriteOnlyBodyContent'
  end
  if @api_client.config.client_side_validation && opts[:'letters_positioning_method'] && !['UseEmUnitsAndCompensationOfRoundingErrorsInCss', 'UsePixelUnitsInCssLetterSpacingForIE'].include?(opts[:'letters_positioning_method'])
    fail ArgumentError, 'invalid value for "letters_positioning_method", must be one of UseEmUnitsAndCompensationOfRoundingErrorsInCss, UsePixelUnitsInCssLetterSpacingForIE'
  end
  if @api_client.config.client_side_validation && opts[:'parts_embedding_mode'] && !['EmbedAllIntoHtml', 'EmbedCssOnly', 'NoEmbedding'].include?(opts[:'parts_embedding_mode'])
    fail ArgumentError, 'invalid value for "parts_embedding_mode", must be one of EmbedAllIntoHtml, EmbedCssOnly, NoEmbedding'
  end
  if @api_client.config.client_side_validation && opts[:'raster_images_saving_mode'] && !['AsPngImagesEmbeddedIntoSvg', 'AsExternalPngFilesReferencedViaSvg', 'AsEmbeddedPartsOfPngPageBackground'].include?(opts[:'raster_images_saving_mode'])
    fail ArgumentError, 'invalid value for "raster_images_saving_mode", must be one of AsPngImagesEmbeddedIntoSvg, AsExternalPngFilesReferencedViaSvg, AsEmbeddedPartsOfPngPageBackground'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/html".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'additionalMarginWidthInPoints'] = opts[:'additional_margin_width_in_points'] if !opts[:'additional_margin_width_in_points'].nil?
  query_params[:'compressSvgGraphicsIfAny'] = opts[:'compress_svg_graphics_if_any'] if !opts[:'compress_svg_graphics_if_any'].nil?
  query_params[:'convertMarkedContentToLayers'] = opts[:'convert_marked_content_to_layers'] if !opts[:'convert_marked_content_to_layers'].nil?
  query_params[:'defaultFontName'] = opts[:'default_font_name'] if !opts[:'default_font_name'].nil?
  query_params[:'documentType'] = opts[:'document_type'] if !opts[:'document_type'].nil?
  query_params[:'fixedLayout'] = opts[:'fixed_layout'] if !opts[:'fixed_layout'].nil?
  query_params[:'imageResolution'] = opts[:'image_resolution'] if !opts[:'image_resolution'].nil?
  query_params[:'minimalLineWidth'] = opts[:'minimal_line_width'] if !opts[:'minimal_line_width'].nil?
  query_params[:'preventGlyphsGrouping'] = opts[:'prevent_glyphs_grouping'] if !opts[:'prevent_glyphs_grouping'].nil?
  query_params[:'splitCssIntoPages'] = opts[:'split_css_into_pages'] if !opts[:'split_css_into_pages'].nil?
  query_params[:'splitIntoPages'] = opts[:'split_into_pages'] if !opts[:'split_into_pages'].nil?
  query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
  query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
  query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
  query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :multi) if !opts[:'explicit_list_of_saved_pages'].nil?
  query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
  query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
  query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
  query_params[:'lettersPositioningMethod'] = opts[:'letters_positioning_method'] if !opts[:'letters_positioning_method'].nil?
  query_params[:'pagesFlowTypeDependsOnViewersScreenSize'] = opts[:'pages_flow_type_depends_on_viewers_screen_size'] if !opts[:'pages_flow_type_depends_on_viewers_screen_size'].nil?
  query_params[:'partsEmbeddingMode'] = opts[:'parts_embedding_mode'] if !opts[:'parts_embedding_mode'].nil?
  query_params[:'rasterImagesSavingMode'] = opts[:'raster_images_saving_mode'] if !opts[:'raster_images_saving_mode'].nil?
  query_params[:'removeEmptyAreasOnTopAndBottom'] = opts[:'remove_empty_areas_on_top_and_bottom'] if !opts[:'remove_empty_areas_on_top_and_bottom'].nil?
  query_params[:'saveShadowedTextsAsTransparentTexts'] = opts[:'save_shadowed_texts_as_transparent_texts'] if !opts[:'save_shadowed_texts_as_transparent_texts'].nil?
  query_params[:'saveTransparentTexts'] = opts[:'save_transparent_texts'] if !opts[:'save_transparent_texts'].nil?
  query_params[:'specialFolderForAllImages'] = opts[:'special_folder_for_all_images'] if !opts[:'special_folder_for_all_images'].nil?
  query_params[:'specialFolderForSvgImages'] = opts[:'special_folder_for_svg_images'] if !opts[:'special_folder_for_svg_images'].nil?
  query_params[:'trySaveTextUnderliningAndStrikeoutingInCss'] = opts[:'try_save_text_underlining_and_strikeouting_in_css'] if !opts[:'try_save_text_underlining_and_strikeouting_in_css'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'flowLayoutParagraphFullWidth'] = opts[:'flow_layout_paragraph_full_width'] if !opts[:'flow_layout_paragraph_full_width'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_mobi_xml(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11492

def get_pdf_in_storage_to_mobi_xml(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_mobi_xml_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_mobi_xml_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_mobi_xml_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
11550
11551
11552
11553
11554
11555
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11512

def get_pdf_in_storage_to_mobi_xml_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_mobi_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_mobi_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/mobixml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_mobi_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_pdf_a(name, type, opts = {}) ⇒ File

Converts PDF document (located on storage) to PdfA format and returns resulting file in response content

Parameters:

  • name —

    The document name.

  • type —

    Type of PdfA format.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11566

def get_pdf_in_storage_to_pdf_a(name, type, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_pdf_a_with_http_info(name, type, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_pdf_a_with_http_info(name, type, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_pdf_a_with_http_info(name, type, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to PdfA format and returns resulting file in response content

Parameters:

  • name —

    The document name.

  • type —

    Type of PdfA format.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11588

def get_pdf_in_storage_to_pdf_a_with_http_info(name, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_pdf_a ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_pdf_a"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling PdfApi.get_pdf_in_storage_to_pdf_a"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['PDFA1A', 'PDFA1B', 'PDFA3A', 'PDFA3B'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of PDFA1A, PDFA1B, PDFA3A, PDFA3B"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/pdfa".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = type
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_pdf_a\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_pptx(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to PPTX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

Returns:

  • (File) 


11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11653

def get_pdf_in_storage_to_pptx(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_pptx_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_pptx_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_pptx_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to PPTX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    File data, response status code and response headers



11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11676

def get_pdf_in_storage_to_pptx_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_pptx ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_pptx"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/pptx".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'separateImages'] = opts[:'separate_images'] if !opts[:'separate_images'].nil?
  query_params[:'slidesAsImages'] = opts[:'slides_as_images'] if !opts[:'slides_as_images'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_pptx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_svg(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to SVG format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :compress_output_to_zip_archive (BOOLEAN) —

    Specifies whether output will be created as one zip-archive.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11733

def get_pdf_in_storage_to_svg(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_svg_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_svg_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_svg_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to SVG format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :compress_output_to_zip_archive (BOOLEAN) —

    Specifies whether output will be created as one zip-archive.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



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
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11755

def get_pdf_in_storage_to_svg_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_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 PdfApi.get_pdf_in_storage_to_svg"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/svg".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'compressOutputToZipArchive'] = opts[:'compress_output_to_zip_archive'] if !opts[:'compress_output_to_zip_archive'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_svg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_te_x(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to TeX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11809

def get_pdf_in_storage_to_te_x(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_te_x_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_te_x_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_te_x_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to TeX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
11865
11866
11867
11868
11869
11870
11871
11872
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11829

def get_pdf_in_storage_to_te_x_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_te_x ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_te_x"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/tex".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_te_x\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_text(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to Text format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11881

def get_pdf_in_storage_to_text(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_text_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_text_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_text_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to Text format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11901

def get_pdf_in_storage_to_text_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_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 PdfApi.get_pdf_in_storage_to_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_tiff(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to TIFF format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 11968

def get_pdf_in_storage_to_tiff(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_tiff_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_tiff_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_tiff_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to TIFF format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12003

def get_pdf_in_storage_to_tiff_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_tiff"
  end
  if @api_client.config.client_side_validation && opts[:'compression'] && !['LZW', 'CCITT4', 'CCITT3', 'RLE', 'None'].include?(opts[:'compression'])
    fail ArgumentError, 'invalid value for "compression", must be one of LZW, CCITT4, CCITT3, RLE, None'
  end
  if @api_client.config.client_side_validation && opts[:'color_depth'] && !['Default', 'Format8bpp', 'Format4bpp', 'Format1bpp'].include?(opts[:'color_depth'])
    fail ArgumentError, 'invalid value for "color_depth", must be one of Default, Format8bpp, Format4bpp, Format1bpp'
  end
  if @api_client.config.client_side_validation && opts[:'orientation'] && !['None', 'Landscape', 'Portrait'].include?(opts[:'orientation'])
    fail ArgumentError, 'invalid value for "orientation", must be one of None, Landscape, Portrait'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/tiff".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'brightness'] = opts[:'brightness'] if !opts[:'brightness'].nil?
  query_params[:'compression'] = opts[:'compression'] if !opts[:'compression'].nil?
  query_params[:'colorDepth'] = opts[:'color_depth'] if !opts[:'color_depth'].nil?
  query_params[:'leftMargin'] = opts[:'left_margin'] if !opts[:'left_margin'].nil?
  query_params[:'rightMargin'] = opts[:'right_margin'] if !opts[:'right_margin'].nil?
  query_params[:'topMargin'] = opts[:'top_margin'] if !opts[:'top_margin'].nil?
  query_params[:'bottomMargin'] = opts[:'bottom_margin'] if !opts[:'bottom_margin'].nil?
  query_params[:'orientation'] = opts[:'orientation'] if !opts[:'orientation'].nil?
  query_params[:'skipBlankPages'] = opts[:'skip_blank_pages'] if !opts[:'skip_blank_pages'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'xResolution'] = opts[:'x_resolution'] if !opts[:'x_resolution'].nil?
  query_params[:'yResolution'] = opts[:'y_resolution'] if !opts[:'y_resolution'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'pageCount'] = opts[:'page_count'] if !opts[:'page_count'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_xls(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to XLS format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12084

def get_pdf_in_storage_to_xls(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_xls_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_xls_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_xls_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to XLS format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



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
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12109

def get_pdf_in_storage_to_xls_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_xls ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_xls"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xls".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_xls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_xlsx(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to XLSX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (File) 


12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12171

def get_pdf_in_storage_to_xlsx(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_xlsx_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_xlsx_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_xlsx_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to XLSX format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12196

def get_pdf_in_storage_to_xlsx_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_xlsx ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_xlsx"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xlsx".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_xml(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to XML format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12253

def get_pdf_in_storage_to_xml(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_xml_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_xml_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_xml_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to XML format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
12311
12312
12313
12314
12315
12316
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12273

def get_pdf_in_storage_to_xml_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pdf_in_storage_to_xps(name, opts = {}) ⇒ File

Converts PDF document (located on storage) to XPS format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12325

def get_pdf_in_storage_to_xps(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_pdf_in_storage_to_xps_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_pdf_in_storage_to_xps_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_pdf_in_storage_to_xps_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (located on storage) to XPS format and returns resulting file in response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12345

def get_pdf_in_storage_to_xps_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_pdf_in_storage_to_xps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_pdf_in_storage_to_xps"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_pdf_in_storage_to_xps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_poly_line_annotation(name, annotation_id, opts = {}) ⇒ PolyLineAnnotationResponse

Read document page polyline annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12398

def get_poly_line_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_poly_line_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_poly_line_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_poly_line_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(PolyLineAnnotationResponse, Fixnum, Hash)>

Read document page polyline annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PolyLineAnnotationResponse data, response status code and response headers



12419
12420
12421
12422
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12419

def get_poly_line_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_poly_line_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_poly_line_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_poly_line_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polyline/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolyLineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_poly_line_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_polygon_annotation(name, annotation_id, opts = {}) ⇒ PolygonAnnotationResponse

Read document page polygon annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12476

def get_polygon_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_polygon_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_polygon_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_polygon_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(PolygonAnnotationResponse, Fixnum, Hash)>

Read document page polygon annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PolygonAnnotationResponse data, response status code and response headers



12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12497

def get_polygon_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_polygon_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_polygon_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_polygon_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polygon/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolygonAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_polygon_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_popup_annotation(name, annotation_id, opts = {}) ⇒ PopupAnnotationResponse

Read document page popup annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12554

def get_popup_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_popup_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_popup_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_popup_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(PopupAnnotationResponse, Fixnum, Hash)>

Read document page popup annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    PopupAnnotationResponse data, response status code and response headers



12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12575

def get_popup_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_popup_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_popup_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_popup_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/popup/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PopupAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_popup_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ps_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert PS file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.ps)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12630

def get_ps_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_ps_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_ps_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_ps_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert PS file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.ps)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12649

def get_ps_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_ps_in_storage_to_pdf ..."
  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 PdfApi.get_ps_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/ps"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_ps_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_radio_button_field(name, field_name, opts = {}) ⇒ RadioButtonFieldResponse

Read document RadioButton field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12702

def get_radio_button_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_radio_button_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_radio_button_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_radio_button_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(RadioButtonFieldResponse, Fixnum, Hash)>

Read document RadioButton field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    RadioButtonFieldResponse data, response status code and response headers



12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12723

def get_radio_button_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_radio_button_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_radio_button_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_radio_button_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/radiobutton/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RadioButtonFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_radio_button_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_redaction_annotation(name, annotation_id, opts = {}) ⇒ RedactionAnnotationResponse

Read document page redaction annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12780

def get_redaction_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_redaction_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_redaction_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_redaction_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(RedactionAnnotationResponse, Fixnum, Hash)>

Read document page redaction annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12801

def get_redaction_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_redaction_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_redaction_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_redaction_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/redaction/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RedactionAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_redaction_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_annotation(name, annotation_id, opts = {}) ⇒ ScreenAnnotationResponse

Read document page screen annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12858

def get_screen_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_screen_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_screen_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_screen_annotation_data(name, annotation_id, opts = {}) ⇒ File

Read document page screen annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12936

def get_screen_annotation_data(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_screen_annotation_data_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_screen_annotation_data_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_screen_annotation_data_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read document page screen annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12957

def get_screen_annotation_data_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_screen_annotation_data ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_screen_annotation_data"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_screen_annotation_data"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/screen/{annotationId}/data".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_screen_annotation_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(ScreenAnnotationResponse, Fixnum, Hash)>

Read document page screen annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ScreenAnnotationResponse data, response status code and response headers



12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 12879

def get_screen_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_screen_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_screen_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_screen_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/screen/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_screen_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_signature_field(name, field_name, opts = {}) ⇒ SignatureFieldResponse

Read document signature field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13014

def get_signature_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_signature_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_signature_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_signature_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(SignatureFieldResponse, Fixnum, Hash)>

Read document signature field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SignatureFieldResponse data, response status code and response headers



13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13035

def get_signature_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_signature_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_signature_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_signature_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/signature/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sound_annotation(name, annotation_id, opts = {}) ⇒ SoundAnnotationResponse

Read document page sound annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13092

def get_sound_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_sound_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_sound_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_sound_annotation_data(name, annotation_id, opts = {}) ⇒ File

Read document page sound annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13170

def get_sound_annotation_data(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_sound_annotation_data_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_sound_annotation_data_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_sound_annotation_data_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read document page sound annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



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
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13191

def get_sound_annotation_data_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_sound_annotation_data ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_sound_annotation_data"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_sound_annotation_data"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/sound/{annotationId}/data".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_sound_annotation_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sound_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(SoundAnnotationResponse, Fixnum, Hash)>

Read document page sound annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SoundAnnotationResponse data, response status code and response headers



13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13113

def get_sound_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_sound_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_sound_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_sound_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/sound/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SoundAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_sound_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_square_annotation(name, annotation_id, opts = {}) ⇒ SquareAnnotationResponse

Read document page square annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13248

def get_square_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_square_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_square_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_square_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(SquareAnnotationResponse, Fixnum, Hash)>

Read document page square annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SquareAnnotationResponse data, response status code and response headers



13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13269

def get_square_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_square_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_square_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_square_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/square/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquareAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_square_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_squiggly_annotation(name, annotation_id, opts = {}) ⇒ SquigglyAnnotationResponse

Read document page squiggly annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13326

def get_squiggly_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_squiggly_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_squiggly_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_squiggly_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(SquigglyAnnotationResponse, Fixnum, Hash)>

Read document page squiggly annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SquigglyAnnotationResponse data, response status code and response headers



13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13347

def get_squiggly_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_squiggly_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_squiggly_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_squiggly_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/squiggly/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquigglyAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_squiggly_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stamp_annotation(name, annotation_id, opts = {}) ⇒ StampAnnotationResponse

Read document page stamp annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13404

def get_stamp_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_stamp_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_stamp_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_stamp_annotation_data(name, annotation_id, opts = {}) ⇒ File

Read document page stamp annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13482

def get_stamp_annotation_data(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_stamp_annotation_data_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_stamp_annotation_data_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_stamp_annotation_data_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read document page stamp annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    File data, response status code and response headers



13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13503

def get_stamp_annotation_data_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_stamp_annotation_data ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_stamp_annotation_data"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_stamp_annotation_data"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}/data".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_stamp_annotation_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stamp_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(StampAnnotationResponse, Fixnum, Hash)>

Read document page stamp annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    StampAnnotationResponse data, response status code and response headers



13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13425

def get_stamp_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_stamp_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_stamp_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_stamp_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_stamp_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_strike_out_annotation(name, annotation_id, opts = {}) ⇒ StrikeOutAnnotationResponse

Read document page StrikeOut annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13560

def get_strike_out_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_strike_out_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_strike_out_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_strike_out_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(StrikeOutAnnotationResponse, Fixnum, Hash)>

Read document page StrikeOut annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



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
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13581

def get_strike_out_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_strike_out_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_strike_out_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_strike_out_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/strikeout/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StrikeOutAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_strike_out_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_svg_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert SVG file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.svg)

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

    the optional parameters

Options Hash (opts):

  • :adjust_page_size (BOOLEAN) —

    Adjust page size

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13644

def get_svg_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_svg_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_svg_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_svg_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert SVG file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.svg)

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

    the optional parameters

Options Hash (opts):

  • :adjust_page_size (BOOLEAN) —

    Adjust page size

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13671

def get_svg_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_svg_in_storage_to_pdf ..."
  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 PdfApi.get_svg_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/svg"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'adjustPageSize'] = opts[:'adjust_page_size'] if !opts[:'adjust_page_size'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_svg_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_table(name, table_id, opts = {}) ⇒ TableRecognizedResponse

Read document page table by ID.

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13732

def get_table(name, table_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_table_with_http_info(name, table_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_table_with_http_info(name, table_id, opts)
    else
      raise
    end
  return data
end

#get_table_with_http_info(name, table_id, opts = {}) ⇒ Array<(TableRecognizedResponse, Fixnum, Hash)>

Read document page table by ID.

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TableRecognizedResponse data, response status code and response headers



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
13793
13794
13795
13796
13797
13798
13799
13800
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13753

def get_table_with_http_info(name, table_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_table ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_table"
  end
  # verify the required parameter 'table_id' is set
  if @api_client.config.client_side_validation && table_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_id' when calling PdfApi.get_table"
  end
  # resource path
  local_var_path = "/pdf/{name}/tables/{tableId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'tableId' + '}', table_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TableRecognizedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_te_x_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert TeX file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.tex)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13808

def get_te_x_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_te_x_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_te_x_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_te_x_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert TeX file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.tex)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13827

def get_te_x_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_te_x_in_storage_to_pdf ..."
  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 PdfApi.get_te_x_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/tex"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_te_x_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_text(name, llx, lly, urx, ury, opts = {}) ⇒ TextRectsResponse

Read document text.

Parameters:

  • name —

    The document name.

  • llx —

    X-coordinate of lower - left corner.

  • lly —

    Y - coordinate of lower-left corner.

  • urx —

    X - coordinate of upper-right corner.

  • ury —

    Y - coordinate of upper-right corner.

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

    the optional parameters

Options Hash (opts):

  • :format (Array<String>) —

    List of formats for search.

  • :regex (String) —

    Formats are specified as a regular expression.

  • :split_rects (BOOLEAN) —

    Split result fragments (default is true). (default to true)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13886

def get_text(name, llx, lly, urx, ury, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_text_with_http_info(name, llx, lly, urx, ury, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_text_with_http_info(name, llx, lly, urx, ury, opts)
    else
      raise
    end
  return data
end

#get_text_annotation(name, annotation_id, opts = {}) ⇒ TextAnnotationResponse

Read document page text annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13989

def get_text_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_text_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_text_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_text_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(TextAnnotationResponse, Fixnum, Hash)>

Read document page text annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextAnnotationResponse data, response status code and response headers



14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14010

def get_text_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_text_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_text_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_text_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/text/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_text_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_text_box_field(name, field_name, opts = {}) ⇒ TextBoxFieldResponse

Read document text box field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14067

def get_text_box_field(name, field_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_text_box_field_with_http_info(name, field_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_text_box_field_with_http_info(name, field_name, opts)
    else
      raise
    end
  return data
end

#get_text_box_field_with_http_info(name, field_name, opts = {}) ⇒ Array<(TextBoxFieldResponse, Fixnum, Hash)>

Read document text box field by name.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    TextBoxFieldResponse data, response status code and response headers



14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14088

def get_text_box_field_with_http_info(name, field_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_text_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_text_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_text_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/textbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_text_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_text_with_http_info(name, llx, lly, urx, ury, opts = {}) ⇒ Array<(TextRectsResponse, Fixnum, Hash)>

Read document text.

Parameters:

  • name —

    The document name.

  • llx —

    X-coordinate of lower - left corner.

  • lly —

    Y - coordinate of lower-left corner.

  • urx —

    X - coordinate of upper-right corner.

  • ury —

    Y - coordinate of upper-right corner.

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

    the optional parameters

Options Hash (opts):

  • :format (Array<String>) —

    List of formats for search.

  • :regex (String) —

    Formats are specified as a regular expression.

  • :split_rects (BOOLEAN) —

    Split result fragments (default is true).

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    TextRectsResponse data, response status code and response headers



13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 13913

def get_text_with_http_info(name, llx, lly, urx, ury, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_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 PdfApi.get_text"
  end
  # verify the required parameter 'llx' is set
  if @api_client.config.client_side_validation && llx.nil?
    fail ArgumentError, "Missing the required parameter 'llx' when calling PdfApi.get_text"
  end
  # verify the required parameter 'lly' is set
  if @api_client.config.client_side_validation && lly.nil?
    fail ArgumentError, "Missing the required parameter 'lly' when calling PdfApi.get_text"
  end
  # verify the required parameter 'urx' is set
  if @api_client.config.client_side_validation && urx.nil?
    fail ArgumentError, "Missing the required parameter 'urx' when calling PdfApi.get_text"
  end
  # verify the required parameter 'ury' is set
  if @api_client.config.client_side_validation && ury.nil?
    fail ArgumentError, "Missing the required parameter 'ury' when calling PdfApi.get_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'LLX'] = llx
  query_params[:'LLY'] = lly
  query_params[:'URX'] = urx
  query_params[:'URY'] = ury
  query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :multi) if !opts[:'format'].nil?
  query_params[:'regex'] = opts[:'regex'] if !opts[:'regex'].nil?
  query_params[:'splitRects'] = opts[:'split_rects'] if !opts[:'split_rects'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextRectsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_underline_annotation(name, annotation_id, opts = {}) ⇒ UnderlineAnnotationResponse

Read document page underline annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14145

def get_underline_annotation(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_underline_annotation_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_underline_annotation_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#get_underline_annotation_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(UnderlineAnnotationResponse, Fixnum, Hash)>

Read document page underline annotation by ID.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14166

def get_underline_annotation_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_underline_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_underline_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.get_underline_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/underline/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnderlineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_underline_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_verify_signature(name, sign_name, opts = {}) ⇒ SignatureVerifyResponse

Verify signature document.

Parameters:

  • name —

    The document name.

  • sign_name —

    Sign name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14223

def get_verify_signature(name, sign_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_verify_signature_with_http_info(name, sign_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_verify_signature_with_http_info(name, sign_name, opts)
    else
      raise
    end
  return data
end

#get_verify_signature_with_http_info(name, sign_name, opts = {}) ⇒ Array<(SignatureVerifyResponse, Fixnum, Hash)>

Verify signature document.

Parameters:

  • name —

    The document name.

  • sign_name —

    Sign name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SignatureVerifyResponse data, response status code and response headers



14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14244

def get_verify_signature_with_http_info(name, sign_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_verify_signature ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_verify_signature"
  end
  # verify the required parameter 'sign_name' is set
  if @api_client.config.client_side_validation && sign_name.nil?
    fail ArgumentError, "Missing the required parameter 'sign_name' when calling PdfApi.get_verify_signature"
  end
  # resource path
  local_var_path = "/pdf/{name}/verifySignature".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'signName'] = sign_name
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureVerifyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_verify_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_web_in_storage_to_pdf(url, opts = {}) ⇒ File

Convert web page to PDF format and return resulting file in response.

Parameters:

  • url —

    Source url

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14307

def get_web_in_storage_to_pdf(url, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_web_in_storage_to_pdf_with_http_info(url, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_web_in_storage_to_pdf_with_http_info(url, opts)
    else
      raise
    end
  return data
end

#get_web_in_storage_to_pdf_with_http_info(url, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert web page to PDF format and return resulting file in response.

Parameters:

  • url —

    Source url

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

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14333

def get_web_in_storage_to_pdf_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_web_in_storage_to_pdf ..."
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling PdfApi.get_web_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/web"

  # query parameters
  query_params = {}
  query_params[:'url'] = url
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_web_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_words_per_page(name, opts = {}) ⇒ WordCountResponse

Get number of words per document page.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14392

def get_words_per_page(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_words_per_page_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_words_per_page_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_words_per_page_with_http_info(name, opts = {}) ⇒ Array<(WordCountResponse, Fixnum, Hash)>

Get number of words per document page.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    WordCountResponse data, response status code and response headers



14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14412

def get_words_per_page_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_words_per_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_words_per_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/wordCount".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WordCountResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_words_per_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xfa_pdf_in_storage_to_acro_form(name, opts = {}) ⇒ File

Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14464

def get_xfa_pdf_in_storage_to_acro_form(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14484

def get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xfa_pdf_in_storage_to_acro_form ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_xfa_pdf_in_storage_to_acro_form"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xfatoacroform".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xfa_pdf_in_storage_to_acro_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xml_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert XML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xml)

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

    the optional parameters

Options Hash (opts):

  • :xsl_file_path (String) —

    Full XSL source filename (ex. /folder1/folder2/template.xsl)

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14536

def get_xml_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xml_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xml_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_xml_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert XML file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xml)

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

    the optional parameters

Options Hash (opts):

  • :xsl_file_path (String) —

    Full XSL source filename (ex. /folder1/folder2/template.xsl)

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14556

def get_xml_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xml_in_storage_to_pdf ..."
  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 PdfApi.get_xml_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/xml"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'xslFilePath'] = opts[:'xsl_file_path'] if !opts[:'xsl_file_path'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xml_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xmp_metadata_json(name, opts = {}) ⇒ XmpMetadata

Gets document XMP Metadata as JSON.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14610

def get_xmp_metadata_json(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xmp_metadata_json_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xmp_metadata_json_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_xmp_metadata_json_with_http_info(name, opts = {}) ⇒ Array<(XmpMetadata, Fixnum, Hash)>

Gets document XMP Metadata as JSON.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

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

    XmpMetadata data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14631

def get_xmp_metadata_json_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xmp_metadata_json ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_xmp_metadata_json"
  end
  # resource path
  local_var_path = "/pdf/{name}/xmpmetadata/json".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'XmpMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xmp_metadata_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xmp_metadata_xml(name, opts = {}) ⇒ File

Gets document XMP Metadata as XML file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

  • (File) 


14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14685

def get_xmp_metadata_xml(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xmp_metadata_xml_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xmp_metadata_xml_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#get_xmp_metadata_xml_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Gets document XMP Metadata as XML file.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

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

    File data, response status code and response headers



14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14706

def get_xmp_metadata_xml_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xmp_metadata_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_xmp_metadata_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/xmpmetadata/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xmp_metadata_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xps_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert XPS file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xps)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14758

def get_xps_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xps_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xps_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_xps_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert XPS file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xps)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14777

def get_xps_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xps_in_storage_to_pdf ..."
  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 PdfApi.get_xps_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/xps"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xps_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xsl_fo_in_storage_to_pdf(src_path, opts = {}) ⇒ File

Convert XslFo file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xslfo)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

  • (File) 


14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14828

def get_xsl_fo_in_storage_to_pdf(src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, opts)
    else
      raise
    end
  return data
end

#get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert XslFo file (located on storage) to PDF format and return resulting file in response.

Parameters:

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xslfo)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

Returns:

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

    File data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14847

def get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_xsl_fo_in_storage_to_pdf ..."
  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 PdfApi.get_xsl_fo_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/create/xslfo"

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_xsl_fo_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_file(src_path, dest_path, opts = {}) ⇒ nil

Move file

Parameters:

  • src_path —

    Source file path e.g. &#39;/src.ext&#39;

  • dest_path —

    Destination file path e.g. &#39;/dest.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to move

Returns:

  • (nil) 


14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14901

def move_file(src_path, dest_path, opts = {})
  @api_client.request_token_if_needed
  move_file_with_http_info(src_path, dest_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      move_file_with_http_info(src_path, dest_path, opts)
    else
      raise
    end
  return nil
end

#move_file_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Move file

Parameters:

  • src_path —

    Source file path e.g. &#39;/src.ext&#39;

  • dest_path —

    Destination file path e.g. &#39;/dest.ext&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

  • :version_id (String) —

    File version ID to move

Returns:

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

    nil, response status code and response headers



14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14923

def move_file_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.move_file"
  end
  # resource path
  local_var_path = "/pdf/storage/file/move/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'dest_storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#move_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_folder(src_path, dest_path, opts = {}) ⇒ nil

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. &#39;/folder&#39;

  • dest_path —

    Destination folder path to move to e.g &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

  • (nil) 


14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 14981

def move_folder(src_path, dest_path, opts = {})
  @api_client.request_token_if_needed
  move_folder_with_http_info(src_path, dest_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      move_folder_with_http_info(src_path, dest_path, opts)
    else
      raise
    end
  return nil
end

#move_folder_with_http_info(src_path, dest_path, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Move folder

Parameters:

  • src_path —

    Folder path to move e.g. &#39;/folder&#39;

  • dest_path —

    Destination folder path to move to e.g &#39;/dst&#39;

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

    the optional parameters

Options Hash (opts):

  • :src_storage_name (String) —

    Source storage name

  • :dest_storage_name (String) —

    Destination storage name

Returns:

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

    nil, response status code and response headers



15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15002

def move_folder_with_http_info(src_path, dest_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.move_folder"
  end
  # resource path
  local_var_path = "/pdf/storage/folder/move/{srcPath}".sub('{' + 'srcPath' + '}', src_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'destPath'] = dest_path
  query_params[:'srcStorageName'] = opts[:'src_storage_name'] if !opts[:'src_storage_name'].nil?
  query_params[:'destStorageName'] = opts[:'dest_storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#move_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#object_exists(path, opts = {}) ⇒ ObjectExist

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID

Returns:



15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15058

def object_exists(path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = object_exists_with_http_info(path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = object_exists_with_http_info(path, opts)
    else
      raise
    end
  return data
end

#object_exists_with_http_info(path, opts = {}) ⇒ Array<(ObjectExist, Fixnum, Hash)>

Check if file or folder exists

Parameters:

  • path —

    File or folder path e.g. &#39;/file.ext&#39; or &#39;/folder&#39;

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

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

  • :version_id (String) —

    File version ID

Returns:

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

    ObjectExist data, response status code and response headers



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
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15078

def object_exists_with_http_info(path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.object_exists"
  end
  # resource path
  local_var_path = "/pdf/storage/exist/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'storage_name'].nil?
  query_params[:'versionId'] = opts[:'version_id'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ObjectExist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#object_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_add_document_attachment(name, attachment_info, opts = {}) ⇒ AttachmentsResponse

Adds a file attachment to the PDF document.

Parameters:

  • name —

    The document name.

  • attachment_info —

    AttachmentInfoAttachmentInfo instance.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15131

def post_add_document_attachment(name, attachment_info, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_add_document_attachment_with_http_info(name, attachment_info, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_add_document_attachment_with_http_info(name, attachment_info, opts)
    else
      raise
    end
  return data
end

#post_add_document_attachment_with_http_info(name, attachment_info, opts = {}) ⇒ Array<(AttachmentsResponse, Fixnum, Hash)>

Adds a file attachment to the PDF document.

Parameters:

  • name —

    The document name.

  • attachment_info —

    AttachmentInfoAttachmentInfo instance.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AttachmentsResponse data, response status code and response headers



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
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15152

def post_add_document_attachment_with_http_info(name, attachment_info, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_add_document_attachment ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_add_document_attachment"
  end
  # verify the required parameter 'attachment_info' is set
  if @api_client.config.client_side_validation && attachment_info.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_info' when calling PdfApi.post_add_document_attachment"
  end
  # resource path
  local_var_path = "/pdf/{name}/attachments".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_append_document(name, append_file, opts = {}) ⇒ DocumentResponse

Append document to existing one.

Parameters:

  • name —

    The original document name.

  • append_file —

    Append file server path.

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

    the optional parameters

Options Hash (opts):

  • :start_page (Integer) —

    Appending start page. (default to 0)

  • :end_page (Integer) —

    Appending end page. (default to 0)

  • :storage (String) —

    The documents storage.

  • :folder (String) —

    The original document folder.

Returns:



15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15210

def post_append_document(name, append_file, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_append_document_with_http_info(name, append_file, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_append_document_with_http_info(name, append_file, opts)
    else
      raise
    end
  return data
end

#post_append_document_with_http_info(name, append_file, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Append document to existing one.

Parameters:

  • name —

    The original document name.

  • append_file —

    Append file server path.

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

    the optional parameters

Options Hash (opts):

  • :start_page (Integer) —

    Appending start page.

  • :end_page (Integer) —

    Appending end page.

  • :storage (String) —

    The documents storage.

  • :folder (String) —

    The original document folder.

Returns:

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

    DocumentResponse data, response status code and response headers



15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15233

def post_append_document_with_http_info(name, append_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_append_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_append_document"
  end
  # verify the required parameter 'append_file' is set
  if @api_client.config.client_side_validation && append_file.nil?
    fail ArgumentError, "Missing the required parameter 'append_file' when calling PdfApi.post_append_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/appendDocument".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'appendFile'] = append_file
  query_params[:'startPage'] = opts[:'start_page'] if !opts[:'start_page'].nil?
  query_params[:'endPage'] = opts[:'end_page'] if !opts[:'end_page'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_append_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_bookmark(name, bookmark_path, bookmarks, opts = {}) ⇒ BookmarksResponse

Add document bookmarks.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The parent bookmark path. Specify an empty string when adding a bookmark to the root.

  • bookmarks —

    The array of bookmark.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15295

def post_bookmark(name, bookmark_path, bookmarks, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_bookmark_with_http_info(name, bookmark_path, bookmarks, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_bookmark_with_http_info(name, bookmark_path, bookmarks, opts)
    else
      raise
    end
  return data
end

#post_bookmark_with_http_info(name, bookmark_path, bookmarks, opts = {}) ⇒ Array<(BookmarksResponse, Fixnum, Hash)>

Add document bookmarks.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The parent bookmark path. Specify an empty string when adding a bookmark to the root.

  • bookmarks —

    The array of bookmark.

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

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

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

    BookmarksResponse data, response status code and response headers



15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15318

def post_bookmark_with_http_info(name, bookmark_path, bookmarks, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_bookmark ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_bookmark"
  end
  # verify the required parameter 'bookmark_path' is set
  if @api_client.config.client_side_validation && bookmark_path.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark_path' when calling PdfApi.post_bookmark"
  end
  # verify the required parameter 'bookmarks' is set
  if @api_client.config.client_side_validation && bookmarks.nil?
    fail ArgumentError, "Missing the required parameter 'bookmarks' when calling PdfApi.post_bookmark"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/bookmark/{bookmarkPath}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'bookmarkPath' + '}', bookmark_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_change_password_document_in_storage(name, owner_password, new_user_password, new_owner_password, opts = {}) ⇒ AsposeResponse

Change document password in storage.

Parameters:

  • name —

    Document name.

  • owner_password —

    Owner password (encrypted Base64).

  • new_user_password —

    New user password (encrypted Base64).

  • new_owner_password —

    New owner password (encrypted Base64).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15381

def post_change_password_document_in_storage(name, owner_password, new_user_password, new_owner_password, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts)
    else
      raise
    end
  return data
end

#post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Change document password in storage.

Parameters:

  • name —

    Document name.

  • owner_password —

    Owner password (encrypted Base64).

  • new_user_password —

    New user password (encrypted Base64).

  • new_owner_password —

    New owner password (encrypted Base64).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15404

def post_change_password_document_in_storage_with_http_info(name, owner_password, new_user_password, new_owner_password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_change_password_document_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_change_password_document_in_storage"
  end
  # verify the required parameter 'owner_password' is set
  if @api_client.config.client_side_validation && owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.post_change_password_document_in_storage"
  end
  # verify the required parameter 'new_user_password' is set
  if @api_client.config.client_side_validation && new_user_password.nil?
    fail ArgumentError, "Missing the required parameter 'new_user_password' when calling PdfApi.post_change_password_document_in_storage"
  end
  # verify the required parameter 'new_owner_password' is set
  if @api_client.config.client_side_validation && new_owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'new_owner_password' when calling PdfApi.post_change_password_document_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/changepassword".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'ownerPassword'] = owner_password
  query_params[:'newUserPassword'] = new_user_password
  query_params[:'newOwnerPassword'] = new_owner_password
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_change_password_document_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_check_box_fields(name, fields, opts = {}) ⇒ AsposeResponse

Add document checkbox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15472

def post_check_box_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_check_box_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_check_box_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#post_check_box_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document checkbox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15493

def post_check_box_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_check_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_check_box_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_check_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/checkbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_combo_box_fields(name, fields, opts = {}) ⇒ AsposeResponse

Add document combobox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15549

def post_combo_box_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_combo_box_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_combo_box_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#post_combo_box_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document combobox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15570

def post_combo_box_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_combo_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_combo_box_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_combo_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/combobox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_compare_pdf(path1, path2, out_path, opts = {}) ⇒ AsposeResponse

Compare two PDF documents.

Parameters:

  • path1 —

    Path to first PDF document.

  • path2 —

    Path to second PDF document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

Returns:



15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15626

def post_compare_pdf(path1, path2, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_compare_pdf_with_http_info(path1, path2, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_compare_pdf_with_http_info(path1, path2, out_path, opts)
    else
      raise
    end
  return data
end

#post_compare_pdf_with_http_info(path1, path2, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Compare two PDF documents.

Parameters:

  • path1 —

    Path to first PDF document.

  • path2 —

    Path to second PDF document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

Returns:

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

    AsposeResponse data, response status code and response headers



15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15647

def post_compare_pdf_with_http_info(path1, path2, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_compare_pdf ..."
  end
  # verify the required parameter 'path1' is set
  if @api_client.config.client_side_validation && path1.nil?
    fail ArgumentError, "Missing the required parameter 'path1' when calling PdfApi.post_compare_pdf"
  end
  # verify the required parameter 'path2' is set
  if @api_client.config.client_side_validation && path2.nil?
    fail ArgumentError, "Missing the required parameter 'path2' when calling PdfApi.post_compare_pdf"
  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 PdfApi.post_compare_pdf"
  end
  # resource path
  local_var_path = "/pdf/compare"

  # query parameters
  query_params = {}
  query_params[:'path1'] = path1
  query_params[:'path2'] = path2
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_compare_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_create_document(name, document_config, opts = {}) ⇒ DocumentResponse

Create empty document.

Parameters:

  • name —

    The new document name.

  • document_config —

    The document config for new document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:



15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15710

def post_create_document(name, document_config, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_create_document_with_http_info(name, document_config, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_create_document_with_http_info(name, document_config, opts)
    else
      raise
    end
  return data
end

#post_create_document_with_http_info(name, document_config, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Create empty document.

Parameters:

  • name —

    The new document name.

  • document_config —

    The document config for new document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:

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

    DocumentResponse data, response status code and response headers



15731
15732
15733
15734
15735
15736
15737
15738
15739
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15731

def post_create_document_with_http_info(name, document_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_create_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_create_document"
  end
  # verify the required parameter 'document_config' is set
  if @api_client.config.client_side_validation && document_config.nil?
    fail ArgumentError, "Missing the required parameter 'document_config' when calling PdfApi.post_create_document"
  end
  # resource path
  local_var_path = "/pdf/{name}".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_create_field(name, page, field, opts = {}) ⇒ AsposeResponse

Create field.

Parameters:

  • name —

    The document name.

  • page —

    Document page number.

  • field —

    Field with the field data.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15788

def post_create_field(name, page, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_create_field_with_http_info(name, page, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_create_field_with_http_info(name, page, field, opts)
    else
      raise
    end
  return data
end

#post_create_field_with_http_info(name, page, field, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Create field.

Parameters:

  • name —

    The document name.

  • page —

    Document page number.

  • field —

    Field with the field data.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
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
15861
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15810

def post_create_field_with_http_info(name, page, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_create_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_create_field"
  end
  # verify the required parameter 'page' is set
  if @api_client.config.client_side_validation && page.nil?
    fail ArgumentError, "Missing the required parameter 'page' when calling PdfApi.post_create_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.post_create_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = page
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_decrypt_document_in_storage(name, password, opts = {}) ⇒ AsposeResponse

Decrypt document in storage.

Parameters:

  • name —

    Document name.

  • password —

    The password (encrypted Base64).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15871

def post_decrypt_document_in_storage(name, password, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_decrypt_document_in_storage_with_http_info(name, password, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_decrypt_document_in_storage_with_http_info(name, password, opts)
    else
      raise
    end
  return data
end

#post_decrypt_document_in_storage_with_http_info(name, password, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Decrypt document in storage.

Parameters:

  • name —

    Document name.

  • password —

    The password (encrypted Base64).

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15892

def post_decrypt_document_in_storage_with_http_info(name, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_decrypt_document_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_decrypt_document_in_storage"
  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 PdfApi.post_decrypt_document_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/decrypt".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'password'] = password
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_decrypt_document_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_document_image_footer(name, image_footer, opts = {}) ⇒ AsposeResponse

Add document image footer.

Parameters:

  • name —

    The document name.

  • image_footer —

    The image footer.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15952

def post_document_image_footer(name, image_footer, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_image_footer_with_http_info(name, image_footer, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_image_footer_with_http_info(name, image_footer, opts)
    else
      raise
    end
  return data
end

#post_document_image_footer_with_http_info(name, image_footer, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document image footer.

Parameters:

  • name —

    The document name.

  • image_footer —

    The image footer.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 15975

def post_document_image_footer_with_http_info(name, image_footer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_image_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 PdfApi.post_document_image_footer"
  end
  # verify the required parameter 'image_footer' is set
  if @api_client.config.client_side_validation && image_footer.nil?
    fail ArgumentError, "Missing the required parameter 'image_footer' when calling PdfApi.post_document_image_footer"
  end
  # resource path
  local_var_path = "/pdf/{name}/footer/image".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPageNumber'] = opts[:'start_page_number'] if !opts[:'start_page_number'].nil?
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_image_header(name, image_header, opts = {}) ⇒ AsposeResponse

Add document image header.

Parameters:

  • name —

    The document name.

  • image_header —

    The image header.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16035

def post_document_image_header(name, image_header, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_image_header_with_http_info(name, image_header, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_image_header_with_http_info(name, image_header, opts)
    else
      raise
    end
  return data
end

#post_document_image_header_with_http_info(name, image_header, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document image header.

Parameters:

  • name —

    The document name.

  • image_header —

    The image header.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16058

def post_document_image_header_with_http_info(name, image_header, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_image_header ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_image_header"
  end
  # verify the required parameter 'image_header' is set
  if @api_client.config.client_side_validation && image_header.nil?
    fail ArgumentError, "Missing the required parameter 'image_header' when calling PdfApi.post_document_image_header"
  end
  # resource path
  local_var_path = "/pdf/{name}/header/image".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPageNumber'] = opts[:'start_page_number'] if !opts[:'start_page_number'].nil?
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_image_stamps(name, stamps, opts = {}) ⇒ AsposeResponse

Add document pages image stamps.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16117

def post_document_image_stamps(name, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_image_stamps_with_http_info(name, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_image_stamps_with_http_info(name, stamps, opts)
    else
      raise
    end
  return data
end

#post_document_image_stamps_page_specified(name, stamps, opts = {}) ⇒ AsposeResponse

Add document image stamps to specified pages.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamps.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16197

def post_document_image_stamps_page_specified(name, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_image_stamps_page_specified_with_http_info(name, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_image_stamps_page_specified_with_http_info(name, stamps, opts)
    else
      raise
    end
  return data
end

#post_document_image_stamps_page_specified_with_http_info(name, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document image stamps to specified pages.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamps.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



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
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16219

def post_document_image_stamps_page_specified_with_http_info(name, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_image_stamps_page_specified ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_image_stamps_page_specified"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_document_image_stamps_page_specified"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/image/pagespecified".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_image_stamps_with_http_info(name, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document pages image stamps.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16139
16140
16141
16142
16143
16144
16145
16146
16147
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16139

def post_document_image_stamps_with_http_info(name, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_image_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_image_stamps"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_document_image_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/image".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_page_number_stamps(name, stamp, opts = {}) ⇒ AsposeResponse

Add document page number stamps.

Parameters:

  • name —

    The document name.

  • stamp —

    The stamp.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16279

def post_document_page_number_stamps(name, stamp, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_page_number_stamps_with_http_info(name, stamp, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_page_number_stamps_with_http_info(name, stamp, opts)
    else
      raise
    end
  return data
end

#post_document_page_number_stamps_with_http_info(name, stamp, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page number stamps.

Parameters:

  • name —

    The document name.

  • stamp —

    The stamp.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16303

def post_document_page_number_stamps_with_http_info(name, stamp, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_page_number_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_page_number_stamps"
  end
  # verify the required parameter 'stamp' is set
  if @api_client.config.client_side_validation && stamp.nil?
    fail ArgumentError, "Missing the required parameter 'stamp' when calling PdfApi.post_document_page_number_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/pagenumber".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPageNumber'] = opts[:'start_page_number'] if !opts[:'start_page_number'].nil?
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_pages_crop(name, pages, rect, opts = {}) ⇒ AsposeResponse

Crop PDF document pages.

Parameters:

  • name —

    The document name.

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

  • rect —

    Rectangle of document area.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16364

def post_document_pages_crop(name, pages, rect, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_pages_crop_with_http_info(name, pages, rect, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_pages_crop_with_http_info(name, pages, rect, opts)
    else
      raise
    end
  return data
end

#post_document_pages_crop_with_http_info(name, pages, rect, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Crop PDF document pages.

Parameters:

  • name —

    The document name.

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

  • rect —

    Rectangle of document area.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16387

def post_document_pages_crop_with_http_info(name, pages, rect, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_pages_crop ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_pages_crop"
  end
  # verify the required parameter 'pages' is set
  if @api_client.config.client_side_validation && pages.nil?
    fail ArgumentError, "Missing the required parameter 'pages' when calling PdfApi.post_document_pages_crop"
  end
  # verify the required parameter 'rect' is set
  if @api_client.config.client_side_validation && rect.nil?
    fail ArgumentError, "Missing the required parameter 'rect' when calling PdfApi.post_document_pages_crop"
  end
  # resource path
  local_var_path = "/pdf/{name}/crop".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'pages'] = pages
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_pages_resize(name, height, width, pages, opts = {}) ⇒ AsposeResponse

Rsize PDF document.

Parameters:

  • name —

    The document name.

  • height —

    Page Height

  • width —

    Page width

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16452

def post_document_pages_resize(name, height, width, pages, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_pages_resize_with_http_info(name, height, width, pages, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_pages_resize_with_http_info(name, height, width, pages, opts)
    else
      raise
    end
  return data
end

#post_document_pages_resize_with_http_info(name, height, width, pages, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Rsize PDF document.

Parameters:

  • name —

    The document name.

  • height —

    Page Height

  • width —

    Page width

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



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
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16476

def post_document_pages_resize_with_http_info(name, height, width, pages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_pages_resize ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_pages_resize"
  end
  # verify the required parameter 'height' is set
  if @api_client.config.client_side_validation && height.nil?
    fail ArgumentError, "Missing the required parameter 'height' when calling PdfApi.post_document_pages_resize"
  end
  # verify the required parameter 'width' is set
  if @api_client.config.client_side_validation && width.nil?
    fail ArgumentError, "Missing the required parameter 'width' when calling PdfApi.post_document_pages_resize"
  end
  # verify the required parameter 'pages' is set
  if @api_client.config.client_side_validation && pages.nil?
    fail ArgumentError, "Missing the required parameter 'pages' when calling PdfApi.post_document_pages_resize"
  end
  # resource path
  local_var_path = "/pdf/{name}/resize".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'height'] = height
  query_params[:'width'] = width
  query_params[:'pages'] = pages
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_document_pages_resize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_document_pages_rotate(name, rotation_angle, pages, opts = {}) ⇒ AsposeResponse

Rotate PDF document.

Parameters:

  • name —

    The document name.

  • rotation_angle —

    Rotation Angle (CKW). Can be 90, 180, 270.

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16547

def post_document_pages_rotate(name, rotation_angle, pages, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_pages_rotate_with_http_info(name, rotation_angle, pages, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_pages_rotate_with_http_info(name, rotation_angle, pages, opts)
    else
      raise
    end
  return data
end

#post_document_pages_rotate_with_http_info(name, rotation_angle, pages, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Rotate PDF document.

Parameters:

  • name —

    The document name.

  • rotation_angle —

    Rotation Angle (CKW). Can be 90, 180, 270.

  • pages —

    Comma separated list of pages and page ranges. (Example: 1,3-5,8)

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16570

def post_document_pages_rotate_with_http_info(name, rotation_angle, pages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_pages_rotate ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_pages_rotate"
  end
  # verify the required parameter 'rotation_angle' is set
  if @api_client.config.client_side_validation && rotation_angle.nil?
    fail ArgumentError, "Missing the required parameter 'rotation_angle' when calling PdfApi.post_document_pages_rotate"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['None', 'on90', 'on180', 'on270'].include?(rotation_angle)
    fail ArgumentError, "invalid value for 'rotation_angle', must be one of None, on90, on180, on270"
  end
  # verify the required parameter 'pages' is set
  if @api_client.config.client_side_validation && pages.nil?
    fail ArgumentError, "Missing the required parameter 'pages' when calling PdfApi.post_document_pages_rotate"
  end
  # resource path
  local_var_path = "/pdf/{name}/rotate".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'rotationAngle'] = rotation_angle
  query_params[:'pages'] = pages
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_document_pages_rotate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_document_text_footer(name, text_footer, opts = {}) ⇒ AsposeResponse

Add document text footer.

Parameters:

  • name —

    The document name.

  • text_footer —

    The text footer.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16640

def post_document_text_footer(name, text_footer, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_text_footer_with_http_info(name, text_footer, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_text_footer_with_http_info(name, text_footer, opts)
    else
      raise
    end
  return data
end

#post_document_text_footer_with_http_info(name, text_footer, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document text footer.

Parameters:

  • name —

    The document name.

  • text_footer —

    The text footer.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16663

def post_document_text_footer_with_http_info(name, text_footer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_text_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 PdfApi.post_document_text_footer"
  end
  # verify the required parameter 'text_footer' is set
  if @api_client.config.client_side_validation && text_footer.nil?
    fail ArgumentError, "Missing the required parameter 'text_footer' when calling PdfApi.post_document_text_footer"
  end
  # resource path
  local_var_path = "/pdf/{name}/footer/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPageNumber'] = opts[:'start_page_number'] if !opts[:'start_page_number'].nil?
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_text_header(name, text_header, opts = {}) ⇒ AsposeResponse

Add document text header.

Parameters:

  • name —

    The document name.

  • text_header —

    The text header.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16723

def post_document_text_header(name, text_header, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_text_header_with_http_info(name, text_header, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_text_header_with_http_info(name, text_header, opts)
    else
      raise
    end
  return data
end

#post_document_text_header_with_http_info(name, text_header, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document text header.

Parameters:

  • name —

    The document name.

  • text_header —

    The text header.

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

    the optional parameters

Options Hash (opts):

  • :start_page_number (Integer) —

    The start page number.

  • :end_page_number (Integer) —

    The end page number.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16746

def post_document_text_header_with_http_info(name, text_header, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_text_header ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_text_header"
  end
  # verify the required parameter 'text_header' is set
  if @api_client.config.client_side_validation && text_header.nil?
    fail ArgumentError, "Missing the required parameter 'text_header' when calling PdfApi.post_document_text_header"
  end
  # resource path
  local_var_path = "/pdf/{name}/header/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPageNumber'] = opts[:'start_page_number'] if !opts[:'start_page_number'].nil?
  query_params[:'endPageNumber'] = opts[:'end_page_number'] if !opts[:'end_page_number'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_text_replace(name, text_replace, opts = {}) ⇒ TextReplaceResponse

Document’s replace text method.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:



16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16804

def post_document_text_replace(name, text_replace, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_text_replace_with_http_info(name, text_replace, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_text_replace_with_http_info(name, text_replace, opts)
    else
      raise
    end
  return data
end

#post_document_text_replace_with_http_info(name, text_replace, opts = {}) ⇒ Array<(TextReplaceResponse, Fixnum, Hash)>

Document&#39;s replace text method.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:

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

    TextReplaceResponse data, response status code and response headers



16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16825

def post_document_text_replace_with_http_info(name, text_replace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_text_replace ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_text_replace"
  end
  # verify the required parameter 'text_replace' is set
  if @api_client.config.client_side_validation && text_replace.nil?
    fail ArgumentError, "Missing the required parameter 'text_replace' when calling PdfApi.post_document_text_replace"
  end
  # resource path
  local_var_path = "/pdf/{name}/text/replace".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_text_stamps(name, stamps, opts = {}) ⇒ AsposeResponse

Add document pages text stamps.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16882

def post_document_text_stamps(name, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_text_stamps_with_http_info(name, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_text_stamps_with_http_info(name, stamps, opts)
    else
      raise
    end
  return data
end

#post_document_text_stamps_page_specified(name, stamps, opts = {}) ⇒ AsposeResponse

Add document text stamps to specified pages.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamps.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16962

def post_document_text_stamps_page_specified(name, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_document_text_stamps_page_specified_with_http_info(name, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_document_text_stamps_page_specified_with_http_info(name, stamps, opts)
    else
      raise
    end
  return data
end

#post_document_text_stamps_page_specified_with_http_info(name, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document text stamps to specified pages.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamps.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16984

def post_document_text_stamps_page_specified_with_http_info(name, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_text_stamps_page_specified ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_text_stamps_page_specified"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_document_text_stamps_page_specified"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/text/pagespecified".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_document_text_stamps_with_http_info(name, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document pages text stamps.

Parameters:

  • name —

    The document name.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 16904

def post_document_text_stamps_with_http_info(name, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_text_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_document_text_stamps"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_document_text_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/stamps/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_encrypt_document_in_storage(name, user_password, owner_password, crypto_algorithm, opts = {}) ⇒ AsposeResponse

Encrypt document in storage.

Parameters:

  • name —

    Document name.

  • user_password —

    User password (encrypted Base64).

  • owner_password —

    Owner password (encrypted Base64).

  • crypto_algorithm —

    Cryptographic algorithm, see CryptoAlgorithm for details.

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

    the optional parameters

Options Hash (opts):

  • :permissions_flags (Array<PermissionsFlags>) —

    Array of document permissions, see PermissionsFlags for details.

  • :use_pdf20 (BOOLEAN) —

    Support for revision 6 (Extension 8).

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17045

def post_encrypt_document_in_storage(name, user_password, owner_password, crypto_algorithm, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_encrypt_document_in_storage_with_http_info(name, user_password, owner_password, crypto_algorithm, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_encrypt_document_in_storage_with_http_info(name, user_password, owner_password, crypto_algorithm, opts)
    else
      raise
    end
  return data
end

#post_encrypt_document_in_storage_with_http_info(name, user_password, owner_password, crypto_algorithm, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Encrypt document in storage.

Parameters:

  • name —

    Document name.

  • user_password —

    User password (encrypted Base64).

  • owner_password —

    Owner password (encrypted Base64).

  • crypto_algorithm —

    Cryptographic algorithm, see CryptoAlgorithm for details.

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

    the optional parameters

Options Hash (opts):

  • :permissions_flags (Array<PermissionsFlags>) —

    Array of document permissions, see PermissionsFlags for details.

  • :use_pdf20 (BOOLEAN) —

    Support for revision 6 (Extension 8).

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17070

def post_encrypt_document_in_storage_with_http_info(name, user_password, owner_password, crypto_algorithm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_encrypt_document_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_encrypt_document_in_storage"
  end
  # verify the required parameter 'user_password' is set
  if @api_client.config.client_side_validation && user_password.nil?
    fail ArgumentError, "Missing the required parameter 'user_password' when calling PdfApi.post_encrypt_document_in_storage"
  end
  # verify the required parameter 'owner_password' is set
  if @api_client.config.client_side_validation && owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.post_encrypt_document_in_storage"
  end
  # verify the required parameter 'crypto_algorithm' is set
  if @api_client.config.client_side_validation && crypto_algorithm.nil?
    fail ArgumentError, "Missing the required parameter 'crypto_algorithm' when calling PdfApi.post_encrypt_document_in_storage"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['RC4x40', 'RC4x128', 'AESx128', 'AESx256'].include?(crypto_algorithm)
    fail ArgumentError, "invalid value for 'crypto_algorithm', must be one of RC4x40, RC4x128, AESx128, AESx256"
  end
  # resource path
  local_var_path = "/pdf/{name}/encrypt".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'userPassword'] = user_password
  query_params[:'ownerPassword'] = owner_password
  query_params[:'cryptoAlgorithm'] = crypto_algorithm
  query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :multi) if !opts[:'permissions_flags'].nil?
  query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_encrypt_document_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flatten_document(name, opts = {}) ⇒ AsposeResponse

Flatten the document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :update_appearances (BOOLEAN) —

    If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance..

  • :call_events (BOOLEAN) —

    If set, formatting and other JavaScript events will be called.

  • :hide_buttons (BOOLEAN) —

    If set, buttons will be removed from flattened document.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17146

def post_flatten_document(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_flatten_document_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#post_flatten_document_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Flatten the document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :update_appearances (BOOLEAN) —

    If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance..

  • :call_events (BOOLEAN) —

    If set, formatting and other JavaScript events will be called.

  • :hide_buttons (BOOLEAN) —

    If set, buttons will be removed from flattened document.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17169

def post_flatten_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_flatten_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_flatten_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/flatten".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'updateAppearances'] = opts[:'update_appearances'] if !opts[:'update_appearances'].nil?
  query_params[:'callEvents'] = opts[:'call_events'] if !opts[:'call_events'].nil?
  query_params[:'hideButtons'] = opts[:'hide_buttons'] if !opts[:'hide_buttons'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_flatten_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_html_to_pdf(opts = {}) ⇒ File

Convert HTML file (zip archive in request content) to PDF format and return resulting file in response.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

Returns:

  • (File) 


17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17229

def post_html_to_pdf(opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_html_to_pdf_with_http_info(opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_html_to_pdf_with_http_info(opts)
    else
      raise
    end
  return data
end

#post_html_to_pdf_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Convert HTML file (zip archive in request content) to PDF format and return resulting file in response.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

Returns:

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

    File data, response status code and response headers



17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17254

def post_html_to_pdf_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_html_to_pdf ..."
  end
  # resource path
  local_var_path = "/pdf/create/html"

  # query parameters
  query_params = {}
  query_params[:'htmlFileName'] = opts[:'html_file_name'] if !opts[:'html_file_name'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_html_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_import_fields_from_fdf(name, opts = {}) ⇒ AsposeResponse

Update fields from FDF file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :fdf_data (File) —

    Fdf file.

Returns:



17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17309

def post_import_fields_from_fdf(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_import_fields_from_fdf_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_import_fields_from_fdf_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#post_import_fields_from_fdf_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from FDF file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :fdf_data (File) —

    Fdf file.

Returns:

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

    AsposeResponse data, response status code and response headers



17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17330

def post_import_fields_from_fdf_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_fdf ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_fdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'fdf_data'] if !opts[:'fdf_data'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_fdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_import_fields_from_xfdf(name, opts = {}) ⇒ AsposeResponse

Update fields from XFDF file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :xfdf_data (File) —

    Xfdf file.

Returns:



17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17385

def post_import_fields_from_xfdf(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_import_fields_from_xfdf_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_import_fields_from_xfdf_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#post_import_fields_from_xfdf_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from XFDF file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :xfdf_data (File) —

    Xfdf file.

Returns:

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

    AsposeResponse data, response status code and response headers



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
17446
17447
17448
17449
17450
17451
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17406

def post_import_fields_from_xfdf_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_xfdf ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_xfdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'xfdf_data'] if !opts[:'xfdf_data'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_xfdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_import_fields_from_xml(name, opts = {}) ⇒ AsposeResponse

Update fields from XML file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :xml_data (File) —

    Xml file.

Returns:



17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17461

def post_import_fields_from_xml(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_import_fields_from_xml_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_import_fields_from_xml_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#post_import_fields_from_xml_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from XML file in request.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :xml_data (File) —

    Xml file.

Returns:

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

    AsposeResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17482

def post_import_fields_from_xml_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_import_fields_from_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_import_fields_from_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'xml_data'] if !opts[:'xml_data'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_import_fields_from_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_insert_image(name, page_number, llx, lly, urx, ury, opts = {}) ⇒ AsposeResponse

Insert image to document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • llx —

    Coordinate lower left X.

  • lly —

    Coordinate lower left Y.

  • urx —

    Coordinate upper right X.

  • ury —

    Coordinate upper right Y.

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

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:



17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17543

def post_insert_image(name, page_number, llx, lly, urx, ury, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, opts)
    else
      raise
    end
  return data
end

#post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Insert image to document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • llx —

    Coordinate lower left X.

  • lly —

    Coordinate lower left Y.

  • urx —

    Coordinate upper right X.

  • ury —

    Coordinate upper right Y.

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

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:

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

    AsposeResponse data, response status code and response headers



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
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17570

def post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_insert_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 PdfApi.post_insert_image"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_insert_image"
  end
  # verify the required parameter 'llx' is set
  if @api_client.config.client_side_validation && llx.nil?
    fail ArgumentError, "Missing the required parameter 'llx' when calling PdfApi.post_insert_image"
  end
  # verify the required parameter 'lly' is set
  if @api_client.config.client_side_validation && lly.nil?
    fail ArgumentError, "Missing the required parameter 'lly' when calling PdfApi.post_insert_image"
  end
  # verify the required parameter 'urx' is set
  if @api_client.config.client_side_validation && urx.nil?
    fail ArgumentError, "Missing the required parameter 'urx' when calling PdfApi.post_insert_image"
  end
  # verify the required parameter 'ury' is set
  if @api_client.config.client_side_validation && ury.nil?
    fail ArgumentError, "Missing the required parameter 'ury' when calling PdfApi.post_insert_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'llx'] = llx
  query_params[:'lly'] = lly
  query_params[:'urx'] = urx
  query_params[:'ury'] = ury
  query_params[:'imageFilePath'] = opts[:'image_file_path'] if !opts[:'image_file_path'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'image'] if !opts[:'image'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_insert_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_list_box_fields(name, fields, opts = {}) ⇒ AsposeResponse

Add document listbox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17650

def post_list_box_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_list_box_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_list_box_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#post_list_box_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document listbox fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17671

def post_list_box_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_list_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_list_box_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_list_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/listbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_move_page(name, page_number, new_index, opts = {}) ⇒ AsposeResponse

Move page to new position.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • new_index —

    The new page position/index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17728

def post_move_page(name, page_number, new_index, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_move_page_with_http_info(name, page_number, new_index, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_move_page_with_http_info(name, page_number, new_index, opts)
    else
      raise
    end
  return data
end

#post_move_page_with_http_info(name, page_number, new_index, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Move page to new position.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • new_index —

    The new page position/index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17750

def post_move_page_with_http_info(name, page_number, new_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_move_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_move_page"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_move_page"
  end
  # verify the required parameter 'new_index' is set
  if @api_client.config.client_side_validation && new_index.nil?
    fail ArgumentError, "Missing the required parameter 'new_index' when calling PdfApi.post_move_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/movePage".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'newIndex'] = new_index
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_move_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_optimize_document(name, options, opts = {}) ⇒ AsposeResponse

Optimize document.

Parameters:

  • name —

    The document name.

  • options —

    The optimization options.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17812

def post_optimize_document(name, options, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_optimize_document_with_http_info(name, options, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_optimize_document_with_http_info(name, options, opts)
    else
      raise
    end
  return data
end

#post_optimize_document_with_http_info(name, options, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Optimize document.

Parameters:

  • name —

    The document name.

  • options —

    The optimization options.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17833

def post_optimize_document_with_http_info(name, options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_optimize_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_optimize_document"
  end
  # verify the required parameter 'options' is set
  if @api_client.config.client_side_validation && options.nil?
    fail ArgumentError, "Missing the required parameter 'options' when calling PdfApi.post_optimize_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/optimize".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_organize_document(name, pages, out_path, opts = {}) ⇒ AsposeResponse

Merge selected pages of a document.

Parameters:

  • name —

    The original document name.

  • pages —

    1-based page numbers of the source document that make up the resulting document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

  • :folder (String) —

    The source document folder.

Returns:



17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17890

def post_organize_document(name, pages, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_organize_document_with_http_info(name, pages, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_organize_document_with_http_info(name, pages, out_path, opts)
    else
      raise
    end
  return data
end

#post_organize_document_with_http_info(name, pages, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Merge selected pages of a document.

Parameters:

  • name —

    The original document name.

  • pages —

    1-based page numbers of the source document that make up the resulting document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

  • :folder (String) —

    The source document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17912

def post_organize_document_with_http_info(name, pages, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_organize_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_organize_document"
  end
  # verify the required parameter 'pages' is set
  if @api_client.config.client_side_validation && pages.nil?
    fail ArgumentError, "Missing the required parameter 'pages' when calling PdfApi.post_organize_document"
  end
  if @api_client.config.client_side_validation && pages.to_s.length < 1
    fail ArgumentError, 'invalid value for "pages" when calling PdfApi.post_organize_document, the character length must be great than or equal to 1.'
  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 PdfApi.post_organize_document"
  end
  if @api_client.config.client_side_validation && out_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "out_path" when calling PdfApi.post_organize_document, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = "/pdf/{name}/organize".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'pages'] = pages
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_organize_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_organize_documents(organize_documents, out_path, opts = {}) ⇒ AsposeResponse

Merge selected pages of different documents.

Parameters:

  • organize_documents —

    Array of OrganizeDocumentData to make up the resulting document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

Returns:



17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 17982

def post_organize_documents(organize_documents, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_organize_documents_with_http_info(organize_documents, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_organize_documents_with_http_info(organize_documents, out_path, opts)
    else
      raise
    end
  return data
end

#post_organize_documents_with_http_info(organize_documents, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Merge selected pages of different documents.

Parameters:

  • organize_documents —

    Array of OrganizeDocumentData to make up the resulting document.

  • out_path —

    Full filename of the resulting document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The documents storage.

Returns:

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

    AsposeResponse data, response status code and response headers



18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18002

def post_organize_documents_with_http_info(organize_documents, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_organize_documents ..."
  end
  # verify the required parameter 'organize_documents' is set
  if @api_client.config.client_side_validation && organize_documents.nil?
    fail ArgumentError, "Missing the required parameter 'organize_documents' when calling PdfApi.post_organize_documents"
  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 PdfApi.post_organize_documents"
  end
  if @api_client.config.client_side_validation && out_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "out_path" when calling PdfApi.post_organize_documents, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = "/pdf/organize"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_caret_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page caret annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18063

def post_page_caret_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_caret_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_caret_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_caret_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page caret annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18085

def post_page_caret_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_caret_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_caret_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_caret_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_caret_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/caret".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_certify(name, page_number, sign, doc_mdp_access_permission_type, opts = {}) ⇒ AsposeResponse

Certify document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • sign —

    Signature object containing signature data.

  • doc_mdp_access_permission_type —

    The access permissions granted for this document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18147

def post_page_certify(name, page_number, sign, doc_mdp_access_permission_type, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts)
    else
      raise
    end
  return data
end

#post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Certify document page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • sign —

    Signature object containing signature data.

  • doc_mdp_access_permission_type —

    The access permissions granted for this document.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18170

def post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_certify ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_certify"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_certify"
  end
  # verify the required parameter 'sign' is set
  if @api_client.config.client_side_validation && sign.nil?
    fail ArgumentError, "Missing the required parameter 'sign' when calling PdfApi.post_page_certify"
  end
  # verify the required parameter 'doc_mdp_access_permission_type' is set
  if @api_client.config.client_side_validation && doc_mdp_access_permission_type.nil?
    fail ArgumentError, "Missing the required parameter 'doc_mdp_access_permission_type' when calling PdfApi.post_page_certify"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['NoChanges', 'FillingInForms', 'AnnotationModification'].include?(doc_mdp_access_permission_type)
    fail ArgumentError, "invalid value for 'doc_mdp_access_permission_type', must be one of NoChanges, FillingInForms, AnnotationModification"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/certify".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'docMdpAccessPermissionType'] = doc_mdp_access_permission_type
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_circle_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page circle annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18240

def post_page_circle_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_circle_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_circle_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_circle_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page circle annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18262

def post_page_circle_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_circle_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_circle_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_circle_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_circle_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/circle".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_file_attachment_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page FileAttachment annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    Annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18323

def post_page_file_attachment_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page FileAttachment annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    Annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18345

def post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_file_attachment_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_file_attachment_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_file_attachment_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_file_attachment_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/fileattachment".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_free_text_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page free text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18406

def post_page_free_text_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_free_text_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_free_text_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_free_text_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page free text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18428

def post_page_free_text_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_free_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_free_text_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_free_text_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_free_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/freetext".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_highlight_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page highlight annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18489

def post_page_highlight_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_highlight_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_highlight_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_highlight_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page highlight annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18511

def post_page_highlight_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_highlight_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_highlight_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_highlight_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_highlight_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/highlight".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_image_stamps(name, page_number, stamps, opts = {}) ⇒ AsposeResponse

Add document page image stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18573

def post_page_image_stamps(name, page_number, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_image_stamps_with_http_info(name, page_number, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_image_stamps_with_http_info(name, page_number, stamps, opts)
    else
      raise
    end
  return data
end

#post_page_image_stamps_with_http_info(name, page_number, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page image stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



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
18640
18641
18642
18643
18644
18645
18646
18647
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18596

def post_page_image_stamps_with_http_info(name, page_number, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_image_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_image_stamps"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_image_stamps"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_page_image_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamps/image".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_ink_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page ink annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18658

def post_page_ink_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_ink_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_ink_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_ink_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page ink annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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_pdf_cloud/api/pdf_api.rb', line 18680

def post_page_ink_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_ink_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_ink_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_ink_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_ink_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/ink".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_line_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page line annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18741

def post_page_line_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_line_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_line_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_line_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page line annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18763

def post_page_line_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_line_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_line_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/line".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_link_annotations(name, page_number, links, opts = {}) ⇒ AsposeResponse

Add document page link annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • links —

    Array of link annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18824

def post_page_link_annotations(name, page_number, links, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_link_annotations_with_http_info(name, page_number, links, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_link_annotations_with_http_info(name, page_number, links, opts)
    else
      raise
    end
  return data
end

#post_page_link_annotations_with_http_info(name, page_number, links, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page link annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • links —

    Array of link annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18846

def post_page_link_annotations_with_http_info(name, page_number, links, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_link_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_link_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_link_annotations"
  end
  # verify the required parameter 'links' is set
  if @api_client.config.client_side_validation && links.nil?
    fail ArgumentError, "Missing the required parameter 'links' when calling PdfApi.post_page_link_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/links".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_movie_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page movie annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18907

def post_page_movie_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_movie_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_movie_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_movie_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page movie annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18929

def post_page_movie_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_movie_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_movie_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_movie_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_movie_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/movie".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_pdf_page_stamps(name, page_number, stamps, opts = {}) ⇒ AsposeResponse

Add document pdf page stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 18991

def post_page_pdf_page_stamps(name, page_number, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_pdf_page_stamps_with_http_info(name, page_number, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_pdf_page_stamps_with_http_info(name, page_number, stamps, opts)
    else
      raise
    end
  return data
end

#post_page_pdf_page_stamps_with_http_info(name, page_number, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document pdf page stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

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

    AsposeResponse data, response status code and response headers



19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
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
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19014

def post_page_pdf_page_stamps_with_http_info(name, page_number, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_pdf_page_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_pdf_page_stamps"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_pdf_page_stamps"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_page_pdf_page_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamps/pdfpage".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_poly_line_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page polyline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19076

def post_page_poly_line_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_poly_line_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_poly_line_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_poly_line_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page polyline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19098

def post_page_poly_line_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_poly_line_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_poly_line_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_poly_line_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_poly_line_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/polyline".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_polygon_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page polygon annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19159

def post_page_polygon_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_polygon_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_polygon_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_polygon_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page polygon annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19181

def post_page_polygon_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_polygon_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_polygon_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_polygon_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_polygon_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/polygon".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_redaction_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page redaction annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :apply (BOOLEAN) —

    Apply redaction immediately after adding. (default to false)

Returns:



19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19243

def post_page_redaction_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_redaction_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_redaction_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_redaction_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page redaction annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :apply (BOOLEAN) —

    Apply redaction immediately after adding.

Returns:

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

    AsposeResponse data, response status code and response headers



19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19266

def post_page_redaction_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_redaction_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_redaction_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_redaction_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_redaction_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/redaction".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'apply'] = opts[:'apply'] if !opts[:'apply'].nil?

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

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_screen_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page screen annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19328

def post_page_screen_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_screen_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_screen_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_screen_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page screen annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19350

def post_page_screen_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_screen_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_screen_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_screen_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_screen_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/screen".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_sound_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page sound annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19411

def post_page_sound_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_sound_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_sound_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_sound_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page sound annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19433

def post_page_sound_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_sound_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_sound_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_sound_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_sound_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/sound".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_square_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page square annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19494

def post_page_square_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_square_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_square_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_square_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page square annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19516

def post_page_square_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_square_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_square_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_square_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_square_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/square".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_squiggly_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page squiggly annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19577

def post_page_squiggly_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_squiggly_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_squiggly_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_squiggly_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page squiggly annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19599

def post_page_squiggly_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_squiggly_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_squiggly_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_squiggly_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_squiggly_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/squiggly".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

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

#post_page_stamp_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page stamp annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19660

def post_page_stamp_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page stamp annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AsposeResponse data, response status code and response headers



19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19682

def post_page_stamp_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_stamp_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_stamp_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_stamp_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_stamp_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/stamp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotations)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_stamp_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_strike_out_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page StrikeOut annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19743

def post_page_strike_out_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_strike_out_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_strike_out_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_strike_out_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page StrikeOut annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19765

def post_page_strike_out_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_strike_out_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_strike_out_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_strike_out_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_strike_out_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/strikeout".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotations)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_strike_out_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_tables(name, page_number, tables, opts = {}) ⇒ AsposeResponse

Add document page tables.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • tables —

    The array of table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19826

def post_page_tables(name, page_number, tables, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_tables_with_http_info(name, page_number, tables, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_tables_with_http_info(name, page_number, tables, opts)
    else
      raise
    end
  return data
end

#post_page_tables_with_http_info(name, page_number, tables, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page tables.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • tables —

    The array of table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19848

def post_page_tables_with_http_info(name, page_number, tables, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_tables ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_tables"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_tables"
  end
  # verify the required parameter 'tables' is set
  if @api_client.config.client_side_validation && tables.nil?
    fail ArgumentError, "Missing the required parameter 'tables' when calling PdfApi.post_page_tables"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/tables".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(tables)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_text_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19909

def post_page_text_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_text_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_text_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_text_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page text annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19931

def post_page_text_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_text_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_text_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_text_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_text_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotations)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_text_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_text_replace(name, page_number, text_replace_list_request, opts = {}) ⇒ TextReplaceResponse

Page’s replace text method.

Parameters:

  • name
  • page_number
  • text_replace_list_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:



19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 19992

def post_page_text_replace(name, page_number, text_replace_list_request, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, opts)
    else
      raise
    end
  return data
end

#post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, opts = {}) ⇒ Array<(TextReplaceResponse, Fixnum, Hash)>

Page&#39;s replace text method.

Parameters:

  • name
  • page_number
  • text_replace_list_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String)
  • :folder (String)

Returns:

  • (Array<(TextReplaceResponse, Fixnum, Hash)>) —

    TextReplaceResponse data, response status code and response headers



20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20014

def post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_text_replace ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_text_replace"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_text_replace"
  end
  # verify the required parameter 'text_replace_list_request' is set
  if @api_client.config.client_side_validation && text_replace_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'text_replace_list_request' when calling PdfApi.post_page_text_replace"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/text/replace".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace_list_request)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_text_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_text_stamps(name, page_number, stamps, opts = {}) ⇒ AsposeResponse

Add document page text stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20076

def post_page_text_stamps(name, page_number, stamps, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_text_stamps_with_http_info(name, page_number, stamps, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_text_stamps_with_http_info(name, page_number, stamps, opts)
    else
      raise
    end
  return data
end

#post_page_text_stamps_with_http_info(name, page_number, stamps, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page text stamps.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamps —

    The array of stamp.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20099

def post_page_text_stamps_with_http_info(name, page_number, stamps, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_text_stamps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_text_stamps"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_text_stamps"
  end
  # verify the required parameter 'stamps' is set
  if @api_client.config.client_side_validation && stamps.nil?
    fail ArgumentError, "Missing the required parameter 'stamps' when calling PdfApi.post_page_text_stamps"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamps/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(stamps)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_text_stamps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_underline_annotations(name, page_number, annotations, opts = {}) ⇒ AsposeResponse

Add document page underline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20161

def post_page_underline_annotations(name, page_number, annotations, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_page_underline_annotations_with_http_info(name, page_number, annotations, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_page_underline_annotations_with_http_info(name, page_number, annotations, opts)
    else
      raise
    end
  return data
end

#post_page_underline_annotations_with_http_info(name, page_number, annotations, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document page underline annotations.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotations —

    The array of annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20183

def post_page_underline_annotations_with_http_info(name, page_number, annotations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_underline_annotations ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_underline_annotations"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_underline_annotations"
  end
  # verify the required parameter 'annotations' is set
  if @api_client.config.client_side_validation && annotations.nil?
    fail ArgumentError, "Missing the required parameter 'annotations' when calling PdfApi.post_page_underline_annotations"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/underline".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotations)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_underline_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_pdf_to_xlsx(opts = {}) ⇒ File

Converts PDF document (in request content) to XLSX format and uploads and returns resulting file in response content.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (File) 


20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20244

def post_pdf_to_xlsx(opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_pdf_to_xlsx_with_http_info(opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_pdf_to_xlsx_with_http_info(opts)
    else
      raise
    end
  return data
end

#post_pdf_to_xlsx_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Converts PDF document (in request content) to XLSX format and uploads and returns resulting file in response content.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(File, Fixnum, Hash)>) —

    File data, response status code and response headers



20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20266

def post_pdf_to_xlsx_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_pdf_to_xlsx ..."
  end
  # resource path
  local_var_path = "/pdf/convert/xlsx"

  # query parameters
  query_params = {}
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_pdf_to_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_popup_annotation(name, annotation_id, annotation, opts = {}) ⇒ AsposeResponse

Add document popup annotations.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The parent annotation ID.

  • annotation —

    The annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20320

def post_popup_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_popup_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_popup_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#post_popup_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document popup annotations.

Parameters:

  • name —

    The document name.

  • annotation_id —

    The parent annotation ID.

  • annotation —

    The annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20342

def post_popup_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_popup_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_popup_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.post_popup_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.post_popup_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/{annotationId}/popup".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_popup_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_radio_button_fields(name, fields, opts = {}) ⇒ AsposeResponse

Add document RadioButton fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20402

def post_radio_button_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_radio_button_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_radio_button_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#post_radio_button_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document RadioButton fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20423

def post_radio_button_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_radio_button_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_radio_button_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_radio_button_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/radiobutton".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(fields)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_radio_button_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_sign_document(name, sign, opts = {}) ⇒ AsposeResponse

Sign document.

Parameters:

  • name —

    The document name.

  • sign —

    Signature object containing signature data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20479

def post_sign_document(name, sign, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_sign_document_with_http_info(name, sign, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_sign_document_with_http_info(name, sign, opts)
    else
      raise
    end
  return data
end

#post_sign_document_with_http_info(name, sign, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Sign document.

Parameters:

  • name —

    The document name.

  • sign —

    Signature object containing signature data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20500

def post_sign_document_with_http_info(name, sign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_sign_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_sign_document"
  end
  # verify the required parameter 'sign' is set
  if @api_client.config.client_side_validation && sign.nil?
    fail ArgumentError, "Missing the required parameter 'sign' when calling PdfApi.post_sign_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/sign".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(sign)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_sign_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_sign_page(name, page_number, sign, opts = {}) ⇒ AsposeResponse

Sign page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • sign —

    Signature object containing signature data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20557

def post_sign_page(name, page_number, sign, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_sign_page_with_http_info(name, page_number, sign, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_sign_page_with_http_info(name, page_number, sign, opts)
    else
      raise
    end
  return data
end

#post_sign_page_with_http_info(name, page_number, sign, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Sign page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • sign —

    Signature object containing signature data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20579

def post_sign_page_with_http_info(name, page_number, sign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_sign_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_sign_page"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_sign_page"
  end
  # verify the required parameter 'sign' is set
  if @api_client.config.client_side_validation && sign.nil?
    fail ArgumentError, "Missing the required parameter 'sign' when calling PdfApi.post_sign_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/sign".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(sign)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_sign_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_signature_field(name, field, opts = {}) ⇒ AsposeResponse

Add document signature field.

Parameters:

  • name —

    The document name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20639

def post_signature_field(name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_signature_field_with_http_info(name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_signature_field_with_http_info(name, field, opts)
    else
      raise
    end
  return data
end

#post_signature_field_with_http_info(name, field, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document signature field.

Parameters:

  • name —

    The document name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20660

def post_signature_field_with_http_info(name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_signature_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_signature_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.post_signature_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/signature".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_split_document(name, opts = {}) ⇒ SplitResultResponse

Split document to parts.

Parameters:

  • name —

    Document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Resulting documents format.

  • :from (Integer) —

    Start page if defined.

  • :to (Integer) —

    End page if defined.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20719

def post_split_document(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_split_document_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_split_document_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#post_split_document_with_http_info(name, opts = {}) ⇒ Array<(SplitResultResponse, Fixnum, Hash)>

Split document to parts.

Parameters:

  • name —

    Document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (String) —

    Resulting documents format.

  • :from (Integer) —

    Start page if defined.

  • :to (Integer) —

    End page if defined.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

  • (Array<(SplitResultResponse, Fixnum, Hash)>) —

    SplitResultResponse data, response status code and response headers



20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20743

def post_split_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_split_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_split_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/split".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SplitResultResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_split_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_split_range_pdf_document(name, options, opts = {}) ⇒ SplitResultResponse

Split document into ranges.

Parameters:

  • name —

    The document name.

  • options —

    The splitting options.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:



20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20801

def post_split_range_pdf_document(name, options, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_split_range_pdf_document_with_http_info(name, options, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_split_range_pdf_document_with_http_info(name, options, opts)
    else
      raise
    end
  return data
end

#post_split_range_pdf_document_with_http_info(name, options, opts = {}) ⇒ Array<(SplitResultResponse, Fixnum, Hash)>

Split document into ranges.

Parameters:

  • name —

    The document name.

  • options —

    The splitting options.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    Base64 encoded password.

Returns:

  • (Array<(SplitResultResponse, Fixnum, Hash)>) —

    SplitResultResponse data, response status code and response headers



20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20823

def post_split_range_pdf_document_with_http_info(name, options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_split_range_pdf_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_split_range_pdf_document"
  end
  # verify the required parameter 'options' is set
  if @api_client.config.client_side_validation && options.nil?
    fail ArgumentError, "Missing the required parameter 'options' when calling PdfApi.post_split_range_pdf_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/splitrangepdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(options)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SplitResultResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_split_range_pdf_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_text_box_fields(name, fields, opts = {}) ⇒ AsposeResponse

Add document text box fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20880

def post_text_box_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_text_box_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_text_box_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#post_text_box_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add document text box fields.

Parameters:

  • name —

    The document name.

  • fields —

    The array of field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20901

def post_text_box_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_text_box_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_text_box_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.post_text_box_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/textbox".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(fields)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_text_box_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_xmp_metadata(name, metadata, opts = {}) ⇒ AsposeResponse

Add or remove XMP Metadata properties.

Parameters:

  • name —

    The document name.

  • metadata —

    XmpMetadata instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20958

def post_xmp_metadata(name, metadata, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = post_xmp_metadata_with_http_info(name, metadata, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = post_xmp_metadata_with_http_info(name, metadata, opts)
    else
      raise
    end
  return data
end

#post_xmp_metadata_with_http_info(name, metadata, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add or remove XMP Metadata properties.

Parameters:

  • name —

    The document name.

  • metadata —

    XmpMetadata instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 20980

def post_xmp_metadata_with_http_info(name, metadata, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_xmp_metadata ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_xmp_metadata"
  end
  # verify the required parameter 'metadata' is set
  if @api_client.config.client_side_validation && metadata.nil?
    fail ArgumentError, "Missing the required parameter 'metadata' when calling PdfApi.post_xmp_metadata"
  end
  # resource path
  local_var_path = "/pdf/{name}/xmpmetadata".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(metadata)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_xmp_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_add_new_page(name, opts = {}) ⇒ DocumentPagesResponse

Add new page to end of the document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21036

def put_add_new_page(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_add_new_page_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_add_new_page_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#put_add_new_page_with_http_info(name, opts = {}) ⇒ Array<(DocumentPagesResponse, Fixnum, Hash)>

Add new page to end of the document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(DocumentPagesResponse, Fixnum, Hash)>) —

    DocumentPagesResponse data, response status code and response headers



21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21056

def put_add_new_page_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_add_new_page ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_add_new_page"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_add_new_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_add_text(name, page_number, paragraph, opts = {}) ⇒ AsposeResponse

Add text to PDF document page.

Parameters:

  • name —

    The document name.

  • page_number —

    Number of page (starting from 1).

  • paragraph —

    Paragraph data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage (String) —

    The document storage.

Returns:



21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21110

def put_add_text(name, page_number, paragraph, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_add_text_with_http_info(name, page_number, paragraph, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_add_text_with_http_info(name, page_number, paragraph, opts)
    else
      raise
    end
  return data
end

#put_add_text_with_http_info(name, page_number, paragraph, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add text to PDF document page.

Parameters:

  • name —

    The document name.

  • page_number —

    Number of page (starting from 1).

  • paragraph —

    Paragraph data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    Document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21132

def put_add_text_with_http_info(name, page_number, paragraph, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_add_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 PdfApi.put_add_text"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_add_text"
  end
  # verify the required parameter 'paragraph' is set
  if @api_client.config.client_side_validation && paragraph.nil?
    fail ArgumentError, "Missing the required parameter 'paragraph' when calling PdfApi.put_add_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/text".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(paragraph)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_add_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_annotations_flatten(name, opts = {}) ⇒ AsposeResponse

Flattens the annotations of the specified types

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_page (Integer) —

    The start page number.

  • :end_page (Integer) —

    The end page number.

  • :annotation_types (Array<AnnotationType>) —

    Array of annotation types.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21194

def put_annotations_flatten(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_annotations_flatten_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_annotations_flatten_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#put_annotations_flatten_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Flattens the annotations of the specified types

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_page (Integer) —

    The start page number.

  • :end_page (Integer) —

    The end page number.

  • :annotation_types (Array<AnnotationType>) —

    Array of annotation types.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21217

def put_annotations_flatten_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_annotations_flatten ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_annotations_flatten"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/flatten".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'startPage'] = opts[:'start_page'] if !opts[:'start_page'].nil?
  query_params[:'endPage'] = opts[:'end_page'] if !opts[:'end_page'].nil?
  query_params[:'annotationTypes'] = @api_client.build_collection_param(opts[:'annotation_types'], :multi) if !opts[:'annotation_types'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_annotations_flatten\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_bookmark(name, bookmark_path, bookmark, opts = {}) ⇒ BookmarkResponse

Update document bookmark.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

  • bookmark —

    The bookmark.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21275

def put_bookmark(name, bookmark_path, bookmark, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_bookmark_with_http_info(name, bookmark_path, bookmark, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_bookmark_with_http_info(name, bookmark_path, bookmark, opts)
    else
      raise
    end
  return data
end

#put_bookmark_with_http_info(name, bookmark_path, bookmark, opts = {}) ⇒ Array<(BookmarkResponse, Fixnum, Hash)>

Update document bookmark.

Parameters:

  • name —

    The document name.

  • bookmark_path —

    The bookmark path.

  • bookmark —

    The bookmark.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(BookmarkResponse, Fixnum, Hash)>) —

    BookmarkResponse data, response status code and response headers



21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21298

def put_bookmark_with_http_info(name, bookmark_path, bookmark, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_bookmark ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_bookmark"
  end
  # verify the required parameter 'bookmark_path' is set
  if @api_client.config.client_side_validation && bookmark_path.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark_path' when calling PdfApi.put_bookmark"
  end
  # verify the required parameter 'bookmark' is set
  if @api_client.config.client_side_validation && bookmark.nil?
    fail ArgumentError, "Missing the required parameter 'bookmark' when calling PdfApi.put_bookmark"
  end
  # resource path
  local_var_path = "/pdf/{name}/bookmarks/bookmark/{bookmarkPath}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'bookmarkPath' + '}', bookmark_path.to_s)

  # query parameters
  query_params = {}
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(bookmark)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BookmarkResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_caret_annotation(name, annotation_id, annotation, opts = {}) ⇒ CaretAnnotationResponse

Replace document caret annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21360

def put_caret_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_caret_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_caret_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_caret_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(CaretAnnotationResponse, Fixnum, Hash)>

Replace document caret annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(CaretAnnotationResponse, Fixnum, Hash)>) —

    CaretAnnotationResponse data, response status code and response headers



21382
21383
21384
21385
21386
21387
21388
21389
21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21382

def put_caret_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_caret_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_caret_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_caret_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_caret_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/caret/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CaretAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_caret_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_change_password_document(out_path, owner_password, new_user_password, new_owner_password, opts = {}) ⇒ AsposeResponse

Change document password from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • owner_password —

    Owner password (encrypted Base64).

  • new_user_password —

    New user password (encrypted Base64).

  • new_owner_password —

    New owner password (encrypted Base64).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be changed password.

Returns:



21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21444

def put_change_password_document(out_path, owner_password, new_user_password, new_owner_password, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_change_password_document_with_http_info(out_path, owner_password, new_user_password, new_owner_password, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_change_password_document_with_http_info(out_path, owner_password, new_user_password, new_owner_password, opts)
    else
      raise
    end
  return data
end

#put_change_password_document_with_http_info(out_path, owner_password, new_user_password, new_owner_password, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Change document password from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • owner_password —

    Owner password (encrypted Base64).

  • new_user_password —

    New user password (encrypted Base64).

  • new_owner_password —

    New owner password (encrypted Base64).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be changed password.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21467

def put_change_password_document_with_http_info(out_path, owner_password, new_user_password, new_owner_password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_change_password_document ..."
  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 PdfApi.put_change_password_document"
  end
  # verify the required parameter 'owner_password' is set
  if @api_client.config.client_side_validation && owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.put_change_password_document"
  end
  # verify the required parameter 'new_user_password' is set
  if @api_client.config.client_side_validation && new_user_password.nil?
    fail ArgumentError, "Missing the required parameter 'new_user_password' when calling PdfApi.put_change_password_document"
  end
  # verify the required parameter 'new_owner_password' is set
  if @api_client.config.client_side_validation && new_owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'new_owner_password' when calling PdfApi.put_change_password_document"
  end
  # resource path
  local_var_path = "/pdf/changepassword"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'ownerPassword'] = owner_password
  query_params[:'newUserPassword'] = new_user_password
  query_params[:'newOwnerPassword'] = new_owner_password
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_change_password_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_check_box_field(name, field_name, field, opts = {}) ⇒ CheckBoxFieldResponse

Replace document checkbox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21538

def put_check_box_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_check_box_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_check_box_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_check_box_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(CheckBoxFieldResponse, Fixnum, Hash)>

Replace document checkbox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(CheckBoxFieldResponse, Fixnum, Hash)>) —

    CheckBoxFieldResponse data, response status code and response headers



21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21560

def put_check_box_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_check_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_check_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_check_box_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_check_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/checkbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_check_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_circle_annotation(name, annotation_id, annotation, opts = {}) ⇒ CircleAnnotationResponse

Replace document circle annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21621

def put_circle_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_circle_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_circle_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_circle_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(CircleAnnotationResponse, Fixnum, Hash)>

Replace document circle annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(CircleAnnotationResponse, Fixnum, Hash)>) —

    CircleAnnotationResponse data, response status code and response headers



21643
21644
21645
21646
21647
21648
21649
21650
21651
21652
21653
21654
21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21643

def put_circle_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_circle_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_circle_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_circle_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_circle_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/circle/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CircleAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_circle_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_combo_box_field(name, field_name, field, opts = {}) ⇒ ComboBoxFieldResponse

Replace document combobox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21704

def put_combo_box_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_combo_box_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_combo_box_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_combo_box_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(ComboBoxFieldResponse, Fixnum, Hash)>

Replace document combobox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(ComboBoxFieldResponse, Fixnum, Hash)>) —

    ComboBoxFieldResponse data, response status code and response headers



21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21726

def put_combo_box_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_combo_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_combo_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_combo_box_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_combo_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/combobox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ComboBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_combo_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_create_document(name, opts = {}) ⇒ DocumentResponse

Create empty document.

Parameters:

  • name —

    The new document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:



21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21785

def put_create_document(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_create_document_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_create_document_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#put_create_document_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Create empty document.

Parameters:

  • name —

    The new document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:

  • (Array<(DocumentResponse, Fixnum, Hash)>) —

    DocumentResponse data, response status code and response headers



21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21805

def put_create_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_create_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_create_document"
  end
  # resource path
  local_var_path = "/pdf/{name}".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_create_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_create_pdf_from_layer(name, page_number, out_path, layer_id, opts = {}) ⇒ AsposeResponse

Create a separate PDF from a PDF Layer and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • layer_id —

    Layer Id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:



21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21861

def put_create_pdf_from_layer(name, page_number, out_path, layer_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts)
    else
      raise
    end
  return data
end

#put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Create a separate PDF from a PDF Layer and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • layer_id —

    Layer Id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :pass_base64 (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21885

def put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_create_pdf_from_layer ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_create_pdf_from_layer"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_create_pdf_from_layer"
  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 PdfApi.put_create_pdf_from_layer"
  end
  # verify the required parameter 'layer_id' is set
  if @api_client.config.client_side_validation && layer_id.nil?
    fail ArgumentError, "Missing the required parameter 'layer_id' when calling PdfApi.put_create_pdf_from_layer"
  end
  # resource path
  local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = page_number
  query_params[:'outPath'] = out_path
  query_params[:'layerId'] = layer_id
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_create_pdf_from_layer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_decrypt_document(out_path, password, opts = {}) ⇒ AsposeResponse

Decrypt document from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • password —

    The password (encrypted Base64).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be decrypted.

Returns:



21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21954

def put_decrypt_document(out_path, password, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_decrypt_document_with_http_info(out_path, password, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_decrypt_document_with_http_info(out_path, password, opts)
    else
      raise
    end
  return data
end

#put_decrypt_document_with_http_info(out_path, password, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Decrypt document from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • password —

    The password (encrypted Base64).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be decrypted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 21975

def put_decrypt_document_with_http_info(out_path, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_decrypt_document ..."
  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 PdfApi.put_decrypt_document"
  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 PdfApi.put_decrypt_document"
  end
  # resource path
  local_var_path = "/pdf/decrypt"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'password'] = password
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_decrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_document_display_properties(name, display_properties, opts = {}) ⇒ DisplayPropertiesResponse

Update document display properties.

Parameters:

  • name —

    The document name.

  • display_properties —

    The display properties.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22035

def put_document_display_properties(name, display_properties, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_document_display_properties_with_http_info(name, display_properties, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_document_display_properties_with_http_info(name, display_properties, opts)
    else
      raise
    end
  return data
end

#put_document_display_properties_with_http_info(name, display_properties, opts = {}) ⇒ Array<(DisplayPropertiesResponse, Fixnum, Hash)>

Update document display properties.

Parameters:

  • name —

    The document name.

  • display_properties —

    The display properties.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(DisplayPropertiesResponse, Fixnum, Hash)>) —

    DisplayPropertiesResponse data, response status code and response headers



22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
22068
22069
22070
22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22056

def put_document_display_properties_with_http_info(name, display_properties, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_document_display_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 PdfApi.put_document_display_properties"
  end
  # verify the required parameter 'display_properties' is set
  if @api_client.config.client_side_validation && display_properties.nil?
    fail ArgumentError, "Missing the required parameter 'display_properties' when calling PdfApi.put_document_display_properties"
  end
  # resource path
  local_var_path = "/pdf/{name}/displayproperties".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(display_properties)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DisplayPropertiesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_document_display_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, opts = {}) ⇒ AsposeResponse

Encrypt document from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • user_password —

    User password (encrypted Base64).

  • owner_password —

    Owner password (encrypted Base64).

  • crypto_algorithm —

    Cryptographic algorithm, see CryptoAlgorithm for details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :permissions_flags (Array<PermissionsFlags>) —

    Array of document permissions, see PermissionsFlags for details.

  • :use_pdf20 (BOOLEAN) —

    Support for revision 6 (Extension 8).

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be encrypted.

Returns:



22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22116

def put_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts)
    else
      raise
    end
  return data
end

#put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Encrypt document from content.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • user_password —

    User password (encrypted Base64).

  • owner_password —

    Owner password (encrypted Base64).

  • crypto_algorithm —

    Cryptographic algorithm, see CryptoAlgorithm for details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :permissions_flags (Array<PermissionsFlags>) —

    Array of document permissions, see PermissionsFlags for details.

  • :use_pdf20 (BOOLEAN) —

    Support for revision 6 (Extension 8).

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be encrypted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22141

def put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_encrypt_document ..."
  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 PdfApi.put_encrypt_document"
  end
  # verify the required parameter 'user_password' is set
  if @api_client.config.client_side_validation && user_password.nil?
    fail ArgumentError, "Missing the required parameter 'user_password' when calling PdfApi.put_encrypt_document"
  end
  # verify the required parameter 'owner_password' is set
  if @api_client.config.client_side_validation && owner_password.nil?
    fail ArgumentError, "Missing the required parameter 'owner_password' when calling PdfApi.put_encrypt_document"
  end
  # verify the required parameter 'crypto_algorithm' is set
  if @api_client.config.client_side_validation && crypto_algorithm.nil?
    fail ArgumentError, "Missing the required parameter 'crypto_algorithm' when calling PdfApi.put_encrypt_document"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['RC4x40', 'RC4x128', 'AESx128', 'AESx256'].include?(crypto_algorithm)
    fail ArgumentError, "invalid value for 'crypto_algorithm', must be one of RC4x40, RC4x128, AESx128, AESx256"
  end
  # resource path
  local_var_path = "/pdf/encrypt"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'userPassword'] = user_password
  query_params[:'ownerPassword'] = owner_password
  query_params[:'cryptoAlgorithm'] = crypto_algorithm
  query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :multi) if !opts[:'permissions_flags'].nil?
  query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_encrypt_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_epub_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :dst_folder (String) —

    The destination document folder.

Returns:



22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22217

def put_epub_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :dst_folder (String) —

    The destination document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22238

def put_epub_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_epub_in_storage_to_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 PdfApi.put_epub_in_storage_to_pdf"
  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 PdfApi.put_epub_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/epub".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_epub_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_export_fields_from_pdf_to_fdf_in_storage(name, fdf_output_file_path, opts = {}) ⇒ AsposeResponse

Export fields from from PDF in storage to FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_output_file_path —

    The output Fdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22296

def put_export_fields_from_pdf_to_fdf_in_storage(name, fdf_output_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts)
    else
      raise
    end
  return data
end

#put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Export fields from from PDF in storage to FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_output_file_path —

    The output Fdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22317

def put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_fdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_fdf_in_storage"
  end
  # verify the required parameter 'fdf_output_file_path' is set
  if @api_client.config.client_side_validation && fdf_output_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'fdf_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_fdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/fdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fdfOutputFilePath'] = fdf_output_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_export_fields_from_pdf_to_xfdf_in_storage(name, xfdf_output_file_path, opts = {}) ⇒ AsposeResponse

Export fields from from PDF in storage to XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_output_file_path —

    The output xfdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22375

def put_export_fields_from_pdf_to_xfdf_in_storage(name, xfdf_output_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts)
    else
      raise
    end
  return data
end

#put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Export fields from from PDF in storage to XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_output_file_path —

    The output xfdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22396
22397
22398
22399
22400
22401
22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22396

def put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage"
  end
  # verify the required parameter 'xfdf_output_file_path' is set
  if @api_client.config.client_side_validation && xfdf_output_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xfdf_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_xfdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/xfdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xfdfOutputFilePath'] = xfdf_output_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_export_fields_from_pdf_to_xml_in_storage(name, xml_output_file_path, opts = {}) ⇒ AsposeResponse

Export fields from from PDF in storage to XML file in storage.

Parameters:

  • name —

    The document name.

  • xml_output_file_path —

    The output xml file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464
22465
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22454

def put_export_fields_from_pdf_to_xml_in_storage(name, xml_output_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts)
    else
      raise
    end
  return data
end

#put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Export fields from from PDF in storage to XML file in storage.

Parameters:

  • name —

    The document name.

  • xml_output_file_path —

    The output xml file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22475
22476
22477
22478
22479
22480
22481
22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22475

def put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_export_fields_from_pdf_to_xml_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_export_fields_from_pdf_to_xml_in_storage"
  end
  # verify the required parameter 'xml_output_file_path' is set
  if @api_client.config.client_side_validation && xml_output_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xml_output_file_path' when calling PdfApi.put_export_fields_from_pdf_to_xml_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/export/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xmlOutputFilePath'] = xml_output_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_export_fields_from_pdf_to_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_fields_flatten(name, opts = {}) ⇒ AsposeResponse

Flatten form fields in document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22532

def put_fields_flatten(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_fields_flatten_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_fields_flatten_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#put_fields_flatten_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Flatten form fields in document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22552
22553
22554
22555
22556
22557
22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
22569
22570
22571
22572
22573
22574
22575
22576
22577
22578
22579
22580
22581
22582
22583
22584
22585
22586
22587
22588
22589
22590
22591
22592
22593
22594
22595
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22552

def put_fields_flatten_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_fields_flatten ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_fields_flatten"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/flatten".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_fields_flatten\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_file_attachment_annotation(name, annotation_id, annotation, opts = {}) ⇒ FileAttachmentAnnotationResponse

Replace document FileAttachment annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22606

def put_file_attachment_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_file_attachment_annotation_data_extract(name, annotation_id, opts = {}) ⇒ AsposeResponse

Extract document FileAttachment annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :out_folder (String) —

    The output folder.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22689
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22689

def put_file_attachment_annotation_data_extract(name, annotation_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, opts)
    else
      raise
    end
  return data
end

#put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document FileAttachment annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :out_folder (String) —

    The output folder.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22711
22712
22713
22714
22715
22716
22717
22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
22742
22743
22744
22745
22746
22747
22748
22749
22750
22751
22752
22753
22754
22755
22756
22757
22758
22759
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22711

def put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_file_attachment_annotation_data_extract ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_file_attachment_annotation_data_extract"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_file_attachment_annotation_data_extract"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/fileattachment/{annotationId}/data/extract".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'outFolder'] = opts[:'out_folder'] if !opts[:'out_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_file_attachment_annotation_data_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(FileAttachmentAnnotationResponse, Fixnum, Hash)>

Replace document FileAttachment annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
22658
22659
22660
22661
22662
22663
22664
22665
22666
22667
22668
22669
22670
22671
22672
22673
22674
22675
22676
22677
22678
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22628

def put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_file_attachment_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_file_attachment_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_file_attachment_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_file_attachment_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/fileattachment/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileAttachmentAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_file_attachment_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_free_text_annotation(name, annotation_id, annotation, opts = {}) ⇒ FreeTextAnnotationResponse

Replace document free text annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22770

def put_free_text_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_free_text_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_free_text_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_free_text_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(FreeTextAnnotationResponse, Fixnum, Hash)>

Replace document free text annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(FreeTextAnnotationResponse, Fixnum, Hash)>) —

    FreeTextAnnotationResponse data, response status code and response headers



22792
22793
22794
22795
22796
22797
22798
22799
22800
22801
22802
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
22813
22814
22815
22816
22817
22818
22819
22820
22821
22822
22823
22824
22825
22826
22827
22828
22829
22830
22831
22832
22833
22834
22835
22836
22837
22838
22839
22840
22841
22842
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22792

def put_free_text_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_free_text_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_free_text_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_free_text_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_free_text_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/freetext/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FreeTextAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_free_text_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_highlight_annotation(name, annotation_id, annotation, opts = {}) ⇒ HighlightAnnotationResponse

Replace document highlight annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22853

def put_highlight_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_highlight_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_highlight_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_highlight_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(HighlightAnnotationResponse, Fixnum, Hash)>

Replace document highlight annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
22907
22908
22909
22910
22911
22912
22913
22914
22915
22916
22917
22918
22919
22920
22921
22922
22923
22924
22925
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22875

def put_highlight_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_highlight_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_highlight_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_highlight_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_highlight_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/highlight/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HighlightAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_highlight_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_html_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert HTML file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.zip)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22943

def put_html_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_html_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_html_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_html_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert HTML file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.zip)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :html_file_name (String) —

    Name of HTML file in ZIP.

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
22986
22987
22988
22989
22990
22991
22992
22993
22994
22995
22996
22997
22998
22999
23000
23001
23002
23003
23004
23005
23006
23007
23008
23009
23010
23011
23012
23013
23014
23015
23016
23017
23018
23019
23020
23021
23022
23023
23024
23025
23026
23027
23028
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 22972

def put_html_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_html_in_storage_to_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 PdfApi.put_html_in_storage_to_pdf"
  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 PdfApi.put_html_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/html".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'htmlFileName'] = opts[:'html_file_name'] if !opts[:'html_file_name'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_html_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_image_extract_as_gif(name, image_id, opts = {}) ⇒ AsposeResponse

Extract document image in GIF format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23041
23042
23043
23044
23045
23046
23047
23048
23049
23050
23051
23052
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23041

def put_image_extract_as_gif(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_image_extract_as_gif_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_image_extract_as_gif_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#put_image_extract_as_gif_with_http_info(name, image_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document image in GIF format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23065
23066
23067
23068
23069
23070
23071
23072
23073
23074
23075
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086
23087
23088
23089
23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23065

def put_image_extract_as_gif_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_image_extract_as_gif ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_image_extract_as_gif"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.put_image_extract_as_gif"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/gif".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_image_extract_as_gif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_image_extract_as_jpeg(name, image_id, opts = {}) ⇒ AsposeResponse

Extract document image in JPEG format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23128
23129
23130
23131
23132
23133
23134
23135
23136
23137
23138
23139
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23128

def put_image_extract_as_jpeg(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_image_extract_as_jpeg_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_image_extract_as_jpeg_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#put_image_extract_as_jpeg_with_http_info(name, image_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document image in JPEG format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23152
23153
23154
23155
23156
23157
23158
23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
23169
23170
23171
23172
23173
23174
23175
23176
23177
23178
23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
23196
23197
23198
23199
23200
23201
23202
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23152

def put_image_extract_as_jpeg_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_image_extract_as_jpeg ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_image_extract_as_jpeg"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.put_image_extract_as_jpeg"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/jpeg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_image_extract_as_jpeg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_image_extract_as_png(name, image_id, opts = {}) ⇒ AsposeResponse

Extract document image in PNG format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23215
23216
23217
23218
23219
23220
23221
23222
23223
23224
23225
23226
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23215

def put_image_extract_as_png(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_image_extract_as_png_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_image_extract_as_png_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#put_image_extract_as_png_with_http_info(name, image_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document image in PNG format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23239

def put_image_extract_as_png_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_image_extract_as_png ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_image_extract_as_png"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.put_image_extract_as_png"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_image_extract_as_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_image_extract_as_tiff(name, image_id, opts = {}) ⇒ AsposeResponse

Extract document image in TIFF format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23302
23303
23304
23305
23306
23307
23308
23309
23310
23311
23312
23313
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23302

def put_image_extract_as_tiff(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_image_extract_as_tiff_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_image_extract_as_tiff_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#put_image_extract_as_tiff_with_http_info(name, image_id, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document image in TIFF format to folder

Parameters:

  • name —

    The document name.

  • image_id —

    Image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
23369
23370
23371
23372
23373
23374
23375
23376
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23326

def put_image_extract_as_tiff_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_image_extract_as_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_image_extract_as_tiff"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.put_image_extract_as_tiff"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}/extract/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_image_extract_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_image_in_storage_to_pdf(name, image_templates, opts = {}) ⇒ AsposeResponse

Convert image file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • image_templates —

    ImageTemplatesRequestImage templates

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



23386
23387
23388
23389
23390
23391
23392
23393
23394
23395
23396
23397
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23386

def put_image_in_storage_to_pdf(name, image_templates, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_image_in_storage_to_pdf_with_http_info(name, image_templates, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_image_in_storage_to_pdf_with_http_info(name, image_templates, opts)
    else
      raise
    end
  return data
end

#put_image_in_storage_to_pdf_with_http_info(name, image_templates, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert image file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • image_templates —

    ImageTemplatesRequestImage templates

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23407
23408
23409
23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
23450
23451
23452
23453
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23407

def put_image_in_storage_to_pdf_with_http_info(name, image_templates, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_image_in_storage_to_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 PdfApi.put_image_in_storage_to_pdf"
  end
  # verify the required parameter 'image_templates' is set
  if @api_client.config.client_side_validation && image_templates.nil?
    fail ArgumentError, "Missing the required parameter 'image_templates' when calling PdfApi.put_image_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/images".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(image_templates)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_image_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_images_extract_as_gif(name, page_number, opts = {}) ⇒ AsposeResponse

Extract document images in GIF format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23466
23467
23468
23469
23470
23471
23472
23473
23474
23475
23476
23477
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23466

def put_images_extract_as_gif(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_images_extract_as_gif_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_images_extract_as_gif_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#put_images_extract_as_gif_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document images in GIF format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
23510
23511
23512
23513
23514
23515
23516
23517
23518
23519
23520
23521
23522
23523
23524
23525
23526
23527
23528
23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23490

def put_images_extract_as_gif_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_images_extract_as_gif ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_images_extract_as_gif"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_images_extract_as_gif"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/extract/gif".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_images_extract_as_gif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_images_extract_as_jpeg(name, page_number, opts = {}) ⇒ AsposeResponse

Extract document images in JPEG format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23553
23554
23555
23556
23557
23558
23559
23560
23561
23562
23563
23564
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23553

def put_images_extract_as_jpeg(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_images_extract_as_jpeg_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_images_extract_as_jpeg_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#put_images_extract_as_jpeg_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document images in JPEG format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23577
23578
23579
23580
23581
23582
23583
23584
23585
23586
23587
23588
23589
23590
23591
23592
23593
23594
23595
23596
23597
23598
23599
23600
23601
23602
23603
23604
23605
23606
23607
23608
23609
23610
23611
23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
23627
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23577

def put_images_extract_as_jpeg_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_images_extract_as_jpeg ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_images_extract_as_jpeg"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_images_extract_as_jpeg"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/extract/jpeg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_images_extract_as_jpeg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_images_extract_as_png(name, page_number, opts = {}) ⇒ AsposeResponse

Extract document images in PNG format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23640
23641
23642
23643
23644
23645
23646
23647
23648
23649
23650
23651
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23640

def put_images_extract_as_png(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_images_extract_as_png_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_images_extract_as_png_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#put_images_extract_as_png_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document images in PNG format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23664
23665
23666
23667
23668
23669
23670
23671
23672
23673
23674
23675
23676
23677
23678
23679
23680
23681
23682
23683
23684
23685
23686
23687
23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
23706
23707
23708
23709
23710
23711
23712
23713
23714
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23664

def put_images_extract_as_png_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_images_extract_as_png ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_images_extract_as_png"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_images_extract_as_png"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/extract/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_images_extract_as_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_images_extract_as_tiff(name, page_number, opts = {}) ⇒ AsposeResponse

Extract document images in TIFF format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:



23727
23728
23729
23730
23731
23732
23733
23734
23735
23736
23737
23738
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23727

def put_images_extract_as_tiff(name, page_number, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_images_extract_as_tiff_with_http_info(name, page_number, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_images_extract_as_tiff_with_http_info(name, page_number, opts)
    else
      raise
    end
  return data
end

#put_images_extract_as_tiff_with_http_info(name, page_number, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document images in TIFF format to folder.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :dest_folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23751
23752
23753
23754
23755
23756
23757
23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
23775
23776
23777
23778
23779
23780
23781
23782
23783
23784
23785
23786
23787
23788
23789
23790
23791
23792
23793
23794
23795
23796
23797
23798
23799
23800
23801
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23751

def put_images_extract_as_tiff_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_images_extract_as_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_images_extract_as_tiff"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_images_extract_as_tiff"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/extract/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'destFolder'] = opts[:'dest_folder'] if !opts[:'dest_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_images_extract_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {}) ⇒ AsposeResponse

Update fields from FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_file_path —

    The Fdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



23811
23812
23813
23814
23815
23816
23817
23818
23819
23820
23821
23822
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23811

def put_import_fields_from_fdf_in_storage(name, fdf_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts)
    else
      raise
    end
  return data
end

#put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from FDF file in storage.

Parameters:

  • name —

    The document name.

  • fdf_file_path —

    The Fdf file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
23851
23852
23853
23854
23855
23856
23857
23858
23859
23860
23861
23862
23863
23864
23865
23866
23867
23868
23869
23870
23871
23872
23873
23874
23875
23876
23877
23878
23879
23880
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23832

def put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_fdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_fdf_in_storage"
  end
  # verify the required parameter 'fdf_file_path' is set
  if @api_client.config.client_side_validation && fdf_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'fdf_file_path' when calling PdfApi.put_import_fields_from_fdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/fdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'fdfFilePath'] = fdf_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_fdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {}) ⇒ AsposeResponse

Update fields from XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_file_path —

    The XFDF file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



23890
23891
23892
23893
23894
23895
23896
23897
23898
23899
23900
23901
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23890

def put_import_fields_from_xfdf_in_storage(name, xfdf_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts)
    else
      raise
    end
  return data
end

#put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from XFDF file in storage.

Parameters:

  • name —

    The document name.

  • xfdf_file_path —

    The XFDF file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23911
23912
23913
23914
23915
23916
23917
23918
23919
23920
23921
23922
23923
23924
23925
23926
23927
23928
23929
23930
23931
23932
23933
23934
23935
23936
23937
23938
23939
23940
23941
23942
23943
23944
23945
23946
23947
23948
23949
23950
23951
23952
23953
23954
23955
23956
23957
23958
23959
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23911

def put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_xfdf_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_xfdf_in_storage"
  end
  # verify the required parameter 'xfdf_file_path' is set
  if @api_client.config.client_side_validation && xfdf_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xfdf_file_path' when calling PdfApi.put_import_fields_from_xfdf_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xfdf".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xfdfFilePath'] = xfdf_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_xfdf_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_import_fields_from_xml_in_storage(name, xml_file_path, opts = {}) ⇒ AsposeResponse

Update fields from XML file in storage.

Parameters:

  • name —

    The document name.

  • xml_file_path —

    Full source filename (ex. /folder1/folder2/template.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



23969
23970
23971
23972
23973
23974
23975
23976
23977
23978
23979
23980
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23969

def put_import_fields_from_xml_in_storage(name, xml_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts)
    else
      raise
    end
  return data
end

#put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update fields from XML file in storage.

Parameters:

  • name —

    The document name.

  • xml_file_path —

    Full source filename (ex. /folder1/folder2/template.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



23990
23991
23992
23993
23994
23995
23996
23997
23998
23999
24000
24001
24002
24003
24004
24005
24006
24007
24008
24009
24010
24011
24012
24013
24014
24015
24016
24017
24018
24019
24020
24021
24022
24023
24024
24025
24026
24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
24037
24038
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 23990

def put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_import_fields_from_xml_in_storage ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_import_fields_from_xml_in_storage"
  end
  # verify the required parameter 'xml_file_path' is set
  if @api_client.config.client_side_validation && xml_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'xml_file_path' when calling PdfApi.put_import_fields_from_xml_in_storage"
  end
  # resource path
  local_var_path = "/pdf/{name}/import/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'xmlFilePath'] = xml_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_import_fields_from_xml_in_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_ink_annotation(name, annotation_id, annotation, opts = {}) ⇒ InkAnnotationResponse

Replace document ink annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24049
24050
24051
24052
24053
24054
24055
24056
24057
24058
24059
24060
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24049

def put_ink_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_ink_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_ink_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_ink_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(InkAnnotationResponse, Fixnum, Hash)>

Replace document ink annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(InkAnnotationResponse, Fixnum, Hash)>) —

    InkAnnotationResponse data, response status code and response headers



24071
24072
24073
24074
24075
24076
24077
24078
24079
24080
24081
24082
24083
24084
24085
24086
24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
24107
24108
24109
24110
24111
24112
24113
24114
24115
24116
24117
24118
24119
24120
24121
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24071

def put_ink_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_ink_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_ink_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_ink_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_ink_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/ink/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InkAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_ink_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_line_annotation(name, annotation_id, annotation, opts = {}) ⇒ LineAnnotationResponse

Replace document line annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24132
24133
24134
24135
24136
24137
24138
24139
24140
24141
24142
24143
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24132

def put_line_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_line_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_line_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_line_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(LineAnnotationResponse, Fixnum, Hash)>

Replace document line annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(LineAnnotationResponse, Fixnum, Hash)>) —

    LineAnnotationResponse data, response status code and response headers



24154
24155
24156
24157
24158
24159
24160
24161
24162
24163
24164
24165
24166
24167
24168
24169
24170
24171
24172
24173
24174
24175
24176
24177
24178
24179
24180
24181
24182
24183
24184
24185
24186
24187
24188
24189
24190
24191
24192
24193
24194
24195
24196
24197
24198
24199
24200
24201
24202
24203
24204
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24154

def put_line_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_line_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_line_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_line_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_line_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/line/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_line_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_link_annotation(name, link_id, link, opts = {}) ⇒ LinkAnnotationResponse

Replace document page link annotations

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

  • link —

    Link annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24215
24216
24217
24218
24219
24220
24221
24222
24223
24224
24225
24226
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24215

def put_link_annotation(name, link_id, link, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_link_annotation_with_http_info(name, link_id, link, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_link_annotation_with_http_info(name, link_id, link, opts)
    else
      raise
    end
  return data
end

#put_link_annotation_with_http_info(name, link_id, link, opts = {}) ⇒ Array<(LinkAnnotationResponse, Fixnum, Hash)>

Replace document page link annotations

Parameters:

  • name —

    The document name.

  • link_id —

    The link ID.

  • link —

    Link annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(LinkAnnotationResponse, Fixnum, Hash)>) —

    LinkAnnotationResponse data, response status code and response headers



24237
24238
24239
24240
24241
24242
24243
24244
24245
24246
24247
24248
24249
24250
24251
24252
24253
24254
24255
24256
24257
24258
24259
24260
24261
24262
24263
24264
24265
24266
24267
24268
24269
24270
24271
24272
24273
24274
24275
24276
24277
24278
24279
24280
24281
24282
24283
24284
24285
24286
24287
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24237

def put_link_annotation_with_http_info(name, link_id, link, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_link_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_link_annotation"
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling PdfApi.put_link_annotation"
  end
  # verify the required parameter 'link' is set
  if @api_client.config.client_side_validation && link.nil?
    fail ArgumentError, "Missing the required parameter 'link' when calling PdfApi.put_link_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/links/{linkId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'linkId' + '}', link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(link)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LinkAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_link_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_list_box_field(name, field_name, field, opts = {}) ⇒ ListBoxFieldResponse

Replace document listbox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24298
24299
24300
24301
24302
24303
24304
24305
24306
24307
24308
24309
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24298

def put_list_box_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_list_box_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_list_box_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_list_box_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(ListBoxFieldResponse, Fixnum, Hash)>

Replace document listbox field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(ListBoxFieldResponse, Fixnum, Hash)>) —

    ListBoxFieldResponse data, response status code and response headers



24320
24321
24322
24323
24324
24325
24326
24327
24328
24329
24330
24331
24332
24333
24334
24335
24336
24337
24338
24339
24340
24341
24342
24343
24344
24345
24346
24347
24348
24349
24350
24351
24352
24353
24354
24355
24356
24357
24358
24359
24360
24361
24362
24363
24364
24365
24366
24367
24368
24369
24370
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24320

def put_list_box_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_list_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_list_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_list_box_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_list_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/listbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_list_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_markdown_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert MD file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.md)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :dst_folder (String) —

    The destination document folder.

Returns:



24380
24381
24382
24383
24384
24385
24386
24387
24388
24389
24390
24391
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24380

def put_markdown_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert MD file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.md)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :dst_folder (String) —

    The destination document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



24401
24402
24403
24404
24405
24406
24407
24408
24409
24410
24411
24412
24413
24414
24415
24416
24417
24418
24419
24420
24421
24422
24423
24424
24425
24426
24427
24428
24429
24430
24431
24432
24433
24434
24435
24436
24437
24438
24439
24440
24441
24442
24443
24444
24445
24446
24447
24448
24449
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24401

def put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_markdown_in_storage_to_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 PdfApi.put_markdown_in_storage_to_pdf"
  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 PdfApi.put_markdown_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/markdown".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_markdown_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_merge_documents(name, merge_documents, opts = {}) ⇒ DocumentResponse

Merge a list of documents.

Parameters:

  • name —

    Resulting document name.

  • merge_documents —

    MergeDocuments with a list of documents.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    Resulting document storage.

  • :folder (String) —

    Resulting document folder.

Returns:



24459
24460
24461
24462
24463
24464
24465
24466
24467
24468
24469
24470
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24459

def put_merge_documents(name, merge_documents, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_merge_documents_with_http_info(name, merge_documents, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_merge_documents_with_http_info(name, merge_documents, opts)
    else
      raise
    end
  return data
end

#put_merge_documents_with_http_info(name, merge_documents, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Merge a list of documents.

Parameters:

  • name —

    Resulting document name.

  • merge_documents —

    MergeDocuments with a list of documents.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    Resulting document storage.

  • :folder (String) —

    Resulting document folder.

Returns:

  • (Array<(DocumentResponse, Fixnum, Hash)>) —

    DocumentResponse data, response status code and response headers



24480
24481
24482
24483
24484
24485
24486
24487
24488
24489
24490
24491
24492
24493
24494
24495
24496
24497
24498
24499
24500
24501
24502
24503
24504
24505
24506
24507
24508
24509
24510
24511
24512
24513
24514
24515
24516
24517
24518
24519
24520
24521
24522
24523
24524
24525
24526
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24480

def put_merge_documents_with_http_info(name, merge_documents, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_merge_documents ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_merge_documents"
  end
  # verify the required parameter 'merge_documents' is set
  if @api_client.config.client_side_validation && merge_documents.nil?
    fail ArgumentError, "Missing the required parameter 'merge_documents' when calling PdfApi.put_merge_documents"
  end
  # resource path
  local_var_path = "/pdf/{name}/merge".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(merge_documents)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_merge_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_mht_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert MHT file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.mht)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



24542
24543
24544
24545
24546
24547
24548
24549
24550
24551
24552
24553
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24542

def put_mht_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_mht_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_mht_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_mht_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert MHT file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.mht)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



24569
24570
24571
24572
24573
24574
24575
24576
24577
24578
24579
24580
24581
24582
24583
24584
24585
24586
24587
24588
24589
24590
24591
24592
24593
24594
24595
24596
24597
24598
24599
24600
24601
24602
24603
24604
24605
24606
24607
24608
24609
24610
24611
24612
24613
24614
24615
24616
24617
24618
24619
24620
24621
24622
24623
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24569

def put_mht_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_mht_in_storage_to_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 PdfApi.put_mht_in_storage_to_pdf"
  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 PdfApi.put_mht_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/mht".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_mht_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_movie_annotation(name, annotation_id, annotation, opts = {}) ⇒ MovieAnnotationResponse

Replace document movie annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24634
24635
24636
24637
24638
24639
24640
24641
24642
24643
24644
24645
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24634

def put_movie_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_movie_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_movie_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_movie_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(MovieAnnotationResponse, Fixnum, Hash)>

Replace document movie annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(MovieAnnotationResponse, Fixnum, Hash)>) —

    MovieAnnotationResponse data, response status code and response headers



24656
24657
24658
24659
24660
24661
24662
24663
24664
24665
24666
24667
24668
24669
24670
24671
24672
24673
24674
24675
24676
24677
24678
24679
24680
24681
24682
24683
24684
24685
24686
24687
24688
24689
24690
24691
24692
24693
24694
24695
24696
24697
24698
24699
24700
24701
24702
24703
24704
24705
24706
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24656

def put_movie_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_movie_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_movie_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_movie_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_movie_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/movie/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MovieAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_movie_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_add_stamp(name, page_number, stamp, opts = {}) ⇒ AsposeResponse

Add page stamp.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamp —

    Stamp with data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



24717
24718
24719
24720
24721
24722
24723
24724
24725
24726
24727
24728
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24717

def put_page_add_stamp(name, page_number, stamp, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_add_stamp_with_http_info(name, page_number, stamp, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_add_stamp_with_http_info(name, page_number, stamp, opts)
    else
      raise
    end
  return data
end

#put_page_add_stamp_with_http_info(name, page_number, stamp, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Add page stamp.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamp —

    Stamp with data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



24739
24740
24741
24742
24743
24744
24745
24746
24747
24748
24749
24750
24751
24752
24753
24754
24755
24756
24757
24758
24759
24760
24761
24762
24763
24764
24765
24766
24767
24768
24769
24770
24771
24772
24773
24774
24775
24776
24777
24778
24779
24780
24781
24782
24783
24784
24785
24786
24787
24788
24789
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24739

def put_page_add_stamp_with_http_info(name, page_number, stamp, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_add_stamp ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_add_stamp"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_add_stamp"
  end
  # verify the required parameter 'stamp' is set
  if @api_client.config.client_side_validation && stamp.nil?
    fail ArgumentError, "Missing the required parameter 'stamp' when calling PdfApi.put_page_add_stamp"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/stamp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(stamp)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_add_stamp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_bmp(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to bmp image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



24803
24804
24805
24806
24807
24808
24809
24810
24811
24812
24813
24814
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24803

def put_page_convert_to_bmp(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_bmp_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_bmp_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_bmp_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to bmp image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



24828
24829
24830
24831
24832
24833
24834
24835
24836
24837
24838
24839
24840
24841
24842
24843
24844
24845
24846
24847
24848
24849
24850
24851
24852
24853
24854
24855
24856
24857
24858
24859
24860
24861
24862
24863
24864
24865
24866
24867
24868
24869
24870
24871
24872
24873
24874
24875
24876
24877
24878
24879
24880
24881
24882
24883
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24828

def put_page_convert_to_bmp_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_bmp ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_bmp"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_bmp"
  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 PdfApi.put_page_convert_to_bmp"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/bmp".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_bmp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_emf(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to emf image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



24897
24898
24899
24900
24901
24902
24903
24904
24905
24906
24907
24908
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24897

def put_page_convert_to_emf(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_emf_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_emf_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_emf_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to emf image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



24922
24923
24924
24925
24926
24927
24928
24929
24930
24931
24932
24933
24934
24935
24936
24937
24938
24939
24940
24941
24942
24943
24944
24945
24946
24947
24948
24949
24950
24951
24952
24953
24954
24955
24956
24957
24958
24959
24960
24961
24962
24963
24964
24965
24966
24967
24968
24969
24970
24971
24972
24973
24974
24975
24976
24977
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24922

def put_page_convert_to_emf_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_emf ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_emf"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_emf"
  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 PdfApi.put_page_convert_to_emf"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/emf".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_emf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_gif(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to gif image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



24991
24992
24993
24994
24995
24996
24997
24998
24999
25000
25001
25002
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 24991

def put_page_convert_to_gif(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_gif_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_gif_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_gif_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to gif image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25016
25017
25018
25019
25020
25021
25022
25023
25024
25025
25026
25027
25028
25029
25030
25031
25032
25033
25034
25035
25036
25037
25038
25039
25040
25041
25042
25043
25044
25045
25046
25047
25048
25049
25050
25051
25052
25053
25054
25055
25056
25057
25058
25059
25060
25061
25062
25063
25064
25065
25066
25067
25068
25069
25070
25071
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25016

def put_page_convert_to_gif_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_gif ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_gif"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_gif"
  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 PdfApi.put_page_convert_to_gif"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/gif".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_gif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_jpeg(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to Jpeg image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



25085
25086
25087
25088
25089
25090
25091
25092
25093
25094
25095
25096
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25085

def put_page_convert_to_jpeg(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to Jpeg image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25110
25111
25112
25113
25114
25115
25116
25117
25118
25119
25120
25121
25122
25123
25124
25125
25126
25127
25128
25129
25130
25131
25132
25133
25134
25135
25136
25137
25138
25139
25140
25141
25142
25143
25144
25145
25146
25147
25148
25149
25150
25151
25152
25153
25154
25155
25156
25157
25158
25159
25160
25161
25162
25163
25164
25165
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25110

def put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_jpeg ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_jpeg"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_jpeg"
  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 PdfApi.put_page_convert_to_jpeg"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/jpeg".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_jpeg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_png(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to png image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



25179
25180
25181
25182
25183
25184
25185
25186
25187
25188
25189
25190
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25179

def put_page_convert_to_png(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_png_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_png_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_png_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to png image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25204
25205
25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
25254
25255
25256
25257
25258
25259
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25204

def put_page_convert_to_png_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_png ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_png"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_png"
  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 PdfApi.put_page_convert_to_png"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/png".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_page_convert_to_tiff(name, page_number, out_path, opts = {}) ⇒ AsposeResponse

Convert document page to Tiff image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width. (default to 0)

  • :height (Integer) —

    The converted image height. (default to 0)

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



25273
25274
25275
25276
25277
25278
25279
25280
25281
25282
25283
25284
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25273

def put_page_convert_to_tiff(name, page_number, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_page_convert_to_tiff_with_http_info(name, page_number, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_page_convert_to_tiff_with_http_info(name, page_number, out_path, opts)
    else
      raise
    end
  return data
end

#put_page_convert_to_tiff_with_http_info(name, page_number, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert document page to Tiff image and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • out_path —

    The out path of result image.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The converted image width.

  • :height (Integer) —

    The converted image height.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25298
25299
25300
25301
25302
25303
25304
25305
25306
25307
25308
25309
25310
25311
25312
25313
25314
25315
25316
25317
25318
25319
25320
25321
25322
25323
25324
25325
25326
25327
25328
25329
25330
25331
25332
25333
25334
25335
25336
25337
25338
25339
25340
25341
25342
25343
25344
25345
25346
25347
25348
25349
25350
25351
25352
25353
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25298

def put_page_convert_to_tiff_with_http_info(name, page_number, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_page_convert_to_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_page_convert_to_tiff"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_page_convert_to_tiff"
  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 PdfApi.put_page_convert_to_tiff"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/convert/tiff".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_page_convert_to_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pcl_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert PCL file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pcl)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



25363
25364
25365
25366
25367
25368
25369
25370
25371
25372
25373
25374
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25363

def put_pcl_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pcl_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pcl_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_pcl_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert PCL file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pcl)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25384
25385
25386
25387
25388
25389
25390
25391
25392
25393
25394
25395
25396
25397
25398
25399
25400
25401
25402
25403
25404
25405
25406
25407
25408
25409
25410
25411
25412
25413
25414
25415
25416
25417
25418
25419
25420
25421
25422
25423
25424
25425
25426
25427
25428
25429
25430
25431
25432
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25384

def put_pcl_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pcl_in_storage_to_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 PdfApi.put_pcl_in_storage_to_pdf"
  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 PdfApi.put_pcl_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/pcl".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pcl_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_a_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert PDFA file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :dont_optimize (BOOLEAN) —

    If set, document resources will not be optimized.

  • :storage (String) —

    The document storage.

Returns:



25443
25444
25445
25446
25447
25448
25449
25450
25451
25452
25453
25454
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25443

def put_pdf_a_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_a_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_a_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_a_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert PDFA file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :dont_optimize (BOOLEAN) —

    If set, document resources will not be optimized.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25465
25466
25467
25468
25469
25470
25471
25472
25473
25474
25475
25476
25477
25478
25479
25480
25481
25482
25483
25484
25485
25486
25487
25488
25489
25490
25491
25492
25493
25494
25495
25496
25497
25498
25499
25500
25501
25502
25503
25504
25505
25506
25507
25508
25509
25510
25511
25512
25513
25514
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25465

def put_pdf_a_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_a_in_storage_to_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 PdfApi.put_pdf_a_in_storage_to_pdf"
  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 PdfApi.put_pdf_a_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/pdfa".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'dontOptimize'] = opts[:'dont_optimize'] if !opts[:'dont_optimize'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_a_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_doc(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to DOC format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:



25532
25533
25534
25535
25536
25537
25538
25539
25540
25541
25542
25543
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25532

def put_pdf_in_request_to_doc(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_doc_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_doc_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_doc_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to DOC format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25561
25562
25563
25564
25565
25566
25567
25568
25569
25570
25571
25572
25573
25574
25575
25576
25577
25578
25579
25580
25581
25582
25583
25584
25585
25586
25587
25588
25589
25590
25591
25592
25593
25594
25595
25596
25597
25598
25599
25600
25601
25602
25603
25604
25605
25606
25607
25608
25609
25610
25611
25612
25613
25614
25615
25616
25617
25618
25619
25620
25621
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25561

def put_pdf_in_request_to_doc_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_doc ..."
  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 PdfApi.put_pdf_in_request_to_doc"
  end
  if @api_client.config.client_side_validation && opts[:'format'] && !['Doc', 'DocX'].include?(opts[:'format'])
    fail ArgumentError, 'invalid value for "format", must be one of Doc, DocX'
  end
  if @api_client.config.client_side_validation && opts[:'mode'] && !['Textbox', 'Flow', 'EnhancedFlow'].include?(opts[:'mode'])
    fail ArgumentError, 'invalid value for "mode", must be one of Textbox, Flow, EnhancedFlow'
  end
  # resource path
  local_var_path = "/pdf/convert/doc"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'addReturnToLineEnd'] = opts[:'add_return_to_line_end'] if !opts[:'add_return_to_line_end'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'imageResolutionX'] = opts[:'image_resolution_x'] if !opts[:'image_resolution_x'].nil?
  query_params[:'imageResolutionY'] = opts[:'image_resolution_y'] if !opts[:'image_resolution_y'].nil?
  query_params[:'maxDistanceBetweenTextLines'] = opts[:'max_distance_between_text_lines'] if !opts[:'max_distance_between_text_lines'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?
  query_params[:'recognizeBullets'] = opts[:'recognize_bullets'] if !opts[:'recognize_bullets'].nil?
  query_params[:'relativeHorizontalProximity'] = opts[:'relative_horizontal_proximity'] if !opts[:'relative_horizontal_proximity'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_epub(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to EPUB format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



25631
25632
25633
25634
25635
25636
25637
25638
25639
25640
25641
25642
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25631

def put_pdf_in_request_to_epub(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_epub_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_epub_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_epub_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to EPUB format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25652
25653
25654
25655
25656
25657
25658
25659
25660
25661
25662
25663
25664
25665
25666
25667
25668
25669
25670
25671
25672
25673
25674
25675
25676
25677
25678
25679
25680
25681
25682
25683
25684
25685
25686
25687
25688
25689
25690
25691
25692
25693
25694
25695
25696
25697
25698
25699
25700
25701
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25652

def put_pdf_in_request_to_epub_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_epub ..."
  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 PdfApi.put_pdf_in_request_to_epub"
  end
  if @api_client.config.client_side_validation && opts[:'content_recognition_mode'] && !['Flow', 'PdfFlow', 'Fixed'].include?(opts[:'content_recognition_mode'])
    fail ArgumentError, 'invalid value for "content_recognition_mode", must be one of Flow, PdfFlow, Fixed'
  end
  # resource path
  local_var_path = "/pdf/convert/epub"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'contentRecognitionMode'] = opts[:'content_recognition_mode'] if !opts[:'content_recognition_mode'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_epub\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_html(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to Html format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.html)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

  • :output_format (String) —

    This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is &quot;Zip&quot; or missed (default). In case of the &quot;Folder&quot;, all resulting files and directories will be uploaded to the folder of the resulting HTML file. (default to Zip)

  • :file (File) —

    A file to be converted.

Returns:



25740
25741
25742
25743
25744
25745
25746
25747
25748
25749
25750
25751
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25740

def put_pdf_in_request_to_html(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_html_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_html_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_html_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to Html format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.html)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

  • :output_format (String) —

    This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is &quot;Zip&quot; or missed (default). In case of the &quot;Folder&quot;, all resulting files and directories will be uploaded to the folder of the resulting HTML file.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25790
25791
25792
25793
25794
25795
25796
25797
25798
25799
25800
25801
25802
25803
25804
25805
25806
25807
25808
25809
25810
25811
25812
25813
25814
25815
25816
25817
25818
25819
25820
25821
25822
25823
25824
25825
25826
25827
25828
25829
25830
25831
25832
25833
25834
25835
25836
25837
25838
25839
25840
25841
25842
25843
25844
25845
25846
25847
25848
25849
25850
25851
25852
25853
25854
25855
25856
25857
25858
25859
25860
25861
25862
25863
25864
25865
25866
25867
25868
25869
25870
25871
25872
25873
25874
25875
25876
25877
25878
25879
25880
25881
25882
25883
25884
25885
25886
25887
25888
25889
25890
25891
25892
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25790

def put_pdf_in_request_to_html_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_html ..."
  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 PdfApi.put_pdf_in_request_to_html"
  end
  if @api_client.config.client_side_validation && opts[:'document_type'] && !['Xhtml', 'Html5'].include?(opts[:'document_type'])
    fail ArgumentError, 'invalid value for "document_type", must be one of Xhtml, Html5'
  end
  if @api_client.config.client_side_validation && opts[:'antialiasing_processing'] && !['NoAdditionalProcessing', 'TryCorrectResultHtml'].include?(opts[:'antialiasing_processing'])
    fail ArgumentError, 'invalid value for "antialiasing_processing", must be one of NoAdditionalProcessing, TryCorrectResultHtml'
  end
  if @api_client.config.client_side_validation && opts[:'font_encoding_strategy'] && !['Default', 'DecreaseToUnicodePriorityLevel'].include?(opts[:'font_encoding_strategy'])
    fail ArgumentError, 'invalid value for "font_encoding_strategy", must be one of Default, DecreaseToUnicodePriorityLevel'
  end
  if @api_client.config.client_side_validation && opts[:'font_saving_mode'] && !['AlwaysSaveAsWOFF', 'AlwaysSaveAsTTF', 'AlwaysSaveAsEOT', 'SaveInAllFormats'].include?(opts[:'font_saving_mode'])
    fail ArgumentError, 'invalid value for "font_saving_mode", must be one of AlwaysSaveAsWOFF, AlwaysSaveAsTTF, AlwaysSaveAsEOT, SaveInAllFormats'
  end
  if @api_client.config.client_side_validation && opts[:'html_markup_generation_mode'] && !['WriteAllHtml', 'WriteOnlyBodyContent'].include?(opts[:'html_markup_generation_mode'])
    fail ArgumentError, 'invalid value for "html_markup_generation_mode", must be one of WriteAllHtml, WriteOnlyBodyContent'
  end
  if @api_client.config.client_side_validation && opts[:'letters_positioning_method'] && !['UseEmUnitsAndCompensationOfRoundingErrorsInCss', 'UsePixelUnitsInCssLetterSpacingForIE'].include?(opts[:'letters_positioning_method'])
    fail ArgumentError, 'invalid value for "letters_positioning_method", must be one of UseEmUnitsAndCompensationOfRoundingErrorsInCss, UsePixelUnitsInCssLetterSpacingForIE'
  end
  if @api_client.config.client_side_validation && opts[:'parts_embedding_mode'] && !['EmbedAllIntoHtml', 'EmbedCssOnly', 'NoEmbedding'].include?(opts[:'parts_embedding_mode'])
    fail ArgumentError, 'invalid value for "parts_embedding_mode", must be one of EmbedAllIntoHtml, EmbedCssOnly, NoEmbedding'
  end
  if @api_client.config.client_side_validation && opts[:'raster_images_saving_mode'] && !['AsPngImagesEmbeddedIntoSvg', 'AsExternalPngFilesReferencedViaSvg', 'AsEmbeddedPartsOfPngPageBackground'].include?(opts[:'raster_images_saving_mode'])
    fail ArgumentError, 'invalid value for "raster_images_saving_mode", must be one of AsPngImagesEmbeddedIntoSvg, AsExternalPngFilesReferencedViaSvg, AsEmbeddedPartsOfPngPageBackground'
  end
  if @api_client.config.client_side_validation && opts[:'output_format'] && !['Zip', 'Folder'].include?(opts[:'output_format'])
    fail ArgumentError, 'invalid value for "output_format", must be one of Zip, Folder'
  end
  # resource path
  local_var_path = "/pdf/convert/html"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'additionalMarginWidthInPoints'] = opts[:'additional_margin_width_in_points'] if !opts[:'additional_margin_width_in_points'].nil?
  query_params[:'compressSvgGraphicsIfAny'] = opts[:'compress_svg_graphics_if_any'] if !opts[:'compress_svg_graphics_if_any'].nil?
  query_params[:'convertMarkedContentToLayers'] = opts[:'convert_marked_content_to_layers'] if !opts[:'convert_marked_content_to_layers'].nil?
  query_params[:'defaultFontName'] = opts[:'default_font_name'] if !opts[:'default_font_name'].nil?
  query_params[:'documentType'] = opts[:'document_type'] if !opts[:'document_type'].nil?
  query_params[:'fixedLayout'] = opts[:'fixed_layout'] if !opts[:'fixed_layout'].nil?
  query_params[:'imageResolution'] = opts[:'image_resolution'] if !opts[:'image_resolution'].nil?
  query_params[:'minimalLineWidth'] = opts[:'minimal_line_width'] if !opts[:'minimal_line_width'].nil?
  query_params[:'preventGlyphsGrouping'] = opts[:'prevent_glyphs_grouping'] if !opts[:'prevent_glyphs_grouping'].nil?
  query_params[:'splitCssIntoPages'] = opts[:'split_css_into_pages'] if !opts[:'split_css_into_pages'].nil?
  query_params[:'splitIntoPages'] = opts[:'split_into_pages'] if !opts[:'split_into_pages'].nil?
  query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
  query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
  query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
  query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :multi) if !opts[:'explicit_list_of_saved_pages'].nil?
  query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
  query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
  query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
  query_params[:'lettersPositioningMethod'] = opts[:'letters_positioning_method'] if !opts[:'letters_positioning_method'].nil?
  query_params[:'pagesFlowTypeDependsOnViewersScreenSize'] = opts[:'pages_flow_type_depends_on_viewers_screen_size'] if !opts[:'pages_flow_type_depends_on_viewers_screen_size'].nil?
  query_params[:'partsEmbeddingMode'] = opts[:'parts_embedding_mode'] if !opts[:'parts_embedding_mode'].nil?
  query_params[:'rasterImagesSavingMode'] = opts[:'raster_images_saving_mode'] if !opts[:'raster_images_saving_mode'].nil?
  query_params[:'removeEmptyAreasOnTopAndBottom'] = opts[:'remove_empty_areas_on_top_and_bottom'] if !opts[:'remove_empty_areas_on_top_and_bottom'].nil?
  query_params[:'saveShadowedTextsAsTransparentTexts'] = opts[:'save_shadowed_texts_as_transparent_texts'] if !opts[:'save_shadowed_texts_as_transparent_texts'].nil?
  query_params[:'saveTransparentTexts'] = opts[:'save_transparent_texts'] if !opts[:'save_transparent_texts'].nil?
  query_params[:'specialFolderForAllImages'] = opts[:'special_folder_for_all_images'] if !opts[:'special_folder_for_all_images'].nil?
  query_params[:'specialFolderForSvgImages'] = opts[:'special_folder_for_svg_images'] if !opts[:'special_folder_for_svg_images'].nil?
  query_params[:'trySaveTextUnderliningAndStrikeoutingInCss'] = opts[:'try_save_text_underlining_and_strikeouting_in_css'] if !opts[:'try_save_text_underlining_and_strikeouting_in_css'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'flowLayoutParagraphFullWidth'] = opts[:'flow_layout_paragraph_full_width'] if !opts[:'flow_layout_paragraph_full_width'].nil?
  query_params[:'outputFormat'] = opts[:'output_format'] if !opts[:'output_format'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_mobi_xml(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to MOBIXML format and uploads resulting ZIP archive file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.mobixml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



25901
25902
25903
25904
25905
25906
25907
25908
25909
25910
25911
25912
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25901

def put_pdf_in_request_to_mobi_xml(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_mobi_xml_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_mobi_xml_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_mobi_xml_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to MOBIXML format and uploads resulting ZIP archive file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.mobixml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25921
25922
25923
25924
25925
25926
25927
25928
25929
25930
25931
25932
25933
25934
25935
25936
25937
25938
25939
25940
25941
25942
25943
25944
25945
25946
25947
25948
25949
25950
25951
25952
25953
25954
25955
25956
25957
25958
25959
25960
25961
25962
25963
25964
25965
25966
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25921

def put_pdf_in_request_to_mobi_xml_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_mobi_xml ..."
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_pdf_in_request_to_mobi_xml"
  end
  # resource path
  local_var_path = "/pdf/convert/mobixml"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_mobi_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_pdf_a(out_path, type, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to PdfA format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • type —

    Type of PdfA format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:



25977
25978
25979
25980
25981
25982
25983
25984
25985
25986
25987
25988
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25977

def put_pdf_in_request_to_pdf_a(out_path, type, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to PdfA format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • type —

    Type of PdfA format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



25999
26000
26001
26002
26003
26004
26005
26006
26007
26008
26009
26010
26011
26012
26013
26014
26015
26016
26017
26018
26019
26020
26021
26022
26023
26024
26025
26026
26027
26028
26029
26030
26031
26032
26033
26034
26035
26036
26037
26038
26039
26040
26041
26042
26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
26054
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 25999

def put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_pdf_a ..."
  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 PdfApi.put_pdf_in_request_to_pdf_a"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling PdfApi.put_pdf_in_request_to_pdf_a"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['PDFA1A', 'PDFA1B', 'PDFA3A', 'PDFA3B'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of PDFA1A, PDFA1B, PDFA3A, PDFA3B"
  end
  # resource path
  local_var_path = "/pdf/convert/pdfa"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'type'] = type
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_pdf_a\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_pptx(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to PPTX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pptx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

  • :file (File) —

    A file to be converted.

Returns:



26066
26067
26068
26069
26070
26071
26072
26073
26074
26075
26076
26077
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26066

def put_pdf_in_request_to_pptx(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_pptx_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_pptx_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_pptx_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to PPTX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pptx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26089
26090
26091
26092
26093
26094
26095
26096
26097
26098
26099
26100
26101
26102
26103
26104
26105
26106
26107
26108
26109
26110
26111
26112
26113
26114
26115
26116
26117
26118
26119
26120
26121
26122
26123
26124
26125
26126
26127
26128
26129
26130
26131
26132
26133
26134
26135
26136
26137
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26089

def put_pdf_in_request_to_pptx_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_pptx ..."
  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 PdfApi.put_pdf_in_request_to_pptx"
  end
  # resource path
  local_var_path = "/pdf/convert/pptx"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'separateImages'] = opts[:'separate_images'] if !opts[:'separate_images'].nil?
  query_params[:'slidesAsImages'] = opts[:'slides_as_images'] if !opts[:'slides_as_images'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_pptx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_svg(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to SVG format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:



26147
26148
26149
26150
26151
26152
26153
26154
26155
26156
26157
26158
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26147

def put_pdf_in_request_to_svg(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_svg_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_svg_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_svg_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to SVG format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26168
26169
26170
26171
26172
26173
26174
26175
26176
26177
26178
26179
26180
26181
26182
26183
26184
26185
26186
26187
26188
26189
26190
26191
26192
26193
26194
26195
26196
26197
26198
26199
26200
26201
26202
26203
26204
26205
26206
26207
26208
26209
26210
26211
26212
26213
26214
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26168

def put_pdf_in_request_to_svg_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_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 PdfApi.put_pdf_in_request_to_svg"
  end
  # resource path
  local_var_path = "/pdf/convert/svg"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_svg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_te_x(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to TeX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



26223
26224
26225
26226
26227
26228
26229
26230
26231
26232
26233
26234
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26223

def put_pdf_in_request_to_te_x(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_te_x_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_te_x_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_te_x_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to TeX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26243
26244
26245
26246
26247
26248
26249
26250
26251
26252
26253
26254
26255
26256
26257
26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
26268
26269
26270
26271
26272
26273
26274
26275
26276
26277
26278
26279
26280
26281
26282
26283
26284
26285
26286
26287
26288
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26243

def put_pdf_in_request_to_te_x_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_te_x ..."
  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 PdfApi.put_pdf_in_request_to_te_x"
  end
  # resource path
  local_var_path = "/pdf/convert/tex"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_te_x\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_tiff(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to TIFF format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tiff)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



26312
26313
26314
26315
26316
26317
26318
26319
26320
26321
26322
26323
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26312

def put_pdf_in_request_to_tiff(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_tiff_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_tiff_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_tiff_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to TIFF format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tiff)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26347
26348
26349
26350
26351
26352
26353
26354
26355
26356
26357
26358
26359
26360
26361
26362
26363
26364
26365
26366
26367
26368
26369
26370
26371
26372
26373
26374
26375
26376
26377
26378
26379
26380
26381
26382
26383
26384
26385
26386
26387
26388
26389
26390
26391
26392
26393
26394
26395
26396
26397
26398
26399
26400
26401
26402
26403
26404
26405
26406
26407
26408
26409
26410
26411
26412
26413
26414
26415
26416
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26347

def put_pdf_in_request_to_tiff_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_tiff ..."
  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 PdfApi.put_pdf_in_request_to_tiff"
  end
  if @api_client.config.client_side_validation && opts[:'compression'] && !['LZW', 'CCITT4', 'CCITT3', 'RLE', 'None'].include?(opts[:'compression'])
    fail ArgumentError, 'invalid value for "compression", must be one of LZW, CCITT4, CCITT3, RLE, None'
  end
  if @api_client.config.client_side_validation && opts[:'color_depth'] && !['Default', 'Format8bpp', 'Format4bpp', 'Format1bpp'].include?(opts[:'color_depth'])
    fail ArgumentError, 'invalid value for "color_depth", must be one of Default, Format8bpp, Format4bpp, Format1bpp'
  end
  if @api_client.config.client_side_validation && opts[:'orientation'] && !['None', 'Landscape', 'Portrait'].include?(opts[:'orientation'])
    fail ArgumentError, 'invalid value for "orientation", must be one of None, Landscape, Portrait'
  end
  # resource path
  local_var_path = "/pdf/convert/tiff"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'brightness'] = opts[:'brightness'] if !opts[:'brightness'].nil?
  query_params[:'compression'] = opts[:'compression'] if !opts[:'compression'].nil?
  query_params[:'colorDepth'] = opts[:'color_depth'] if !opts[:'color_depth'].nil?
  query_params[:'leftMargin'] = opts[:'left_margin'] if !opts[:'left_margin'].nil?
  query_params[:'rightMargin'] = opts[:'right_margin'] if !opts[:'right_margin'].nil?
  query_params[:'topMargin'] = opts[:'top_margin'] if !opts[:'top_margin'].nil?
  query_params[:'bottomMargin'] = opts[:'bottom_margin'] if !opts[:'bottom_margin'].nil?
  query_params[:'orientation'] = opts[:'orientation'] if !opts[:'orientation'].nil?
  query_params[:'skipBlankPages'] = opts[:'skip_blank_pages'] if !opts[:'skip_blank_pages'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'xResolution'] = opts[:'x_resolution'] if !opts[:'x_resolution'].nil?
  query_params[:'yResolution'] = opts[:'y_resolution'] if !opts[:'y_resolution'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'pageCount'] = opts[:'page_count'] if !opts[:'page_count'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_xls(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to XLS format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xls)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:



26430
26431
26432
26433
26434
26435
26436
26437
26438
26439
26440
26441
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26430

def put_pdf_in_request_to_xls(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_xls_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_xls_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_xls_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to XLS format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xls)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26455
26456
26457
26458
26459
26460
26461
26462
26463
26464
26465
26466
26467
26468
26469
26470
26471
26472
26473
26474
26475
26476
26477
26478
26479
26480
26481
26482
26483
26484
26485
26486
26487
26488
26489
26490
26491
26492
26493
26494
26495
26496
26497
26498
26499
26500
26501
26502
26503
26504
26505
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26455

def put_pdf_in_request_to_xls_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_xls ..."
  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 PdfApi.put_pdf_in_request_to_xls"
  end
  # resource path
  local_var_path = "/pdf/convert/xls"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_xls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_xlsx(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to XLSX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xlsx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:



26519
26520
26521
26522
26523
26524
26525
26526
26527
26528
26529
26530
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26519

def put_pdf_in_request_to_xlsx(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_xlsx_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_xlsx_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_xlsx_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to XLSX format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xlsx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26544
26545
26546
26547
26548
26549
26550
26551
26552
26553
26554
26555
26556
26557
26558
26559
26560
26561
26562
26563
26564
26565
26566
26567
26568
26569
26570
26571
26572
26573
26574
26575
26576
26577
26578
26579
26580
26581
26582
26583
26584
26585
26586
26587
26588
26589
26590
26591
26592
26593
26594
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26544

def put_pdf_in_request_to_xlsx_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_xlsx ..."
  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 PdfApi.put_pdf_in_request_to_xlsx"
  end
  # resource path
  local_var_path = "/pdf/convert/xlsx"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_xml(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to XML format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



26603
26604
26605
26606
26607
26608
26609
26610
26611
26612
26613
26614
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26603

def put_pdf_in_request_to_xml(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_xml_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_xml_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_xml_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to XML format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26623
26624
26625
26626
26627
26628
26629
26630
26631
26632
26633
26634
26635
26636
26637
26638
26639
26640
26641
26642
26643
26644
26645
26646
26647
26648
26649
26650
26651
26652
26653
26654
26655
26656
26657
26658
26659
26660
26661
26662
26663
26664
26665
26666
26667
26668
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26623

def put_pdf_in_request_to_xml_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_xml ..."
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_pdf_in_request_to_xml"
  end
  # resource path
  local_var_path = "/pdf/convert/xml"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_request_to_xps(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (in request content) to XPS format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



26677
26678
26679
26680
26681
26682
26683
26684
26685
26686
26687
26688
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26677

def put_pdf_in_request_to_xps(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_request_to_xps_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_request_to_xps_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_request_to_xps_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (in request content) to XPS format and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26697
26698
26699
26700
26701
26702
26703
26704
26705
26706
26707
26708
26709
26710
26711
26712
26713
26714
26715
26716
26717
26718
26719
26720
26721
26722
26723
26724
26725
26726
26727
26728
26729
26730
26731
26732
26733
26734
26735
26736
26737
26738
26739
26740
26741
26742
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26697

def put_pdf_in_request_to_xps_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_request_to_xps ..."
  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 PdfApi.put_pdf_in_request_to_xps"
  end
  # resource path
  local_var_path = "/pdf/convert/xps"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_request_to_xps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_doc(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to DOC format and uploads resulting file to storage.

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



26761
26762
26763
26764
26765
26766
26767
26768
26769
26770
26771
26772
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26761

def put_pdf_in_storage_to_doc(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_doc_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_doc_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_doc_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to DOC format and uploads resulting file to storage.

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.doc)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :add_return_to_line_end (BOOLEAN) —

    Add return to line end.

  • :format (String) —

    Allows to specify .doc or .docx file format.

  • :image_resolution_x (Integer) —

    Image resolution X.

  • :image_resolution_y (Integer) —

    Image resolution Y.

  • :max_distance_between_text_lines (Float) —

    Max distance between text lines.

  • :mode (String) —

    Allows to control how a PDF document is converted into a word processing document.

  • :recognize_bullets (BOOLEAN) —

    Recognize bullets.

  • :relative_horizontal_proximity (Float) —

    Relative horizontal proximity.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26791
26792
26793
26794
26795
26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
26809
26810
26811
26812
26813
26814
26815
26816
26817
26818
26819
26820
26821
26822
26823
26824
26825
26826
26827
26828
26829
26830
26831
26832
26833
26834
26835
26836
26837
26838
26839
26840
26841
26842
26843
26844
26845
26846
26847
26848
26849
26850
26851
26852
26853
26854
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26791

def put_pdf_in_storage_to_doc_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_doc ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_doc"
  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 PdfApi.put_pdf_in_storage_to_doc"
  end
  if @api_client.config.client_side_validation && opts[:'format'] && !['Doc', 'DocX'].include?(opts[:'format'])
    fail ArgumentError, 'invalid value for "format", must be one of Doc, DocX'
  end
  if @api_client.config.client_side_validation && opts[:'mode'] && !['Textbox', 'Flow', 'EnhancedFlow'].include?(opts[:'mode'])
    fail ArgumentError, 'invalid value for "mode", must be one of Textbox, Flow, EnhancedFlow'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/doc".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'addReturnToLineEnd'] = opts[:'add_return_to_line_end'] if !opts[:'add_return_to_line_end'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'imageResolutionX'] = opts[:'image_resolution_x'] if !opts[:'image_resolution_x'].nil?
  query_params[:'imageResolutionY'] = opts[:'image_resolution_y'] if !opts[:'image_resolution_y'].nil?
  query_params[:'maxDistanceBetweenTextLines'] = opts[:'max_distance_between_text_lines'] if !opts[:'max_distance_between_text_lines'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?
  query_params[:'recognizeBullets'] = opts[:'recognize_bullets'] if !opts[:'recognize_bullets'].nil?
  query_params[:'relativeHorizontalProximity'] = opts[:'relative_horizontal_proximity'] if !opts[:'relative_horizontal_proximity'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_epub(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



26865
26866
26867
26868
26869
26870
26871
26872
26873
26874
26875
26876
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26865

def put_pdf_in_storage_to_epub(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_epub_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_epub_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_epub_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.epub)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :content_recognition_mode (String) —

    Property tunes conversion for this or that desirable method of recognition of content.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



26887
26888
26889
26890
26891
26892
26893
26894
26895
26896
26897
26898
26899
26900
26901
26902
26903
26904
26905
26906
26907
26908
26909
26910
26911
26912
26913
26914
26915
26916
26917
26918
26919
26920
26921
26922
26923
26924
26925
26926
26927
26928
26929
26930
26931
26932
26933
26934
26935
26936
26937
26938
26939
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26887

def put_pdf_in_storage_to_epub_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_epub ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_epub"
  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 PdfApi.put_pdf_in_storage_to_epub"
  end
  if @api_client.config.client_side_validation && opts[:'content_recognition_mode'] && !['Flow', 'PdfFlow', 'Fixed'].include?(opts[:'content_recognition_mode'])
    fail ArgumentError, 'invalid value for "content_recognition_mode", must be one of Flow, PdfFlow, Fixed'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/epub".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'contentRecognitionMode'] = opts[:'content_recognition_mode'] if !opts[:'content_recognition_mode'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_epub\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_html(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to Html format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.html)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

  • :output_format (String) —

    This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is &quot;Zip&quot; or missed (default). In case of the &quot;Folder&quot;, all resulting files and directories will be uploaded to the folder of the resulting HTML file. (default to Zip)

Returns:



26979
26980
26981
26982
26983
26984
26985
26986
26987
26988
26989
26990
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 26979

def put_pdf_in_storage_to_html(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_html_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_html_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_html_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to Html format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.html)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :additional_margin_width_in_points (Integer) —

    Defines width of margin that will be forcibly left around that output HTML-areas.

  • :compress_svg_graphics_if_any (BOOLEAN) —

    The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.

  • :convert_marked_content_to_layers (BOOLEAN) —

    If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with &quot;data-pdflayer&quot; attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.

  • :default_font_name (String) —

    Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.

  • :document_type (String) —

    Result document type.

  • :fixed_layout (BOOLEAN) —

    The value indicating whether that HTML is created as fixed layout.

  • :image_resolution (Integer) —

    Resolution for image rendering.

  • :minimal_line_width (Integer) —

    This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.

  • :prevent_glyphs_grouping (BOOLEAN) —

    This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.

  • :split_css_into_pages (BOOLEAN) —

    When multipage-mode selected(i.e &#39;SplitIntoPages&#39; is &#39;true&#39;), then this attribute defines whether should be created separate CSS-file for each result HTML page.

  • :split_into_pages (BOOLEAN) —

    The flag that indicates whether each page of source document will be converted into it&#39;s own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.

  • :use_z_order (BOOLEAN) —

    If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.

  • :antialiasing_processing (String) —

    The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.

  • :css_class_names_prefix (String) —

    When PDFtoHTML converter generates result CSSs, CSS class names (something like &quot;.stl_01 {}&quot; … &quot;.stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.

  • :explicit_list_of_saved_pages (Array<Integer>) —

    With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1…) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.

  • :font_encoding_strategy (String) —

    Defines encoding special rule to tune PDF decoding for current document.

  • :font_saving_mode (String) —

    Defines font saving mode that will be used during saving of PDF to desirable format.

  • :html_markup_generation_mode (String) —

    Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

  • :letters_positioning_method (String) —

    The mode of positioning of letters in words in result HTML.

  • :pages_flow_type_depends_on_viewers_screen_size (BOOLEAN) —

    If attribute &#39;SplitOnPages&#x3D;false&#39;, than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.

  • :parts_embedding_mode (String) —

    It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.

  • :raster_images_saving_mode (String) —

    Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.

  • :remove_empty_areas_on_top_and_bottom (BOOLEAN) —

    Defines whether in created HTML will be removed top and bottom empty area without any content (if any).

  • :save_shadowed_texts_as_transparent_texts (BOOLEAN) —

    Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).

  • :save_transparent_texts (BOOLEAN) —

    Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.

  • :special_folder_for_all_images (String) —

    The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :special_folder_for_svg_images (String) —

    The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.

  • :try_save_text_underlining_and_strikeouting_in_css (BOOLEAN) —

    PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text&#39;s underlining and put this info into CSS instead of drawing of underlining graphically.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :flow_layout_paragraph_full_width (BOOLEAN) —

    This attribute specifies full width paragraph text for Flow mode, FixedLayout &#x3D; false.

  • :output_format (String) —

    This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is &quot;Zip&quot; or missed (default). In case of the &quot;Folder&quot;, all resulting files and directories will be uploaded to the folder of the resulting HTML file.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27030
27031
27032
27033
27034
27035
27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
27072
27073
27074
27075
27076
27077
27078
27079
27080
27081
27082
27083
27084
27085
27086
27087
27088
27089
27090
27091
27092
27093
27094
27095
27096
27097
27098
27099
27100
27101
27102
27103
27104
27105
27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
27116
27117
27118
27119
27120
27121
27122
27123
27124
27125
27126
27127
27128
27129
27130
27131
27132
27133
27134
27135
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27030

def put_pdf_in_storage_to_html_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_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 PdfApi.put_pdf_in_storage_to_html"
  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 PdfApi.put_pdf_in_storage_to_html"
  end
  if @api_client.config.client_side_validation && opts[:'document_type'] && !['Xhtml', 'Html5'].include?(opts[:'document_type'])
    fail ArgumentError, 'invalid value for "document_type", must be one of Xhtml, Html5'
  end
  if @api_client.config.client_side_validation && opts[:'antialiasing_processing'] && !['NoAdditionalProcessing', 'TryCorrectResultHtml'].include?(opts[:'antialiasing_processing'])
    fail ArgumentError, 'invalid value for "antialiasing_processing", must be one of NoAdditionalProcessing, TryCorrectResultHtml'
  end
  if @api_client.config.client_side_validation && opts[:'font_encoding_strategy'] && !['Default', 'DecreaseToUnicodePriorityLevel'].include?(opts[:'font_encoding_strategy'])
    fail ArgumentError, 'invalid value for "font_encoding_strategy", must be one of Default, DecreaseToUnicodePriorityLevel'
  end
  if @api_client.config.client_side_validation && opts[:'font_saving_mode'] && !['AlwaysSaveAsWOFF', 'AlwaysSaveAsTTF', 'AlwaysSaveAsEOT', 'SaveInAllFormats'].include?(opts[:'font_saving_mode'])
    fail ArgumentError, 'invalid value for "font_saving_mode", must be one of AlwaysSaveAsWOFF, AlwaysSaveAsTTF, AlwaysSaveAsEOT, SaveInAllFormats'
  end
  if @api_client.config.client_side_validation && opts[:'html_markup_generation_mode'] && !['WriteAllHtml', 'WriteOnlyBodyContent'].include?(opts[:'html_markup_generation_mode'])
    fail ArgumentError, 'invalid value for "html_markup_generation_mode", must be one of WriteAllHtml, WriteOnlyBodyContent'
  end
  if @api_client.config.client_side_validation && opts[:'letters_positioning_method'] && !['UseEmUnitsAndCompensationOfRoundingErrorsInCss', 'UsePixelUnitsInCssLetterSpacingForIE'].include?(opts[:'letters_positioning_method'])
    fail ArgumentError, 'invalid value for "letters_positioning_method", must be one of UseEmUnitsAndCompensationOfRoundingErrorsInCss, UsePixelUnitsInCssLetterSpacingForIE'
  end
  if @api_client.config.client_side_validation && opts[:'parts_embedding_mode'] && !['EmbedAllIntoHtml', 'EmbedCssOnly', 'NoEmbedding'].include?(opts[:'parts_embedding_mode'])
    fail ArgumentError, 'invalid value for "parts_embedding_mode", must be one of EmbedAllIntoHtml, EmbedCssOnly, NoEmbedding'
  end
  if @api_client.config.client_side_validation && opts[:'raster_images_saving_mode'] && !['AsPngImagesEmbeddedIntoSvg', 'AsExternalPngFilesReferencedViaSvg', 'AsEmbeddedPartsOfPngPageBackground'].include?(opts[:'raster_images_saving_mode'])
    fail ArgumentError, 'invalid value for "raster_images_saving_mode", must be one of AsPngImagesEmbeddedIntoSvg, AsExternalPngFilesReferencedViaSvg, AsEmbeddedPartsOfPngPageBackground'
  end
  if @api_client.config.client_side_validation && opts[:'output_format'] && !['Zip', 'Folder'].include?(opts[:'output_format'])
    fail ArgumentError, 'invalid value for "output_format", must be one of Zip, Folder'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/html".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'additionalMarginWidthInPoints'] = opts[:'additional_margin_width_in_points'] if !opts[:'additional_margin_width_in_points'].nil?
  query_params[:'compressSvgGraphicsIfAny'] = opts[:'compress_svg_graphics_if_any'] if !opts[:'compress_svg_graphics_if_any'].nil?
  query_params[:'convertMarkedContentToLayers'] = opts[:'convert_marked_content_to_layers'] if !opts[:'convert_marked_content_to_layers'].nil?
  query_params[:'defaultFontName'] = opts[:'default_font_name'] if !opts[:'default_font_name'].nil?
  query_params[:'documentType'] = opts[:'document_type'] if !opts[:'document_type'].nil?
  query_params[:'fixedLayout'] = opts[:'fixed_layout'] if !opts[:'fixed_layout'].nil?
  query_params[:'imageResolution'] = opts[:'image_resolution'] if !opts[:'image_resolution'].nil?
  query_params[:'minimalLineWidth'] = opts[:'minimal_line_width'] if !opts[:'minimal_line_width'].nil?
  query_params[:'preventGlyphsGrouping'] = opts[:'prevent_glyphs_grouping'] if !opts[:'prevent_glyphs_grouping'].nil?
  query_params[:'splitCssIntoPages'] = opts[:'split_css_into_pages'] if !opts[:'split_css_into_pages'].nil?
  query_params[:'splitIntoPages'] = opts[:'split_into_pages'] if !opts[:'split_into_pages'].nil?
  query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
  query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
  query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
  query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :multi) if !opts[:'explicit_list_of_saved_pages'].nil?
  query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
  query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
  query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
  query_params[:'lettersPositioningMethod'] = opts[:'letters_positioning_method'] if !opts[:'letters_positioning_method'].nil?
  query_params[:'pagesFlowTypeDependsOnViewersScreenSize'] = opts[:'pages_flow_type_depends_on_viewers_screen_size'] if !opts[:'pages_flow_type_depends_on_viewers_screen_size'].nil?
  query_params[:'partsEmbeddingMode'] = opts[:'parts_embedding_mode'] if !opts[:'parts_embedding_mode'].nil?
  query_params[:'rasterImagesSavingMode'] = opts[:'raster_images_saving_mode'] if !opts[:'raster_images_saving_mode'].nil?
  query_params[:'removeEmptyAreasOnTopAndBottom'] = opts[:'remove_empty_areas_on_top_and_bottom'] if !opts[:'remove_empty_areas_on_top_and_bottom'].nil?
  query_params[:'saveShadowedTextsAsTransparentTexts'] = opts[:'save_shadowed_texts_as_transparent_texts'] if !opts[:'save_shadowed_texts_as_transparent_texts'].nil?
  query_params[:'saveTransparentTexts'] = opts[:'save_transparent_texts'] if !opts[:'save_transparent_texts'].nil?
  query_params[:'specialFolderForAllImages'] = opts[:'special_folder_for_all_images'] if !opts[:'special_folder_for_all_images'].nil?
  query_params[:'specialFolderForSvgImages'] = opts[:'special_folder_for_svg_images'] if !opts[:'special_folder_for_svg_images'].nil?
  query_params[:'trySaveTextUnderliningAndStrikeoutingInCss'] = opts[:'try_save_text_underlining_and_strikeouting_in_css'] if !opts[:'try_save_text_underlining_and_strikeouting_in_css'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'flowLayoutParagraphFullWidth'] = opts[:'flow_layout_paragraph_full_width'] if !opts[:'flow_layout_paragraph_full_width'].nil?
  query_params[:'outputFormat'] = opts[:'output_format'] if !opts[:'output_format'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_mobi_xml(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to MOBIXML format and uploads resulting ZIP archive file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.mobixml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
27155
27156
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27145

def put_pdf_in_storage_to_mobi_xml(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to MOBIXML format and uploads resulting ZIP archive file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.mobixml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27166
27167
27168
27169
27170
27171
27172
27173
27174
27175
27176
27177
27178
27179
27180
27181
27182
27183
27184
27185
27186
27187
27188
27189
27190
27191
27192
27193
27194
27195
27196
27197
27198
27199
27200
27201
27202
27203
27204
27205
27206
27207
27208
27209
27210
27211
27212
27213
27214
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27166

def put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_mobi_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_mobi_xml"
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_pdf_in_storage_to_mobi_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/mobixml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_mobi_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_pdf_a(name, out_path, type, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • type —

    Type of PdfA format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



27226
27227
27228
27229
27230
27231
27232
27233
27234
27235
27236
27237
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27226

def put_pdf_in_storage_to_pdf_a(name, out_path, type, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • type —

    Type of PdfA format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27249
27250
27251
27252
27253
27254
27255
27256
27257
27258
27259
27260
27261
27262
27263
27264
27265
27266
27267
27268
27269
27270
27271
27272
27273
27274
27275
27276
27277
27278
27279
27280
27281
27282
27283
27284
27285
27286
27287
27288
27289
27290
27291
27292
27293
27294
27295
27296
27297
27298
27299
27300
27301
27302
27303
27304
27305
27306
27307
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27249

def put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_pdf_a ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_pdf_a"
  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 PdfApi.put_pdf_in_storage_to_pdf_a"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling PdfApi.put_pdf_in_storage_to_pdf_a"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['PDFA1A', 'PDFA1B', 'PDFA3A', 'PDFA3B'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of PDFA1A, PDFA1B, PDFA3A, PDFA3B"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/pdfa".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'type'] = type
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_pdf_a\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_pptx(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pptx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

Returns:



27320
27321
27322
27323
27324
27325
27326
27327
27328
27329
27330
27331
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27320

def put_pdf_in_storage_to_pptx(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_pptx_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_pptx_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_pptx_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pptx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :separate_images (BOOLEAN) —

    Separate images.

  • :slides_as_images (BOOLEAN) —

    Slides as images.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    Base64 encoded password.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27344
27345
27346
27347
27348
27349
27350
27351
27352
27353
27354
27355
27356
27357
27358
27359
27360
27361
27362
27363
27364
27365
27366
27367
27368
27369
27370
27371
27372
27373
27374
27375
27376
27377
27378
27379
27380
27381
27382
27383
27384
27385
27386
27387
27388
27389
27390
27391
27392
27393
27394
27395
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27344

def put_pdf_in_storage_to_pptx_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_pptx ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_pptx"
  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 PdfApi.put_pdf_in_storage_to_pptx"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/pptx".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'separateImages'] = opts[:'separate_images'] if !opts[:'separate_images'].nil?
  query_params[:'slidesAsImages'] = opts[:'slides_as_images'] if !opts[:'slides_as_images'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_pptx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_svg(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to SVG format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



27406
27407
27408
27409
27410
27411
27412
27413
27414
27415
27416
27417
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27406

def put_pdf_in_storage_to_svg(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_svg_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_svg_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_svg_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to SVG format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27428
27429
27430
27431
27432
27433
27434
27435
27436
27437
27438
27439
27440
27441
27442
27443
27444
27445
27446
27447
27448
27449
27450
27451
27452
27453
27454
27455
27456
27457
27458
27459
27460
27461
27462
27463
27464
27465
27466
27467
27468
27469
27470
27471
27472
27473
27474
27475
27476
27477
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27428

def put_pdf_in_storage_to_svg_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_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 PdfApi.put_pdf_in_storage_to_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 PdfApi.put_pdf_in_storage_to_svg"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/svg".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_svg\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_te_x(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to TeX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



27487
27488
27489
27490
27491
27492
27493
27494
27495
27496
27497
27498
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27487

def put_pdf_in_storage_to_te_x(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_te_x_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_te_x_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_te_x_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to TeX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27508
27509
27510
27511
27512
27513
27514
27515
27516
27517
27518
27519
27520
27521
27522
27523
27524
27525
27526
27527
27528
27529
27530
27531
27532
27533
27534
27535
27536
27537
27538
27539
27540
27541
27542
27543
27544
27545
27546
27547
27548
27549
27550
27551
27552
27553
27554
27555
27556
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27508

def put_pdf_in_storage_to_te_x_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_te_x ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_te_x"
  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 PdfApi.put_pdf_in_storage_to_te_x"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/tex".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_te_x\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_tiff(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tiff)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



27581
27582
27583
27584
27585
27586
27587
27588
27589
27590
27591
27592
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27581

def put_pdf_in_storage_to_tiff(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_tiff_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_tiff_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_tiff_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.tiff)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :brightness (Float) —

    Image brightness.

  • :compression (String) —

    Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.

  • :color_depth (String) —

    Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.

  • :left_margin (Integer) —

    Left image margin.

  • :right_margin (Integer) —

    Right image margin.

  • :top_margin (Integer) —

    Top image margin.

  • :bottom_margin (Integer) —

    Bottom image margin.

  • :orientation (String) —

    Image orientation. Possible values are: None, Landscape, Portait.

  • :skip_blank_pages (BOOLEAN) —

    Skip blank pages flag.

  • :width (Integer) —

    Image width.

  • :height (Integer) —

    Image height.

  • :x_resolution (Integer) —

    Horizontal resolution.

  • :y_resolution (Integer) —

    Vertical resolution.

  • :page_index (Integer) —

    Start page to export.

  • :page_count (Integer) —

    Number of pages to export.

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27617
27618
27619
27620
27621
27622
27623
27624
27625
27626
27627
27628
27629
27630
27631
27632
27633
27634
27635
27636
27637
27638
27639
27640
27641
27642
27643
27644
27645
27646
27647
27648
27649
27650
27651
27652
27653
27654
27655
27656
27657
27658
27659
27660
27661
27662
27663
27664
27665
27666
27667
27668
27669
27670
27671
27672
27673
27674
27675
27676
27677
27678
27679
27680
27681
27682
27683
27684
27685
27686
27687
27688
27689
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27617

def put_pdf_in_storage_to_tiff_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_tiff ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_tiff"
  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 PdfApi.put_pdf_in_storage_to_tiff"
  end
  if @api_client.config.client_side_validation && opts[:'compression'] && !['LZW', 'CCITT4', 'CCITT3', 'RLE', 'None'].include?(opts[:'compression'])
    fail ArgumentError, 'invalid value for "compression", must be one of LZW, CCITT4, CCITT3, RLE, None'
  end
  if @api_client.config.client_side_validation && opts[:'color_depth'] && !['Default', 'Format8bpp', 'Format4bpp', 'Format1bpp'].include?(opts[:'color_depth'])
    fail ArgumentError, 'invalid value for "color_depth", must be one of Default, Format8bpp, Format4bpp, Format1bpp'
  end
  if @api_client.config.client_side_validation && opts[:'orientation'] && !['None', 'Landscape', 'Portrait'].include?(opts[:'orientation'])
    fail ArgumentError, 'invalid value for "orientation", must be one of None, Landscape, Portrait'
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/tiff".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'brightness'] = opts[:'brightness'] if !opts[:'brightness'].nil?
  query_params[:'compression'] = opts[:'compression'] if !opts[:'compression'].nil?
  query_params[:'colorDepth'] = opts[:'color_depth'] if !opts[:'color_depth'].nil?
  query_params[:'leftMargin'] = opts[:'left_margin'] if !opts[:'left_margin'].nil?
  query_params[:'rightMargin'] = opts[:'right_margin'] if !opts[:'right_margin'].nil?
  query_params[:'topMargin'] = opts[:'top_margin'] if !opts[:'top_margin'].nil?
  query_params[:'bottomMargin'] = opts[:'bottom_margin'] if !opts[:'bottom_margin'].nil?
  query_params[:'orientation'] = opts[:'orientation'] if !opts[:'orientation'].nil?
  query_params[:'skipBlankPages'] = opts[:'skip_blank_pages'] if !opts[:'skip_blank_pages'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'xResolution'] = opts[:'x_resolution'] if !opts[:'x_resolution'].nil?
  query_params[:'yResolution'] = opts[:'y_resolution'] if !opts[:'y_resolution'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'pageCount'] = opts[:'page_count'] if !opts[:'page_count'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_xls(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to XLS format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xls)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



27704
27705
27706
27707
27708
27709
27710
27711
27712
27713
27714
27715
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27704

def put_pdf_in_storage_to_xls(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_xls_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_xls_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_xls_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to XLS format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xls)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27730
27731
27732
27733
27734
27735
27736
27737
27738
27739
27740
27741
27742
27743
27744
27745
27746
27747
27748
27749
27750
27751
27752
27753
27754
27755
27756
27757
27758
27759
27760
27761
27762
27763
27764
27765
27766
27767
27768
27769
27770
27771
27772
27773
27774
27775
27776
27777
27778
27779
27780
27781
27782
27783
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27730

def put_pdf_in_storage_to_xls_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_xls ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_xls"
  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 PdfApi.put_pdf_in_storage_to_xls"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xls".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_xls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_xlsx(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to XLSX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xlsx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:



27798
27799
27800
27801
27802
27803
27804
27805
27806
27807
27808
27809
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27798

def put_pdf_in_storage_to_xlsx(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_xlsx_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_xlsx_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_xlsx_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to XLSX format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xlsx)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :insert_blank_column_at_first (BOOLEAN) —

    Insert blank column at first

  • :minimize_the_number_of_worksheets (BOOLEAN) —

    Minimize the number of worksheets

  • :scale_factor (Float) —

    Scale factor (Obsolete)

  • :uniform_worksheets (BOOLEAN) —

    Uniform worksheets

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27824
27825
27826
27827
27828
27829
27830
27831
27832
27833
27834
27835
27836
27837
27838
27839
27840
27841
27842
27843
27844
27845
27846
27847
27848
27849
27850
27851
27852
27853
27854
27855
27856
27857
27858
27859
27860
27861
27862
27863
27864
27865
27866
27867
27868
27869
27870
27871
27872
27873
27874
27875
27876
27877
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27824

def put_pdf_in_storage_to_xlsx_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_xlsx ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_xlsx"
  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 PdfApi.put_pdf_in_storage_to_xlsx"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xlsx".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'insertBlankColumnAtFirst'] = opts[:'insert_blank_column_at_first'] if !opts[:'insert_blank_column_at_first'].nil?
  query_params[:'minimizeTheNumberOfWorksheets'] = opts[:'minimize_the_number_of_worksheets'] if !opts[:'minimize_the_number_of_worksheets'].nil?
  query_params[:'scaleFactor'] = opts[:'scale_factor'] if !opts[:'scale_factor'].nil?
  query_params[:'uniformWorksheets'] = opts[:'uniform_worksheets'] if !opts[:'uniform_worksheets'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_xlsx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_xml(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to XML format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



27887
27888
27889
27890
27891
27892
27893
27894
27895
27896
27897
27898
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27887

def put_pdf_in_storage_to_xml(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_xml_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_xml_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_xml_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to XML format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27908
27909
27910
27911
27912
27913
27914
27915
27916
27917
27918
27919
27920
27921
27922
27923
27924
27925
27926
27927
27928
27929
27930
27931
27932
27933
27934
27935
27936
27937
27938
27939
27940
27941
27942
27943
27944
27945
27946
27947
27948
27949
27950
27951
27952
27953
27954
27955
27956
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27908

def put_pdf_in_storage_to_xml_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_xml ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_xml"
  end
  # verify the required parameter 'out_path' is set
  if @api_client.config.client_side_validation && out_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.put_pdf_in_storage_to_xml"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_pdf_in_storage_to_xps(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document (located on storage) to XPS format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



27966
27967
27968
27969
27970
27971
27972
27973
27974
27975
27976
27977
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27966

def put_pdf_in_storage_to_xps(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_pdf_in_storage_to_xps_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_pdf_in_storage_to_xps_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_pdf_in_storage_to_xps_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document (located on storage) to XPS format and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



27987
27988
27989
27990
27991
27992
27993
27994
27995
27996
27997
27998
27999
28000
28001
28002
28003
28004
28005
28006
28007
28008
28009
28010
28011
28012
28013
28014
28015
28016
28017
28018
28019
28020
28021
28022
28023
28024
28025
28026
28027
28028
28029
28030
28031
28032
28033
28034
28035
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 27987

def put_pdf_in_storage_to_xps_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_pdf_in_storage_to_xps ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_pdf_in_storage_to_xps"
  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 PdfApi.put_pdf_in_storage_to_xps"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_pdf_in_storage_to_xps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_poly_line_annotation(name, annotation_id, annotation, opts = {}) ⇒ PolyLineAnnotationResponse

Replace document polyline annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28046
28047
28048
28049
28050
28051
28052
28053
28054
28055
28056
28057
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28046

def put_poly_line_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_poly_line_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_poly_line_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_poly_line_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(PolyLineAnnotationResponse, Fixnum, Hash)>

Replace document polyline annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(PolyLineAnnotationResponse, Fixnum, Hash)>) —

    PolyLineAnnotationResponse data, response status code and response headers



28068
28069
28070
28071
28072
28073
28074
28075
28076
28077
28078
28079
28080
28081
28082
28083
28084
28085
28086
28087
28088
28089
28090
28091
28092
28093
28094
28095
28096
28097
28098
28099
28100
28101
28102
28103
28104
28105
28106
28107
28108
28109
28110
28111
28112
28113
28114
28115
28116
28117
28118
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28068

def put_poly_line_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_poly_line_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_poly_line_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_poly_line_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_poly_line_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polyline/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolyLineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_poly_line_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_polygon_annotation(name, annotation_id, annotation, opts = {}) ⇒ PolygonAnnotationResponse

Replace document polygon annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28129
28130
28131
28132
28133
28134
28135
28136
28137
28138
28139
28140
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28129

def put_polygon_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_polygon_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_polygon_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_polygon_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(PolygonAnnotationResponse, Fixnum, Hash)>

Replace document polygon annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(PolygonAnnotationResponse, Fixnum, Hash)>) —

    PolygonAnnotationResponse data, response status code and response headers



28151
28152
28153
28154
28155
28156
28157
28158
28159
28160
28161
28162
28163
28164
28165
28166
28167
28168
28169
28170
28171
28172
28173
28174
28175
28176
28177
28178
28179
28180
28181
28182
28183
28184
28185
28186
28187
28188
28189
28190
28191
28192
28193
28194
28195
28196
28197
28198
28199
28200
28201
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28151

def put_polygon_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_polygon_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_polygon_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_polygon_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_polygon_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/polygon/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PolygonAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_polygon_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_popup_annotation(name, annotation_id, annotation, opts = {}) ⇒ PopupAnnotationResponse

Replace document popup annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28212
28213
28214
28215
28216
28217
28218
28219
28220
28221
28222
28223
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28212

def put_popup_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_popup_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_popup_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_popup_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(PopupAnnotationResponse, Fixnum, Hash)>

Replace document popup annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(PopupAnnotationResponse, Fixnum, Hash)>) —

    PopupAnnotationResponse data, response status code and response headers



28234
28235
28236
28237
28238
28239
28240
28241
28242
28243
28244
28245
28246
28247
28248
28249
28250
28251
28252
28253
28254
28255
28256
28257
28258
28259
28260
28261
28262
28263
28264
28265
28266
28267
28268
28269
28270
28271
28272
28273
28274
28275
28276
28277
28278
28279
28280
28281
28282
28283
28284
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28234

def put_popup_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_popup_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_popup_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_popup_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_popup_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/popup/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PopupAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_popup_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_privileges(name, privileges, opts = {}) ⇒ AsposeResponse

Update privilege document.

Parameters:

  • name —

    The document name.

  • privileges —

    Document privileges. DocumentPrivilege

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28294
28295
28296
28297
28298
28299
28300
28301
28302
28303
28304
28305
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28294

def put_privileges(name, privileges, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_privileges_with_http_info(name, privileges, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_privileges_with_http_info(name, privileges, opts)
    else
      raise
    end
  return data
end

#put_privileges_with_http_info(name, privileges, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Update privilege document.

Parameters:

  • name —

    The document name.

  • privileges —

    Document privileges. DocumentPrivilege

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



28315
28316
28317
28318
28319
28320
28321
28322
28323
28324
28325
28326
28327
28328
28329
28330
28331
28332
28333
28334
28335
28336
28337
28338
28339
28340
28341
28342
28343
28344
28345
28346
28347
28348
28349
28350
28351
28352
28353
28354
28355
28356
28357
28358
28359
28360
28361
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28315

def put_privileges_with_http_info(name, privileges, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_privileges ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_privileges"
  end
  # verify the required parameter 'privileges' is set
  if @api_client.config.client_side_validation && privileges.nil?
    fail ArgumentError, "Missing the required parameter 'privileges' when calling PdfApi.put_privileges"
  end
  # resource path
  local_var_path = "/pdf/{name}/privileges".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(privileges)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_privileges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_ps_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert PS file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.ps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



28371
28372
28373
28374
28375
28376
28377
28378
28379
28380
28381
28382
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28371

def put_ps_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_ps_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_ps_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_ps_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert PS file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.ps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



28392
28393
28394
28395
28396
28397
28398
28399
28400
28401
28402
28403
28404
28405
28406
28407
28408
28409
28410
28411
28412
28413
28414
28415
28416
28417
28418
28419
28420
28421
28422
28423
28424
28425
28426
28427
28428
28429
28430
28431
28432
28433
28434
28435
28436
28437
28438
28439
28440
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28392

def put_ps_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_ps_in_storage_to_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 PdfApi.put_ps_in_storage_to_pdf"
  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 PdfApi.put_ps_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/ps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_ps_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_radio_button_field(name, field_name, field, opts = {}) ⇒ RadioButtonFieldResponse

Replace document RadioButton field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28451
28452
28453
28454
28455
28456
28457
28458
28459
28460
28461
28462
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28451

def put_radio_button_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_radio_button_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_radio_button_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_radio_button_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(RadioButtonFieldResponse, Fixnum, Hash)>

Replace document RadioButton field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(RadioButtonFieldResponse, Fixnum, Hash)>) —

    RadioButtonFieldResponse data, response status code and response headers



28473
28474
28475
28476
28477
28478
28479
28480
28481
28482
28483
28484
28485
28486
28487
28488
28489
28490
28491
28492
28493
28494
28495
28496
28497
28498
28499
28500
28501
28502
28503
28504
28505
28506
28507
28508
28509
28510
28511
28512
28513
28514
28515
28516
28517
28518
28519
28520
28521
28522
28523
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28473

def put_radio_button_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_radio_button_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_radio_button_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_radio_button_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_radio_button_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/radiobutton/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RadioButtonFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_radio_button_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_redaction_annotation(name, annotation_id, annotation, opts = {}) ⇒ RedactionAnnotationResponse

Replace document redaction annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :apply (BOOLEAN) —

    Apply redaction immediately after adding. (default to false)

Returns:



28535
28536
28537
28538
28539
28540
28541
28542
28543
28544
28545
28546
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28535

def put_redaction_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_redaction_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_redaction_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_redaction_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(RedactionAnnotationResponse, Fixnum, Hash)>

Replace document redaction annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :apply (BOOLEAN) —

    Apply redaction immediately after adding.

Returns:



28558
28559
28560
28561
28562
28563
28564
28565
28566
28567
28568
28569
28570
28571
28572
28573
28574
28575
28576
28577
28578
28579
28580
28581
28582
28583
28584
28585
28586
28587
28588
28589
28590
28591
28592
28593
28594
28595
28596
28597
28598
28599
28600
28601
28602
28603
28604
28605
28606
28607
28608
28609
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28558

def put_redaction_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_redaction_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_redaction_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_redaction_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_redaction_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/redaction/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'apply'] = opts[:'apply'] if !opts[:'apply'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RedactionAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_redaction_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_replace_image(name, image_id, opts = {}) ⇒ ImageResponse

Replace document image.

Parameters:

  • name —

    The document name.

  • image_id —

    The image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:



28621
28622
28623
28624
28625
28626
28627
28628
28629
28630
28631
28632
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28621

def put_replace_image(name, image_id, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_replace_image_with_http_info(name, image_id, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_replace_image_with_http_info(name, image_id, opts)
    else
      raise
    end
  return data
end

#put_replace_image_with_http_info(name, image_id, opts = {}) ⇒ Array<(ImageResponse, Fixnum, Hash)>

Replace document image.

Parameters:

  • name —

    The document name.

  • image_id —

    The image ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:

  • (Array<(ImageResponse, Fixnum, Hash)>) —

    ImageResponse data, response status code and response headers



28644
28645
28646
28647
28648
28649
28650
28651
28652
28653
28654
28655
28656
28657
28658
28659
28660
28661
28662
28663
28664
28665
28666
28667
28668
28669
28670
28671
28672
28673
28674
28675
28676
28677
28678
28679
28680
28681
28682
28683
28684
28685
28686
28687
28688
28689
28690
28691
28692
28693
28694
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28644

def put_replace_image_with_http_info(name, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_replace_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 PdfApi.put_replace_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling PdfApi.put_replace_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/{imageId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'imageFilePath'] = opts[:'image_file_path'] if !opts[:'image_file_path'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'image'] if !opts[:'image'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_replace_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_replace_multiple_image(name, image_ids, opts = {}) ⇒ ImagesResponse

Replace document multiple image.

Parameters:

  • name —

    The document name.

  • image_ids —

    The image IDs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:



28706
28707
28708
28709
28710
28711
28712
28713
28714
28715
28716
28717
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28706

def put_replace_multiple_image(name, image_ids, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_replace_multiple_image_with_http_info(name, image_ids, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_replace_multiple_image_with_http_info(name, image_ids, opts)
    else
      raise
    end
  return data
end

#put_replace_multiple_image_with_http_info(name, image_ids, opts = {}) ⇒ Array<(ImagesResponse, Fixnum, Hash)>

Replace document multiple image.

Parameters:

  • name —

    The document name.

  • image_ids —

    The image IDs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :image_file_path (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :image (File) —

    Image file.

Returns:

  • (Array<(ImagesResponse, Fixnum, Hash)>) —

    ImagesResponse data, response status code and response headers



28729
28730
28731
28732
28733
28734
28735
28736
28737
28738
28739
28740
28741
28742
28743
28744
28745
28746
28747
28748
28749
28750
28751
28752
28753
28754
28755
28756
28757
28758
28759
28760
28761
28762
28763
28764
28765
28766
28767
28768
28769
28770
28771
28772
28773
28774
28775
28776
28777
28778
28779
28780
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28729

def put_replace_multiple_image_with_http_info(name, image_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_replace_multiple_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 PdfApi.put_replace_multiple_image"
  end
  # verify the required parameter 'image_ids' is set
  if @api_client.config.client_side_validation && image_ids.nil?
    fail ArgumentError, "Missing the required parameter 'image_ids' when calling PdfApi.put_replace_multiple_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/images/replace".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'imageIds'] = @api_client.build_collection_param(image_ids, :multi)
  query_params[:'imageFilePath'] = opts[:'image_file_path'] if !opts[:'image_file_path'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'image'] if !opts[:'image'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_replace_multiple_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_screen_annotation(name, annotation_id, annotation, opts = {}) ⇒ ScreenAnnotationResponse

Replace document screen annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28791
28792
28793
28794
28795
28796
28797
28798
28799
28800
28801
28802
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28791

def put_screen_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_screen_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_screen_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_screen_annotation_data_extract(name, annotation_id, out_file_path, opts = {}) ⇒ AsposeResponse

Extract document screen annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



28874
28875
28876
28877
28878
28879
28880
28881
28882
28883
28884
28885
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28874

def put_screen_annotation_data_extract(name, annotation_id, out_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_screen_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_screen_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
    else
      raise
    end
  return data
end

#put_screen_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document screen annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



28896
28897
28898
28899
28900
28901
28902
28903
28904
28905
28906
28907
28908
28909
28910
28911
28912
28913
28914
28915
28916
28917
28918
28919
28920
28921
28922
28923
28924
28925
28926
28927
28928
28929
28930
28931
28932
28933
28934
28935
28936
28937
28938
28939
28940
28941
28942
28943
28944
28945
28946
28947
28948
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28896

def put_screen_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_screen_annotation_data_extract ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_screen_annotation_data_extract"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_screen_annotation_data_extract"
  end
  # verify the required parameter 'out_file_path' is set
  if @api_client.config.client_side_validation && out_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_file_path' when calling PdfApi.put_screen_annotation_data_extract"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/screen/{annotationId}/data/extract".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'outFilePath'] = out_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_screen_annotation_data_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_screen_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(ScreenAnnotationResponse, Fixnum, Hash)>

Replace document screen annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(ScreenAnnotationResponse, Fixnum, Hash)>) —

    ScreenAnnotationResponse data, response status code and response headers



28813
28814
28815
28816
28817
28818
28819
28820
28821
28822
28823
28824
28825
28826
28827
28828
28829
28830
28831
28832
28833
28834
28835
28836
28837
28838
28839
28840
28841
28842
28843
28844
28845
28846
28847
28848
28849
28850
28851
28852
28853
28854
28855
28856
28857
28858
28859
28860
28861
28862
28863
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28813

def put_screen_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_screen_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_screen_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_screen_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_screen_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/screen/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_screen_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_searchable_document(name, opts = {}) ⇒ AsposeResponse

Create searchable PDF document. Generate OCR layer for images in input PDF document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :lang (String) —

    language for OCR engine. Possible values: eng, ara, bel, ben, bul, ces, dan, deu, ell, fin, fra, heb, hin, ind, isl, ita, jpn, kor, nld, nor, pol, por, ron, rus, spa, swe, tha, tur, ukr, vie, chi_sim, chi_tra or thier combination e.g. eng,rus

Returns:



28958
28959
28960
28961
28962
28963
28964
28965
28966
28967
28968
28969
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28958

def put_searchable_document(name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_searchable_document_with_http_info(name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_searchable_document_with_http_info(name, opts)
    else
      raise
    end
  return data
end

#put_searchable_document_with_http_info(name, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Create searchable PDF document. Generate OCR layer for images in input PDF document.

Parameters:

  • name —

    The document name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :lang (String) —

    language for OCR engine. Possible values: eng, ara, bel, ben, bul, ces, dan, deu, ell, fin, fra, heb, hin, ind, isl, ita, jpn, kor, nld, nor, pol, por, ron, rus, spa, swe, tha, tur, ukr, vie, chi_sim, chi_tra or thier combination e.g. eng,rus

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



28979
28980
28981
28982
28983
28984
28985
28986
28987
28988
28989
28990
28991
28992
28993
28994
28995
28996
28997
28998
28999
29000
29001
29002
29003
29004
29005
29006
29007
29008
29009
29010
29011
29012
29013
29014
29015
29016
29017
29018
29019
29020
29021
29022
29023
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 28979

def put_searchable_document_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_searchable_document ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_searchable_document"
  end
  # resource path
  local_var_path = "/pdf/{name}/ocr".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_searchable_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_set_property(name, property_name, value, opts = {}) ⇒ DocumentPropertyResponse

Add/update document property.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

  • value —

    Property value.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:



29035
29036
29037
29038
29039
29040
29041
29042
29043
29044
29045
29046
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29035

def put_set_property(name, property_name, value, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_set_property_with_http_info(name, property_name, value, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_set_property_with_http_info(name, property_name, value, opts)
    else
      raise
    end
  return data
end

#put_set_property_with_http_info(name, property_name, value, opts = {}) ⇒ Array<(DocumentPropertyResponse, Fixnum, Hash)>

Add/update document property.

Parameters:

  • name —

    The document name.

  • property_name —

    Property name.

  • value —

    Property value.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :password (String) —

    The password (Base64).

Returns:

  • (Array<(DocumentPropertyResponse, Fixnum, Hash)>) —

    DocumentPropertyResponse data, response status code and response headers



29058
29059
29060
29061
29062
29063
29064
29065
29066
29067
29068
29069
29070
29071
29072
29073
29074
29075
29076
29077
29078
29079
29080
29081
29082
29083
29084
29085
29086
29087
29088
29089
29090
29091
29092
29093
29094
29095
29096
29097
29098
29099
29100
29101
29102
29103
29104
29105
29106
29107
29108
29109
29110
29111
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29058

def put_set_property_with_http_info(name, property_name, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_set_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 PdfApi.put_set_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 PdfApi.put_set_property"
  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 PdfApi.put_set_property"
  end
  # resource path
  local_var_path = "/pdf/{name}/documentproperties/{propertyName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'value'] = value
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocumentPropertyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_set_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_signature_field(name, field_name, field, opts = {}) ⇒ SignatureFieldResponse

Replace document signature field.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29122
29123
29124
29125
29126
29127
29128
29129
29130
29131
29132
29133
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29122

def put_signature_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_signature_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_signature_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_signature_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(SignatureFieldResponse, Fixnum, Hash)>

Replace document signature field.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(SignatureFieldResponse, Fixnum, Hash)>) —

    SignatureFieldResponse data, response status code and response headers



29144
29145
29146
29147
29148
29149
29150
29151
29152
29153
29154
29155
29156
29157
29158
29159
29160
29161
29162
29163
29164
29165
29166
29167
29168
29169
29170
29171
29172
29173
29174
29175
29176
29177
29178
29179
29180
29181
29182
29183
29184
29185
29186
29187
29188
29189
29190
29191
29192
29193
29194
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29144

def put_signature_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_signature_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_signature_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_signature_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_signature_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/signature/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_sound_annotation(name, annotation_id, annotation, opts = {}) ⇒ SoundAnnotationResponse

Replace document sound annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29205
29206
29207
29208
29209
29210
29211
29212
29213
29214
29215
29216
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29205

def put_sound_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_sound_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_sound_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_sound_annotation_data_extract(name, annotation_id, out_file_path, opts = {}) ⇒ AsposeResponse

Extract document sound annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29288
29289
29290
29291
29292
29293
29294
29295
29296
29297
29298
29299
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29288

def put_sound_annotation_data_extract(name, annotation_id, out_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
    else
      raise
    end
  return data
end

#put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document sound annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



29310
29311
29312
29313
29314
29315
29316
29317
29318
29319
29320
29321
29322
29323
29324
29325
29326
29327
29328
29329
29330
29331
29332
29333
29334
29335
29336
29337
29338
29339
29340
29341
29342
29343
29344
29345
29346
29347
29348
29349
29350
29351
29352
29353
29354
29355
29356
29357
29358
29359
29360
29361
29362
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29310

def put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_sound_annotation_data_extract ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_sound_annotation_data_extract"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_sound_annotation_data_extract"
  end
  # verify the required parameter 'out_file_path' is set
  if @api_client.config.client_side_validation && out_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_file_path' when calling PdfApi.put_sound_annotation_data_extract"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/sound/{annotationId}/data/extract".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'outFilePath'] = out_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_sound_annotation_data_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_sound_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(SoundAnnotationResponse, Fixnum, Hash)>

Replace document sound annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(SoundAnnotationResponse, Fixnum, Hash)>) —

    SoundAnnotationResponse data, response status code and response headers



29227
29228
29229
29230
29231
29232
29233
29234
29235
29236
29237
29238
29239
29240
29241
29242
29243
29244
29245
29246
29247
29248
29249
29250
29251
29252
29253
29254
29255
29256
29257
29258
29259
29260
29261
29262
29263
29264
29265
29266
29267
29268
29269
29270
29271
29272
29273
29274
29275
29276
29277
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29227

def put_sound_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_sound_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_sound_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_sound_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_sound_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/sound/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SoundAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_sound_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_square_annotation(name, annotation_id, annotation, opts = {}) ⇒ SquareAnnotationResponse

Replace document square annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29373
29374
29375
29376
29377
29378
29379
29380
29381
29382
29383
29384
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29373

def put_square_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_square_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_square_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_square_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(SquareAnnotationResponse, Fixnum, Hash)>

Replace document square annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(SquareAnnotationResponse, Fixnum, Hash)>) —

    SquareAnnotationResponse data, response status code and response headers



29395
29396
29397
29398
29399
29400
29401
29402
29403
29404
29405
29406
29407
29408
29409
29410
29411
29412
29413
29414
29415
29416
29417
29418
29419
29420
29421
29422
29423
29424
29425
29426
29427
29428
29429
29430
29431
29432
29433
29434
29435
29436
29437
29438
29439
29440
29441
29442
29443
29444
29445
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29395

def put_square_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_square_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_square_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_square_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_square_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/square/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquareAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_square_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_squiggly_annotation(name, annotation_id, annotation, opts = {}) ⇒ SquigglyAnnotationResponse

Replace document squiggly annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29456
29457
29458
29459
29460
29461
29462
29463
29464
29465
29466
29467
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29456

def put_squiggly_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_squiggly_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_squiggly_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_squiggly_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(SquigglyAnnotationResponse, Fixnum, Hash)>

Replace document squiggly annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(SquigglyAnnotationResponse, Fixnum, Hash)>) —

    SquigglyAnnotationResponse data, response status code and response headers



29478
29479
29480
29481
29482
29483
29484
29485
29486
29487
29488
29489
29490
29491
29492
29493
29494
29495
29496
29497
29498
29499
29500
29501
29502
29503
29504
29505
29506
29507
29508
29509
29510
29511
29512
29513
29514
29515
29516
29517
29518
29519
29520
29521
29522
29523
29524
29525
29526
29527
29528
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29478

def put_squiggly_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_squiggly_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_squiggly_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_squiggly_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_squiggly_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/squiggly/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SquigglyAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_squiggly_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_stamp_annotation(name, annotation_id, annotation, opts = {}) ⇒ StampAnnotationResponse

Replace document stamp annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29539
29540
29541
29542
29543
29544
29545
29546
29547
29548
29549
29550
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29539

def put_stamp_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_stamp_annotation_data_extract(name, annotation_id, out_file_path, opts = {}) ⇒ AsposeResponse

Extract document stamp annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29622
29623
29624
29625
29626
29627
29628
29629
29630
29631
29632
29633
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29622

def put_stamp_annotation_data_extract(name, annotation_id, out_file_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts)
    else
      raise
    end
  return data
end

#put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Extract document stamp annotation content to storage

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • out_file_path —

    The output file path.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



29644
29645
29646
29647
29648
29649
29650
29651
29652
29653
29654
29655
29656
29657
29658
29659
29660
29661
29662
29663
29664
29665
29666
29667
29668
29669
29670
29671
29672
29673
29674
29675
29676
29677
29678
29679
29680
29681
29682
29683
29684
29685
29686
29687
29688
29689
29690
29691
29692
29693
29694
29695
29696
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29644

def put_stamp_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_stamp_annotation_data_extract ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_stamp_annotation_data_extract"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_stamp_annotation_data_extract"
  end
  # verify the required parameter 'out_file_path' is set
  if @api_client.config.client_side_validation && out_file_path.nil?
    fail ArgumentError, "Missing the required parameter 'out_file_path' when calling PdfApi.put_stamp_annotation_data_extract"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}/data/extract".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'outFilePath'] = out_file_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_stamp_annotation_data_extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(StampAnnotationResponse, Fixnum, Hash)>

Replace document stamp annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(StampAnnotationResponse, Fixnum, Hash)>) —

    StampAnnotationResponse data, response status code and response headers



29561
29562
29563
29564
29565
29566
29567
29568
29569
29570
29571
29572
29573
29574
29575
29576
29577
29578
29579
29580
29581
29582
29583
29584
29585
29586
29587
29588
29589
29590
29591
29592
29593
29594
29595
29596
29597
29598
29599
29600
29601
29602
29603
29604
29605
29606
29607
29608
29609
29610
29611
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29561

def put_stamp_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_stamp_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_stamp_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_stamp_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_stamp_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/stamp/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StampAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_stamp_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_strike_out_annotation(name, annotation_id, annotation, opts = {}) ⇒ StrikeOutAnnotationResponse

Replace document StrikeOut annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29707
29708
29709
29710
29711
29712
29713
29714
29715
29716
29717
29718
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29707

def put_strike_out_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_strike_out_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_strike_out_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_strike_out_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(StrikeOutAnnotationResponse, Fixnum, Hash)>

Replace document StrikeOut annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29729
29730
29731
29732
29733
29734
29735
29736
29737
29738
29739
29740
29741
29742
29743
29744
29745
29746
29747
29748
29749
29750
29751
29752
29753
29754
29755
29756
29757
29758
29759
29760
29761
29762
29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
29775
29776
29777
29778
29779
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29729

def put_strike_out_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_strike_out_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_strike_out_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_strike_out_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_strike_out_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/strikeout/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StrikeOutAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_strike_out_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_svg_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert SVG file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :adjust_page_size (BOOLEAN) —

    Adjust page size

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



29797
29798
29799
29800
29801
29802
29803
29804
29805
29806
29807
29808
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29797

def put_svg_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_svg_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_svg_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_svg_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert SVG file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.svg)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :adjust_page_size (BOOLEAN) —

    Adjust page size

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



29826
29827
29828
29829
29830
29831
29832
29833
29834
29835
29836
29837
29838
29839
29840
29841
29842
29843
29844
29845
29846
29847
29848
29849
29850
29851
29852
29853
29854
29855
29856
29857
29858
29859
29860
29861
29862
29863
29864
29865
29866
29867
29868
29869
29870
29871
29872
29873
29874
29875
29876
29877
29878
29879
29880
29881
29882
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29826

def put_svg_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_svg_in_storage_to_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 PdfApi.put_svg_in_storage_to_pdf"
  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 PdfApi.put_svg_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/svg".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'adjustPageSize'] = opts[:'adjust_page_size'] if !opts[:'adjust_page_size'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_svg_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_table(name, table_id, table, opts = {}) ⇒ AsposeResponse

Replace document page table.

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

  • table —

    The table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



29893
29894
29895
29896
29897
29898
29899
29900
29901
29902
29903
29904
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29893

def put_table(name, table_id, table, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_table_with_http_info(name, table_id, table, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_table_with_http_info(name, table_id, table, opts)
    else
      raise
    end
  return data
end

#put_table_with_http_info(name, table_id, table, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Replace document page table.

Parameters:

  • name —

    The document name.

  • table_id —

    The table ID.

  • table —

    The table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



29915
29916
29917
29918
29919
29920
29921
29922
29923
29924
29925
29926
29927
29928
29929
29930
29931
29932
29933
29934
29935
29936
29937
29938
29939
29940
29941
29942
29943
29944
29945
29946
29947
29948
29949
29950
29951
29952
29953
29954
29955
29956
29957
29958
29959
29960
29961
29962
29963
29964
29965
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29915

def put_table_with_http_info(name, table_id, table, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_table ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_table"
  end
  # verify the required parameter 'table_id' is set
  if @api_client.config.client_side_validation && table_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_id' when calling PdfApi.put_table"
  end
  # verify the required parameter 'table' is set
  if @api_client.config.client_side_validation && table.nil?
    fail ArgumentError, "Missing the required parameter 'table' when calling PdfApi.put_table"
  end
  # resource path
  local_var_path = "/pdf/{name}/tables/{tableId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'tableId' + '}', table_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(table)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_te_x_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert TeX file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



29975
29976
29977
29978
29979
29980
29981
29982
29983
29984
29985
29986
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29975

def put_te_x_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_te_x_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_te_x_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_te_x_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert TeX file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.tex)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



29996
29997
29998
29999
30000
30001
30002
30003
30004
30005
30006
30007
30008
30009
30010
30011
30012
30013
30014
30015
30016
30017
30018
30019
30020
30021
30022
30023
30024
30025
30026
30027
30028
30029
30030
30031
30032
30033
30034
30035
30036
30037
30038
30039
30040
30041
30042
30043
30044
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 29996

def put_te_x_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_te_x_in_storage_to_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 PdfApi.put_te_x_in_storage_to_pdf"
  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 PdfApi.put_te_x_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/tex".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_te_x_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_text_annotation(name, annotation_id, annotation, opts = {}) ⇒ TextAnnotationResponse

Replace document text annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30055
30056
30057
30058
30059
30060
30061
30062
30063
30064
30065
30066
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30055

def put_text_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_text_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_text_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_text_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(TextAnnotationResponse, Fixnum, Hash)>

Replace document text annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(TextAnnotationResponse, Fixnum, Hash)>) —

    TextAnnotationResponse data, response status code and response headers



30077
30078
30079
30080
30081
30082
30083
30084
30085
30086
30087
30088
30089
30090
30091
30092
30093
30094
30095
30096
30097
30098
30099
30100
30101
30102
30103
30104
30105
30106
30107
30108
30109
30110
30111
30112
30113
30114
30115
30116
30117
30118
30119
30120
30121
30122
30123
30124
30125
30126
30127
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30077

def put_text_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_text_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_text_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_text_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_text_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/text/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_text_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_text_box_field(name, field_name, field, opts = {}) ⇒ TextBoxFieldResponse

Replace document text box field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30138
30139
30140
30141
30142
30143
30144
30145
30146
30147
30148
30149
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30138

def put_text_box_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_text_box_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_text_box_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_text_box_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(TextBoxFieldResponse, Fixnum, Hash)>

Replace document text box field

Parameters:

  • name —

    The document name.

  • field_name —

    The field name.

  • field —

    The field.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(TextBoxFieldResponse, Fixnum, Hash)>) —

    TextBoxFieldResponse data, response status code and response headers



30160
30161
30162
30163
30164
30165
30166
30167
30168
30169
30170
30171
30172
30173
30174
30175
30176
30177
30178
30179
30180
30181
30182
30183
30184
30185
30186
30187
30188
30189
30190
30191
30192
30193
30194
30195
30196
30197
30198
30199
30200
30201
30202
30203
30204
30205
30206
30207
30208
30209
30210
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30160

def put_text_box_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_text_box_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_text_box_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_text_box_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_text_box_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/textbox/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TextBoxFieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_text_box_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_underline_annotation(name, annotation_id, annotation, opts = {}) ⇒ UnderlineAnnotationResponse

Replace document underline annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30221
30222
30223
30224
30225
30226
30227
30228
30229
30230
30231
30232
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30221

def put_underline_annotation(name, annotation_id, annotation, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_underline_annotation_with_http_info(name, annotation_id, annotation, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_underline_annotation_with_http_info(name, annotation_id, annotation, opts)
    else
      raise
    end
  return data
end

#put_underline_annotation_with_http_info(name, annotation_id, annotation, opts = {}) ⇒ Array<(UnderlineAnnotationResponse, Fixnum, Hash)>

Replace document underline annotation

Parameters:

  • name —

    The document name.

  • annotation_id —

    The annotation ID.

  • annotation —

    Annotation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30243
30244
30245
30246
30247
30248
30249
30250
30251
30252
30253
30254
30255
30256
30257
30258
30259
30260
30261
30262
30263
30264
30265
30266
30267
30268
30269
30270
30271
30272
30273
30274
30275
30276
30277
30278
30279
30280
30281
30282
30283
30284
30285
30286
30287
30288
30289
30290
30291
30292
30293
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30243

def put_underline_annotation_with_http_info(name, annotation_id, annotation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_underline_annotation ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_underline_annotation"
  end
  # verify the required parameter 'annotation_id' is set
  if @api_client.config.client_side_validation && annotation_id.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_id' when calling PdfApi.put_underline_annotation"
  end
  # verify the required parameter 'annotation' is set
  if @api_client.config.client_side_validation && annotation.nil?
    fail ArgumentError, "Missing the required parameter 'annotation' when calling PdfApi.put_underline_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/annotations/underline/{annotationId}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(annotation)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnderlineAnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_underline_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_update_field(name, field_name, field, opts = {}) ⇒ FieldResponse

Update field.

Parameters:

  • name —

    The document name.

  • field_name —

    The name of a field to be updated.

  • field —

    Field with the field data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30304
30305
30306
30307
30308
30309
30310
30311
30312
30313
30314
30315
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30304

def put_update_field(name, field_name, field, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_update_field_with_http_info(name, field_name, field, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_update_field_with_http_info(name, field_name, field, opts)
    else
      raise
    end
  return data
end

#put_update_field_with_http_info(name, field_name, field, opts = {}) ⇒ Array<(FieldResponse, Fixnum, Hash)>

Update field.

Parameters:

  • name —

    The document name.

  • field_name —

    The name of a field to be updated.

  • field —

    Field with the field data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(FieldResponse, Fixnum, Hash)>) —

    FieldResponse data, response status code and response headers



30326
30327
30328
30329
30330
30331
30332
30333
30334
30335
30336
30337
30338
30339
30340
30341
30342
30343
30344
30345
30346
30347
30348
30349
30350
30351
30352
30353
30354
30355
30356
30357
30358
30359
30360
30361
30362
30363
30364
30365
30366
30367
30368
30369
30370
30371
30372
30373
30374
30375
30376
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30326

def put_update_field_with_http_info(name, field_name, field, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_update_field ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_update_field"
  end
  # verify the required parameter 'field_name' is set
  if @api_client.config.client_side_validation && field_name.nil?
    fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_update_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_update_field"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(field)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FieldResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_update_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_update_fields(name, fields, opts = {}) ⇒ FieldsResponse

Update fields.

Parameters:

  • name —

    The document name.

  • fields —

    Fields with the fields data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



30386
30387
30388
30389
30390
30391
30392
30393
30394
30395
30396
30397
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30386

def put_update_fields(name, fields, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_update_fields_with_http_info(name, fields, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_update_fields_with_http_info(name, fields, opts)
    else
      raise
    end
  return data
end

#put_update_fields_with_http_info(name, fields, opts = {}) ⇒ Array<(FieldsResponse, Fixnum, Hash)>

Update fields.

Parameters:

  • name —

    The document name.

  • fields —

    Fields with the fields data.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (Array<(FieldsResponse, Fixnum, Hash)>) —

    FieldsResponse data, response status code and response headers



30407
30408
30409
30410
30411
30412
30413
30414
30415
30416
30417
30418
30419
30420
30421
30422
30423
30424
30425
30426
30427
30428
30429
30430
30431
30432
30433
30434
30435
30436
30437
30438
30439
30440
30441
30442
30443
30444
30445
30446
30447
30448
30449
30450
30451
30452
30453
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30407

def put_update_fields_with_http_info(name, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_update_fields ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_update_fields"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling PdfApi.put_update_fields"
  end
  # resource path
  local_var_path = "/pdf/{name}/fields".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  post_body = @api_client.object_to_http_body(fields)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FieldsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_update_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_web_in_storage_to_pdf(name, url, opts = {}) ⇒ AsposeResponse

Convert web page to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • url —

    Source url

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



30470
30471
30472
30473
30474
30475
30476
30477
30478
30479
30480
30481
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30470

def put_web_in_storage_to_pdf(name, url, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_web_in_storage_to_pdf_with_http_info(name, url, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_web_in_storage_to_pdf_with_http_info(name, url, opts)
    else
      raise
    end
  return data
end

#put_web_in_storage_to_pdf_with_http_info(name, url, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert web page to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • url —

    Source url

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :height (Float) —

    Page height

  • :width (Float) —

    Page width

  • :is_landscape (BOOLEAN) —

    Is page landscaped

  • :margin_left (Float) —

    Page margin left

  • :margin_bottom (Float) —

    Page margin bottom

  • :margin_right (Float) —

    Page margin right

  • :margin_top (Float) —

    Page margin top

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30498
30499
30500
30501
30502
30503
30504
30505
30506
30507
30508
30509
30510
30511
30512
30513
30514
30515
30516
30517
30518
30519
30520
30521
30522
30523
30524
30525
30526
30527
30528
30529
30530
30531
30532
30533
30534
30535
30536
30537
30538
30539
30540
30541
30542
30543
30544
30545
30546
30547
30548
30549
30550
30551
30552
30553
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30498

def put_web_in_storage_to_pdf_with_http_info(name, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_web_in_storage_to_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 PdfApi.put_web_in_storage_to_pdf"
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling PdfApi.put_web_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/web".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'url'] = url
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'isLandscape'] = opts[:'is_landscape'] if !opts[:'is_landscape'].nil?
  query_params[:'marginLeft'] = opts[:'margin_left'] if !opts[:'margin_left'].nil?
  query_params[:'marginBottom'] = opts[:'margin_bottom'] if !opts[:'margin_bottom'].nil?
  query_params[:'marginRight'] = opts[:'margin_right'] if !opts[:'margin_right'].nil?
  query_params[:'marginTop'] = opts[:'margin_top'] if !opts[:'margin_top'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_web_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_xfa_pdf_in_request_to_acro_form(out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:



30562
30563
30564
30565
30566
30567
30568
30569
30570
30571
30572
30573
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30562

def put_xfa_pdf_in_request_to_acro_form(out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_xfa_pdf_in_request_to_acro_form_with_http_info(out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_xfa_pdf_in_request_to_acro_form_with_http_info(out_path, opts)
    else
      raise
    end
  return data
end

#put_xfa_pdf_in_request_to_acro_form_with_http_info(out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.

Parameters:

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :file (File) —

    A file to be converted.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30582
30583
30584
30585
30586
30587
30588
30589
30590
30591
30592
30593
30594
30595
30596
30597
30598
30599
30600
30601
30602
30603
30604
30605
30606
30607
30608
30609
30610
30611
30612
30613
30614
30615
30616
30617
30618
30619
30620
30621
30622
30623
30624
30625
30626
30627
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30582

def put_xfa_pdf_in_request_to_acro_form_with_http_info(out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_xfa_pdf_in_request_to_acro_form ..."
  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 PdfApi.put_xfa_pdf_in_request_to_acro_form"
  end
  # resource path
  local_var_path = "/pdf/convert/xfatoacroform"

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  post_body =  opts[:'file'] if !opts[:'file'].nil?
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_xfa_pdf_in_request_to_acro_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_xfa_pdf_in_storage_to_acro_form(name, out_path, opts = {}) ⇒ AsposeResponse

Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:



30637
30638
30639
30640
30641
30642
30643
30644
30645
30646
30647
30648
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30637

def put_xfa_pdf_in_storage_to_acro_form(name, out_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_xfa_pdf_in_storage_to_acro_form_with_http_info(name, out_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_xfa_pdf_in_storage_to_acro_form_with_http_info(name, out_path, opts)
    else
      raise
    end
  return data
end

#put_xfa_pdf_in_storage_to_acro_form_with_http_info(name, out_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage

Parameters:

  • name —

    The document name.

  • out_path —

    Full resulting filename (ex. /folder1/folder2/result.pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :folder (String) —

    The document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30658
30659
30660
30661
30662
30663
30664
30665
30666
30667
30668
30669
30670
30671
30672
30673
30674
30675
30676
30677
30678
30679
30680
30681
30682
30683
30684
30685
30686
30687
30688
30689
30690
30691
30692
30693
30694
30695
30696
30697
30698
30699
30700
30701
30702
30703
30704
30705
30706
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30658

def put_xfa_pdf_in_storage_to_acro_form_with_http_info(name, out_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_xfa_pdf_in_storage_to_acro_form ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_xfa_pdf_in_storage_to_acro_form"
  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 PdfApi.put_xfa_pdf_in_storage_to_acro_form"
  end
  # resource path
  local_var_path = "/pdf/{name}/convert/xfatoacroform".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'outPath'] = out_path
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_xfa_pdf_in_storage_to_acro_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_xml_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert XML file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :xsl_file_path (String) —

    Full XSL source filename (ex. /folder1/folder2/template.xsl)

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



30717
30718
30719
30720
30721
30722
30723
30724
30725
30726
30727
30728
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30717

def put_xml_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_xml_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_xml_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_xml_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert XML file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xml)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :xsl_file_path (String) —

    Full XSL source filename (ex. /folder1/folder2/template.xsl)

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30739
30740
30741
30742
30743
30744
30745
30746
30747
30748
30749
30750
30751
30752
30753
30754
30755
30756
30757
30758
30759
30760
30761
30762
30763
30764
30765
30766
30767
30768
30769
30770
30771
30772
30773
30774
30775
30776
30777
30778
30779
30780
30781
30782
30783
30784
30785
30786
30787
30788
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30739

def put_xml_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_xml_in_storage_to_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 PdfApi.put_xml_in_storage_to_pdf"
  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 PdfApi.put_xml_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/xml".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'xslFilePath'] = opts[:'xsl_file_path'] if !opts[:'xsl_file_path'].nil?
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_xml_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_xps_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert XPS file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



30798
30799
30800
30801
30802
30803
30804
30805
30806
30807
30808
30809
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30798

def put_xps_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_xps_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_xps_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_xps_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert XPS file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xps)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30819
30820
30821
30822
30823
30824
30825
30826
30827
30828
30829
30830
30831
30832
30833
30834
30835
30836
30837
30838
30839
30840
30841
30842
30843
30844
30845
30846
30847
30848
30849
30850
30851
30852
30853
30854
30855
30856
30857
30858
30859
30860
30861
30862
30863
30864
30865
30866
30867
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30819

def put_xps_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_xps_in_storage_to_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 PdfApi.put_xps_in_storage_to_pdf"
  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 PdfApi.put_xps_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/xps".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_xps_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_xsl_fo_in_storage_to_pdf(name, src_path, opts = {}) ⇒ AsposeResponse

Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xpsfo)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:



30877
30878
30879
30880
30881
30882
30883
30884
30885
30886
30887
30888
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30877

def put_xsl_fo_in_storage_to_pdf(name, src_path, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = put_xsl_fo_in_storage_to_pdf_with_http_info(name, src_path, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = put_xsl_fo_in_storage_to_pdf_with_http_info(name, src_path, opts)
    else
      raise
    end
  return data
end

#put_xsl_fo_in_storage_to_pdf_with_http_info(name, src_path, opts = {}) ⇒ Array<(AsposeResponse, Fixnum, Hash)>

Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.

Parameters:

  • name —

    The document name.

  • src_path —

    Full source filename (ex. /folder1/folder2/template.xpsfo)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dst_folder (String) —

    The destination document folder.

  • :storage (String) —

    The document storage.

Returns:

  • (Array<(AsposeResponse, Fixnum, Hash)>) —

    AsposeResponse data, response status code and response headers



30898
30899
30900
30901
30902
30903
30904
30905
30906
30907
30908
30909
30910
30911
30912
30913
30914
30915
30916
30917
30918
30919
30920
30921
30922
30923
30924
30925
30926
30927
30928
30929
30930
30931
30932
30933
30934
30935
30936
30937
30938
30939
30940
30941
30942
30943
30944
30945
30946
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30898

def put_xsl_fo_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_xsl_fo_in_storage_to_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 PdfApi.put_xsl_fo_in_storage_to_pdf"
  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 PdfApi.put_xsl_fo_in_storage_to_pdf"
  end
  # resource path
  local_var_path = "/pdf/{name}/create/xslfo".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'srcPath'] = src_path
  query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AsposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_xsl_fo_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#storage_exists(storage_name, opts = {}) ⇒ StorageExist

Check if storage exists

Parameters:

  • storage_name —

    Storage name

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



30953
30954
30955
30956
30957
30958
30959
30960
30961
30962
30963
30964
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30953

def storage_exists(storage_name, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = storage_exists_with_http_info(storage_name, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = storage_exists_with_http_info(storage_name, opts)
    else
      raise
    end
  return data
end

#storage_exists_with_http_info(storage_name, opts = {}) ⇒ Array<(StorageExist, Fixnum, Hash)>

Check if storage exists

Parameters:

  • storage_name —

    Storage name

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StorageExist, Fixnum, Hash)>) —

    StorageExist data, response status code and response headers



30971
30972
30973
30974
30975
30976
30977
30978
30979
30980
30981
30982
30983
30984
30985
30986
30987
30988
30989
30990
30991
30992
30993
30994
30995
30996
30997
30998
30999
31000
31001
31002
31003
31004
31005
31006
31007
31008
31009
31010
31011
31012
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 30971

def storage_exists_with_http_info(storage_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.storage_exists"
  end
  # resource path
  local_var_path = "/pdf/storage/{storageName}/exist".sub('{' + 'storageName' + '}', storage_name.to_s)

  # 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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StorageExist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#storage_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_file(path, file, opts = {}) ⇒ FilesUploadResult

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

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:



31021
31022
31023
31024
31025
31026
31027
31028
31029
31030
31031
31032
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 31021

def upload_file(path, file, opts = {})
  @api_client.request_token_if_needed
  data, _status_code, _headers = upload_file_with_http_info(path, file, opts)
  rescue ApiError => error
    if error.code == 401
      @api_client.request_token_if_needed
      data, _status_code, _headers = upload_file_with_http_info(path, file, opts)
    else
      raise
    end
  return data
end

#upload_file_with_http_info(path, file, opts = {}) ⇒ Array<(FilesUploadResult, Fixnum, Hash)>

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

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storage_name (String) —

    Storage name

Returns:

  • (Array<(FilesUploadResult, Fixnum, Hash)>) —

    FilesUploadResult data, response status code and response headers



31041
31042
31043
31044
31045
31046
31047
31048
31049
31050
31051
31052
31053
31054
31055
31056
31057
31058
31059
31060
31061
31062
31063
31064
31065
31066
31067
31068
31069
31070
31071
31072
31073
31074
31075
31076
31077
31078
31079
31080
31081
31082
31083
31084
31085
31086
31087
31088
31089
31090
 
# File 'lib/aspose_pdf_cloud/api/pdf_api.rb', line 31041

def upload_file_with_http_info(path, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.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 PdfApi.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 PdfApi.upload_file"
  end
  # resource path
  local_var_path = "/pdf/storage/file/{path}".sub('{' + 'path' + '}', path.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageName'] = opts[:'storage_name'] if !opts[:'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'])

  # form parameters
  form_params = {}
  # Fix header in file
  post_body = nil
  # Fix header in file
  post_body = file
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])

  # http body (model)
  # Fix header in file
  # post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FilesUploadResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#upload_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end