Class: TestKaferiCloud::PdfApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PdfApi

Returns a new instance of PdfApi.



28
29
30
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

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:



40
41
42
43
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 40

def delete_page(name, page_number, opts = {})
  data, _status_code, _headers = delete_page_with_http_info(name, page_number, opts)
  return data
end

#delete_page_with_http_info(name, page_number, opts = {}) ⇒ Array<(SaaSposeResponse, 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<(SaaSposeResponse, Fixnum, Hash)>) —

    SaaSposeResponse data, response status code and response headers



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 53

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'SaaSposeResponse')
  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 = {}) ⇒ SaaSposeResponse

Delete custom document properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



106
107
108
109
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 106

def delete_properties(name, opts = {})
  data, _status_code, _headers = delete_properties_with_http_info(name, opts)
  return data
end

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

Delete custom document properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    SaaSposeResponse data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 118

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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'SaaSposeResponse')
  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 = {}) ⇒ SaaSposeResponse

Delete document property.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



168
169
170
171
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 168

def delete_property(name, property_name, opts = {})
  data, _status_code, _headers = delete_property_with_http_info(name, property_name, opts)
  return data
end

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

Delete document property.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    SaaSposeResponse data, response status code and response headers



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 181

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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'SaaSposeResponse')
  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

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

Read common document info or convert to some format if the format specified.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :out_path (String) —

    Path to save result

Returns:

  • (File) 


236
237
238
239
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 236

def get_document(name, opts = {})
  data, _status_code, _headers = get_document_with_http_info(name, opts)
  return data
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:



302
303
304
305
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 302

def get_document_attachment_by_index(name, attachment_index, opts = {})
  data, _status_code, _headers = get_document_attachment_by_index_with_http_info(name, attachment_index, opts)
  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



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
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 315

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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:



368
369
370
371
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 368

def get_document_attachments(name, opts = {})
  data, _status_code, _headers = get_document_attachments_with_http_info(name, opts)
  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



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

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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.

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:



429
430
431
432
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 429

def get_document_bookmarks(name, opts = {})
  data, _status_code, _headers = get_document_bookmarks_with_http_info(name, opts)
  return data
end

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

Read document bookmarks.

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<(BookmarksResponse, Fixnum, Hash)>) —

    BookmarksResponse data, response status code and response headers



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 441

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".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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_properties(name, opts = {}) ⇒ DocumentPropertiesResponse

Read document properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



490
491
492
493
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 490

def get_document_properties(name, opts = {})
  data, _status_code, _headers = get_document_properties_with_http_info(name, opts)
  return data
end

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

Read document properties.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    DocumentPropertiesResponse data, response status code and response headers



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 502

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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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
  • property_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

Returns:



552
553
554
555
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 552

def get_document_property(name, property_name, opts = {})
  data, _status_code, _headers = get_document_property_with_http_info(name, property_name, opts)
  return data
end

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

