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
@@ -58,25 +58,58 @@ module Mindee
58
58
  # @param prediction [Hash]
59
59
  # @param page_id [Integer, nil]
60
60
  def initialize(prediction, page_id)
61
- super()
62
- @alternate_name = StringField.new(prediction['alternate_name'], page_id)
63
- @authority = StringField.new(prediction['authority'], page_id)
64
- @birth_date = DateField.new(prediction['birth_date'], page_id)
65
- @birth_place = StringField.new(prediction['birth_place'], page_id)
66
- @card_access_number = StringField.new(prediction['card_access_number'], page_id)
67
- @document_number = StringField.new(prediction['document_number'], page_id)
68
- @expiry_date = DateField.new(prediction['expiry_date'], page_id)
69
- @gender = StringField.new(prediction['gender'], page_id)
70
- @given_names = []
61
+ super
62
+ @alternate_name = Parsing::Standard::StringField.new(
63
+ prediction['alternate_name'],
64
+ page_id
65
+ )
66
+ @authority = Parsing::Standard::StringField.new(
67
+ prediction['authority'],
68
+ page_id
69
+ )
70
+ @birth_date = Parsing::Standard::DateField.new(
71
+ prediction['birth_date'],
72
+ page_id
73
+ )
74
+ @birth_place = Parsing::Standard::StringField.new(
75
+ prediction['birth_place'],
76
+ page_id
77
+ )
78
+ @card_access_number = Parsing::Standard::StringField.new(
79
+ prediction['card_access_number'],
80
+ page_id
81
+ )
82
+ @document_number = Parsing::Standard::StringField.new(
83
+ prediction['document_number'],
84
+ page_id
85
+ )
86
+ @expiry_date = Parsing::Standard::DateField.new(
87
+ prediction['expiry_date'],
88
+ page_id
89
+ )
90
+ @gender = Parsing::Standard::StringField.new(
91
+ prediction['gender'],
92
+ page_id
93
+ )
94
+ @given_names = [] # : Array[Parsing::Standard::StringField]
71
95
  prediction['given_names'].each do |item|
72
- @given_names.push(StringField.new(item, page_id))
96
+ @given_names.push(Parsing::Standard::StringField.new(item, page_id))
73
97
  end
74
- @issue_date = DateField.new(prediction['issue_date'], page_id)
75
- @mrz1 = StringField.new(prediction['mrz1'], page_id)
76
- @mrz2 = StringField.new(prediction['mrz2'], page_id)
77
- @mrz3 = StringField.new(prediction['mrz3'], page_id)
78
- @nationality = StringField.new(prediction['nationality'], page_id)
79
- @surname = StringField.new(prediction['surname'], page_id)
98
+ @issue_date = Parsing::Standard::DateField.new(
99
+ prediction['issue_date'],
100
+ page_id
101
+ )
102
+ @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
103
+ @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
104
+ @mrz3 = Parsing::Standard::StringField.new(prediction['mrz3'], page_id)
105
+ @nationality = Parsing::Standard::StringField.new(
106
+ prediction['nationality'],
107
+ page_id
108
+ )
109
+ @surname = Parsing::Standard::StringField.new(
110
+ prediction['surname'],
111
+ page_id
112
+ )
80
113
  end
81
114
 
82
115
  # @return [String]
@@ -11,11 +11,15 @@ module Mindee
11
11
  class IdCardV2Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = IdCardV2PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ IdCardV2PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
19
23
  end
20
24
  end
21
25
 
@@ -33,9 +37,15 @@ module Mindee
33
37
  # @param prediction [Hash]
34
38
  # @param page_id [Integer, nil]
35
39
  def initialize(prediction, page_id)
36
- @document_side = ClassificationField.new(prediction['document_side'], page_id)
37
- @document_type = ClassificationField.new(prediction['document_type'], page_id)
38
- super(prediction, page_id)
40
+ @document_side = Parsing::Standard::ClassificationField.new(
41
+ prediction['document_side'],
42
+ page_id
43
+ )
44
+ @document_type = Parsing::Standard::ClassificationField.new(
45
+ prediction['document_type'],
46
+ page_id
47
+ )
48
+ super
39
49
  end
