pdf4me 1.0.1 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (291) hide show
  1. checksums.yaml +4 -4
  2. data/{LICENSE → LICENSE.txt} +6 -6
  3. data/README.md +124 -395
  4. data/lib/pdf4me.rb +40 -110
  5. data/lib/pdf4me/actions/complex_action.rb +64 -0
  6. data/lib/pdf4me/actions/convert_file_to_pdf.rb +30 -0
  7. data/lib/pdf4me/actions/convert_to_pdf.rb +14 -0
  8. data/lib/pdf4me/actions/create_pdf_a.rb +29 -0
  9. data/lib/pdf4me/actions/create_thumbnail.rb +55 -0
  10. data/lib/pdf4me/actions/extract_pages.rb +49 -0
  11. data/lib/pdf4me/actions/merge_two_pdfs.rb +34 -0
  12. data/lib/pdf4me/actions/optimize.rb +10 -0
  13. data/lib/pdf4me/actions/optimize_by_profile.rb +42 -0
  14. data/lib/pdf4me/actions/split_by_page_nr.rb +55 -0
  15. data/lib/pdf4me/actions/text_stamp.rb +63 -0
  16. data/lib/pdf4me/actions/wrapper_action.rb +65 -0
  17. data/lib/pdf4me/client.rb +87 -0
  18. data/lib/pdf4me/configuration.rb +9 -88
  19. data/lib/pdf4me/exceptions.rb +26 -0
  20. data/lib/pdf4me/models/base.rb +26 -0
  21. data/lib/pdf4me/models/convert_to_pdf_action.rb +26 -246
  22. data/lib/pdf4me/models/convert_to_pdf_res.rb +5 -185
  23. data/lib/pdf4me/models/doc_log.rb +12 -257
  24. data/lib/pdf4me/models/doc_metadata.rb +13 -282
  25. data/lib/pdf4me/models/document.rb +14 -282
  26. data/lib/pdf4me/models/notification.rb +8 -191
  27. data/lib/pdf4me/models/optimize_action.rb +72 -508
  28. data/lib/pdf4me/models/optimize_res.rb +5 -195
  29. data/lib/pdf4me/models/page.rb +12 -254
  30. data/lib/pdf4me/utils/assigner.rb +10 -0
  31. data/lib/pdf4me/utils/serializer.rb +43 -0
  32. data/lib/pdf4me/version.rb +1 -13
  33. data/spec/actions/create_pdf_a_spec.rb +21 -0
  34. data/spec/actions/wrapper_action_spec.rb +24 -0
  35. data/spec/files/4.pdf +0 -0
  36. data/spec/spec_helper.rb +17 -100
  37. metadata +70 -421
  38. data/Gemfile +0 -7
  39. data/Rakefile +0 -8
  40. data/docs/ActionFlow.md +0 -8
  41. data/docs/ApiUsageRes.md +0 -11
  42. data/docs/ArchiveConfig.md +0 -11
  43. data/docs/ArchiveJobReq.md +0 -12
  44. data/docs/ArchiveJobRes.md +0 -9
  45. data/docs/Color.md +0 -10
  46. data/docs/ConvertApi.md +0 -102
  47. data/docs/ConvertToPdf.md +0 -10
  48. data/docs/ConvertToPdfAction.md +0 -10
  49. data/docs/ConvertToPdfRes.md +0 -8
  50. data/docs/CreateImages.md +0 -10
  51. data/docs/CreateImagesRes.md +0 -8
  52. data/docs/CreatePdfA.md +0 -10
  53. data/docs/CreatePdfARes.md +0 -8
  54. data/docs/CustomCMSConfig.md +0 -23
  55. data/docs/DocAction.md +0 -8
  56. data/docs/DocLog.md +0 -12
  57. data/docs/DocMetadata.md +0 -16
  58. data/docs/Document.md +0 -16
  59. data/docs/DocumentApi.md +0 -203
  60. data/docs/DropDocumentReq.md +0 -20
  61. data/docs/DropDocumentRes.md +0 -15
  62. data/docs/ExecutionTrigger.md +0 -10
  63. data/docs/Extract.md +0 -10
  64. data/docs/ExtractAction.md +0 -9
  65. data/docs/ExtractApi.md +0 -102
  66. data/docs/ExtractRes.md +0 -8
  67. data/docs/GetDocumentListRes.md +0 -13
  68. data/docs/GetDocumentReq.md +0 -14
  69. data/docs/GetDocumentRes.md +0 -14
  70. data/docs/IFormFile.md +0 -13
  71. data/docs/Image.md +0 -15
  72. data/docs/ImageAction.md +0 -30
  73. data/docs/ImageApi.md +0 -107
  74. data/docs/Job.md +0 -10
  75. data/docs/JobApi.md +0 -197
  76. data/docs/JobConfig.md +0 -18
  77. data/docs/JobConfigRes.md +0 -8
  78. data/docs/KeyValuePairStringObject.md +0 -9
  79. data/docs/KeyValuePairStringString.md +0 -9
  80. data/docs/ManagementApi.md +0 -92
  81. data/docs/Merge.md +0 -10
  82. data/docs/MergeAction.md +0 -8
  83. data/docs/MergeApi.md +0 -102
  84. data/docs/MergeRes.md +0 -8
  85. data/docs/Notification.md +0 -9
  86. data/docs/OcrAction.md +0 -12
  87. data/docs/OcrApi.md +0 -57
  88. data/docs/Optimize.md +0 -10
  89. data/docs/OptimizeAction.md +0 -35
  90. data/docs/OptimizeApi.md +0 -103
  91. data/docs/OptimizeRes.md +0 -9
  92. data/docs/Page.md +0 -14
  93. data/docs/PageSelection.md +0 -10
  94. data/docs/Pdf4meAction.md +0 -12
  95. data/docs/Pdf4meDocument.md +0 -32
  96. data/docs/Pdf4meException.md +0 -8
  97. data/docs/PdfAAction.md +0 -14
  98. data/docs/PdfAApi.md +0 -102
  99. data/docs/PdfFont.md +0 -9
  100. data/docs/Pricing.md +0 -13
  101. data/docs/ProduceDocuments.md +0 -14
  102. data/docs/ProduceDocumentsRes.md +0 -8
  103. data/docs/ProduceOutput.md +0 -8
  104. data/docs/RGBSet.md +0 -10
  105. data/docs/RecognizeDocument.md +0 -10
  106. data/docs/RecognizeDocumentRes.md +0 -9
  107. data/docs/Rectangle.md +0 -11
  108. data/docs/Rotate.md +0 -10
  109. data/docs/RunJobRes.md +0 -10
  110. data/docs/SignatureConfig.md +0 -7
  111. data/docs/Split.md +0 -10
  112. data/docs/SplitAction.md +0 -11
  113. data/docs/SplitApi.md +0 -103
  114. data/docs/SplitRes.md +0 -8
  115. data/docs/Stamp.md +0 -10
  116. data/docs/StampAction.md +0 -22
  117. data/docs/StampApi.md +0 -110
  118. data/docs/StampRes.md +0 -8
  119. data/docs/StorageFolder.md +0 -10
  120. data/docs/Text.md +0 -17
  121. data/docs/Transform.md +0 -13
  122. data/docs/Translate.md +0 -9
  123. data/docs/UserFingerprint.md +0 -9
  124. data/docs/VersionRes.md +0 -8
  125. data/docs/java.md +0 -425
  126. data/lib/pdf4me/api/convert_api.rb +0 -130
  127. data/lib/pdf4me/api/document_api.rb +0 -218
  128. data/lib/pdf4me/api/extract_api.rb +0 -131
  129. data/lib/pdf4me/api/image_api.rb +0 -139
  130. data/lib/pdf4me/api/job_api.rb +0 -223
  131. data/lib/pdf4me/api/management_api.rb +0 -117
  132. data/lib/pdf4me/api/merge_api.rb +0 -131
  133. data/lib/pdf4me/api/ocr_api.rb +0 -74
  134. data/lib/pdf4me/api/optimize_api.rb +0 -139
  135. data/lib/pdf4me/api/pdf_a_api.rb +0 -134
  136. data/lib/pdf4me/api/split_api.rb +0 -135
  137. data/lib/pdf4me/api/stamp_api.rb +0 -159
  138. data/lib/pdf4me/api_client.rb +0 -380
  139. data/lib/pdf4me/api_error.rb +0 -38
  140. data/lib/pdf4me/models/action_flow.rb +0 -190
  141. data/lib/pdf4me/models/api_usage_res.rb +0 -219
  142. data/lib/pdf4me/models/archive_config.rb +0 -226
  143. data/lib/pdf4me/models/archive_job_req.rb +0 -249
  144. data/lib/pdf4me/models/archive_job_res.rb +0 -207
  145. data/lib/pdf4me/models/color.rb +0 -206
  146. data/lib/pdf4me/models/convert_to_pdf.rb +0 -209
  147. data/lib/pdf4me/models/create_images.rb +0 -209
  148. data/lib/pdf4me/models/create_images_res.rb +0 -189
  149. data/lib/pdf4me/models/create_pdf_a.rb +0 -209
  150. data/lib/pdf4me/models/create_pdf_a_res.rb +0 -189
  151. data/lib/pdf4me/models/custom_cms_config.rb +0 -323
  152. data/lib/pdf4me/models/doc_action.rb +0 -190
  153. data/lib/pdf4me/models/drop_document_req.rb +0 -348
  154. data/lib/pdf4me/models/drop_document_res.rb +0 -260
  155. data/lib/pdf4me/models/execution_trigger.rb +0 -206
  156. data/lib/pdf4me/models/extract.rb +0 -207
  157. data/lib/pdf4me/models/extract_action.rb +0 -201
  158. data/lib/pdf4me/models/extract_res.rb +0 -188
  159. data/lib/pdf4me/models/get_document_list_res.rb +0 -237
  160. data/lib/pdf4me/models/get_document_req.rb +0 -243
  161. data/lib/pdf4me/models/get_document_res.rb +0 -246
  162. data/lib/pdf4me/models/i_form_file.rb +0 -235
  163. data/lib/pdf4me/models/image.rb +0 -300
  164. data/lib/pdf4me/models/image_action.rb +0 -513
  165. data/lib/pdf4me/models/job.rb +0 -213
  166. data/lib/pdf4me/models/job_config.rb +0 -298
  167. data/lib/pdf4me/models/job_config_res.rb +0 -193
  168. data/lib/pdf4me/models/key_value_pair_string_object.rb +0 -197
  169. data/lib/pdf4me/models/key_value_pair_string_string.rb +0 -197
  170. data/lib/pdf4me/models/merge.rb +0 -209
  171. data/lib/pdf4me/models/merge_action.rb +0 -190
  172. data/lib/pdf4me/models/merge_res.rb +0 -188
  173. data/lib/pdf4me/models/ocr_action.rb +0 -259
  174. data/lib/pdf4me/models/optimize.rb +0 -209
  175. data/lib/pdf4me/models/page_selection.rb +0 -246
  176. data/lib/pdf4me/models/pdf4me_action.rb +0 -259
  177. data/lib/pdf4me/models/pdf4me_document.rb +0 -511
  178. data/lib/pdf4me/models/pdf4me_exception.rb +0 -189
  179. data/lib/pdf4me/models/pdf_a_action.rb +0 -297
  180. data/lib/pdf4me/models/pdf_font.rb +0 -213
  181. data/lib/pdf4me/models/pricing.rb +0 -278
  182. data/lib/pdf4me/models/produce_documents.rb +0 -251
  183. data/lib/pdf4me/models/produce_documents_res.rb +0 -191
  184. data/lib/pdf4me/models/produce_output.rb +0 -221
  185. data/lib/pdf4me/models/recognize_document.rb +0 -209
  186. data/lib/pdf4me/models/recognize_document_res.rb +0 -198
  187. data/lib/pdf4me/models/rectangle.rb +0 -215
  188. data/lib/pdf4me/models/rgb_set.rb +0 -206
  189. data/lib/pdf4me/models/rotate.rb +0 -221
  190. data/lib/pdf4me/models/run_job_res.rb +0 -215
  191. data/lib/pdf4me/models/signature_config.rb +0 -179
  192. data/lib/pdf4me/models/split.rb +0 -207
  193. data/lib/pdf4me/models/split_action.rb +0 -219
  194. data/lib/pdf4me/models/split_res.rb +0 -190
  195. data/lib/pdf4me/models/stamp.rb +0 -209
  196. data/lib/pdf4me/models/stamp_action.rb +0 -387
  197. data/lib/pdf4me/models/stamp_res.rb +0 -189
  198. data/lib/pdf4me/models/storage_folder.rb +0 -239
  199. data/lib/pdf4me/models/text.rb +0 -320
  200. data/lib/pdf4me/models/transform.rb +0 -263
  201. data/lib/pdf4me/models/translate.rb +0 -207
  202. data/lib/pdf4me/models/user_fingerprint.rb +0 -197
  203. data/lib/pdf4me/models/version_res.rb +0 -188
  204. data/pdf4me.gemspec +0 -47
  205. data/spec/api/convert_api_spec.rb +0 -60
  206. data/spec/api/document_api_spec.rb +0 -83
  207. data/spec/api/extract_api_spec.rb +0 -60
  208. data/spec/api/image_api_spec.rb +0 -62
  209. data/spec/api/job_api_spec.rb +0 -82
  210. data/spec/api/management_api_spec.rb +0 -57
  211. data/spec/api/merge_api_spec.rb +0 -60
  212. data/spec/api/ocr_api_spec.rb +0 -47
  213. data/spec/api/optimize_api_spec.rb +0 -60
  214. data/spec/api/pdf_a_api_spec.rb +0 -60
  215. data/spec/api/split_api_spec.rb +0 -60
  216. data/spec/api/stamp_api_spec.rb +0 -63
  217. data/spec/api_client_spec.rb +0 -226
  218. data/spec/configuration_spec.rb +0 -42
  219. data/spec/models/action_flow_spec.rb +0 -42
  220. data/spec/models/api_usage_res_spec.rb +0 -60
  221. data/spec/models/archive_config_spec.rb +0 -60
  222. data/spec/models/archive_job_req_spec.rb +0 -66
  223. data/spec/models/archive_job_res_spec.rb +0 -48
  224. data/spec/models/color_spec.rb +0 -54
  225. data/spec/models/convert_to_pdf_action_spec.rb +0 -62
  226. data/spec/models/convert_to_pdf_res_spec.rb +0 -42
  227. data/spec/models/convert_to_pdf_spec.rb +0 -54
  228. data/spec/models/create_images_res_spec.rb +0 -42
  229. data/spec/models/create_images_spec.rb +0 -54
  230. data/spec/models/create_pdf_a_res_spec.rb +0 -42
  231. data/spec/models/create_pdf_a_spec.rb +0 -54
  232. data/spec/models/custom_cms_config_spec.rb +0 -132
  233. data/spec/models/doc_action_spec.rb +0 -42
  234. data/spec/models/doc_log_spec.rb +0 -70
  235. data/spec/models/doc_metadata_spec.rb +0 -90
  236. data/spec/models/document_spec.rb +0 -90
  237. data/spec/models/drop_document_req_spec.rb +0 -118
  238. data/spec/models/drop_document_res_spec.rb +0 -84
  239. data/spec/models/execution_trigger_spec.rb +0 -54
  240. data/spec/models/extract_action_spec.rb +0 -48
  241. data/spec/models/extract_res_spec.rb +0 -42
  242. data/spec/models/extract_spec.rb +0 -54
  243. data/spec/models/get_document_list_res_spec.rb +0 -72
  244. data/spec/models/get_document_req_spec.rb +0 -78
  245. data/spec/models/get_document_res_spec.rb +0 -78
  246. data/spec/models/i_form_file_spec.rb +0 -72
  247. data/spec/models/image_action_spec.rb +0 -206
  248. data/spec/models/image_spec.rb +0 -88
  249. data/spec/models/job_config_res_spec.rb +0 -42
  250. data/spec/models/job_config_spec.rb +0 -102
  251. data/spec/models/job_spec.rb +0 -54
  252. data/spec/models/key_value_pair_string_object_spec.rb +0 -48
  253. data/spec/models/key_value_pair_string_string_spec.rb +0 -48
  254. data/spec/models/merge_action_spec.rb +0 -42
  255. data/spec/models/merge_res_spec.rb +0 -42
  256. data/spec/models/merge_spec.rb +0 -54
  257. data/spec/models/notification_spec.rb +0 -48
  258. data/spec/models/ocr_action_spec.rb +0 -70
  259. data/spec/models/optimize_action_spec.rb +0 -228
  260. data/spec/models/optimize_res_spec.rb +0 -48
  261. data/spec/models/optimize_spec.rb +0 -54
  262. data/spec/models/page_selection_spec.rb +0 -58
  263. data/spec/models/page_spec.rb +0 -78
  264. data/spec/models/pdf4me_action_spec.rb +0 -70
  265. data/spec/models/pdf4me_document_spec.rb +0 -202
  266. data/spec/models/pdf4me_exception_spec.rb +0 -42
  267. data/spec/models/pdf_a_action_spec.rb +0 -86
  268. data/spec/models/pdf_font_spec.rb +0 -48
  269. data/spec/models/pricing_spec.rb +0 -80
  270. data/spec/models/produce_documents_res_spec.rb +0 -42
  271. data/spec/models/produce_documents_spec.rb +0 -78
  272. data/spec/models/produce_output_spec.rb +0 -46
  273. data/spec/models/recognize_document_res_spec.rb +0 -48
  274. data/spec/models/recognize_document_spec.rb +0 -54
  275. data/spec/models/rectangle_spec.rb +0 -60
  276. data/spec/models/rgb_set_spec.rb +0 -54
  277. data/spec/models/rotate_spec.rb +0 -54
  278. data/spec/models/run_job_res_spec.rb +0 -54
  279. data/spec/models/signature_config_spec.rb +0 -36
  280. data/spec/models/split_action_spec.rb +0 -60
  281. data/spec/models/split_res_spec.rb +0 -42
  282. data/spec/models/split_spec.rb +0 -54
  283. data/spec/models/stamp_action_spec.rb +0 -142
  284. data/spec/models/stamp_res_spec.rb +0 -42
  285. data/spec/models/stamp_spec.rb +0 -54
  286. data/spec/models/storage_folder_spec.rb +0 -58
  287. data/spec/models/text_spec.rb +0 -104
  288. data/spec/models/transform_spec.rb +0 -72
  289. data/spec/models/translate_spec.rb +0 -48
  290. data/spec/models/user_fingerprint_spec.rb +0 -48
  291. data/spec/models/version_res_spec.rb +0 -42
