mindee 3.19.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (600) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +2 -1
  3. data/CHANGELOG.md +28 -0
  4. data/README.md +42 -52
  5. data/Steepfile +31 -0
  6. data/bin/mindee.rb +30 -62
  7. data/docs/advanced_file_operations.md +111 -0
  8. data/docs/code_samples/bank_account_details_v1.txt +5 -0
  9. data/docs/code_samples/bank_account_details_v2.txt +5 -0
  10. data/docs/code_samples/bank_check_v1.txt +5 -0
  11. data/docs/code_samples/{us_driver_license_v1.txt → bank_statement_fr_v2_async.txt} +6 -1
  12. data/docs/code_samples/barcode_reader_v1.txt +5 -0
  13. data/docs/code_samples/bill_of_lading_v1_async.txt +6 -1
  14. data/docs/code_samples/business_card_v1_async.txt +6 -1
  15. data/docs/code_samples/carte_grise_v1.txt +5 -0
  16. data/docs/code_samples/cropper_v1.txt +5 -0
  17. data/docs/code_samples/default.txt +8 -2
  18. data/docs/code_samples/default_async.txt +7 -2
  19. data/docs/code_samples/delivery_notes_v1_async.txt +6 -1
  20. data/docs/code_samples/driver_license_v1_async.txt +6 -1
  21. data/docs/code_samples/energy_bill_fra_v1_async.txt +6 -1
  22. data/docs/code_samples/expense_receipts_v5.txt +7 -1
  23. data/docs/code_samples/expense_receipts_v5_async.txt +6 -1
  24. data/docs/code_samples/financial_document_v1.txt +7 -1
  25. data/docs/code_samples/financial_document_v1_async.txt +6 -1
  26. data/docs/code_samples/french_healthcard_v1_async.txt +6 -1
  27. data/docs/code_samples/idcard_fr_v1.txt +5 -0
  28. data/docs/code_samples/idcard_fr_v2.txt +5 -0
  29. data/docs/code_samples/ind_passport_v1_async.txt +6 -1
  30. data/docs/code_samples/international_id_v2_async.txt +6 -1
  31. data/docs/code_samples/invoice_splitter_v1_async.txt +6 -1
  32. data/docs/code_samples/invoices_v4.txt +7 -1
  33. data/docs/code_samples/invoices_v4_async.txt +6 -1
  34. data/docs/code_samples/license_plates_v1.txt +5 -0
  35. data/docs/code_samples/multi_receipts_detector_v1.txt +5 -0
  36. data/docs/code_samples/nutrition_facts_v1_async.txt +6 -1
  37. data/docs/code_samples/passport_v1.txt +5 -0
  38. data/docs/code_samples/payslip_fra_v2_async.txt +6 -1
  39. data/docs/code_samples/payslip_fra_v3_async.txt +6 -1
  40. data/docs/code_samples/resume_v1_async.txt +6 -1
  41. data/docs/code_samples/us_healthcare_cards_v1_async.txt +6 -1
  42. data/docs/code_samples/us_mail_v3_async.txt +6 -1
  43. data/docs/code_samples/us_w9_v1.txt +5 -0
  44. data/docs/getting_started.md +50 -118
  45. data/docs/{barcode_reader_v1.md → global_products/barcode_reader_v1.md} +26 -9
  46. data/docs/{bill_of_lading_v1.md → global_products/bill_of_lading_v1.md} +62 -37
  47. data/docs/{business_card_v1.md → global_products/business_card_v1.md} +35 -10
  48. data/docs/{cropper_v1.md → global_products/cropper_v1.md} +32 -13
  49. data/docs/{delivery_notes_v1.md → global_products/delivery_notes_v1.md} +35 -10
  50. data/docs/{driver_license_v1.md → global_products/driver_license_v1.md} +65 -9
  51. data/docs/{expense_receipts_v5.md → global_products/expense_receipts_v5.md} +57 -21
  52. data/docs/{financial_document_v1.md → global_products/financial_document_v1.md} +70 -33
  53. data/docs/{international_id_v2.md → global_products/international_id_v2.md} +39 -13
  54. data/docs/{invoice_splitter_v1.md → global_products/invoice_splitter_v1.md} +25 -6
  55. data/docs/{invoices_v4.md → global_products/invoices_v4.md} +70 -33
  56. data/docs/{multi_receipts_detector_v1.md → global_products/multi_receipts_detector_v1.md} +32 -13
  57. data/docs/{nutrition_facts_v1.md → global_products/nutrition_facts_v1.md} +103 -78
  58. data/docs/{passport_v1.md → global_products/passport_v1.md} +26 -9
  59. data/docs/{resume_v1.md → global_products/resume_v1.md} +72 -46
  60. data/docs/{generated_v1.md → global_products/universal.md} +39 -19
  61. data/docs/global_products.md +6 -0
  62. data/docs/loading_a_document.md +316 -0
  63. data/docs/{bank_account_details_v2.md → localized_products/bank_account_details_v2.md} +24 -7
  64. data/docs/{bank_check_v1.md → localized_products/bank_check_v1.md} +37 -18
  65. data/docs/localized_products/bank_statement_fr_v2.md +269 -0
  66. data/docs/{carte_grise_v1.md → localized_products/carte_grise_v1.md} +25 -8
  67. data/docs/{energy_bill_fra_v1.md → localized_products/energy_bill_fra_v1.md} +70 -45
  68. data/docs/{french_healthcard_v1.md → localized_products/french_healthcard_v1.md} +36 -11
  69. data/docs/{idcard_fr_v2.md → localized_products/idcard_fr_v2.md} +34 -16
  70. data/docs/{ind_passport_v1.md → localized_products/ind_passport_v1.md} +37 -11
  71. data/docs/{license_plates_v1.md → localized_products/license_plates_v1.md} +25 -8
  72. data/docs/{payslip_fra_v3.md → localized_products/payslip_fra_v3.md} +80 -55
  73. data/docs/{us_healthcare_cards_v1.md → localized_products/us_healthcare_cards_v1.md} +37 -12
  74. data/docs/{us_mail_v3.md → localized_products/us_mail_v3.md} +49 -24
  75. data/docs/{us_w9_v1.md → localized_products/us_w9_v1.md} +64 -45
  76. data/docs/localized_products.md +6 -0
  77. data/examples/auto_invoice_splitter_extraction.rb +5 -5
  78. data/examples/auto_multi_receipts_detector_extraction.rb +4 -5
  79. data/lib/mindee/client.rb +354 -209
  80. data/lib/mindee/errors/mindee_error.rb +17 -0
  81. data/lib/mindee/errors/mindee_http_error.rb +36 -0
  82. data/lib/mindee/errors/mindee_input_error.rb +30 -0
  83. data/lib/mindee/errors.rb +5 -0
  84. data/lib/mindee/extraction/multi_receipts_extractor.rb +28 -1
  85. data/lib/mindee/extraction.rb +0 -3
  86. data/lib/mindee/geometry/polygon.rb +1 -1
  87. data/lib/mindee/geometry/utils.rb +1 -1
  88. data/lib/mindee/http/endpoint.rb +48 -40
  89. data/lib/mindee/http/{error.rb → http_error_handler.rb} +5 -35
  90. data/lib/mindee/http/response_validation.rb +2 -2
  91. data/lib/mindee/http/workflow_endpoint.rb +12 -12
  92. data/lib/mindee/http.rb +1 -1
  93. data/lib/mindee/{extraction/common → image}/extracted_image.rb +22 -18
  94. data/lib/mindee/{extraction/common → image}/image_extractor.rb +20 -78
  95. data/lib/mindee/image/image_utils.rb +68 -7
  96. data/lib/mindee/image.rb +2 -0
  97. data/lib/mindee/input/local_response.rb +8 -8
  98. data/lib/mindee/input/sources/base64_input_source.rb +6 -6
  99. data/lib/mindee/input/sources/bytes_input_source.rb +3 -3
  100. data/lib/mindee/input/sources/file_input_source.rb +3 -3
  101. data/lib/mindee/input/sources/local_input_source.rb +43 -41
  102. data/lib/mindee/input/sources/path_input_source.rb +3 -3
  103. data/lib/mindee/input/sources/url_input_source.rb +11 -8
  104. data/lib/mindee/logging/logger.rb +16 -0
  105. data/lib/mindee/logging.rb +3 -0
  106. data/lib/mindee/parsing/common/api_request.rb +36 -0
  107. data/lib/mindee/parsing/common/api_response.rb +6 -96
  108. data/lib/mindee/parsing/common/document.rb +12 -8
  109. data/lib/mindee/parsing/common/execution.rb +4 -2
  110. data/lib/mindee/parsing/common/execution_priority.rb +6 -0
  111. data/lib/mindee/parsing/common/extras/cropper_extra.rb +2 -1
  112. data/lib/mindee/parsing/common/extras/extras.rb +9 -4
  113. data/lib/mindee/parsing/common/extras/full_text_ocr_extra.rb +1 -0
  114. data/lib/mindee/parsing/common/inference.rb +23 -4
  115. data/lib/mindee/parsing/common/job.rb +46 -0
  116. data/lib/mindee/parsing/common/ocr/mvision_v1.rb +6 -6
  117. data/lib/mindee/parsing/common/ocr/ocr.rb +29 -29
  118. data/lib/mindee/parsing/common/page.rb +5 -3
  119. data/lib/mindee/parsing/common/prediction.rb +2 -0
  120. data/lib/mindee/parsing/common/workflow_response.rb +28 -0
  121. data/lib/mindee/parsing/common.rb +3 -0
  122. data/lib/mindee/parsing/standard/abstract_field.rb +72 -0
  123. data/lib/mindee/parsing/standard/amount_field.rb +2 -2
  124. data/lib/mindee/parsing/standard/base_field.rb +5 -84
  125. data/lib/mindee/parsing/standard/boolean_field.rb +4 -3
  126. data/lib/mindee/parsing/standard/classification_field.rb +1 -1
  127. data/lib/mindee/parsing/standard/company_registration_field.rb +7 -2
  128. data/lib/mindee/parsing/standard/date_field.rb +2 -2
  129. data/lib/mindee/parsing/standard/feature_field.rb +24 -0
  130. data/lib/mindee/parsing/standard/payment_details_field.rb +2 -2
  131. data/lib/mindee/parsing/standard/position_field.rb +3 -1
  132. data/lib/mindee/parsing/standard/string_field.rb +1 -1
  133. data/lib/mindee/parsing/standard/tax_field.rb +1 -1
  134. data/lib/mindee/parsing/standard.rb +1 -0
  135. data/lib/mindee/parsing/{generated/generated_list_field.rb → universal/universal_list_field.rb} +12 -12
  136. data/lib/mindee/parsing/{generated/generated_object_field.rb → universal/universal_object_field.rb} +23 -14
  137. data/lib/mindee/parsing/universal.rb +4 -0
  138. data/lib/mindee/parsing.rb +1 -2
  139. data/lib/mindee/{extraction/pdf_extractor → pdf}/extracted_pdf.rb +15 -12
  140. data/lib/mindee/pdf/pdf_compressor.rb +12 -10
  141. data/lib/mindee/{extraction/pdf_extractor → pdf}/pdf_extractor.rb +20 -17
  142. data/lib/mindee/pdf/pdf_processor.rb +12 -22
  143. data/lib/mindee/pdf/pdf_tools.rb +52 -6
  144. data/lib/mindee/pdf.rb +2 -0
  145. data/lib/mindee/product/.rubocop.yml +3 -0
  146. data/lib/mindee/product/barcode_reader/barcode_reader_v1.rb +9 -3
  147. data/lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb +5 -5
  148. data/lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb +9 -5
  149. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1.rb +9 -3
  150. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rb +1 -1
  151. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rb +13 -7
  152. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_items.rb +62 -0
  153. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rb +1 -1
  154. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_document.rb +44 -17
  155. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rb +1 -1
  156. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_page.rb +9 -5
  157. data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rb +1 -1
  158. data/lib/mindee/product/business_card/business_card_v1.rb +9 -3
  159. data/lib/mindee/product/business_card/business_card_v1_document.rb +40 -13
  160. data/lib/mindee/product/business_card/business_card_v1_page.rb +9 -5
  161. data/lib/mindee/product/cropper/cropper_v1.rb +10 -4
  162. data/lib/mindee/product/cropper/cropper_v1_page.rb +11 -7
  163. data/lib/mindee/product/delivery_note/delivery_note_v1.rb +9 -3
  164. data/lib/mindee/product/delivery_note/delivery_note_v1_document.rb +29 -8
  165. data/lib/mindee/product/delivery_note/delivery_note_v1_page.rb +9 -5
  166. data/lib/mindee/product/driver_license/driver_license_v1.rb +9 -3
  167. data/lib/mindee/product/driver_license/driver_license_v1_document.rb +44 -14
  168. data/lib/mindee/product/driver_license/driver_license_v1_page.rb +9 -5
  169. data/lib/mindee/product/eu/license_plate/license_plate_v1.rb +9 -3
  170. data/lib/mindee/product/eu/license_plate/license_plate_v1_document.rb +3 -3
  171. data/lib/mindee/product/eu/license_plate/license_plate_v1_page.rb +9 -5
  172. data/lib/mindee/product/financial_document/financial_document_v1.rb +9 -3
  173. data/lib/mindee/product/financial_document/financial_document_v1_document.rb +110 -42
  174. data/lib/mindee/product/financial_document/financial_document_v1_line_item.rb +21 -11
  175. data/lib/mindee/product/financial_document/financial_document_v1_line_items.rb +62 -0
  176. data/lib/mindee/product/financial_document/financial_document_v1_page.rb +9 -5
  177. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1.rb +9 -3
  178. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rb +7 -4
  179. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rb +9 -5
  180. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb +9 -3
  181. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb +1 -1
  182. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb +11 -5
  183. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb +9 -5
  184. data/lib/mindee/product/fr/bank_statement/bank_statement_v2.rb +47 -0
  185. data/lib/mindee/product/fr/bank_statement/{bank_statement_v1_document.rb → bank_statement_v2_document.rb} +62 -26
  186. data/lib/mindee/product/fr/bank_statement/bank_statement_v2_page.rb +38 -0
  187. data/lib/mindee/product/fr/bank_statement/{bank_statement_v1_transaction.rb → bank_statement_v2_transaction.rb} +17 -6
  188. data/lib/mindee/product/fr/bank_statement/bank_statement_v2_transactions.rb +54 -0
  189. data/lib/mindee/product/fr/carte_grise/carte_grise_v1.rb +9 -3
  190. data/lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb +51 -42
  191. data/lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb +9 -5
  192. data/lib/mindee/product/fr/energy_bill/energy_bill_v1.rb +9 -3
  193. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_document.rb +56 -30
  194. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rb +1 -1
  195. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_supplier.rb +1 -1
  196. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rb +13 -7
  197. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_usages.rb +65 -0
  198. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rb +1 -1
  199. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_page.rb +9 -5
  200. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rb +13 -7
  201. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_subscriptions.rb +65 -0
  202. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rb +13 -7
  203. data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contributions.rb +65 -0
  204. data/lib/mindee/product/fr/health_card/health_card_v1.rb +9 -3
  205. data/lib/mindee/product/fr/health_card/health_card_v1_document.rb +15 -6
  206. data/lib/mindee/product/fr/health_card/health_card_v1_page.rb +9 -5
  207. data/lib/mindee/product/fr/id_card/id_card_v1.rb +9 -3
  208. data/lib/mindee/product/fr/id_card/id_card_v1_document.rb +33 -12
  209. data/lib/mindee/product/fr/id_card/id_card_v1_page.rb +14 -7
  210. data/lib/mindee/product/fr/id_card/id_card_v2.rb +9 -3
  211. data/lib/mindee/product/fr/id_card/id_card_v2_document.rb +50 -17
  212. data/lib/mindee/product/fr/id_card/id_card_v2_page.rb +18 -8
  213. data/lib/mindee/product/fr/payslip/payslip_v2.rb +9 -3
  214. data/lib/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rb +1 -1
  215. data/lib/mindee/product/fr/payslip/payslip_v2_document.rb +29 -14
  216. data/lib/mindee/product/fr/payslip/payslip_v2_employee.rb +1 -1
  217. data/lib/mindee/product/fr/payslip/payslip_v2_employer.rb +1 -1
  218. data/lib/mindee/product/fr/payslip/payslip_v2_employment.rb +3 -2
  219. data/lib/mindee/product/fr/payslip/payslip_v2_page.rb +9 -5
  220. data/lib/mindee/product/fr/payslip/payslip_v2_pay_detail.rb +33 -11
  221. data/lib/mindee/product/fr/payslip/payslip_v2_pay_period.rb +1 -1
  222. data/lib/mindee/product/fr/payslip/payslip_v2_pto.rb +13 -4
  223. data/lib/mindee/product/fr/payslip/payslip_v2_salary_detail.rb +13 -7
  224. data/lib/mindee/product/fr/payslip/payslip_v2_salary_details.rb +63 -0
  225. data/lib/mindee/product/fr/payslip/payslip_v3.rb +9 -3
  226. data/lib/mindee/product/fr/payslip/payslip_v3_bank_account_detail.rb +1 -1
  227. data/lib/mindee/product/fr/payslip/payslip_v3_document.rb +31 -19
  228. data/lib/mindee/product/fr/payslip/payslip_v3_employee.rb +1 -1
  229. data/lib/mindee/product/fr/payslip/payslip_v3_employer.rb +1 -1
  230. data/lib/mindee/product/fr/payslip/payslip_v3_employment.rb +1 -1
  231. data/lib/mindee/product/fr/payslip/payslip_v3_page.rb +9 -5
  232. data/lib/mindee/product/fr/payslip/payslip_v3_paid_time_off.rb +13 -7
  233. data/lib/mindee/product/fr/payslip/payslip_v3_paid_time_offs.rb +65 -0
  234. data/lib/mindee/product/fr/payslip/payslip_v3_pay_detail.rb +33 -11
  235. data/lib/mindee/product/fr/payslip/payslip_v3_pay_period.rb +1 -1
  236. data/lib/mindee/product/fr/payslip/payslip_v3_salary_detail.rb +17 -9
  237. data/lib/mindee/product/fr/payslip/payslip_v3_salary_details.rb +65 -0
  238. data/lib/mindee/product/ind/indian_passport/indian_passport_v1.rb +9 -3
  239. data/lib/mindee/product/ind/indian_passport/indian_passport_v1_document.rb +87 -24
  240. data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb +9 -5
  241. data/lib/mindee/product/international_id/international_id_v2.rb +9 -3
  242. data/lib/mindee/product/international_id/international_id_v2_document.rb +62 -20
  243. data/lib/mindee/product/international_id/international_id_v2_page.rb +9 -5
  244. data/lib/mindee/product/invoice/invoice_v4.rb +9 -3
  245. data/lib/mindee/product/invoice/invoice_v4_document.rb +90 -36
  246. data/lib/mindee/product/invoice/invoice_v4_line_item.rb +21 -11
  247. data/lib/mindee/product/invoice/invoice_v4_line_items.rb +62 -0
  248. data/lib/mindee/product/invoice/invoice_v4_page.rb +9 -5
  249. data/lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb +8 -0
  250. data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb +2 -2
  251. data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb +1 -1
  252. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb +9 -3
  253. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb +3 -3
  254. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb +9 -5
  255. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rb +9 -3
  256. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rb +7 -4
  257. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rb +7 -4
  258. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rb +7 -4
  259. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rb +7 -4
  260. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_document.rb +58 -20
  261. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrient.rb +13 -7
  262. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrients.rb +68 -0
  263. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_page.rb +9 -5
  264. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_protein.rb +7 -4
  265. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_saturated_fat.rb +7 -4
  266. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_serving_size.rb +3 -2
  267. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_sodium.rb +7 -4
  268. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_carbohydrate.rb +7 -4
  269. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_fat.rb +7 -4
  270. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_sugar.rb +7 -4
  271. data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_trans_fat.rb +7 -4
  272. data/lib/mindee/product/passport/passport_v1.rb +9 -3
  273. data/lib/mindee/product/passport/passport_v1_document.rb +37 -13
  274. data/lib/mindee/product/passport/passport_v1_page.rb +9 -5
  275. data/lib/mindee/product/receipt/receipt_v5.rb +9 -3
  276. data/lib/mindee/product/receipt/receipt_v5_document.rb +54 -24
  277. data/lib/mindee/product/receipt/receipt_v5_line_item.rb +13 -7
  278. data/lib/mindee/product/receipt/receipt_v5_line_items.rb +54 -0
  279. data/lib/mindee/product/receipt/receipt_v5_page.rb +9 -5
  280. data/lib/mindee/product/resume/resume_v1.rb +9 -3
  281. data/lib/mindee/product/resume/resume_v1_certificate.rb +1 -1
  282. data/lib/mindee/product/resume/resume_v1_certificates.rb +58 -0
  283. data/lib/mindee/product/resume/resume_v1_document.rb +60 -47
  284. data/lib/mindee/product/resume/resume_v1_education.rb +1 -1
  285. data/lib/mindee/product/resume/resume_v1_educations.rb +64 -0
  286. data/lib/mindee/product/resume/resume_v1_language.rb +1 -1
  287. data/lib/mindee/product/resume/resume_v1_languages.rb +54 -0
  288. data/lib/mindee/product/resume/resume_v1_page.rb +9 -5
  289. data/lib/mindee/product/resume/resume_v1_professional_experience.rb +1 -1
  290. data/lib/mindee/product/resume/resume_v1_professional_experiences.rb +68 -0
  291. data/lib/mindee/product/resume/resume_v1_social_networks_url.rb +1 -1
  292. data/lib/mindee/product/resume/resume_v1_social_networks_urls.rb +54 -0
  293. data/lib/mindee/product/universal/universal.rb +46 -0
  294. data/lib/mindee/product/universal/universal_document.rb +32 -0
  295. data/lib/mindee/product/{generated/generated_v1_page.rb → universal/universal_page.rb} +14 -14
  296. data/lib/mindee/product/{generated/generated_v1_prediction.rb → universal/universal_prediction.rb} +32 -24
  297. data/lib/mindee/product/us/bank_check/bank_check_v1.rb +9 -3
  298. data/lib/mindee/product/us/bank_check/bank_check_v1_document.rb +20 -8
  299. data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb +15 -8
  300. data/lib/mindee/product/us/healthcare_card/healthcare_card_v1.rb +9 -3
  301. data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rb +5 -3
  302. data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rb +52 -0
  303. data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb +46 -19
  304. data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb +9 -5
  305. data/lib/mindee/product/us/us_mail/us_mail_v3.rb +9 -3
  306. data/lib/mindee/product/us/us_mail/us_mail_v3_document.rb +20 -12
  307. data/lib/mindee/product/us/us_mail/us_mail_v3_page.rb +9 -5
  308. data/lib/mindee/product/us/us_mail/us_mail_v3_recipient_address.rb +2 -2
  309. data/lib/mindee/product/us/us_mail/us_mail_v3_recipient_addresses.rb +65 -0
  310. data/lib/mindee/product/us/us_mail/us_mail_v3_sender_address.rb +1 -1
  311. data/lib/mindee/product/us/w9/w9_v1.rb +10 -4
  312. data/lib/mindee/product/us/w9/w9_v1_page.rb +49 -18
  313. data/lib/mindee/product.rb +2 -8
  314. data/lib/mindee/version.rb +2 -2
  315. data/lib/mindee.rb +22 -9
  316. data/mindee.gemspec +19 -17
  317. data/sig/custom/marcel.rbs +3 -0
  318. data/sig/custom/mini_magick.rbs +24 -0
  319. data/sig/custom/net_http.rbs +34 -0
  320. data/sig/custom/origami.rbs +54 -0
  321. data/sig/mindee/client.rbs +63 -0
  322. data/sig/mindee/errors/mindee_error.rbs +13 -0
  323. data/sig/mindee/errors/mindee_http_error.rbs +16 -0
  324. data/sig/mindee/errors/mindee_input_error.rbs +17 -0
  325. data/sig/mindee/extraction/multi_receipts_extractor.rbs +6 -0
  326. data/sig/mindee/geometry/min_max.rbs +10 -0
  327. data/sig/mindee/geometry/point.rbs +13 -0
  328. data/sig/mindee/geometry/polygon.rbs +9 -0
  329. data/sig/mindee/geometry/quadrilateral.rbs +18 -0
  330. data/sig/mindee/geometry/utils.rbs +13 -0
  331. data/sig/mindee/http/endpoint.rbs +26 -0
  332. data/sig/mindee/http/http_error_handler.rbs +10 -0
  333. data/sig/mindee/http/response_validation.rbs +10 -0
  334. data/sig/mindee/http/workflow_endpoint.rbs +14 -0
  335. data/sig/mindee/image/extracted_image.rbs +15 -0
  336. data/sig/mindee/image/image_compressor.rbs +8 -0
  337. data/sig/mindee/image/image_extractor.rbs +13 -0
  338. data/sig/mindee/image/image_utils.rbs +19 -0
  339. data/sig/mindee/input/local_response.rbs +13 -0
  340. data/sig/mindee/input/sources/base64_input_source.rbs +11 -0
  341. data/sig/mindee/input/sources/bytes_input_source.rbs +10 -0
  342. data/sig/mindee/input/sources/file_input_source.rbs +10 -0
  343. data/sig/mindee/input/sources/local_input_source.rbs +24 -0
  344. data/sig/mindee/input/sources/path_input_source.rbs +10 -0
  345. data/sig/mindee/input/sources/url_input_source.rbs +20 -0
  346. data/sig/mindee/logging/logger.rbs +9 -0
  347. data/sig/mindee/parsing/common/api_request.rbs +15 -0
  348. data/sig/mindee/parsing/common/api_response.rbs +27 -0
  349. data/sig/mindee/parsing/common/document.rbs +20 -0
  350. data/sig/mindee/parsing/common/execution.rbs +23 -0
  351. data/sig/mindee/parsing/common/execution_file.rbs +12 -0
  352. data/sig/mindee/parsing/common/execution_priority.rbs +13 -0
  353. data/sig/mindee/parsing/common/extras/cropper_extra.rbs +14 -0
  354. data/sig/mindee/parsing/common/extras/extras.rbs +18 -0
  355. data/sig/mindee/parsing/common/extras/full_text_ocr_extra.rbs +15 -0
  356. data/sig/mindee/parsing/common/inference.rbs +19 -0
  357. data/sig/mindee/parsing/common/job.rbs +16 -0
  358. data/sig/mindee/parsing/common/ocr/mvision_v1.rbs +15 -0
  359. data/sig/mindee/parsing/common/ocr/ocr.rbs +39 -0
  360. data/sig/mindee/parsing/common/orientation.rbs +12 -0
  361. data/sig/mindee/parsing/common/page.rbs +15 -0
  362. data/sig/mindee/parsing/common/prediction.rbs +11 -0
  363. data/sig/mindee/parsing/common/product.rbs +13 -0
  364. data/sig/mindee/parsing/common/workflow_response.rbs +13 -0
  365. data/sig/mindee/parsing/standard/abstract_field.rbs +19 -0
  366. data/sig/mindee/parsing/standard/amount_field.rbs +12 -0
  367. data/sig/mindee/parsing/standard/base_field.rbs +12 -0
  368. data/sig/mindee/parsing/standard/boolean_field.rbs +12 -0
  369. data/sig/mindee/parsing/standard/classification_field.rbs +10 -0
  370. data/sig/mindee/parsing/standard/company_registration_field.rbs +14 -0
  371. data/sig/mindee/parsing/standard/date_field.rbs +14 -0
  372. data/sig/mindee/parsing/standard/feature_field.rbs +10 -0
  373. data/sig/mindee/parsing/standard/locale_field.rbs +16 -0
  374. data/sig/mindee/parsing/standard/payment_details_field.rbs +15 -0
  375. data/sig/mindee/parsing/standard/position_field.rbs +17 -0
  376. data/sig/mindee/parsing/standard/string_field.rbs +12 -0
  377. data/sig/mindee/parsing/standard/tax_field.rbs +23 -0
  378. data/sig/mindee/parsing/universal/universal_list_field.rbs +17 -0
  379. data/sig/mindee/parsing/universal/universal_object_field.rbs +23 -0
  380. data/sig/mindee/pdf/extracted_pdf.rbs +15 -0
  381. data/sig/mindee/pdf/pdf_compressor.rbs +15 -0
  382. data/sig/mindee/pdf/pdf_extractor.rbs +16 -0
  383. data/sig/mindee/pdf/pdf_processor.rbs +12 -0
  384. data/sig/mindee/pdf/pdf_tools.rbs +23 -0
  385. data/sig/mindee/product/barcode_reader/barcode_reader_v1.rbs +11 -0
  386. data/sig/mindee/product/barcode_reader/barcode_reader_v1_document.rbs +14 -0
  387. data/sig/mindee/product/barcode_reader/barcode_reader_v1_page.rbs +15 -0
  388. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1.rbs +11 -0
  389. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rbs +14 -0
  390. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rbs +19 -0
  391. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_items.rbs +13 -0
  392. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rbs +15 -0
  393. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_document.rbs +25 -0
  394. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rbs +15 -0
  395. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_page.rbs +15 -0
  396. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rbs +15 -0
  397. data/sig/mindee/product/business_card/business_card_v1.rbs +11 -0
  398. data/sig/mindee/product/business_card/business_card_v1_document.rbs +23 -0
  399. data/sig/mindee/product/business_card/business_card_v1_page.rbs +15 -0
  400. data/sig/mindee/product/cropper/cropper_v1.rbs +11 -0
  401. data/sig/mindee/product/cropper/cropper_v1_document.rbs +12 -0
  402. data/sig/mindee/product/cropper/cropper_v1_page.rbs +16 -0
  403. data/sig/mindee/product/delivery_note/delivery_note_v1.rbs +11 -0
  404. data/sig/mindee/product/delivery_note/delivery_note_v1_document.rbs +19 -0
  405. data/sig/mindee/product/delivery_note/delivery_note_v1_page.rbs +15 -0
  406. data/sig/mindee/product/driver_license/driver_license_v1.rbs +11 -0
  407. data/sig/mindee/product/driver_license/driver_license_v1_document.rbs +25 -0
  408. data/sig/mindee/product/driver_license/driver_license_v1_page.rbs +15 -0
  409. data/sig/mindee/product/eu/license_plate/license_plate_v1.rbs +13 -0
  410. data/sig/mindee/product/eu/license_plate/license_plate_v1_document.rbs +15 -0
  411. data/sig/mindee/product/eu/license_plate/license_plate_v1_page.rbs +17 -0
  412. data/sig/mindee/product/financial_document/financial_document_v1.rbs +11 -0
  413. data/sig/mindee/product/financial_document/financial_document_v1_document.rbs +46 -0
  414. data/sig/mindee/product/financial_document/financial_document_v1_line_item.rbs +21 -0
  415. data/sig/mindee/product/financial_document/financial_document_v1_line_items.rbs +13 -0
  416. data/sig/mindee/product/financial_document/financial_document_v1_page.rbs +15 -0
  417. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1.rbs +13 -0
  418. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rbs +17 -0
  419. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rbs +17 -0
  420. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2.rbs +13 -0
  421. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rbs +17 -0
  422. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rbs +18 -0
  423. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rbs +17 -0
  424. data/sig/mindee/product/fr/bank_statement/bank_statement_v2.rbs +13 -0
  425. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_document.rbs +29 -0
  426. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_page.rbs +17 -0
  427. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_transaction.rbs +18 -0
  428. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_transactions.rbs +15 -0
  429. data/sig/mindee/product/fr/carte_grise/carte_grise_v1.rbs +13 -0
  430. data/sig/mindee/product/fr/carte_grise/carte_grise_v1_document.rbs +55 -0
  431. data/sig/mindee/product/fr/carte_grise/carte_grise_v1_page.rbs +17 -0
  432. data/sig/mindee/product/fr/energy_bill/energy_bill_v1.rbs +13 -0
  433. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_document.rbs +34 -0
  434. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rbs +15 -0
  435. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_supplier.rbs +15 -0
  436. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rbs +21 -0
  437. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_usages.rbs +15 -0
  438. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rbs +16 -0
  439. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_page.rbs +17 -0
  440. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rbs +21 -0
  441. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_subscriptions.rbs +15 -0
  442. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rbs +21 -0
  443. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contributions.rbs +15 -0
  444. data/sig/mindee/product/fr/health_card/health_card_v1.rbs +13 -0
  445. data/sig/mindee/product/fr/health_card/health_card_v1_document.rbs +18 -0
  446. data/sig/mindee/product/fr/health_card/health_card_v1_page.rbs +17 -0
  447. data/sig/mindee/product/fr/id_card/id_card_v1.rbs +13 -0
  448. data/sig/mindee/product/fr/id_card/id_card_v1_document.rbs +24 -0
  449. data/sig/mindee/product/fr/id_card/id_card_v1_page.rbs +18 -0
  450. data/sig/mindee/product/fr/id_card/id_card_v2.rbs +13 -0
  451. data/sig/mindee/product/fr/id_card/id_card_v2_document.rbs +29 -0
  452. data/sig/mindee/product/fr/id_card/id_card_v2_page.rbs +19 -0
  453. data/sig/mindee/product/fr/payslip/payslip_v2.rbs +13 -0
  454. data/sig/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rbs +16 -0
  455. data/sig/mindee/product/fr/payslip/payslip_v2_document.rbs +24 -0
  456. data/sig/mindee/product/fr/payslip/payslip_v2_employee.rbs +20 -0
  457. data/sig/mindee/product/fr/payslip/payslip_v2_employer.rbs +20 -0
  458. data/sig/mindee/product/fr/payslip/payslip_v2_employment.rbs +19 -0
  459. data/sig/mindee/product/fr/payslip/payslip_v2_page.rbs +17 -0
  460. data/sig/mindee/product/fr/payslip/payslip_v2_pay_detail.rbs +23 -0
  461. data/sig/mindee/product/fr/payslip/payslip_v2_pay_period.rbs +18 -0
  462. data/sig/mindee/product/fr/payslip/payslip_v2_pto.rbs +16 -0
  463. data/sig/mindee/product/fr/payslip/payslip_v2_salary_detail.rbs +19 -0
  464. data/sig/mindee/product/fr/payslip/payslip_v2_salary_details.rbs +15 -0
  465. data/sig/mindee/product/fr/payslip/payslip_v3.rbs +13 -0
  466. data/sig/mindee/product/fr/payslip/payslip_v3_bank_account_detail.rbs +16 -0
  467. data/sig/mindee/product/fr/payslip/payslip_v3_document.rbs +26 -0
  468. data/sig/mindee/product/fr/payslip/payslip_v3_employee.rbs +20 -0
  469. data/sig/mindee/product/fr/payslip/payslip_v3_employer.rbs +20 -0
  470. data/sig/mindee/product/fr/payslip/payslip_v3_employment.rbs +20 -0
  471. data/sig/mindee/product/fr/payslip/payslip_v3_page.rbs +17 -0
  472. data/sig/mindee/product/fr/payslip/payslip_v3_paid_time_off.rbs +20 -0
  473. data/sig/mindee/product/fr/payslip/payslip_v3_paid_time_offs.rbs +15 -0
  474. data/sig/mindee/product/fr/payslip/payslip_v3_pay_detail.rbs +23 -0
  475. data/sig/mindee/product/fr/payslip/payslip_v3_pay_period.rbs +18 -0
  476. data/sig/mindee/product/fr/payslip/payslip_v3_salary_detail.rbs +20 -0
  477. data/sig/mindee/product/fr/payslip/payslip_v3_salary_details.rbs +15 -0
  478. data/sig/mindee/product/ind/indian_passport/indian_passport_v1.rbs +13 -0
  479. data/sig/mindee/product/ind/indian_passport/indian_passport_v1_document.rbs +37 -0
  480. data/sig/mindee/product/ind/indian_passport/indian_passport_v1_page.rbs +17 -0
  481. data/sig/mindee/product/international_id/international_id_v2.rbs +11 -0
  482. data/sig/mindee/product/international_id/international_id_v2_document.rbs +29 -0
  483. data/sig/mindee/product/international_id/international_id_v2_page.rbs +15 -0
  484. data/sig/mindee/product/invoice/invoice_v4.rbs +11 -0
  485. data/sig/mindee/product/invoice/invoice_v4_document.rbs +40 -0
  486. data/sig/mindee/product/invoice/invoice_v4_line_item.rbs +21 -0
  487. data/sig/mindee/product/invoice/invoice_v4_line_items.rbs +13 -0
  488. data/sig/mindee/product/invoice/invoice_v4_page.rbs +15 -0
  489. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1.rbs +14 -0
  490. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_document.rbs +19 -0
  491. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_page.rbs +13 -0
  492. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rbs +11 -0
  493. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rbs +13 -0
  494. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rbs +15 -0
  495. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rbs +11 -0
  496. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rbs +14 -0
  497. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rbs +14 -0
  498. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rbs +14 -0
  499. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rbs +14 -0
  500. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_document.rbs +28 -0
  501. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrient.rbs +18 -0
  502. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrients.rbs +13 -0
  503. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_page.rbs +15 -0
  504. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_protein.rbs +14 -0
  505. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_saturated_fat.rbs +14 -0
  506. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_serving_size.rbs +13 -0
  507. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_sodium.rbs +15 -0
  508. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_carbohydrate.rbs +14 -0
  509. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_fat.rbs +14 -0
  510. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_sugar.rbs +14 -0
  511. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_trans_fat.rbs +14 -0
  512. data/sig/mindee/product/passport/passport_v1.rbs +11 -0
  513. data/sig/mindee/product/passport/passport_v1_document.rbs +23 -0
  514. data/sig/mindee/product/passport/passport_v1_page.rbs +15 -0
  515. data/sig/mindee/product/receipt/receipt_v5.rbs +11 -0
  516. data/sig/mindee/product/receipt/receipt_v5_document.rbs +31 -0
  517. data/sig/mindee/product/receipt/receipt_v5_line_item.rbs +17 -0
  518. data/sig/mindee/product/receipt/receipt_v5_line_items.rbs +13 -0
  519. data/sig/mindee/product/receipt/receipt_v5_page.rbs +15 -0
  520. data/sig/mindee/product/resume/resume_v1.rbs +11 -0
  521. data/sig/mindee/product/resume/resume_v1_certificate.rbs +17 -0
  522. data/sig/mindee/product/resume/resume_v1_certificates.rbs +13 -0
  523. data/sig/mindee/product/resume/resume_v1_document.rbs +39 -0
  524. data/sig/mindee/product/resume/resume_v1_education.rbs +20 -0
  525. data/sig/mindee/product/resume/resume_v1_educations.rbs +13 -0
  526. data/sig/mindee/product/resume/resume_v1_language.rbs +15 -0
  527. data/sig/mindee/product/resume/resume_v1_languages.rbs +13 -0
  528. data/sig/mindee/product/resume/resume_v1_page.rbs +15 -0
  529. data/sig/mindee/product/resume/resume_v1_professional_experience.rbs +22 -0
  530. data/sig/mindee/product/resume/resume_v1_professional_experiences.rbs +13 -0
  531. data/sig/mindee/product/resume/resume_v1_social_networks_url.rbs +15 -0
  532. data/sig/mindee/product/resume/resume_v1_social_networks_urls.rbs +13 -0
  533. data/sig/mindee/product/universal/universal.rbs +14 -0
  534. data/sig/mindee/product/universal/universal_document.rbs +10 -0
  535. data/sig/mindee/product/universal/universal_page.rbs +14 -0
  536. data/sig/mindee/product/universal/universal_prediction.rbs +19 -0
  537. data/sig/mindee/product/us/bank_check/bank_check_v1.rbs +13 -0
  538. data/sig/mindee/product/us/bank_check/bank_check_v1_document.rbs +20 -0
  539. data/sig/mindee/product/us/bank_check/bank_check_v1_page.rbs +19 -0
  540. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1.rbs +13 -0
  541. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rbs +17 -0
  542. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rbs +15 -0
  543. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_document.rbs +28 -0
  544. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_page.rbs +17 -0
  545. data/sig/mindee/product/us/us_mail/us_mail_v3.rbs +13 -0
  546. data/sig/mindee/product/us/us_mail/us_mail_v3_document.rbs +21 -0
  547. data/sig/mindee/product/us/us_mail/us_mail_v3_page.rbs +17 -0
  548. data/sig/mindee/product/us/us_mail/us_mail_v3_recipient_address.rbs +23 -0
  549. data/sig/mindee/product/us/us_mail/us_mail_v3_recipient_addresses.rbs +15 -0
  550. data/sig/mindee/product/us/us_mail/us_mail_v3_sender_address.rbs +18 -0
  551. data/sig/mindee/product/us/w9/w9_v1.rbs +13 -0
  552. data/sig/mindee/product/us/w9/w9_v1_document.rbs +14 -0
  553. data/sig/mindee/product/us/w9/w9_v1_page.rbs +29 -0
  554. data/sig/mindee/version.rbs +6 -0
  555. data/sig/mindee.rbs +59 -0
  556. metadata +395 -103
  557. data/docs/bank_statement_fr_v1.md +0 -178
  558. data/docs/code_samples/bank_statement_fr_v1_async.txt +0 -19
  559. data/docs/code_samples/custom_v1.txt +0 -33
  560. data/docs/code_samples/eu_driver_license_v1.txt +0 -19
  561. data/docs/code_samples/expense_receipts_v4.txt +0 -19
  562. data/docs/code_samples/proof_of_address_v1.txt +0 -19
  563. data/docs/code_samples/us_mail_v2_async.txt +0 -19
  564. data/docs/code_samples/workflow_execution.txt +0 -29
  565. data/docs/custom_v1.md +0 -111
  566. data/docs/payslip_fra_v2.md +0 -294
  567. data/lib/mindee/extraction/common.rb +0 -4
  568. data/lib/mindee/extraction/multi_receipts_extractor/multi_receipts_extractor.rb +0 -32
  569. data/lib/mindee/extraction/pdf_extractor.rb +0 -4
  570. data/lib/mindee/extraction/tax_extractor/ocr_extractor.rb +0 -110
  571. data/lib/mindee/extraction/tax_extractor/tax_extractor.rb +0 -338
  572. data/lib/mindee/extraction/tax_extractor.rb +0 -3
  573. data/lib/mindee/parsing/custom/classification_field.rb +0 -28
  574. data/lib/mindee/parsing/custom/list_field.rb +0 -78
  575. data/lib/mindee/parsing/custom.rb +0 -4
  576. data/lib/mindee/parsing/generated.rb +0 -4
  577. data/lib/mindee/product/custom/custom_v1.rb +0 -36
  578. data/lib/mindee/product/custom/custom_v1_document.rb +0 -60
  579. data/lib/mindee/product/custom/custom_v1_page.rb +0 -32
  580. data/lib/mindee/product/eu/driver_license/driver_license_v1.rb +0 -41
  581. data/lib/mindee/product/eu/driver_license/driver_license_v1_document.rb +0 -88
  582. data/lib/mindee/product/eu/driver_license/driver_license_v1_page.rb +0 -53
  583. data/lib/mindee/product/fr/bank_statement/bank_statement_v1.rb +0 -41
  584. data/lib/mindee/product/fr/bank_statement/bank_statement_v1_page.rb +0 -34
  585. data/lib/mindee/product/generated/generated_v1.rb +0 -38
  586. data/lib/mindee/product/generated/generated_v1_document.rb +0 -35
  587. data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb +0 -39
  588. data/lib/mindee/product/proof_of_address/proof_of_address_v1_document.rb +0 -83
  589. data/lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb +0 -32
  590. data/lib/mindee/product/receipt/receipt_v4.rb +0 -36
  591. data/lib/mindee/product/receipt/receipt_v4_document.rb +0 -86
  592. data/lib/mindee/product/receipt/receipt_v4_page.rb +0 -32
  593. data/lib/mindee/product/us/driver_license/driver_license_v1.rb +0 -41
  594. data/lib/mindee/product/us/driver_license/driver_license_v1_document.rb +0 -113
  595. data/lib/mindee/product/us/driver_license/driver_license_v1_page.rb +0 -53
  596. data/lib/mindee/product/us/us_mail/us_mail_v2.rb +0 -41
  597. data/lib/mindee/product/us/us_mail/us_mail_v2_document.rb +0 -100
  598. data/lib/mindee/product/us/us_mail/us_mail_v2_page.rb +0 -34
  599. data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb +0 -105
  600. data/lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb +0 -66
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative '../../../parsing'
4
- require_relative 'healthcare_card_v1_copay'
4
+ require_relative 'healthcare_card_v1_copays'
5
5
 