Read document property by name.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    DocumentPropertyResponse data, response status code and response headers



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 565

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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_with_http_info(name, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read common document info or convert to some format if the format specified.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

  • :out_path (String) —

    Path to save result

Returns:

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

    File data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 250

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[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'outPath'] = opts[:'out_path'] if !opts[:'out_path'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_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) 


619
620
621
622
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 619

def get_download_document_attachment_by_index(name, attachment_index, opts = {})
  data, _status_code, _headers = get_download_document_attachment_by_index_with_http_info(name, attachment_index, opts)
  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



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 632

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_field(name, field_name, opts = {}) ⇒ FieldResponse

Get 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:



686
687
688
689
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 686

def get_field(name, field_name, opts = {})
  data, _status_code, _headers = get_field_with_http_info(name, field_name, opts)
  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/

  • 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



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
736
737
738
739
740
741
742
743
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 699

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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:



752
753
754
755
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 752

def get_fields(name, opts = {})
  data, _status_code, _headers = get_fields_with_http_info(name, opts)
  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



764
765
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 764

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_fragment(name, page_number, fragment_number, opts = {}) ⇒ TextItemsResponse

Read page fragment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



816
817
818
819
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 816

def get_fragment(name, page_number, fragment_number, opts = {})
  data, _status_code, _headers = get_fragment_with_http_info(name, page_number, fragment_number, opts)
  return data
end

#get_fragment_text_format(name, page_number, fragment_number, opts = {}) ⇒ TextFormatResponse

Read page fragment text format.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



891
892
893
894
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 891

def get_fragment_text_format(name, page_number, fragment_number, opts = {})
  data, _status_code, _headers = get_fragment_text_format_with_http_info(name, page_number, fragment_number, opts)
  return data
end

#get_fragment_text_format_with_http_info(name, page_number, fragment_number, opts = {}) ⇒ Array<(TextFormatResponse, Fixnum, Hash)>

Read page fragment text format.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextFormatResponse data, response status code and response headers



905
906
907
908
909
910
911
912
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 905

def get_fragment_text_format_with_http_info(name, page_number, fragment_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_fragment_text_format ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_fragment_text_format"
  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_fragment_text_format"
  end
  # verify the required parameter 'fragment_number' is set
  if @api_client.config.client_side_validation && fragment_number.nil?
    fail ArgumentError, "Missing the required parameter 'fragment_number' when calling PdfApi.get_fragment_text_format"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments/{fragmentNumber}/textFormat".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'fragmentNumber' + '}', fragment_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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextFormatResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_fragment_text_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fragment_with_http_info(name, page_number, fragment_number, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Read page fragment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemsResponse data, response status code and response headers



831
832
833
834
835
836
837
838
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 831

def get_fragment_with_http_info(name, page_number, fragment_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_fragment ..."
  end
  # verify the 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_fragment"
  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_fragment"
  end
  # verify the required parameter 'fragment_number' is set
  if @api_client.config.client_side_validation && fragment_number.nil?
    fail ArgumentError, "Missing the required parameter 'fragment_number' when calling PdfApi.get_fragment"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments/{fragmentNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'fragmentNumber' + '}', fragment_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = opts[:'with_empty'] if !opts[:'with_empty'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_fragment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fragments(name, page_number, opts = {}) ⇒ TextItemsResponse

Read page fragments.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



964
965
966
967
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 964

def get_fragments(name, page_number, opts = {})
  data, _status_code, _headers = get_fragments_with_http_info(name, page_number, opts)
  return data
end

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

Read page fragments.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemsResponse data, response status code and response headers



978
979
980
981
982
983
984
985
986
987
988
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 978

def get_fragments_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_fragments ..."
  end
  # verify the 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_fragments"
  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_fragments"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = opts[:'with_empty'] if !opts[:'with_empty'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_fragments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image(name, page_number, image_number, opts = {}) ⇒ File

Read document image by number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • image_number —

    The image format.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

  • (File) 


1034
1035
1036
1037
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1034

def get_image(name, page_number, image_number, opts = {})
  data, _status_code, _headers = get_image_with_http_info(name, page_number, image_number, opts)
  return data
end

#get_image_with_http_info(name, page_number, image_number, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Read document image by number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • image_number —

    The image format.

  • 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



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1048

def get_image_with_http_info(name, page_number, image_number, 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 '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_image"
  end
  # verify the required parameter 'image_number' is set
  if @api_client.config.client_side_validation && image_number.nil?
    fail ArgumentError, "Missing the required parameter 'image_number' when calling PdfApi.get_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/{imageNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'imageNumber' + '}', image_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(['multipart/form-data'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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\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:



1106
1107
1108
1109
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1106

def get_images(name, page_number, opts = {})
  data, _status_code, _headers = get_images_with_http_info(name, page_number, opts)
  return data
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



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1119

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_page(name, page_number, opts = {}) ⇒ File

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:

  • (File) 


1173
1174
1175
1176
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1173

def get_page(name, page_number, opts = {})
  data, _status_code, _headers = get_page_with_http_info(name, page_number, opts)
  return data
end

#get_page_annotation(name, page_number, annotation_number, opts = {}) ⇒ AnnotationResponse

Read document page annotation by its number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotation_number —

    The annotation number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1241
1242
1243
1244
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1241

def get_page_annotation(name, page_number, annotation_number, opts = {})
  data, _status_code, _headers = get_page_annotation_with_http_info(name, page_number, annotation_number, opts)
  return data
end

#get_page_annotation_with_http_info(name, page_number, annotation_number, opts = {}) ⇒ Array<(AnnotationResponse, Fixnum, Hash)>

Read document page annotation by its number.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • annotation_number —

    The annotation number.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    AnnotationResponse data, response status code and response headers



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1255

def get_page_annotation_with_http_info(name, page_number, annotation_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_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_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_annotation"
  end
  # verify the required parameter 'annotation_number' is set
  if @api_client.config.client_side_validation && annotation_number.nil?
    fail ArgumentError, "Missing the required parameter 'annotation_number' when calling PdfApi.get_page_annotation"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/annotations/{annotationNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'annotationNumber' + '}', annotation_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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'AnnotationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page_annotations(name, page_number, opts = {}) ⇒ AnnotationsResponse

Read documant page 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:



1313
1314
1315
1316
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1313

def get_page_annotations(name, page_number, opts = {})
  data, _status_code, _headers = get_page_annotations_with_http_info(name, page_number, opts)
  return data
end

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

Read documant page 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<(AnnotationsResponse, Fixnum, Hash)>) —

    AnnotationsResponse data, response status code and response headers



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1326

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'AnnotationsResponse')
  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_link_annotation_by_index(name, page_number, link_index, opts = {}) ⇒ LinkAnnotationResponse

Read document page link annotation by its index.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • link_index —

    The link index.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



1381
1382
1383
1384
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1381

def get_page_link_annotation_by_index(name, page_number, link_index, opts = {})
  data, _status_code, _headers = get_page_link_annotation_by_index_with_http_info(name, page_number, link_index, opts)
  return data
end

#get_page_link_annotation_by_index_with_http_info(name, page_number, link_index, opts = {}) ⇒ Array<(LinkAnnotationResponse, Fixnum, Hash)>

Read document page link annotation by its index.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • link_index —

    The link index.

  • 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



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1395

def get_page_link_annotation_by_index_with_http_info(name, page_number, link_index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_page_link_annotation_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_page_link_annotation_by_index"
  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_by_index"
  end
  # verify the required parameter 'link_index' is set
  if @api_client.config.client_side_validation && link_index.nil?
    fail ArgumentError, "Missing the required parameter 'link_index' when calling PdfApi.get_page_link_annotation_by_index"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/links/{linkIndex}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'linkIndex' + '}', link_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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_by_index\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:



1453
1454
1455
1456
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1453

def get_page_link_annotations(name, page_number, opts = {})
  data, _status_code, _headers = get_page_link_annotations_with_http_info(name, page_number, opts)
  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



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
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1466

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_text(name, page_number, x, y, width, height, opts = {}) ⇒ TextRectsResponse

Read page text items.

Parameters:

  • name
  • page_number
  • x
  • y
  • width
  • height
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (Array<String>)
  • :regex (String)
  • :storage (String)
  • :folder (String)

Returns:



1526
1527
1528
1529
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1526

def get_page_text(name, page_number, x, y, width, height, opts = {})
  data, _status_code, _headers = get_page_text_with_http_info(name, page_number, x, y, width, height, opts)
  return data
end

#get_page_text_items(name, page_number, opts = {}) ⇒ TextItemsResponse

Read page text items.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



1622
1623
1624
1625
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1622

def get_page_text_items(name, page_number, opts = {})
  data, _status_code, _headers = get_page_text_items_with_http_info(name, page_number, opts)
  return data
end

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

Read page text items.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemsResponse data, response status code and response headers



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1636

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

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = opts[:'with_empty'] if !opts[:'with_empty'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_page_text_items\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, x, y, width, height, opts = {}) ⇒ Array<(TextRectsResponse, Fixnum, Hash)>

Read page text items.

Parameters:

  • name
  • page_number
  • x
  • y
  • width
  • height
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (Array<String>)
  • :regex (String)
  • :storage (String)
  • :folder (String)

Returns:

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

    TextRectsResponse data, response status code and response headers



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
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1545

def get_page_text_with_http_info(name, page_number, x, y, width, height, 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 'x' is set
  if @api_client.config.client_side_validation && x.nil?
    fail ArgumentError, "Missing the required parameter 'x' when calling PdfApi.get_page_text"
  end
  # verify the required parameter 'y' is set
  if @api_client.config.client_side_validation && y.nil?
    fail ArgumentError, "Missing the required parameter 'y' when calling PdfApi.get_page_text"
  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.get_page_text"
  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.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[:'X'] = x
  query_params[:'Y'] = y
  query_params[:'Width'] = width
  query_params[:'Height'] = height
  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[:'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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_with_http_info(name, page_number, opts = {}) ⇒ Array<(File, 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<(File, Fixnum, Hash)>) —

    File data, response status code and response headers



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1186

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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\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:



1690
1691
1692
1693
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1690

def get_pages(name, opts = {})
  data, _status_code, _headers = get_pages_with_http_info(name, opts)
  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



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1702

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_segment(name, page_number, fragment_number, segment_number, opts = {}) ⇒ TextItemResponse

Read segment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



1754
1755
1756
1757
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1754

def get_segment(name, page_number, fragment_number, segment_number, opts = {})
  data, _status_code, _headers = get_segment_with_http_info(name, page_number, fragment_number, segment_number, opts)
  return data
end

#get_segment_text_format(name, page_number, fragment_number, segment_number, opts = {}) ⇒ TextFormatResponse

Read segment text format.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



1833
1834
1835
1836
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1833

def get_segment_text_format(name, page_number, fragment_number, segment_number, opts = {})
  data, _status_code, _headers = get_segment_text_format_with_http_info(name, page_number, fragment_number, segment_number, opts)
  return data
end

#get_segment_text_format_with_http_info(name, page_number, fragment_number, segment_number, opts = {}) ⇒ Array<(TextFormatResponse, Fixnum, Hash)>

Read segment text format.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextFormatResponse data, response status code and response headers



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
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1848

def get_segment_text_format_with_http_info(name, page_number, fragment_number, segment_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_segment_text_format ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_segment_text_format"
  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_segment_text_format"
  end
  # verify the required parameter 'fragment_number' is set
  if @api_client.config.client_side_validation && fragment_number.nil?
    fail ArgumentError, "Missing the required parameter 'fragment_number' when calling PdfApi.get_segment_text_format"
  end
  # verify the required parameter 'segment_number' is set
  if @api_client.config.client_side_validation && segment_number.nil?
    fail ArgumentError, "Missing the required parameter 'segment_number' when calling PdfApi.get_segment_text_format"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments/{fragmentNumber}/segments/{segmentNumber}/textformat".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'fragmentNumber' + '}', fragment_number.to_s).sub('{' + 'segmentNumber' + '}', segment_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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextFormatResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_segment_text_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_segment_with_http_info(name, page_number, fragment_number, segment_number, opts = {}) ⇒ Array<(TextItemResponse, Fixnum, Hash)>

Read segment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemResponse data, response status code and response headers



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
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1769

def get_segment_with_http_info(name, page_number, fragment_number, segment_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_segment ..."
  end
  # verify the 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_segment"
  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_segment"
  end
  # verify the required parameter 'fragment_number' is set
  if @api_client.config.client_side_validation && fragment_number.nil?
    fail ArgumentError, "Missing the required parameter 'fragment_number' when calling PdfApi.get_segment"
  end
  # verify the required parameter 'segment_number' is set
  if @api_client.config.client_side_validation && segment_number.nil?
    fail ArgumentError, "Missing the required parameter 'segment_number' when calling PdfApi.get_segment"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments/{fragmentNumber}/segments/{segmentNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'fragmentNumber' + '}', fragment_number.to_s).sub('{' + 'segmentNumber' + '}', segment_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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_segments(name, page_number, fragment_number, opts = {}) ⇒ TextItemsResponse

Read fragment segments.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



1912
1913
1914
1915
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1912

def get_segments(name, page_number, fragment_number, opts = {})
  data, _status_code, _headers = get_segments_with_http_info(name, page_number, fragment_number, opts)
  return data
end

#get_segments_with_http_info(name, page_number, fragment_number, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Read fragment segments.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemsResponse data, response status code and response headers



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
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1927

def get_segments_with_http_info(name, page_number, fragment_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.get_segments ..."
  end
  # verify the 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_segments"
  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_segments"
  end
  # verify the required parameter 'fragment_number' is set
  if @api_client.config.client_side_validation && fragment_number.nil?
    fail ArgumentError, "Missing the required parameter 'fragment_number' when calling PdfApi.get_segments"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/fragments/{fragmentNumber}/segments".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'fragmentNumber' + '}', fragment_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = opts[:'with_empty'] if !opts[:'with_empty'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_text(name, x, y, width, height, opts = {}) ⇒ TextRectsResponse

Read document text.

Parameters:

  • name
  • x
  • y
  • width
  • height
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (Array<String>)
  • :regex (String)
  • :storage (String)
  • :folder (String)

Returns:



1991
1992
1993
1994
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 1991

def get_text(name, x, y, width, height, opts = {})
  data, _status_code, _headers = get_text_with_http_info(name, x, y, width, height, opts)
  return data
end

#get_text_items(name, opts = {}) ⇒ TextItemsResponse

Read document text items.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2081
2082
2083
2084
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2081

def get_text_items(name, opts = {})
  data, _status_code, _headers = get_text_items_with_http_info(name, opts)
  return data
end

#get_text_items_with_http_info(name, opts = {}) ⇒ Array<(TextItemsResponse, Fixnum, Hash)>

Read document text items.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TextItemsResponse data, response status code and response headers



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2094

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

  # query parameters
  query_params = {}
  query_params[:'withEmpty'] = opts[:'with_empty'] if !opts[:'with_empty'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'TextItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#get_text_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_text_with_http_info(name, x, y, width, height, opts = {}) ⇒ Array<(TextRectsResponse, Fixnum, Hash)>

Read document text.

Parameters:

  • name
  • x
  • y
  • width
  • height
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (Array<String>)
  • :regex (String)
  • :storage (String)
  • :folder (String)

Returns:

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

    TextRectsResponse data, response status code and response headers



2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2009

def get_text_with_http_info(name, x, y, width, height, 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 'x' is set
  if @api_client.config.client_side_validation && x.nil?
    fail ArgumentError, "Missing the required parameter 'x' when calling PdfApi.get_text"
  end
  # verify the required parameter 'y' is set
  if @api_client.config.client_side_validation && y.nil?
    fail ArgumentError, "Missing the required parameter 'y' when calling PdfApi.get_text"
  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.get_text"
  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.get_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/text".sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'X'] = x
  query_params[:'Y'] = y
  query_params[:'Width'] = width
  query_params[:'Height'] = height
  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[:'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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_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:



2144
2145
2146
2147
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2144

def get_words_per_page(name, opts = {})
  data, _status_code, _headers = get_words_per_page_with_http_info(name, opts)
  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



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

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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

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

Append document to existing one.

Parameters:

  • name —

    The original document name.

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

    the optional parameters

Options Hash (opts):

  • :append_document (AppendDocument) —

    with the append document data.

  • :append_file (String) —

    Append file server path.

  • :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:



2209
2210
2211
2212
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2209

def post_append_document(name, opts = {})
  data, _status_code, _headers = post_append_document_with_http_info(name, opts)
  return data
end

#post_append_document_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Append document to existing one.

Parameters:

  • name —

    The original document name.

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

    the optional parameters

Options Hash (opts):

  • :append_document (AppendDocument) —

    with the append document data.

  • :append_file (String) —

    Append file server path.

  • :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



2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2225

def post_append_document_with_http_info(name, 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
  # resource path
  local_var_path = "/pdf/{name}/appendDocument".sub('{' + 'name' + '}', name.to_s)

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

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'append_document'])
  auth_names = []
  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_create_field(name, page, opts = {}) ⇒ SaaSposeResponse

Create field.

Parameters:

  • name —

    The document name.

  • page —

    Document page number.

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

    the optional parameters

Options Hash (opts):

  • :field (Field) —

    with the field data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2279
2280
2281
2282
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2279

def post_create_field(name, page, opts = {})
  data, _status_code, _headers = post_create_field_with_http_info(name, page, opts)
  return data
end

#post_create_field_with_http_info(name, page, opts = {}) ⇒ Array<(SaaSposeResponse, Fixnum, Hash)>

Create field.

Parameters:

  • name —

    The document name.

  • page —

    Document page number.

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

    the optional parameters

Options Hash (opts):

  • :field (Field) —

    with the field data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



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

def post_create_field_with_http_info(name, page, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'field'])
  auth_names = []
  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 => 'SaaSposeResponse')
  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_document_replace_text(name, text_replace, opts = {}) ⇒ DocumentTextReplaceResponse

Document’s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2348
2349
2350
2351
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2348

def post_document_replace_text(name, text_replace, opts = {})
  data, _status_code, _headers = post_document_replace_text_with_http_info(name, text_replace, opts)
  return data
end

#post_document_replace_text_list(name, text_replace_list_request, opts = {}) ⇒ DocumentTextReplaceResponse

Document’s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2415
2416
2417
2418
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2415

def post_document_replace_text_list(name, text_replace_list_request, opts = {})
  data, _status_code, _headers = post_document_replace_text_list_with_http_info(name, text_replace_list_request, opts)
  return data
end

#post_document_replace_text_list_with_http_info(name, text_replace_list_request, opts = {}) ⇒ Array<(DocumentTextReplaceResponse, Fixnum, Hash)>

Document&#39;s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2428

def post_document_replace_text_list_with_http_info(name, text_replace_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_replace_text_list ..."
  end
  # verify the 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_replace_text_list"
  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_document_replace_text_list"
  end
  # resource path
  local_var_path = "/pdf/{name}/replaceTextList".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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace_list_request)
  auth_names = []
  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 => 'DocumentTextReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_document_replace_text_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_document_replace_text_with_http_info(name, text_replace, opts = {}) ⇒ Array<(DocumentTextReplaceResponse, Fixnum, Hash)>

Document&#39;s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2361

def post_document_replace_text_with_http_info(name, text_replace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_document_replace_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.post_document_replace_text"
  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_replace_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/replaceText".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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace)
  auth_names = []
  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 => 'DocumentTextReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_document_replace_text\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:



2482
2483
2484
2485
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2482

def post_document_text_replace(name, text_replace, opts = {})
  data, _status_code, _headers = post_document_text_replace_with_http_info(name, text_replace, opts)
  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



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2495

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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace)
  auth_names = []
  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_move_page(name, page_number, new_index, opts = {}) ⇒ SaaSposeResponse

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:



2550
2551
2552
2553
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2550

def post_move_page(name, page_number, new_index, opts = {})
  data, _status_code, _headers = post_move_page_with_http_info(name, page_number, new_index, opts)
  return data
end

#post_move_page_with_http_info(name, page_number, new_index, opts = {}) ⇒ Array<(SaaSposeResponse, 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<(SaaSposeResponse, Fixnum, Hash)>) —

    SaaSposeResponse data, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2564

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'SaaSposeResponse')
  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, opts = {}) ⇒ SaaSposeResponse

Optimize document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :options (OptimizeOptions) —

    The optimization options.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2623
2624
2625
2626
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2623

def post_optimize_document(name, opts = {})
  data, _status_code, _headers = post_optimize_document_with_http_info(name, opts)
  return data
end

#post_optimize_document_with_http_info(name, opts = {}) ⇒ Array<(SaaSposeResponse, Fixnum, Hash)>

Optimize document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :options (OptimizeOptions) —

    The optimization options.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2636

def post_optimize_document_with_http_info(name, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'options'])
  auth_names = []
  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 => 'SaaSposeResponse')
  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_page_replace_text(name, page_number, text_replace, opts = {}) ⇒ PageTextReplaceResponse

Page’s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2687
2688
2689
2690
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2687

def post_page_replace_text(name, page_number, text_replace, opts = {})
  data, _status_code, _headers = post_page_replace_text_with_http_info(name, page_number, text_replace, opts)
  return data
end

#post_page_replace_text_list(name, page_number, text_replace_list_request, opts = {}) ⇒ PageTextReplaceResponse

Page’s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



2760
2761
2762
2763
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2760

def post_page_replace_text_list(name, page_number, text_replace_list_request, opts = {})
  data, _status_code, _headers = post_page_replace_text_list_with_http_info(name, page_number, text_replace_list_request, opts)
  return data
end

#post_page_replace_text_list_with_http_info(name, page_number, text_replace_list_request, opts = {}) ⇒ Array<(PageTextReplaceResponse, Fixnum, Hash)>

Page&#39;s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    PageTextReplaceResponse data, response status code and response headers



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
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2774

def post_page_replace_text_list_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_replace_text_list ..."
  end
  # verify the 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_replace_text_list"
  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_replace_text_list"
  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_replace_text_list"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/replaceTextList".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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace_list_request)
  auth_names = []
  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 => 'PageTextReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_replace_text_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_page_replace_text_with_http_info(name, page_number, text_replace, opts = {}) ⇒ Array<(PageTextReplaceResponse, Fixnum, Hash)>

Page&#39;s replace text method. Deprecated

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    PageTextReplaceResponse data, response status code and response headers



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2701

def post_page_replace_text_with_http_info(name, page_number, text_replace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_page_replace_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.post_page_replace_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.post_page_replace_text"
  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_page_replace_text"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/replaceText".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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace)
  auth_names = []
  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 => 'PageTextReplaceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_page_replace_text\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:



2833
2834
2835
2836
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2833

def post_page_text_replace(name, page_number, text_replace_list_request, opts = {})
  data, _status_code, _headers = post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, opts)
  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



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
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2847

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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text_replace_list_request)
  auth_names = []
  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_replace_image(name, page_number, image_number, opts = {}) ⇒ ImageResponse

Replace document image.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • image_number —

    The image number.

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

    the optional parameters

Options Hash (opts):

  • :image_file (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2907
2908
2909
2910
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2907

def post_replace_image(name, page_number, image_number, opts = {})
  data, _status_code, _headers = post_replace_image_with_http_info(name, page_number, image_number, opts)
  return data
end

#post_replace_image_with_http_info(name, page_number, image_number, opts = {}) ⇒ Array<(ImageResponse, Fixnum, Hash)>

Replace document image.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • image_number —

    The image number.

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

    the optional parameters

Options Hash (opts):

  • :image_file (String) —

    Path to image file if specified. Request content is used otherwise.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    ImageResponse data, response status code and response headers



2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2922

def post_replace_image_with_http_info(name, page_number, image_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.post_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.post_replace_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_replace_image"
  end
  # verify the required parameter 'image_number' is set
  if @api_client.config.client_side_validation && image_number.nil?
    fail ArgumentError, "Missing the required parameter 'image_number' when calling PdfApi.post_replace_image"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/images/{imageNumber}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'imageNumber' + '}', image_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'imageFile'] = opts[:'image_file'] if !opts[:'image_file'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'ImageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#post_replace_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_sign_document(name, opts = {}) ⇒ SaaSposeResponse

Sign document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :signature (Signature) —

    Signature object containing signature data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



2981
2982
2983
2984
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2981

def post_sign_document(name, opts = {})
  data, _status_code, _headers = post_sign_document_with_http_info(name, opts)
  return data
end

#post_sign_document_with_http_info(name, opts = {}) ⇒ Array<(SaaSposeResponse, Fixnum, Hash)>

Sign document.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :signature (Signature) —

    Signature object containing signature data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 2994

def post_sign_document_with_http_info(name, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'signature'])
  auth_names = []
  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 => 'SaaSposeResponse')
  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, opts = {}) ⇒ SaaSposeResponse

Sign page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :signature (Signature) —

    Signature object containing signature data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3045
3046
3047
3048
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3045

def post_sign_page(name, page_number, opts = {})
  data, _status_code, _headers = post_sign_page_with_http_info(name, page_number, opts)
  return data
end

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

Sign page.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

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

    the optional parameters

Options Hash (opts):

  • :signature (Signature) —

    Signature object containing signature data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



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
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3059

def post_sign_page_with_http_info(name, page_number, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'signature'])
  auth_names = []
  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 => 'SaaSposeResponse')
  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_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.

Returns:



3115
3116
3117
3118
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3115

def post_split_document(name, opts = {})
  data, _status_code, _headers = post_split_document_with_http_info(name, opts)
  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.

Returns:

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

    SplitResultResponse data, response status code and response headers



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
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3130

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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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

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



3182
3183
3184
3185
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3182

def put_add_new_page(name, opts = {})
  data, _status_code, _headers = put_add_new_page_with_http_info(name, opts)
  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



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

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_paragraph(name, page_number, opts = {}) ⇒ SaaSposeResponse

Add text to PDF document page. Deprecate

Parameters:

  • name —

    Name of the document to which text should be added.

  • page_number —

    Number of page (starting with 1) to which text should be added.

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

    the optional parameters

Options Hash (opts):

  • :paragraph (Paragraph) —

    Paragraph data.

  • :storage (String) —

    File storage to be used.

  • :folder (String) —

    Document folder.

Returns:



3245
3246
3247
3248
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3245

def put_add_paragraph(name, page_number, opts = {})
  data, _status_code, _headers = put_add_paragraph_with_http_info(name, page_number, opts)
  return data
end

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

Add text to PDF document page. Deprecate

Parameters:

  • name —

    Name of the document to which text should be added.

  • page_number —

    Number of page (starting with 1) to which text should be added.

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

    the optional parameters

Options Hash (opts):

  • :paragraph (Paragraph) —

    Paragraph data.

  • :storage (String) —

    File storage to be used.

  • :folder (String) —

    Document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



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

def put_add_paragraph_with_http_info(name, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_add_paragraph ..."
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_add_paragraph"
  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_paragraph"
  end
  # resource path
  local_var_path = "/pdf/{name}/pages/{pageNumber}/paragraph".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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'paragraph'])
  auth_names = []
  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 => 'SaaSposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_add_paragraph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_add_text(name, page_number, opts = {}) ⇒ SaaSposeResponse

Add text to PDF document page.

Parameters:

  • name —

    Name of the document to which text should be added.

  • page_number —

    Number of page (starting with 1) to which text should be added.

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

    the optional parameters

Options Hash (opts):

  • :paragraph (Paragraph) —

    Paragraph data.

  • :storage (String) —

    File storage to be used.

  • :folder (String) —

    Document folder.

Returns:



3314
3315
3316
3317
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3314

def put_add_text(name, page_number, opts = {})
  data, _status_code, _headers = put_add_text_with_http_info(name, page_number, opts)
  return data
end

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

Add text to PDF document page.

Parameters:

  • name —

    Name of the document to which text should be added.

  • page_number —

    Number of page (starting with 1) to which text should be added.

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

    the optional parameters

Options Hash (opts):

  • :paragraph (Paragraph) —

    Paragraph data.

  • :storage (String) —

    File storage to be used.

  • :folder (String) —

    Document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3328

def put_add_text_with_http_info(name, page_number, 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
  # 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[:'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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'paragraph'])
  auth_names = []
  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 => 'SaaSposeResponse')
  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_convert_document(opts = {}) ⇒ File

Convert document from request content to format specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :url (String)
  • :out_path (String) —

    Path to save result

Returns:

  • (File) 


3381
3382
3383
3384
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3381

def put_convert_document(opts = {})
  data, _status_code, _headers = put_convert_document_with_http_info(opts)
  return data
end

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

Convert document from request content to format specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) —

    The format to convert.

  • :url (String)
  • :out_path (String) —

    Path to save result

Returns:

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

    File data, response status code and response headers



3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3393

def put_convert_document_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PdfApi.put_convert_document ..."
  end
  # resource path
  local_var_path = "/pdf/convert"

  # query parameters
  query_params = {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?
  query_params[:'outPath'] = opts[:'out_path'] if !opts[:'out_path'].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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_convert_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create new document.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :template_file (String) —

    The template file server path if defined.

  • :data_file (String) —

    The data file path (for xml template only).

  • :template_type (String) —

    The template type, can be xml, html, bmp, jpg, png, tiff, emf, cgm, tex.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

  • :url (String) —

    The url of web page if defined.

  • :fit_size (BOOLEAN) —

    Draw a margin around content in resulting pdf. (default to false)

Returns:



3444
3445
3446
3447
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3444

def put_create_document(name, opts = {})
  data, _status_code, _headers = put_create_document_with_http_info(name, opts)
  return data
end

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

Create new document from images.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :images (ImagesListRequest) —

    The images file paths set.

  • :ocr (BOOLEAN) —

    To create OCR layer for image or not. (default to false)

  • :ocr_lang (String) —

    The language which is defined for OCR engine. Default is eng. (default to eng)

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:



3518
3519
3520
3521
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3518

def put_create_document_from_images(name, opts = {})
  data, _status_code, _headers = put_create_document_from_images_with_http_info(name, opts)
  return data
end

#put_create_document_from_images_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Create new document from images.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :images (ImagesListRequest) —

    The images file paths set.

  • :ocr (BOOLEAN) —

    To create OCR layer for image or not.

  • :ocr_lang (String) —

    The language which is defined for OCR engine. Default is eng.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

Returns:

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

    DocumentResponse data, response status code and response headers



3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3533

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

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

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'images'])
  auth_names = []
  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_from_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_create_document_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Create new document.