@@ -1,18 +0,0 @@
1
- # Pdf4me::JobConfig
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **job_config_id** | **String** | |
7
- **enabled** | **BOOLEAN** | |
8
- **active** | **BOOLEAN** | | [optional]
9
- **creation_date** | **DateTime** | | [optional]
10
- **mod_date** | **DateTime** | | [optional]
11
- **name** | **String** | |
12
- **user_id** | **String** | |
13
- **source_folder** | [**StorageFolder**](StorageFolder.md) | | [optional]
14
- **execution_trigger** | [**ExecutionTrigger**](ExecutionTrigger.md) | | [optional]
15
- **action_flow** | [**ActionFlow**](ActionFlow.md) | | [optional]
16
- **target_folder** | [**StorageFolder**](StorageFolder.md) | | [optional]
17
-
18
-
@@ -1,8 +0,0 @@
1
- # Pdf4me::JobConfigRes
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **job_config_id** | **String** | |
7
-
8
-
@@ -1,9 +0,0 @@
1
- # Pdf4me::KeyValuePairStringObject
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **key** | **String** | | [optional]
7
- **value** | **Object** | | [optional]
8
-
9
-
@@ -1,9 +0,0 @@
1
- # Pdf4me::KeyValuePairStringString
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **key** | **String** | | [optional]
7
- **value** | **String** | | [optional]
8
-
9
-
@@ -1,92 +0,0 @@
1
- # Pdf4me::ManagementApi
2
-
3
- All URIs are relative to *https://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**api_usage**](ManagementApi.md#api_usage) | **POST** /Management/ApiUsage | ApiUsage
8
- [**version**](ManagementApi.md#version) | **POST** /Management/Version | Version
9
-
10
-
11
- # **api_usage**
12
- > ApiUsageRes api_usage
13
-
14
- ApiUsage
15
-
16
- Give an overview of current ApiUsage and if its payment.
17
-
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'pdf4me'
22
-
23
- api_instance = Pdf4me::ManagementApi.new
24
-
25
- begin
26
- #ApiUsage
27
- result = api_instance.api_usage
28
- p result
29
- rescue Pdf4me::ApiError => e
30
- puts "Exception when calling ManagementApi->api_usage: #{e}"
31
- end
32
- ```
33
-
34
- ### Parameters
35
- This endpoint does not need any parameter.
36
-
37
- ### Return type
38
-
39
- [**ApiUsageRes**](ApiUsageRes.md)
40
-
41
- ### Authorization
42
-
43
- No authorization required
44
-
45
- ### HTTP request headers
46
-
47
- - **Content-Type**: Not defined
48
- - **Accept**: text/plain, application/json, text/json, application/bson
49
-
50
-
51
-
52
- # **version**
53
- > VersionRes version
54
-
55
- Version
56
-
57
- A simple method to get the current Version
58
-
59
- ### Example
60
- ```ruby
61
- # load the gem
62
- require 'pdf4me'
63
-
64
- api_instance = Pdf4me::ManagementApi.new
65
-
66
- begin
67
- #Version
68
- result = api_instance.version
69
- p result
70
- rescue Pdf4me::ApiError => e
71
- puts "Exception when calling ManagementApi->version: #{e}"
72
- end
73
- ```
74
-
75
- ### Parameters
76
- This endpoint does not need any parameter.
77
-
78
- ### Return type
79
-
80
- [**VersionRes**](VersionRes.md)
81
-
82
- ### Authorization
83
-
84
- No authorization required
85
-
86
- ### HTTP request headers
87
-
88
- - **Content-Type**: Not defined
89
- - **Accept**: text/plain, application/json, text/json, application/bson
90
-
91
-
92
-
@@ -1,10 +0,0 @@
1
- # Pdf4me::Merge
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **documents** | [**Array<Document>**](Document.md) | | [optional]
7
- **merge_action** | [**MergeAction**](MergeAction.md) | | [optional]
8
- **notification** | [**Notification**](Notification.md) | Set Notification | [optional]
9
-
10
-
@@ -1,8 +0,0 @@
1
- # Pdf4me::MergeAction
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) | | [optional]
7
-
8
-
@@ -1,102 +0,0 @@
1
- # Pdf4me::MergeApi
2
-
3
- All URIs are relative to *https://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**merge**](MergeApi.md#merge) | **POST** /Merge/Merge |
8
- [**merge2_pdfs**](MergeApi.md#merge2_pdfs) | **POST** /Merge/Merge2Pdfs |
9
-
10
-
11
- # **merge**
12
- > MergeRes merge(opts)
13
-
14
-
15
-
16
- ### Example
17
- ```ruby
18
- # load the gem
19
- require 'pdf4me'
20
-
21
- api_instance = Pdf4me::MergeApi.new
22
-
23
- opts = {
24
- req: Pdf4me::Merge.new # Merge |
25
- }
26
-
27
- begin
28
- result = api_instance.merge(opts)
29
- p result
30
- rescue Pdf4me::ApiError => e
31
- puts "Exception when calling MergeApi->merge: #{e}"
32
- end
33
- ```
34
-
35
- ### Parameters
36
-
37
- Name | Type | Description | Notes
38
- ------------- | ------------- | ------------- | -------------
39
- **req** | [**Merge**](Merge.md)| | [optional]
40
-
41
- ### Return type
42
-
43
- [**MergeRes**](MergeRes.md)
44
-
45
- ### Authorization
46
-
47
- No authorization required
48
-
49
- ### HTTP request headers
50
-
51
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
52
- - **Accept**: text/plain, application/json, text/json, application/bson
53
-
54
-
55
-
56
- # **merge2_pdfs**
57
- > File merge2_pdfs(opts)
58
-
59
-
60
-
61
- ### Example
62
- ```ruby
63
- # load the gem
64
- require 'pdf4me'
65
-
66
- api_instance = Pdf4me::MergeApi.new
67
-
68
- opts = {
69
- file1: "file1_example", # String |
70
- file2: "file2_example" # String |
71
- }
72
-
73
- begin
74
- result = api_instance.merge2_pdfs(opts)
75
- p result
76
- rescue Pdf4me::ApiError => e
77
- puts "Exception when calling MergeApi->merge2_pdfs: #{e}"
78
- end
79
- ```
80
-
81
- ### Parameters
82
-
83
- Name | Type | Description | Notes
84
- ------------- | ------------- | ------------- | -------------
85
- **file1** | **String**| | [optional]
86
- **file2** | **String**| | [optional]
87
-
88
- ### Return type
89
-
90
- **File**
91
-
92
- ### Authorization
93
-
94
- No authorization required
95
-
96
- ### HTTP request headers
97
-
98
- - **Content-Type**: Not defined
99
- - **Accept**: application/octet-stream
100
-
101
-
102
-
@@ -1,8 +0,0 @@
1
- # Pdf4me::MergeRes
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **document** | [**Document**](Document.md) | | [optional]
7
-
8
-
@@ -1,9 +0,0 @@
1
- # Pdf4me::Notification
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **get_notification** | **BOOLEAN** | Run execution in asynchronous way, get notified over Online WebHook | [optional]
7
- **connection_id** | **String** | Will be used for Online WebHook | [optional]
8
-
9
-
@@ -1,12 +0,0 @@
1
- # Pdf4me::OcrAction
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **stapel** | **String** | | [optional]
7
- **businesss_card_reco** | **BOOLEAN** | | [optional]
8
- **full_text_search** | **BOOLEAN** | | [optional]
9
- **output_type** | **String** | | [optional]
10
- **custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) | | [optional]
11
-
12
-
@@ -1,57 +0,0 @@
1
- # Pdf4me::OcrApi
2
-
3
- All URIs are relative to *https://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**recognize_document**](OcrApi.md#recognize_document) | **POST** /Ocr/RecognizeDocument | RecognizeDocument
8
-
9
-
10
- # **recognize_document**
11
- > RecognizeDocumentRes recognize_document(opts)
12
-
13
- RecognizeDocument
14
-
15
- Recognize a Document with OCR and more advanced recognition possibilities like reading out structured business data in form of table.
16
-
17
- ### Example
18
- ```ruby
19
- # load the gem
20
- require 'pdf4me'
21
-
22
- api_instance = Pdf4me::OcrApi.new
23
-
24
- opts = {
25
- req: Pdf4me::RecognizeDocument.new # RecognizeDocument |
26
- }
27
-
28
- begin
29
- #RecognizeDocument
30
- result = api_instance.recognize_document(opts)
31
- p result
32
- rescue Pdf4me::ApiError => e
33
- puts "Exception when calling OcrApi->recognize_document: #{e}"
34
- end
35
- ```
36
-
37
- ### Parameters
38
-
39
- Name | Type | Description | Notes
40
- ------------- | ------------- | ------------- | -------------
41
- **req** | [**RecognizeDocument**](RecognizeDocument.md)| | [optional]
42
-
43
- ### Return type
44
-
45
- [**RecognizeDocumentRes**](RecognizeDocumentRes.md)
46
-
47
- ### Authorization
48
-
49
- No authorization required
50
-
51
- ### HTTP request headers
52
-
53
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
54
- - **Accept**: text/plain, application/json, text/json, application/bson
55
-
56
-
57
-
@@ -1,10 +0,0 @@
1
- # Pdf4me::Optimize
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **document** | [**Document**](Document.md) | Give the document to change or use JobId/DocumentId to reference an uploaded document. | [optional]
7
- **optimize_action** | [**OptimizeAction**](OptimizeAction.md) | Give an image stamp | [optional]
8
- **notification** | [**Notification**](Notification.md) | Set Notification | [optional]
9
-
10
-
@@ -1,35 +0,0 @@
1
- # Pdf4me::OptimizeAction
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **profile** | **String** | With this property one of the predefined optimization profiles can be set. If a profile is set then all the properties listed in TPDFOptimizationProfile(table Profile Settings) are set to their respective values.Properties not listed in this table are left unchanged. One way of quickly arriving at a specific setting is to first set the Profile and then adapt the configuration by setting some of the individual properties. | [optional]
7
- **use_profile** | **BOOLEAN** | | [optional]
8
- **remove_redundant_objects** | **BOOLEAN** | Get or set whether redundant objects should be removed. If this property is set to True, duplicate objects are removed in order to reduce the file size. {default: false} | [optional]
9
- **subset_fonts** | **BOOLEAN** | This property influences two optimizations related to subsetted fonts: - Subset embedded fonts. - Merge embedded font programs of different subsets of the same font, granted they can be merged. <para> Sub-setting refers to removing those glyphs in a font that are not actually used in any text contained in the PDF. </para>{default: false} | [optional]
10
- **optimize_resources** | **BOOLEAN** | Get or set whether resources should be optimized. If set, unused resources such as images, fonts, and color spaces are removed.Also content streams are re-built. {default: false} | [optional]
11
- **force_compression_types** | **BOOLEAN** | If this option is set, then re-compression of images is forced if an image in the input PDF has a compression type that differs from the compression types given in ContinuousCompressions, BitonalCompressions, or IndexedCompressions. Use this option if you want to allow only the given compression types for images in the output PDF. {default: false} | [optional]
12
- **force_recompression** | **BOOLEAN** | If set, all images are always recompressed.If not set (default), images are only recompressed if the resulting image is smaller than the original, i.e.requires less bytes to store in the file. {default: false} | [optional]
13
- **reduce_color_complexity** | **BOOLEAN** | This property is used to enable color complexity reduction of images. (See also Provided Features for Optimizing Images.) If enabled then images with device color spaces(DeviceRGB, DeviceCMYK, or DeviceGray) and indexed images with a device color space as base color space are analyzed and if possible converted as follows: - An image with DeviceRGB or DeviceCMYK color space in which all pixels are gray is converted to a grayscale image with DeviceGray color space. - An image that contains only black and white pixels is converted into a bitonal image. - An image in which all the pixels have the same color is down-sampled to one pixel. Furthermore, images’ masks and soft masks are optimized as follows: - A soft mask that contains only black and white pixels is converted to a mask. - A (soft) mask that is opaque is removed. {default: false} | [optional]
14
- **merge_embedded_fonts** | **BOOLEAN** | Merge embedded font programs. Font programs can be merged, if they originate from the same font, e.g.they are of the same type, have the same name and encoding.Merging of Type1(PostScript) and TrueType fonts is supported. | [optional]
15
- **bitonal_compressions** | **Array<String>** | Get or set the compression types for bi-tonal images. Several values can be combined.The following values are allowed: ComprAttemptNone ComprAttemptRaw ComprAttemptFlate ComprAttemptLZW ComprAttemptGroup3 ComprAttemptGroup4 ComprAttemptSource ComprAttemptJBIG2 Other values are ignored. <para> During optimization, all set compression types are tried and the one resulting in the least memory footprint is taken. Typically, CCITT Group 4 or JBIG2 is used for bi-tonal compression. Due to the simpler algorithm CCITT Group 4 has the advantage of being faster. JBIG2 can achieve compression ratios that are up to twice as high as CCITT Group 4 at the cost of longer computation time. </para>{default: ComprAttemptNone} | [optional]
16
- **bitonal_resolution_dpi** | **Float** | Get or set the target resolution in dots per inch (DPI) after re-sampling images for bi-tonal images.See also ResolutionDPI. {default: 200} | [optional]
17
- **bitonal_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate re-sampling for bi-tonal images.The value -1 deactivates re-sampling for bitonal images. See also ThresholdDPI. {default: -1} | [optional]
18
- **clip_images** | **BOOLEAN** | Get or set the option to clip images. When enabled, then invisible parts of images are clipped (cropped). While this does not affect visual parts of images, it may have a minor visual impact because clipped images are re-compressed. Pre-blended images are not clipped. Enabling this property will also enable the OptimizeResources property. {default: false} | [optional]
19
- **continuous_compressions** | **Array<String>** | Get or set the compression types to be tried for continuous images, i.e. RGB, CMYK, and grayscale images. See also TPDFComprAttempt. Several values can be combined with bitwise or operators. Other values are ignored. During optimization, all set compression types are tried and the one resulting in the least memory footprint is taken. {default: ComprAttemptNone} | [optional]
20
- **linearize** | **BOOLEAN** | Get or set whether to linearize the PDF output file, i.e. optimize file for fast web access. A linearized document has a slightly larger file size than a non-linearized file and provides the following main features: - When a document is opened in a PDF viewer of a web browser, the first page can be viewed without downloading the entire PDF file.In contrast, a non-linearized PDF file must be downloaded completely before the first page can be displayed. - When another page is requested by the user, that page is displayed as quickly as possible and incrementally as data arrives, without downloading the entire PDF file. <para> Signed files cannot be linearizes. So this property must be set to False if a digital signature is applied. </para>{default: false} | [optional]
21
- **image_quality** | **Integer** | Get or set the quality index of lossy compression types. This value ranges from 1 to 100 and is applied to JPEG and JPEG2000 compression.For JPEG2000, a quality index of 100 means lossless compression.JPEG compression is always lossy. {default: 75} | [optional]
22
- **indexed_compressions** | **Array<String>** | Get or set the compression types for images that have an indexed (“palette”) color space.See also TPDFComprAttempt. Several values can be combined with bitwise or operators.The following values are allowed: - ComprAttemptNone - ComprAttemptRaw - ComprAttemptFlate - ComprAttemptLZW - ComprAttemptSource Other values are ignored. <para> During optimization, all set compression types are tried and the one resulting in the least memory footprint is taken. </para>{default: ComprAttemptFlate} | [optional]
23
- **dithering_mode** | **String** | This option enables or disables dithering when down-sampling bi-tonal images. The only values supported are eDitherNone and eDitherFloydSteinberg. Some bi-tonal images try to evoke the impression of different levels of gray by randomly setting pixels to black.If dithering is applied during downsampling then the gray levels of such images are preserved better.If dithering is switched off then lines (e.g.text glyphs) are preserved better. {default: DitherNone} | [optional]
24
- **color_resolution_dpi** | **Float** | Get or set the target resolution in dots per inch (DPI) after re-sampling images for color images.See also ResolutionDPI. {default: 150} | [optional]
25
- **color_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate re-sampling for color images.The value -1 deactivates re-sampling for color images. See also ThresholdDPI. {default: -1} | [optional]
26
- **monochrome_resolution_dpi** | **Float** | Get or set target resolution in dots per inch (DPI) after re-sampling images for monochrome images.See also ResolutionDPI. {default: 150} | [optional]
27
- **monochrome_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate re-sampling for monochrome images.The value -1 deactivates re-sampling for monochrome images. See also ThresholdDPI. {default: -1} | [optional]
28
- **resolution_dpi** | **Integer** | Get or set the resolution in DPI (dots per inch) after re-sampling images. This property affects all three image compression types(BitonalResolutionDPI, ColorResolutionDPI, MonochromeResolutionDPI). A typical value for the resolution when optimizing for the web is 150 DPI.For printing typically no re-sampling is applied(see property ThresholdDPI). Pre-blended images, images with a color key mask, mask, and soft mask images are not re-sampled. When getting ResolutionDPI, the property returns the target resolution in DPI for color images. {default: Different defaults apply to different image types} | [optional]
29
- **threshold_dpi** | **Integer** | Set the threshold in DPI (dots per inch) to selectively activate re-sampling. Only images with a resolution above the threshold DPI will be re-sampled. This property affects all three image compression types(BitonalThresholdDPI, ColorThresholdDPI, MonochromeThresholdDPI). The value -1 deactivates re-sampling. {default: -1} | [optional]
30
- **strip** | **Array<String>** | Get or set the stripping mode. This mode can be configured to remove unneeded data of a PDF document such as Threads, Metadata, the PieceInfo, the StructTreeRoot entry, embedded Thumbs and the SpiderInfo entry.Also this mode is used to indicate whether to flatten form fields, links, and other annotations.Multiple values of TPDFStripType can be combined with the bitwise or operator. {default: StripThreads} | [optional]
31
- **info_entries** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) | Set a key-value pair in the document info dictionary. Values of predefined keys are also stored in the XMP metadata. Popular entries specified in the PDF Reference 1.7 and accepted by most PDF viewers are \"Title\", \"Author\", \"Subject\", \"Creator\" (sometimes referred to as Application), and \"Producer\" (sometimes referred to as PDF Creator). | [optional]
32
- **flatten_signature_fields** | **BOOLEAN** | A signature in a PDF consist of two parts: a.The invisible digital signature in the PDF. b.The visual appearance that was attributed to the signature. Part (a) can be used by a viewing application, to verify that a document has not changed since it has been signed and report this to the user.Part(b) is merely a “decorative” element on the page without further significance. When optimizing a PDF, the PDF is altered and hence the digital signature is broken.Therefore, all signatures are removed , including parts(a) and(b). When the property FlattenSignatureFields is set to True, then digital signatures(parts (a)) are still removed, but their visual appearances(parts (b)) are flattened.I.e.the latter are retained and drawn as non-editable graphic onto the page. <para> Note: The resulting PDF can be misleading as it visually appears to be signed, but it has no digital signature and hence, a viewer application does not report any broken signature.In most cases, such a behavior is undesirable</para> | [optional]
33
- **custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) | | [optional]
34
-
35
-
@@ -1,103 +0,0 @@
1
- # Pdf4me::OptimizeApi
2
-
3
- All URIs are relative to *https://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**optimize**](OptimizeApi.md#optimize) | **POST** /Optimize/Optimize |
8
- [**optimize_by_profile**](OptimizeApi.md#optimize_by_profile) | **POST** /Optimize/OptimizeByProfile |
9
-
10
-
11
- # **optimize**
12
- > OptimizeRes optimize(opts)
13
-
14
-
15
-
16
- ### Example
17
- ```ruby
18
- # load the gem
19
- require 'pdf4me'
20
-
21
- api_instance = Pdf4me::OptimizeApi.new
22
-
23
- opts = {
24
- req: Pdf4me::Optimize.new # Optimize |
25
- }
26
-
27
- begin
28
- result = api_instance.optimize(opts)
29
- p result
30
- rescue Pdf4me::ApiError => e
31
- puts "Exception when calling OptimizeApi->optimize: #{e}"
32
- end
33
- ```
34
-
35
- ### Parameters
36
-
37
- Name | Type | Description | Notes
38
- ------------- | ------------- | ------------- | -------------
39
- **req** | [**Optimize**](Optimize.md)| | [optional]
40
-
41
- ### Return type
42
-
43
- [**OptimizeRes**](OptimizeRes.md)
44
-
45
- ### Authorization
46
-
47
- No authorization required
48
-
49
- ### HTTP request headers
50
-
51
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
52
- - **Accept**: text/plain, application/json, text/json, application/bson
53
-
54
-
55
-
56
- # **optimize_by_profile**
57
- > File optimize_by_profile(profile, opts)
58
-
59
-
60
-
61
- ### Example
62
- ```ruby
63
- # load the gem
64
- require 'pdf4me'
65
-
66
- api_instance = Pdf4me::OptimizeApi.new
67
-
68
- profile = "profile_example" # String |
69
-
70
- opts = {
71
- file: "file_example" # String |
72
- }
73
-
74
- begin
75
- result = api_instance.optimize_by_profile(profile, opts)
76
- p result
77
- rescue Pdf4me::ApiError => e
78
- puts "Exception when calling OptimizeApi->optimize_by_profile: #{e}"
79
- end
80
- ```
81
-
82
- ### Parameters
83
-
84
- Name | Type | Description | Notes
85
- ------------- | ------------- | ------------- | -------------
86
- **profile** | **String**| |
87
- **file** | **String**| | [optional]
88
-
89
- ### Return type
90
-
91
- **File**
92
-
93
- ### Authorization
94
-
95
- No authorization required
96
-
97
- ### HTTP request headers
98
-
99
- - **Content-Type**: Not defined
100
- - **Accept**: application/octet-stream
101
-
102
-
103
-