40
50
 
41
51
  # @return [String]
@@ -13,6 +13,8 @@ module Mindee
13
13
  class PayslipV2 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'payslip_fra'
15
15
  @endpoint_version = '2'
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 = PayslipV2Document.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(PayslipV2Page.new(page))
25
- end
25
+ @pages.push(PayslipV2Page.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
@@ -22,7 +22,7 @@ module Mindee
22
22
  # @param prediction [Hash]
23
23
  # @param page_id [Integer, nil]
24
24
  def initialize(prediction, page_id)
25
- super(prediction, page_id)
25
+ super
26
26
  @bank_name = prediction['bank_name']
27
27
  @iban = prediction['iban']
28
28
  @swift = prediction['swift']
@@ -5,7 +5,7 @@ require_relative 'payslip_v2_employee'
5
5
  require_relative 'payslip_v2_employer'
6
6
  require_relative 'payslip_v2_bank_account_detail'
7
7
  require_relative 'payslip_v2_employment'
8
- require_relative 'payslip_v2_salary_detail'
8
+ require_relative 'payslip_v2_salary_details'
9
9
  require_relative 'payslip_v2_pay_detail'
10
10
  require_relative 'payslip_v2_pto'
11
11
  require_relative 'payslip_v2_pay_period'
@@ -39,24 +39,39 @@ module Mindee
39
39
  # @return [Mindee::Product::FR::Payslip::PayslipV2Pto]
40
40
  attr_reader :pto
41
41
  # Detailed information about the earnings.
42
- # @return [Array<Mindee::Product::FR::Payslip::PayslipV2SalaryDetail>]
42
+ # @return [Mindee::Product::FR::Payslip::PayslipV2SalaryDetails]
43
43
  attr_reader :salary_details
44
44
 
45
45
  # @param prediction [Hash]
46
46
  # @param page_id [Integer, nil]
47
47
  def initialize(prediction, page_id)
48
- super()
49
- @bank_account_details = PayslipV2BankAccountDetail.new(prediction['bank_account_details'], page_id)
50
- @employee = PayslipV2Employee.new(prediction['employee'], page_id)
51
- @employer = PayslipV2Employer.new(prediction['employer'], page_id)
52
- @employment = PayslipV2Employment.new(prediction['employment'], page_id)
53
- @pay_detail = PayslipV2PayDetail.new(prediction['pay_detail'], page_id)
54
- @pay_period = PayslipV2PayPeriod.new(prediction['pay_period'], page_id)
55
- @pto = PayslipV2Pto.new(prediction['pto'], page_id)
56
- @salary_details = []
57
- prediction['salary_details'].each do |item|
58
- @salary_details.push(PayslipV2SalaryDetail.new(item, page_id))
59
- end
48
+ super
49
+ @bank_account_details = Product::FR::Payslip::PayslipV2BankAccountDetail.new(
50
+ prediction['bank_account_details'],
51
+ page_id
52
+ )
53
+ @employee = Product::FR::Payslip::PayslipV2Employee.new(
54
+ prediction['employee'],
55
+ page_id
56
+ )
57
+ @employer = Product::FR::Payslip::PayslipV2Employer.new(
58
+ prediction['employer'],
59
+ page_id
60
+ )
61
+ @employment = Product::FR::Payslip::PayslipV2Employment.new(
62
+ prediction['employment'],
63
+ page_id
64
+ )
65
+ @pay_detail = Product::FR::Payslip::PayslipV2PayDetail.new(
66
+ prediction['pay_detail'],
67
+ page_id
68
+ )
69
+ @pay_period = Product::FR::Payslip::PayslipV2PayPeriod.new(
70
+ prediction['pay_period'],
71
+ page_id
72
+ )
73
+ @pto = Product::FR::Payslip::PayslipV2Pto.new(prediction['pto'], page_id)
74
+ @salary_details = Product::FR::Payslip::PayslipV2SalaryDetails.new(prediction['salary_details'], page_id)
60
75
  end
61
76
 
62
77
  # @return [String]
@@ -34,7 +34,7 @@ module Mindee
34
34
  # @param prediction [Hash]
35
35
  # @param page_id [Integer, nil]
36
36
  def initialize(prediction, page_id)
37
- super(prediction, page_id)
37
+ super
38
38
  @address = prediction['address']
39
39
  @date_of_birth = prediction['date_of_birth']
40
40
  @first_name = prediction['first_name']
@@ -34,7 +34,7 @@ module Mindee
34
34
  # @param prediction [Hash]
35
35
  # @param page_id [Integer, nil]
36
36
  def initialize(prediction, page_id)
37
- super(prediction, page_id)
37
+ super
38
38
  @address = prediction['address']
39
39
  @company_id = prediction['company_id']
40
40
  @company_site = prediction['company_site']
@@ -31,7 +31,7 @@ module Mindee
31
31
  # @param prediction [Hash]
32
32
  # @param page_id [Integer, nil]
33
33
  def initialize(prediction, page_id)
34
- super(prediction, page_id)
34
+ super
35
35
  @category = prediction['category']
36
36
  @coefficient = prediction['coefficient']
37
37
  @collective_agreement = prediction['collective_agreement']
@@ -45,7 +45,8 @@ module Mindee
45
45
  def printable_values
46
46
  printable = {}
47
47
  printable[:category] = format_for_display(@category)
48
- printable[:coefficient] = @coefficient.nil? ? '' : Field.float_to_string(@coefficient)
48
+ printable[:coefficient] =
49
+ @coefficient.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@coefficient)
49
50
  printable[:collective_agreement] = format_for_display(@collective_agreement)