6
6
  module Mindee
7
7
  module Product
@@ -14,7 +14,7 @@ module Mindee
14
14
  # @return [Mindee::Parsing::Standard::StringField]
15
15
  attr_reader :company_name
16
16
  # Is a fixed amount for a covered service.
17
- # @return [Array<Mindee::Product::US::HealthcareCard::HealthcareCardV1Copay>]
17
+ # @return [Mindee::Product::US::HealthcareCard::HealthcareCardV1Copays]
18
18
  attr_reader :copays
19
19
  # The list of dependents covered by the healthcare plan.
20
20
  # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -50,25 +50,52 @@ module Mindee
50
50
  # @param prediction [Hash]
51
51
  # @param page_id [Integer, nil]
52
52
  def initialize(prediction, page_id)
53
- super()
54
- @company_name = StringField.new(prediction['company_name'], page_id)
55
- @copays = []
56
- prediction['copays'].each do |item|
57
- @copays.push(HealthcareCardV1Copay.new(item, page_id))
58
- end
59
- @dependents = []
53
+ super
54
+ @company_name = Parsing::Standard::StringField.new(
55
+ prediction['company_name'],
56
+ page_id
57
+ )
58
+ @copays = Product::US::HealthcareCard::HealthcareCardV1Copays.new(prediction['copays'], page_id)
59
+ @dependents = [] # : Array[Parsing::Standard::StringField]
60
60
  prediction['dependents'].each do |item|