Parameters:

  • name —

    The new document name.

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

    the optional parameters

Options Hash (opts):

  • :template_file (String) —

    The template file server path if defined.

  • :data_file (String) —

    The data file path (for xml template only).

  • :template_type (String) —

    The template type, can be xml, html, bmp, jpg, png, tiff, emf, cgm, tex.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The new document folder.

  • :url (String) —

    The url of web page if defined.

  • :fit_size (BOOLEAN) —

    Draw a margin around content in resulting pdf.

Returns:

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

    DocumentResponse data, response status code and response headers



3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3461

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[:'templateFile'] = opts[:'template_file'] if !opts[:'template_file'].nil?
  query_params[:'dataFile'] = opts[:'data_file'] if !opts[:'data_file'].nil?
  query_params[:'templateType'] = opts[:'template_type'] if !opts[:'template_type'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
  query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?
  query_params[:'fitSize'] = opts[:'fit_size'] if !opts[:'fit_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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_document_save_as_tiff(name, opts = {}) ⇒ SaaSposeResponse

Save document as Tiff image.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :export_options (TiffExportOptions) —

    with tiff export options.

  • :result_file (String) —

    The resulting file.

  • :brightness (Float) —

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

  • :folder (String) —

    The document folder.

Returns:



3601
3602
3603
3604
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3601

def put_document_save_as_tiff(name, opts = {})
  data, _status_code, _headers = put_document_save_as_tiff_with_http_info(name, opts)
  return data
end

#put_document_save_as_tiff_with_http_info(name, opts = {}) ⇒ Array<(SaaSposeResponse, Fixnum, Hash)>

Save document as Tiff image.

Parameters:

  • name —

    The document name.

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

    the optional parameters

Options Hash (opts):

  • :export_options (TiffExportOptions) —

    with tiff export options.

  • :result_file (String) —

    The resulting file.

  • :brightness (Float) —

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

  • :folder (String) —

    The document folder.

Returns:

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

    SaaSposeResponse data, response status code and response headers



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
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3630

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

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

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'export_options'])
  auth_names = []
  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 => 'SaaSposeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PdfApi#put_document_save_as_tiff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Merge a list of documents.