50
51
  printable[:job_title] = format_for_display(@job_title)
51
52
  printable[:position_level] = format_for_display(@position_level)
@@ -11,11 +11,15 @@ module Mindee
11
11
  class PayslipV2Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = PayslipV2PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ PayslipV2PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
19
23
  end
20
24
  end
21
25
 
@@ -43,7 +43,7 @@ module Mindee
43
43
  # @param prediction [Hash]
44
44
  # @param page_id [Integer, nil]
45
45
  def initialize(prediction, page_id)
46
- super(prediction, page_id)
46
+ super
47
47
  @gross_salary = prediction['gross_salary']
48
48
  @gross_salary_ytd = prediction['gross_salary_ytd']
49
49
  @income_tax_rate = prediction['income_tax_rate']
@@ -60,20 +60,42 @@ module Mindee
60
60
  # @return [Hash]
61
61
  def printable_values
62
62
  printable = {}
63
- printable[:gross_salary] = @gross_salary.nil? ? '' : Field.float_to_string(@gross_salary)
64
- printable[:gross_salary_ytd] = @gross_salary_ytd.nil? ? '' : Field.float_to_string(@gross_salary_ytd)
65
- printable[:income_tax_rate] = @income_tax_rate.nil? ? '' : Field.float_to_string(@income_tax_rate)
63
+ printable[:gross_salary] =
64
+ @gross_salary.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_salary)
65
+ printable[:gross_salary_ytd] =
66
+ @gross_salary_ytd.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@gross_salary_ytd)
67
+ printable[:income_tax_rate] =
68
+ @income_tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@income_tax_rate)
66
69
  printable[:income_tax_withheld] =
67
- @income_tax_withheld.nil? ? '' : Field.float_to_string(@income_tax_withheld)
68
- printable[:net_paid] = @net_paid.nil? ? '' : Field.float_to_string(@net_paid)
70
+ if @income_tax_withheld.nil?
71
+ ''
72
+ else
73
+ Parsing::Standard::BaseField.float_to_string(@income_tax_withheld)
74
+ end
75
+ printable[:net_paid] =
76
+ @net_paid.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_paid)
69
77
  printable[:net_paid_before_tax] =