61
- @dependents.push(StringField.new(item, page_id))
61
+ @dependents.push(Parsing::Standard::StringField.new(item, page_id))
62
62
  end
63
- @enrollment_date = DateField.new(prediction['enrollment_date'], page_id)
64
- @group_number = StringField.new(prediction['group_number'], page_id)
65
- @issuer80840 = StringField.new(prediction['issuer_80840'], page_id)
66
- @member_id = StringField.new(prediction['member_id'], page_id)
67
- @member_name = StringField.new(prediction['member_name'], page_id)
68
- @payer_id = StringField.new(prediction['payer_id'], page_id)
69
- @rx_bin = StringField.new(prediction['rx_bin'], page_id)
70
- @rx_grp = StringField.new(prediction['rx_grp'], page_id)
71
- @rx_pcn = StringField.new(prediction['rx_pcn'], page_id)
63
+ @enrollment_date = Parsing::Standard::DateField.new(
64
+ prediction['enrollment_date'],
65
+ page_id
66
+ )
67
+ @group_number = Parsing::Standard::StringField.new(
68
+ prediction['group_number'],
69
+ page_id
70
+ )
71
+ @issuer80840 = Parsing::Standard::StringField.new(
72
+ prediction['issuer_80840'],
73
+ page_id
74
+ )
75
+ @member_id = Parsing::Standard::StringField.new(
76
+ prediction['member_id'],
77
+ page_id
78
+ )
79
+ @member_name = Parsing::Standard::StringField.new(
80
+ prediction['member_name'],
81
+ page_id
82
+ )
83
+ @payer_id = Parsing::Standard::StringField.new(
84
+ prediction['payer_id'],
85
+ page_id
86
+ )
87
+ @rx_bin = Parsing::Standard::StringField.new(
88
+ prediction['rx_bin'],
89
+ page_id
90
+ )
91
+ @rx_grp = Parsing::Standard::StringField.new(
92
+ prediction['rx_grp'],
93
+ page_id
94
+ )
95
+ @rx_pcn = Parsing::Standard::StringField.new(
96
+ prediction['rx_pcn'],
97
+ page_id
98
+ )
72
99
  end