Parameters:

  • name —

    Resulting documen name.

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

    the optional parameters

Options Hash (opts):

  • :merge_documents (MergeDocuments) —

    with a list of documents.

  • :storage (String) —

    Resulting document storage.

  • :folder (String) —

    Resulting document folder.

Returns:



3696
3697
3698
3699
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3696

def put_merge_documents(name, opts = {})
  data, _status_code, _headers = put_merge_documents_with_http_info(name, opts)
  return data
end

#put_merge_documents_with_http_info(name, opts = {}) ⇒ Array<(DocumentResponse, Fixnum, Hash)>

Merge a list of documents.

Parameters:

  • name —

    Resulting documen name.

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

    the optional parameters

Options Hash (opts):

  • :merge_documents (MergeDocuments) —

    with a list of documents.

  • :storage (String) —

    Resulting document storage.

  • :folder (String) —

    Resulting document folder.

Returns:

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

    DocumentResponse data, response status code and response headers



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

def put_merge_documents_with_http_info(name, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'merge_documents'])
  auth_names = []
  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_page_add_stamp(name, page_number, stamp, opts = {}) ⇒ SaaSposeResponse

Add page stamp.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • stamp —

    with data.

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

    the optional parameters

Options Hash (opts):

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3760
3761
3762
3763
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3760