70
- @net_paid_before_tax.nil? ? '' : Field.float_to_string(@net_paid_before_tax)
71
- printable[:net_taxable] = @net_taxable.nil? ? '' : Field.float_to_string(@net_taxable)
72
- printable[:net_taxable_ytd] = @net_taxable_ytd.nil? ? '' : Field.float_to_string(@net_taxable_ytd)
78
+ if @net_paid_before_tax.nil?
79
+ ''
80
+ else
81
+ Parsing::Standard::BaseField.float_to_string(@net_paid_before_tax)
82
+ end
83
+ printable[:net_taxable] =
84
+ @net_taxable.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_taxable)
85
+ printable[:net_taxable_ytd] =
86
+ @net_taxable_ytd.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@net_taxable_ytd)
73
87
  printable[:total_cost_employer] =
74
- @total_cost_employer.nil? ? '' : Field.float_to_string(@total_cost_employer)
88
+ if @total_cost_employer.nil?
89
+ ''
90
+ else
91
+ Parsing::Standard::BaseField.float_to_string(@total_cost_employer)
92
+ end
75
93
  printable[:total_taxes_and_deductions] =
76
- @total_taxes_and_deductions.nil? ? '' : Field.float_to_string(@total_taxes_and_deductions)
94
+ if @total_taxes_and_deductions.nil?
95
+ ''
96
+ else
97
+ Parsing::Standard::BaseField.float_to_string(@total_taxes_and_deductions)
98
+ end
77
99
  printable
78
100
  end
79
101
 
@@ -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
  @end_date = prediction['end_date']
33
33
  @month = prediction['month']
34
34
  @payment_date = prediction['payment_date']
@@ -22,7 +22,7 @@ module Mindee
22
22
  # @param prediction [Hash]
23
23
  # @param page_id [Integer, nil]
24
24
  def initialize(prediction, page_id)
25
- super(prediction, page_id)
25
+ super
26
26
  @accrued_this_period = prediction['accrued_this_period']
27
27
  @balance_end_of_period = prediction['balance_end_of_period']
28
28
  @used_this_period = prediction['used_this_period']
@@ -33,10 +33,19 @@ module Mindee
33
33
  def printable_values
34
34
  printable = {}
35
35
  printable[:accrued_this_period] =
36
- @accrued_this_period.nil? ? '' : Field.float_to_string(@accrued_this_period)
36
+ if @accrued_this_period.nil?
37
+ ''
38
+ else
39
+ Parsing::Standard::BaseField.float_to_string(@accrued_this_period)
40
+ end
37
41
  printable[:balance_end_of_period] =
38
- @balance_end_of_period.nil? ? '' : Field.float_to_string(@balance_end_of_period)
39
- printable[:used_this_period] = @used_this_period.nil? ? '' : Field.float_to_string(@used_this_period)
42
+ if @balance_end_of_period.nil?
43
+ ''
44
+ else
45
+ Parsing::Standard::BaseField.float_to_string(@balance_end_of_period)
46
+ end
47
+ printable[:used_this_period] =
48
+ @used_this_period.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@used_this_period)
40
49
  printable
41
50
  end
42
51
 
@@ -25,7 +25,7 @@ module Mindee
25
25
  # @param prediction [Hash]
26
26
  # @param page_id [Integer, nil]
27
27
  def initialize(prediction, page_id)
28
- super(prediction, page_id)
28
+ super
29
29
  @amount = prediction['amount']
30
30
  @base = prediction['base']
31
31
  @description = prediction['description']
@@ -36,20 +36,26 @@ module Mindee
36
36
  # @return [Hash]
37
37
  def printable_values
38
38
  printable = {}
39
- printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
40
- printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
39
+ printable[:amount] =
40
+ @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
41
+ printable[:base] =
42
+ @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
41
43
  printable[:description] = format_for_display(@description)
42
- printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
44
+ printable[:rate] =
45
+ @rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@rate)
43
46
  printable
44
47
  end
45
48
 
46
49
  # @return [Hash]
47
50
  def table_printable_values
48
51
  printable = {}
49
- printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
50
- printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
52
+ printable[:amount] =
53
+ @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
54
+ printable[:base] =
55
+ @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
51
56
  printable[:description] = format_for_display(@description, 36)