73
100
 
74
101
  # @return [String]
@@ -11,11 +11,15 @@ module Mindee
11
11
  class HealthcareCardV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = HealthcareCardV1PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ HealthcareCardV1PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
19
23
  end
20
24
  end
21
25
 
@@ -13,6 +13,8 @@ module Mindee
13
13
  class UsMailV3 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'us_mail'
15
15
  @endpoint_version = '3'
16
+ @has_async = true
17
+ @has_sync = false
16
18
 
17
19
  # @param prediction [Hash]
18
20
  def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
20
22
  @prediction = UsMailV3Document.new(prediction['prediction'], nil)
21
23
  @pages = []
22
24
  prediction['pages'].each do |page|
23
- if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
24
- @pages.push(UsMailV3Page.new(page))
25
- end
25
+ @pages.push(UsMailV3Page.new(page))
26
26
  end
27
27
  end
28
28
 
@@ -33,6 +33,12 @@ module Mindee
33
33
  # Version for this product.
34
34
  # @return [String]
35
35
  attr_reader :endpoint_version
36
+ # Whether this product has access to an asynchronous endpoint.
37
+ # @return [bool]
38
+ attr_reader :has_async
39
+ # Whether this product has access to synchronous endpoint.
40
+ # @return [bool]
41
+ attr_reader :has_sync
36
42
  end