def put_page_add_stamp(name, page_number, stamp, opts = {})
  data, _status_code, _headers = put_page_add_stamp_with_http_info(name, page_number, stamp, opts)
  return data
end

#put_page_add_stamp_with_http_info(name, page_number, stamp, opts = {}) ⇒ Array<(SaaSposeResponse, Fixnum, Hash)>

Add page stamp.

Parameters:

  • name —

    The document name.

  • page_number —

    The page number.

  • 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<(SaaSposeResponse, Fixnum, Hash)>) —

    SaaSposeResponse data, response status code and response headers



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
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3774

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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stamp)
  auth_names = []
  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 => 'SaaSposeResponse')
  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_searchable_document(name, opts = {}) ⇒ SaaSposeResponse

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:



3832
3833
3834
3835
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3832

def put_searchable_document(name, opts = {})
  data, _status_code, _headers = put_searchable_document_with_http_info(name, opts)
  return data
end

#put_searchable_document_with_http_info(name, opts = {}) ⇒ Array<(SaaSposeResponse, 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<(SaaSposeResponse, Fixnum, Hash)>) —

    SaaSposeResponse data, response status code and response headers



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/test_kaferi_cloud/api/pdf_api.rb', line 3845

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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'SaaSposeResponse')
  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, opts = {}) ⇒ DocumentPropertyResponse