52
- printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
57
+ printable[:rate] =
58
+ @rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@rate)
53
59
  printable
54
60
  end
55
61
 
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'payslip_v2_employee'
4
+ require_relative 'payslip_v2_employer'
5
+ require_relative 'payslip_v2_bank_account_detail'
6
+ require_relative 'payslip_v2_employment'
7
+ require_relative 'payslip_v2_salary_detail'
8
+ require_relative 'payslip_v2_pay_detail'
9
+ require_relative 'payslip_v2_pto'
10
+ require_relative 'payslip_v2_pay_period'
11
+
12
+ module Mindee
13
+ module Product
14
+ module FR
15
+ module Payslip
16
+ # Detailed information about the earnings.
17
+ class PayslipV2SalaryDetails < Array
18
+ # Entries.
19
+ # @return [Array<PayslipV2SalaryDetail>]
20
+ attr_reader :entries
21
+
22
+ # @param prediction [Array]
23
+ # @param page_id [Integer, nil]
24
+ def initialize(prediction, page_id)
25
+ entries = prediction.map do |entry|
26
+ Payslip::PayslipV2SalaryDetail.new(entry, page_id)
27
+ end
28
+ super(entries)
29
+ end
30
+
31
+ # Creates a line of rST table-compliant string separators.
32
+ # @param char [String] Character to use as a separator.
33
+ # @return [String]
34
+ def self.line_items_separator(char)
35
+ out_str = String.new
36
+ out_str << "+#{char * 14}"
37
+ out_str << "+#{char * 11}"
38
+ out_str << "+#{char * 38}"
39
+ out_str << "+#{char * 11}"
40
+ out_str
41
+ end
42
+
43
+ # @return [String]
44
+ def to_s
45
+ return '' if empty?
46
+
47
+ lines = map do |entry|
48
+ "\n #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
49
+ end.join
50
+ out_str = String.new
51
+ out_str << ("\n#{self.class.line_items_separator('-')}\n ")
52
+ out_str << ' | Amount '
53
+ out_str << ' | Base '
54
+ out_str << ' | Description '
55
+ out_str << ' | Rate '
56
+ out_str << (" |\n#{self.class.line_items_separator('=')}")
57
+ out_str + lines
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
63
+ end
@@ -13,6 +13,8 @@ module Mindee
13
13
  class PayslipV3 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'payslip_fra'
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 = PayslipV3Document.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(PayslipV3Page.new(page))
25
- end
25
+ @pages.push(PayslipV3Page.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
@@ -22,7 +22,7 @@ module Mindee
22
22
  # @param prediction [Hash]
23
23
  # @param page_id [Integer, nil]
24
24
  def initialize(prediction, page_id)
25
- super(prediction, page_id)
25
+ super
26
26
  @bank_name = prediction['bank_name']
27
27
  @iban = prediction['iban']
28
28
  @swift = prediction['swift']
@@ -6,9 +6,9 @@ require_relative 'payslip_v3_employee'
6
6
  require_relative 'payslip_v3_employer'
7
7
  require_relative 'payslip_v3_bank_account_detail'
8
8
  require_relative 'payslip_v3_employment'
9
- require_relative 'payslip_v3_salary_detail'
9
+ require_relative 'payslip_v3_salary_details'
10
10
  require_relative 'payslip_v3_pay_detail'
11
- require_relative 'payslip_v3_paid_time_off'
11
+ require_relative 'payslip_v3_paid_time_offs'
12
12
 
13
13
  module Mindee
14
14
  module Product
@@ -30,7 +30,7 @@ module Mindee
30
30
  # @return [Mindee::Product::FR::Payslip::PayslipV3Employment]
31
31
  attr_reader :employment
32
32
  # Information about paid time off.
33
- # @return [Array<Mindee::Product::FR::Payslip::PayslipV3PaidTimeOff>]
33
+ # @return [Mindee::Product::FR::Payslip::PayslipV3PaidTimeOffs]
34
34
  attr_reader :paid_time_off
35
35
  # Detailed information about the pay.
36
36
  # @return [Mindee::Product::FR::Payslip::PayslipV3PayDetail]
@@ -39,27 +39,39 @@ module Mindee
39
39
  # @return [Mindee::Product::FR::Payslip::PayslipV3PayPeriod]
40
40
  attr_reader :pay_period
41
41
  # Detailed information about the earnings.
42
- # @return [Array<Mindee::Product::FR::Payslip::PayslipV3SalaryDetail>]
42
+ # @return [Mindee::Product::FR::Payslip::PayslipV3SalaryDetails]
43
43
  attr_reader :salary_details
44
44
 
45
45
  # @param prediction [Hash]
46
46
  # @param page_id [Integer, nil]
47
47
  def initialize(prediction, page_id)
48
- super()
49
- @bank_account_details = PayslipV3BankAccountDetail.new(prediction['bank_account_details'], page_id)
50
- @employee = PayslipV3Employee.new(prediction['employee'], page_id)
51
- @employer = PayslipV3Employer.new(prediction['employer'], page_id)
52
- @employment = PayslipV3Employment.new(prediction['employment'], page_id)
53
- @paid_time_off = []
54
- prediction['paid_time_off'].each do |item|
55
- @paid_time_off.push(PayslipV3PaidTimeOff.new(item, page_id))
56
- end
57
- @pay_detail = PayslipV3PayDetail.new(prediction['pay_detail'], page_id)
58
- @pay_period = PayslipV3PayPeriod.new(prediction['pay_period'], page_id)
59
- @salary_details = []
60
- prediction['salary_details'].each do |item|
61
- @salary_details.push(PayslipV3SalaryDetail.new(item, page_id))
62
- end
48
+ super
49
+ @bank_account_details = Product::FR::Payslip::PayslipV3BankAccountDetail.new(
50
+ prediction['bank_account_details'],
51
+ page_id
52
+ )
53
+ @employee = Product::FR::Payslip::PayslipV3Employee.new(
54
+ prediction['employee'],
55
+ page_id
56
+ )
57
+ @employer = Product::FR::Payslip::PayslipV3Employer.new(
58
+ prediction['employer'],
59
+ page_id
60
+ )
61
+ @employment = Product::FR::Payslip::PayslipV3Employment.new(
62
+ prediction['employment'],
63
+ page_id
64
+ )
65
+ @paid_time_off = Product::FR::Payslip::PayslipV3PaidTimeOffs.new(prediction['paid_time_off'], page_id)
66
+ @pay_detail = Product::FR::Payslip::PayslipV3PayDetail.new(
67
+ prediction['pay_detail'],
68
+ page_id
69
+ )
70
+ @pay_period = Product::FR::Payslip::PayslipV3PayPeriod.new(
71
+ prediction['pay_period'],
72
+ page_id
73
+ )
74
+ @salary_details = Product::FR::Payslip::PayslipV3SalaryDetails.new(prediction['salary_details'], page_id)
63
75
  end
64
76
 
65
77
  # @return [String]
@@ -34,7 +34,7 @@ module Mindee
34
34
  # @param prediction [Hash]
35
35
  # @param page_id [Integer, nil]
36
36
  def initialize(prediction, page_id)
37
- super(prediction, page_id)
37
+ super
38
38
  @address = prediction['address']
39
39
  @date_of_birth = prediction['date_of_birth']
40
40
  @first_name = prediction['first_name']
@@ -34,7 +34,7 @@ module Mindee
34
34
  # @param prediction [Hash]
35
35
  # @param page_id [Integer, nil]
36
36
  def initialize(prediction, page_id)
37
- super(prediction, page_id)
37
+ super
38
38
  @address = prediction['address']
39
39
  @company_id = prediction['company_id']
40
40
  @company_site = prediction['company_site']
@@ -34,7 +34,7 @@ module Mindee
34
34
  # @param prediction [Hash]
35
35
  # @param page_id [Integer, nil]
36
36
  def initialize(prediction, page_id)
37
- super(prediction, page_id)
37
+ super
38
38
  @category = prediction['category']
39
39
  @coefficient = prediction['coefficient']
40
40
  @collective_agreement = prediction['collective_agreement']