37
43
  end
38
44
  end
@@ -2,7 +2,7 @@
2
2
 
3
3
  require_relative '../../../parsing'
4
4
  require_relative 'us_mail_v3_sender_address'
5
- require_relative 'us_mail_v3_recipient_address'
5
+ require_relative 'us_mail_v3_recipient_addresses'
6
6
 
7
7
  module Mindee
8
8
  module Product
@@ -15,7 +15,7 @@ module Mindee
15
15
  # @return [Mindee::Parsing::Standard::BooleanField]
16
16
  attr_reader :is_return_to_sender
17
17
  # The addresses of the recipients.
18
- # @return [Array<Mindee::Product::US::UsMail::UsMailV3RecipientAddress>]
18
+ # @return [Mindee::Product::US::UsMail::UsMailV3RecipientAddresses]
19
19
  attr_reader :recipient_addresses
20
20
  # The names of the recipients.
21
21
  # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -30,18 +30,26 @@ module Mindee
30
30
  # @param prediction [Hash]
31
31
  # @param page_id [Integer, nil]
32
32
  def initialize(prediction, page_id)
33
- super()
34
- @is_return_to_sender = BooleanField.new(prediction['is_return_to_sender'], page_id)
35
- @recipient_addresses = []
36
- prediction['recipient_addresses'].each do |item|
37
- @recipient_addresses.push(UsMailV3RecipientAddress.new(item, page_id))
38
- end
39
- @recipient_names = []
33
+ super
34
+ @is_return_to_sender = Parsing::Standard::BooleanField.new(
35
+ prediction['is_return_to_sender'],
36
+ page_id
37
+ )
38
+ @recipient_addresses = Product::US::UsMail::UsMailV3RecipientAddresses.new(
39
+ prediction['recipient_addresses'], page_id
40
+ )
41
+ @recipient_names = [] # : Array[Parsing::Standard::StringField]
40
42
  prediction['recipient_names'].each do |item|