Add/update document property.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3897
3898
3899
3900
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3897

def put_set_property(name, property_name, opts = {})
  data, _status_code, _headers = put_set_property_with_http_info(name, property_name, opts)
  return data
end

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

Add/update document property.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DocumentPropertyResponse data, response status code and response headers



3911
3912
3913
3914
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
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3911

def put_set_property_with_http_info(name, property_name, 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
  # 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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'property'])
  auth_names = []
  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_update_field(name, field_name, opts = {}) ⇒ FieldResponse

Update field.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name/

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

    the optional parameters

Options Hash (opts):

  • :field (Field) —

    with the field data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:



3966
3967
3968
3969
 
# File 'lib/test_kaferi_cloud/api/pdf_api.rb', line 3966

def put_update_field(name, field_name, opts = {})
  data, _status_code, _headers = put_update_field_with_http_info(name, field_name, opts)
  return data
end

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

Update field.

Parameters:

  • name —

    The document name.

  • field_name —

    The field name/

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

    the optional parameters

Options Hash (opts):

  • :field (Field) —

    with the field data.

  • :storage (String) —

    The document storage.

  • :folder (String) —

    The document folder.

Returns:

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

    FieldResponse data, response status code and response headers



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

def put_update_field_with_http_info(name, field_name, 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
  # 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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'field'])
  auth_names = []
  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