41
- @recipient_names.push(StringField.new(item, page_id))
43
+ @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
42
44
  end
43
- @sender_address = UsMailV3SenderAddress.new(prediction['sender_address'], page_id)
44
- @sender_name = StringField.new(prediction['sender_name'], page_id)
45
+ @sender_address = Product::US::UsMail::UsMailV3SenderAddress.new(
46
+ prediction['sender_address'],
47
+ page_id
48
+ )
49
+ @sender_name = Parsing::Standard::StringField.new(
50
+ prediction['sender_name'],
51
+ page_id
52
+ )
45
53
  end
46
54
 
47
55
  # @return [String]
@@ -11,11 +11,15 @@ module Mindee
11
11
  class UsMailV3Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = UsMailV3PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ UsMailV3PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
19
23
  end
20
24
  end
21
25
 
@@ -16,7 +16,7 @@ module Mindee
16
16
  # @return [String]
17
17
  attr_reader :complete
18
18
  # Indicates if the recipient's address is a change of address.
19
- # @return [Boolean]
19
+ # @return [bool]
20
20
  attr_reader :is_address_change
21
21
  # The postal code of the recipient's address.
22
22
  # @return [String]
@@ -37,7 +37,7 @@ module Mindee
37
37
  # @param prediction [Hash]
38
38
  # @param page_id [Integer, nil]
39
39
  def initialize(prediction, page_id)
40
- super(prediction, page_id)
40
+ super
41
41
  @city = prediction['city']
42
42
  @complete = prediction['complete']
43
43
  @is_address_change = prediction['is_address_change']
@@ -0,0 +1,65 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'us_mail_v3_sender_address'
4
+ require_relative 'us_mail_v3_recipient_address'
5
+
6
+ module Mindee
7
+ module Product
8
+ module US
9
+ module UsMail
10
+ # The addresses of the recipients.
11
+ class UsMailV3RecipientAddresses < Array
12
+ # Entries.
13
+ # @return [Array<UsMailV3RecipientAddress>]
14
+ attr_reader :entries
15
+
16
+ # @param prediction [Array]
17
+ # @param page_id [Integer, nil]
18
+ def initialize(prediction, page_id)
19
+ entries = prediction.map do |entry|
20
+ UsMail::UsMailV3RecipientAddress.new(entry, page_id)
21
+ end
22
+ super(entries)
23
+ end
24
+
25
+ # Creates a line of rST table-compliant string separators.
26
+ # @param char [String] Character to use as a separator.
27
+ # @return [String]
28
+ def self.line_items_separator(char)
29
+ out_str = String.new
30
+ out_str << "+#{char * 17}"
31
+ out_str << "+#{char * 37}"
32
+ out_str << "+#{char * 19}"
33
+ out_str << "+#{char * 13}"
34
+ out_str << "+#{char * 24}"
35
+ out_str << "+#{char * 7}"
36
+ out_str << "+#{char * 27}"
37
+ out_str << "+#{char * 17}"
38
+ out_str
39
+ end
40
+
41
+ # @return [String]
42
+ def to_s
43
+ return '' if empty?
44
+
45
+ lines = map do |entry|
46
+ "\n #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
47
+ end.join
48
+ out_str = String.new
49
+ out_str << ("\n#{self.class.line_items_separator('-')}\n ")
50
+ out_str << ' | City '
51
+ out_str << ' | Complete Address '
52
+ out_str << ' | Is Address Change'
53
+ out_str << ' | Postal Code'
54
+ out_str << ' | Private Mailbox Number'
55
+ out_str << ' | State'
56
+ out_str << ' | Street '
57
+ out_str << ' | Unit '
58
+ out_str << (" |\n#{self.class.line_items_separator('=')}")
59
+ out_str + lines
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
@@ -28,7 +28,7 @@ module Mindee
28
28
  # @param prediction [Hash]
29
29
  # @param page_id [Integer, nil]
30
30
  def initialize(prediction, page_id)
31
- super(prediction, page_id)
31
+ super
32
32
  @city = prediction['city']
33
33
  @complete = prediction['complete']
34
34
  @postal_code = prediction['postal_code']
@@ -13,16 +13,16 @@ module Mindee
13
13
  class W9V1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'us_w9'
15
15
  @endpoint_version = '1'
16
+ @has_async = false
17
+ @has_sync = true
16
18
 
17
19
  # @param prediction [Hash]
18
20
  def initialize(prediction)
19
21
  super
20
- @prediction = W9V1Document.new
22
+ @prediction = W9V1Document.new(prediction['prediction'], nil)
21
23
  @pages = []
22
24
  prediction['pages'].each do |page|
23
- if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
24
- @pages.push(W9V1Page.new(page))
25
- end
25
+ @pages.push(W9V1Page.new(page))
26
26
  end
27
27
  end
28
28
 
@@ -33,6 +33,12 @@ module Mindee
33
33
  # Version for this product.
34
34
  # @return [String]
35
35
  attr_reader :endpoint_version
36
+ # Whether this product has access to an asynchronous endpoint.
37
+ # @return [bool]
38
+ attr_reader :has_async
39
+ # Whether this product has access to synchronous endpoint.
40
+ # @return [bool]
41
+ attr_reader :has_sync
36
42
  end
37
43
  end
38
44
  end
@@ -11,11 +11,15 @@ module Mindee
11
11
  class W9V1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = W9V1PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ W9V1PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
19
23
  end
20
24
  end
21
25
 
@@ -63,19 +67,46 @@ module Mindee
63
67
  # @param prediction [Hash]
64
68
  # @param page_id [Integer, nil]
65
69
  def initialize(prediction, page_id)
66
- @address = StringField.new(prediction['address'], page_id)
67
- @business_name = StringField.new(prediction['business_name'], page_id)
68
- @city_state_zip = StringField.new(prediction['city_state_zip'], page_id)
69
- @ein = StringField.new(prediction['ein'], page_id)
70
- @name = StringField.new(prediction['name'], page_id)
71
- @signature_date_position = PositionField.new(prediction['signature_date_position'], page_id)
72
- @signature_position = PositionField.new(prediction['signature_position'], page_id)
73
- @ssn = StringField.new(prediction['ssn'], page_id)
74
- @tax_classification = StringField.new(prediction['tax_classification'], page_id)
75
- @tax_classification_llc = StringField.new(prediction['tax_classification_llc'], page_id)
76
- @tax_classification_other_details = StringField.new(prediction['tax_classification_other_details'], page_id)
77
- @w9_revision_date = StringField.new(prediction['w9_revision_date'], page_id)
78
- super()
70
+ @address = Parsing::Standard::StringField.new(
71
+ prediction['address'],
72
+ page_id
73
+ )
74
+ @business_name = Parsing::Standard::StringField.new(
75
+ prediction['business_name'],
76
+ page_id
77
+ )
78
+ @city_state_zip = Parsing::Standard::StringField.new(
79
+ prediction['city_state_zip'],
80
+ page_id
81
+ )
82
+ @ein = Parsing::Standard::StringField.new(prediction['ein'], page_id)
83
+ @name = Parsing::Standard::StringField.new(prediction['name'], page_id)
84
+ @signature_date_position = Parsing::Standard::PositionField.new(
85
+ prediction['signature_date_position'],
86
+ page_id
87
+ )
88
+ @signature_position = Parsing::Standard::PositionField.new(
89
+ prediction['signature_position'],
90
+ page_id
91
+ )
92
+ @ssn = Parsing::Standard::StringField.new(prediction['ssn'], page_id)
93
+ @tax_classification = Parsing::Standard::StringField.new(
94
+ prediction['tax_classification'],
95
+ page_id
96
+ )
97
+ @tax_classification_llc = Parsing::Standard::StringField.new(
98
+ prediction['tax_classification_llc'],
99
+ page_id
100
+ )
101
+ @tax_classification_other_details = Parsing::Standard::StringField.new(
102
+ prediction['tax_classification_other_details'],
103
+ page_id
104
+ )
105
+ @w9_revision_date = Parsing::Standard::StringField.new(
106
+ prediction['w9_revision_date'],
107
+ page_id
108
+ )
109
+ super
79
110
  end
80
111
 
81
112
  # @return [String]
@@ -3,15 +3,13 @@
3
3
  require_relative 'product/barcode_reader/barcode_reader_v1'
4
4
  require_relative 'product/bill_of_lading/bill_of_lading_v1'
5
5
  require_relative 'product/business_card/business_card_v1'
6
- require_relative 'product/custom/custom_v1'
7
6
  require_relative 'product/cropper/cropper_v1'
8
7
  require_relative 'product/delivery_note/delivery_note_v1'
9
8
  require_relative 'product/driver_license/driver_license_v1'
10
9
  require_relative 'product/eu/license_plate/license_plate_v1'
11
- require_relative 'product/eu/driver_license/driver_license_v1'
12
10
  require_relative 'product/fr/bank_account_details/bank_account_details_v1'
13
11
  require_relative 'product/fr/bank_account_details/bank_account_details_v2'
14
- require_relative 'product/fr/bank_statement/bank_statement_v1'
12
+ require_relative 'product/fr/bank_statement/bank_statement_v2'
15
13
  require_relative 'product/fr/carte_grise/carte_grise_v1'
16
14
  require_relative 'product/fr/id_card/id_card_v1'
17
15
  require_relative 'product/fr/id_card/id_card_v2'
@@ -20,7 +18,6 @@ require_relative 'product/fr/health_card/health_card_v1'
20
18
  require_relative 'product/fr/payslip/payslip_v2'
21
19
  require_relative 'product/fr/payslip/payslip_v3'
22
20
  require_relative 'product/financial_document/financial_document_v1'
23
- require_relative 'product/generated/generated_v1'
24
21
  require_relative 'product/ind/indian_passport/indian_passport_v1'
25
22
  require_relative 'product/invoice/invoice_v4'
26
23
  require_relative 'product/invoice_splitter/invoice_splitter_v1'
@@ -28,13 +25,10 @@ require_relative 'product/international_id/international_id_v2'
28
25
  require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
29
26
  require_relative 'product/nutrition_facts_label/nutrition_facts_label_v1'
30
27
  require_relative 'product/passport/passport_v1'
31
- require_relative 'product/proof_of_address/proof_of_address_v1'
32
- require_relative 'product/receipt/receipt_v4'
33
28
  require_relative 'product/receipt/receipt_v5'
34
29
  require_relative 'product/resume/resume_v1'
30
+ require_relative 'product/universal/universal'
35
31
  require_relative 'product/us/bank_check/bank_check_v1'
36
- require_relative 'product/us/driver_license/driver_license_v1'
37
32
  require_relative 'product/us/healthcare_card/healthcare_card_v1'
38
- require_relative 'product/us/us_mail/us_mail_v2'
39
33
  require_relative 'product/us/us_mail/us_mail_v3'
40
34
  require_relative 'product/us/w9/w9_v1'
@@ -3,10 +3,10 @@
3
3
  # Mindee
4
4
  module Mindee
5
5
  # Current version.
6
- VERSION = '3.19.1'
6
+ VERSION = '4.0.0'
7
7
 
8
8
  # Finds and return the current platform.
9
- # @return [String]
9
+ # @return [Symbol, Hash[Symbol | String, Regexp], Nil?]
10
10
  def self.find_platform
11
11
  host = RbConfig::CONFIG['host_os']
12
12
  platforms = {
data/lib/mindee.rb CHANGED
@@ -1,9 +1,17 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require 'mindee/client'
4
- require 'mindee/extraction'
4
+ require 'mindee/logging'
5
5
 
6
6
  module Mindee
7
+ # Mindee internal error module.
8
+ module Errors
9
+ end
10
+
11
+ # Custom extraction module
12
+ module Extraction
13
+ end
14
+
7
15
  # Mindee internal http module.
8
16
  module HTTP
9
17
  end
@@ -29,8 +37,8 @@ module Mindee
29
37
  end
30
38
  end
31
39
 
32
- # Custom extraction module
33
- module Extraction
40
+ # Logging
41
+ module Logging
34
42
  end
35
43
 
36
44
  # Parsing internals and fields.
@@ -39,16 +47,12 @@ module Mindee
39
47
  module Common
40
48
  end
41
49
 
42
- # Custom fields and functions.
43
- module Custom
44
- end
45
-
46
50
  # Standard fields and functions.
47
51
  module Standard
48
52
  end
49
53
 
50
- # Generated fields and functions.
51
- module Generated
54
+ # Universal fields and functions.
55
+ module Universal
52
56
  end
53
57
  end
54
58
 
@@ -66,8 +70,17 @@ module Mindee
66
70
  module FR
67
71
  end
68
72
 
73
+ # Indian-specific products.
74
+ module IND
75
+ end
76
+
69
77
  # US-specific products.
70
78
  module US
71
79
  end
72
80
  end
73
81
  end
82
+
83
+ # Shorthand to call the logger from anywhere.
84
+ def logger
85
+ Mindee::Logging.logger
86
+ end
data/mindee.gemspec CHANGED
@@ -6,20 +6,18 @@ Gem::Specification.new do |spec|
6
6
  spec.name = 'mindee'
7
7
  spec.version = Mindee::VERSION
8
8
  spec.authors = ['Mindee, SA']
9
- spec.email = ['devrel@mindee.co']
9
+ spec.email = ['opensource@mindee.co']
10
10
 
11
11
  spec.summary = 'Mindee API Helper Library for Ruby'
12
12
  spec.description = "Quickly and easily connect to Mindee's API services using Ruby."
13
13
  spec.homepage = 'https://github.com/mindee/mindee-api-ruby'
14
14
  spec.license = 'MIT'
15
15
 
16
- spec.metadata['homepage_uri'] = 'https://mindee.com/'
17
- spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
18
- spec.metadata['changelog_uri'] = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
16
+ spec.metadata['homepage_uri'] = 'https://mindee.com/'
17
+ spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
18
+ spec.metadata['changelog_uri'] = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
19
19
  spec.metadata['rubygems_mfa_required'] = 'true'
20
20
 
21
- # Specify which files should be added to the gem when it is released.
22
- # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
21
  spec.files = Dir.chdir(File.expand_path(__dir__)) do
24
22
  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
25
23
  end
@@ -27,15 +25,19 @@ Gem::Specification.new do |spec|
27
25
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
28
26
  spec.require_paths = ['lib']
29
27
 
30
- spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
31
-
32
- spec.add_runtime_dependency 'marcel', '~> 1.0.2'
33
- spec.add_runtime_dependency 'mini_magick', '>=4', '< 6'
34
- spec.add_runtime_dependency 'origamindee', '~> 3.1.0'
35
- spec.add_runtime_dependency 'pdf-reader', '~> 2.12.0'
36
-
37
- spec.add_development_dependency 'rake', '~> 12.3.3'
38
- spec.add_development_dependency 'rspec', '~> 3.12.0'
39
- spec.add_development_dependency 'rubocop', '~> 1.49.0'
40
- spec.add_development_dependency 'yard', '~> 0.9.34'
28
+ spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
29
+
30
+ spec.add_dependency 'base64', '~> 0.1.0'
31
+ spec.add_dependency 'marcel', '~> 1.0.4'
32
+ spec.add_dependency 'mini_magick', '>= 4', '< 6'
33
+ spec.add_dependency 'origamindee', '~> 4.0.0'
34
+ spec.add_dependency 'pdf-reader', '~> 2.13.0'
35
+
36
+ spec.add_development_dependency 'prism', '~> 1.3'
37
+ spec.add_development_dependency 'rake', '~> 13.2.1'
38
+ spec.add_development_dependency 'rbs', '~> 3.6'
39
+ spec.add_development_dependency 'rspec', '~> 3.13.0'
40
+ spec.add_development_dependency 'rubocop', '~> 1.70.0'
41
+ spec.add_development_dependency 'steep', '~> 1.7.1'
42
+ spec.add_development_dependency 'yard', '~> 0.9.37'
41
43
  end
@@ -0,0 +1,3 @@
1
+ module Marcel
2
+ MimeType: untyped
3
+ end
@@ -0,0 +1,24 @@
1
+ # Stub for the mini_magick library.
2
+ module MiniMagick
3
+ class Image
4
+ def format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
5
+ def self.format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
6
+ def self.quality: (String) -> Net::BufferedIO
7
+ def self.crop: (String) -> Net::BufferedIO
8
+ def self.height: () -> Integer
9
+ def height: () -> Integer
10
+ def self.width: () -> Integer
11
+ def width: () -> Integer
12
+ def self.read: (untyped) -> self
13
+ def self.resolution: () -> Array[Float | Integer]
14
+ def self.write: (StringIO | String) -> Net::BufferedIO
15
+ def write: (StringIO | String) -> Net::BufferedIO
16
+ def quality: (Integer) -> void
17
+ def self.resize: (String) -> void
18
+ def resize: (String) -> void
19
+ def self.to_blob: () -> String
20
+ def to_blob: () -> String
21
+ def self.[]: (?untyped) -> untyped
22
+ def []: (?untyped) -> untyped
23
+ end
24
+ end