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,14 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative '../../../parsing'
4
- require_relative 'bank_statement_v1_transaction'
4
+ require_relative 'bank_statement_v2_transactions'
5
5
 
6
6
  module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module BankStatement
10
- # Bank Statement (FR) V1 document prediction.
11
- class BankStatementV1Document < Mindee::Parsing::Common::Prediction
10
+ # Bank Statement API version 2.0 document data.
11
+ class BankStatementV2Document < Mindee::Parsing::Common::Prediction
12
12
  include Mindee::Parsing::Standard
13
13
  # The unique identifier for a customer's account in the bank's system.
14
14
  # @return [Mindee::Parsing::Standard::StringField]
@@ -22,9 +22,9 @@ module Mindee
22
22
  # The address of the client associated with the bank statement.
23
23
  # @return [Mindee::Parsing::Standard::StringField]
24
24
  attr_reader :client_address
25
- # The name of the client who owns the bank statement.
26
- # @return [Mindee::Parsing::Standard::StringField]
27
- attr_reader :client_name
25
+ # The name of the clients who own the bank statement.
26
+ # @return [Array<Mindee::Parsing::Standard::StringField>]
27
+ attr_reader :client_names
28
28
  # The final amount of money in the account at the end of the statement period.
29
29
  # @return [Mindee::Parsing::Standard::AmountField]
30
30
  attr_reader :closing_balance
@@ -47,39 +47,75 @@ module Mindee
47
47
  # @return [Mindee::Parsing::Standard::AmountField]
48
48
  attr_reader :total_debits
49
49
  # The list of values that represent the financial transactions recorded in a bank statement.
50
- # @return [Array<Mindee::Product::FR::BankStatement::BankStatementV1Transaction>]
50
+ # @return [Mindee::Product::FR::BankStatement::BankStatementV2Transactions]
51
51
  attr_reader :transactions
52
52
 
53
53
  # @param prediction [Hash]
54
54
  # @param page_id [Integer, nil]
55
55
  def initialize(prediction, page_id)
56
- super()
57
- @account_number = StringField.new(prediction['account_number'], page_id)
58
- @bank_address = StringField.new(prediction['bank_address'], page_id)
59
- @bank_name = StringField.new(prediction['bank_name'], page_id)
60
- @client_address = StringField.new(prediction['client_address'], page_id)
61
- @client_name = StringField.new(prediction['client_name'], page_id)
62
- @closing_balance = AmountField.new(prediction['closing_balance'], page_id)
63
- @opening_balance = AmountField.new(prediction['opening_balance'], page_id)
64
- @statement_date = DateField.new(prediction['statement_date'], page_id)
65
- @statement_end_date = DateField.new(prediction['statement_end_date'], page_id)
66
- @statement_start_date = DateField.new(prediction['statement_start_date'], page_id)
67
- @total_credits = AmountField.new(prediction['total_credits'], page_id)
68
- @total_debits = AmountField.new(prediction['total_debits'], page_id)
69
- @transactions = []
70
- prediction['transactions'].each do |item|
71
- @transactions.push(BankStatementV1Transaction.new(item, page_id))
56
+ super
57
+ @account_number = Parsing::Standard::StringField.new(
58
+ prediction['account_number'],
59
+ page_id
60
+ )
61
+ @bank_address = Parsing::Standard::StringField.new(
62
+ prediction['bank_address'],
63
+ page_id
64
+ )
65
+ @bank_name = Parsing::Standard::StringField.new(
66
+ prediction['bank_name'],
67
+ page_id
68
+ )
69
+ @client_address = Parsing::Standard::StringField.new(
70
+ prediction['client_address'],
71
+ page_id
72
+ )
73
+ @client_names = [] # : Array[Parsing::Standard::StringField]
74
+ prediction['client_names'].each do |item|
75
+ @client_names.push(Parsing::Standard::StringField.new(item, page_id))
72
76
  end
77
+ @closing_balance = Parsing::Standard::AmountField.new(
78
+ prediction['closing_balance'],
79
+ page_id
80
+ )
81
+ @opening_balance = Parsing::Standard::AmountField.new(
82
+ prediction['opening_balance'],
83
+ page_id
84
+ )
85
+ @statement_date = Parsing::Standard::DateField.new(
86
+ prediction['statement_date'],
87
+ page_id
88
+ )
89
+ @statement_end_date = Parsing::Standard::DateField.new(
90
+ prediction['statement_end_date'],
91
+ page_id
92
+ )
93
+ @statement_start_date = Parsing::Standard::DateField.new(
94
+ prediction['statement_start_date'],
95
+ page_id
96
+ )
97
+ @total_credits = Parsing::Standard::AmountField.new(
98
+ prediction['total_credits'],
99
+ page_id
100
+ )
101
+ @total_debits = Parsing::Standard::AmountField.new(
102
+ prediction['total_debits'],
103
+ page_id
104
+ )
105
+ @transactions = Product::FR::BankStatement::BankStatementV2Transactions.new(
106
+ prediction['transactions'], page_id
107
+ )
73
108
  end
74
109
 
75
110
  # @return [String]
76
111
  def to_s
112
+ client_names = @client_names.join("\n #{' ' * 14}")
77
113
  transactions = transactions_to_s
78
114
  out_str = String.new
79
115
  out_str << "\n:Account Number: #{@account_number}".rstrip
80
116
  out_str << "\n:Bank Name: #{@bank_name}".rstrip
81
117
  out_str << "\n:Bank Address: #{@bank_address}".rstrip
82
- out_str << "\n:Client Name: #{@client_name}".rstrip
118
+ out_str << "\n:Client Names: #{client_names}".rstrip
83
119
  out_str << "\n:Client Address: #{@client_address}".rstrip
84
120
  out_str << "\n:Statement Date: #{@statement_date}".rstrip
85
121
  out_str << "\n:Statement Start Date: #{@statement_start_date}".rstrip
@@ -100,7 +136,7 @@ module Mindee
100
136
  def transactions_separator(char)
101
137
  out_str = String.new
102
138
  out_str << ' '
103
- out_str << "+#{char * 11}"
139
+ out_str << "+#{char * 12}"
104
140
  out_str << "+#{char * 12}"
105
141
  out_str << "+#{char * 38}"
106
142
  out_str << '+'
@@ -115,7 +151,7 @@ module Mindee
115
151
  out_str = String.new
116
152
  out_str << "\n#{transactions_separator('-')}"
117
153
  out_str << "\n |"
118
- out_str << ' Amount |'
154
+ out_str << ' Amount |'
119
155
  out_str << ' Date |'
120
156
  out_str << ' Description |'
121
157
  out_str << "\n#{transactions_separator('=')}"
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative '../../../parsing'
4
+ require_relative 'bank_statement_v2_document'
5
+
6
+ module Mindee
7
+ module Product
8
+ module FR
9
+ module BankStatement
10
+ # Bank Statement API version 2.0 page data.
11
+ class BankStatementV2Page < Mindee::Parsing::Common::Page
12
+ # @param prediction [Hash]
13
+ def initialize(prediction)
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ BankStatementV2PagePrediction.new(
19
+ prediction['prediction'],
20
+ prediction['id']
21
+ )
22
+ end
23
+ end
24
+ end
25
+
26
+ # Bank Statement V2 page prediction.
27
+ class BankStatementV2PagePrediction < BankStatementV2Document
28
+ # @return [String]
29
+ def to_s
30
+ out_str = String.new
31
+ out_str << "\n#{super}"
32
+ out_str
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -7,7 +7,7 @@ module Mindee
7
7
  module FR
8
8
  module BankStatement
9
9
  # The list of values that represent the financial transactions recorded in a bank statement.
10
- class BankStatementV1Transaction < Mindee::Parsing::Standard::FeatureField
10
+ class BankStatementV2Transaction < Mindee::Parsing::Standard::FeatureField
11
11
  include Mindee::Parsing::Standard
12
12
  # The monetary amount of the transaction.
13
13
  # @return [Float]
@@ -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
  @amount = prediction['amount']
27
27
  @date = prediction['date']
28
28
  @description = prediction['description']
@@ -32,17 +32,28 @@ module Mindee
32
32
  # @return [Hash]
33
33
  def printable_values
34
34
  printable = {}
35
- printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
36
- printable[:date] = format_for_display(@date, nil)
35
+ printable[:amount] =
36
+ @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
37
+ printable[:date] = format_for_display(@date)
38
+ printable[:description] = format_for_display(@description)
39
+ printable
40
+ end
41
+
42
+ # @return [Hash]
43
+ def table_printable_values
44
+ printable = {}
45
+ printable[:amount] =
46
+ @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
47
+ printable[:date] = format_for_display(@date, 10)
37
48
  printable[:description] = format_for_display(@description, 36)
38
49
  printable
39
50
  end
40
51
 
41
52
  # @return [String]
42
53
  def to_table_line
43
- printable = printable_values
54
+ printable = table_printable_values
44
55
  out_str = String.new
45
- out_str << format('| %- 10s', printable[:amount])
56
+ out_str << format('| %- 11s', printable[:amount])
46
57
  out_str << format('| %- 11s', printable[:date])
47
58
  out_str << format('| %- 37s', printable[:description])
48
59
  out_str << '|'
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'bank_statement_v2_transaction'
4
+
5
+ module Mindee
6
+ module Product
7
+ module FR
8
+ module BankStatement
9
+ # The list of values that represent the financial transactions recorded in a bank statement.
10
+ class BankStatementV2Transactions < Array
11
+ # Entries.
12
+ # @return [Array<BankStatementV2Transaction>]
13
+ attr_reader :entries
14
+
15
+ # @param prediction [Array]
16
+ # @param page_id [Integer, nil]
17
+ def initialize(prediction, page_id)
18
+ entries = prediction.map do |entry|
19
+ BankStatement::BankStatementV2Transaction.new(entry, page_id)
20
+ end
21
+ super(entries)
22
+ end
23
+
24
+ # Creates a line of rST table-compliant string separators.
25
+ # @param char [String] Character to use as a separator.
26
+ # @return [String]
27
+ def self.line_items_separator(char)
28
+ out_str = String.new
29
+ out_str << "+#{char * 12}"
30
+ out_str << "+#{char * 12}"
31
+ out_str << "+#{char * 38}"
32
+ out_str
33
+ end
34
+
35
+ # @return [String]
36
+ def to_s
37
+ return '' if empty?
38
+
39
+ lines = map do |entry|
40
+ "\n #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
41
+ end.join
42
+ out_str = String.new
43
+ out_str << ("\n#{self.class.line_items_separator('-')}\n ")
44
+ out_str << ' | Amount '
45
+ out_str << ' | Date '
46
+ out_str << ' | Description '
47
+ out_str << (" |\n#{self.class.line_items_separator('=')}")
48
+ out_str + lines
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -13,6 +13,8 @@ module Mindee
13
13
  class CarteGriseV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'carte_grise'
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)
@@ -20,9 +22,7 @@ module Mindee
20
22
  @prediction = CarteGriseV1Document.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(CarteGriseV1Page.new(page))
25
- end
25
+ @pages.push(CarteGriseV1Page.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
@@ -136,48 +136,57 @@ module Mindee
136
136
  # @param prediction [Hash]
137
137
  # @param page_id [Integer, nil]
138
138
  def initialize(prediction, page_id)
139
- super()
140
- @a = StringField.new(prediction['a'], page_id)
141
- @b = DateField.new(prediction['b'], page_id)
142
- @c1 = StringField.new(prediction['c1'], page_id)
143
- @c3 = StringField.new(prediction['c3'], page_id)
144
- @c41 = StringField.new(prediction['c41'], page_id)
145
- @c4a = StringField.new(prediction['c4a'], page_id)
146
- @d1 = StringField.new(prediction['d1'], page_id)
147
- @d3 = StringField.new(prediction['d3'], page_id)
148
- @e = StringField.new(prediction['e'], page_id)
149
- @f1 = StringField.new(prediction['f1'], page_id)
150
- @f2 = StringField.new(prediction['f2'], page_id)
151
- @f3 = StringField.new(prediction['f3'], page_id)
152
- @formula_number = StringField.new(prediction['formula_number'], page_id)
153
- @g = StringField.new(prediction['g'], page_id)
154
- @g1 = StringField.new(prediction['g1'], page_id)
155
- @i = DateField.new(prediction['i'], page_id)
156
- @j = StringField.new(prediction['j'], page_id)
157
- @j1 = StringField.new(prediction['j1'], page_id)
158
- @j2 = StringField.new(prediction['j2'], page_id)
159
- @j3 = StringField.new(prediction['j3'], page_id)
160
- @mrz1 = StringField.new(prediction['mrz1'], page_id)
161
- @mrz2 = StringField.new(prediction['mrz2'], page_id)
162
- @owner_first_name = StringField.new(prediction['owner_first_name'], page_id)
163
- @owner_surname = StringField.new(prediction['owner_surname'], page_id)
164
- @p1 = StringField.new(prediction['p1'], page_id)
165
- @p2 = StringField.new(prediction['p2'], page_id)
166
- @p3 = StringField.new(prediction['p3'], page_id)
167
- @p6 = StringField.new(prediction['p6'], page_id)
168
- @q = StringField.new(prediction['q'], page_id)
169
- @s1 = StringField.new(prediction['s1'], page_id)
170
- @s2 = StringField.new(prediction['s2'], page_id)
171
- @u1 = StringField.new(prediction['u1'], page_id)
172
- @u2 = StringField.new(prediction['u2'], page_id)
173
- @v7 = StringField.new(prediction['v7'], page_id)
174
- @x1 = StringField.new(prediction['x1'], page_id)
175
- @y1 = StringField.new(prediction['y1'], page_id)
176
- @y2 = StringField.new(prediction['y2'], page_id)
177
- @y3 = StringField.new(prediction['y3'], page_id)
178
- @y4 = StringField.new(prediction['y4'], page_id)
179
- @y5 = StringField.new(prediction['y5'], page_id)
180
- @y6 = StringField.new(prediction['y6'], page_id)
139
+ super
140
+ @a = Parsing::Standard::StringField.new(prediction['a'], page_id)
141
+ @b = Parsing::Standard::DateField.new(prediction['b'], page_id)
142
+ @c1 = Parsing::Standard::StringField.new(prediction['c1'], page_id)
143
+ @c3 = Parsing::Standard::StringField.new(prediction['c3'], page_id)
144
+ @c41 = Parsing::Standard::StringField.new(prediction['c41'], page_id)
145
+ @c4a = Parsing::Standard::StringField.new(prediction['c4a'], page_id)
146
+ @d1 = Parsing::Standard::StringField.new(prediction['d1'], page_id)
147
+ @d3 = Parsing::Standard::StringField.new(prediction['d3'], page_id)
148
+ @e = Parsing::Standard::StringField.new(prediction['e'], page_id)
149
+ @f1 = Parsing::Standard::StringField.new(prediction['f1'], page_id)
150
+ @f2 = Parsing::Standard::StringField.new(prediction['f2'], page_id)
151
+ @f3 = Parsing::Standard::StringField.new(prediction['f3'], page_id)
152
+ @formula_number = Parsing::Standard::StringField.new(
153
+ prediction['formula_number'],
154
+ page_id
155
+ )
156
+ @g = Parsing::Standard::StringField.new(prediction['g'], page_id)
157
+ @g1 = Parsing::Standard::StringField.new(prediction['g1'], page_id)
158
+ @i = Parsing::Standard::DateField.new(prediction['i'], page_id)
159
+ @j = Parsing::Standard::StringField.new(prediction['j'], page_id)
160
+ @j1 = Parsing::Standard::StringField.new(prediction['j1'], page_id)
161
+ @j2 = Parsing::Standard::StringField.new(prediction['j2'], page_id)
162
+ @j3 = Parsing::Standard::StringField.new(prediction['j3'], page_id)
163
+ @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
164
+ @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
165
+ @owner_first_name = Parsing::Standard::StringField.new(
166
+ prediction['owner_first_name'],
167
+ page_id
168
+ )
169
+ @owner_surname = Parsing::Standard::StringField.new(
170
+ prediction['owner_surname'],
171
+ page_id
172
+ )
173
+ @p1 = Parsing::Standard::StringField.new(prediction['p1'], page_id)
174
+ @p2 = Parsing::Standard::StringField.new(prediction['p2'], page_id)
175
+ @p3 = Parsing::Standard::StringField.new(prediction['p3'], page_id)
176
+ @p6 = Parsing::Standard::StringField.new(prediction['p6'], page_id)
177
+ @q = Parsing::Standard::StringField.new(prediction['q'], page_id)
178
+ @s1 = Parsing::Standard::StringField.new(prediction['s1'], page_id)
179
+ @s2 = Parsing::Standard::StringField.new(prediction['s2'], page_id)
180
+ @u1 = Parsing::Standard::StringField.new(prediction['u1'], page_id)
181
+ @u2 = Parsing::Standard::StringField.new(prediction['u2'], page_id)
182
+ @v7 = Parsing::Standard::StringField.new(prediction['v7'], page_id)
183
+ @x1 = Parsing::Standard::StringField.new(prediction['x1'], page_id)
184
+ @y1 = Parsing::Standard::StringField.new(prediction['y1'], page_id)
185
+ @y2 = Parsing::Standard::StringField.new(prediction['y2'], page_id)
186
+ @y3 = Parsing::Standard::StringField.new(prediction['y3'], page_id)
187
+ @y4 = Parsing::Standard::StringField.new(prediction['y4'], page_id)
188
+ @y5 = Parsing::Standard::StringField.new(prediction['y5'], page_id)
189
+ @y6 = Parsing::Standard::StringField.new(prediction['y6'], page_id)
181
190
  end
182
191
 
183
192
  # @return [String]
@@ -11,11 +11,15 @@ module Mindee
11
11
  class CarteGriseV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
14
- super(prediction)
15
- @prediction = CarteGriseV1PagePrediction.new(
16
- prediction['prediction'],
17
- prediction['id']
18
- )
14
+ super
15
+ @prediction = if prediction['prediction'].empty?
16
+ nil
17
+ else
18
+ CarteGriseV1PagePrediction.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 EnergyBillV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'energy_bill_fra'
15
15
  @endpoint_version = '1'
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 = EnergyBillV1Document.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(EnergyBillV1Page.new(page))
25
- end
25
+ @pages.push(EnergyBillV1Page.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
@@ -3,9 +3,9 @@
3
3
  require_relative '../../../parsing'
4
4
  require_relative 'energy_bill_v1_energy_supplier'
5
5
  require_relative 'energy_bill_v1_energy_consumer'
6
- require_relative 'energy_bill_v1_subscription'
7
- require_relative 'energy_bill_v1_energy_usage'
8
- require_relative 'energy_bill_v1_taxes_and_contribution'
6
+ require_relative 'energy_bill_v1_subscriptions'
7
+ require_relative 'energy_bill_v1_energy_usages'
8
+ require_relative 'energy_bill_v1_taxes_and_contributions'
9
9
  require_relative 'energy_bill_v1_meter_detail'
10
10
 
11
11
  module Mindee
@@ -32,7 +32,7 @@ module Mindee
32
32
  # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1EnergySupplier]
33
33
  attr_reader :energy_supplier
34
34
  # Details of energy consumption.
35
- # @return [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsage>]
35
+ # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsages]
36
36
  attr_reader :energy_usage
37
37
  # The date when the energy invoice was issued.
38
38
  # @return [Mindee::Parsing::Standard::DateField]
@@ -44,10 +44,10 @@ module Mindee
44
44
  # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1MeterDetail]
45
45
  attr_reader :meter_details
46
46
  # The subscription details fee for the energy service.
47
- # @return [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1Subscription>]
47
+ # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1Subscriptions]
48
48
  attr_reader :subscription
49
49
  # Details of Taxes and Contributions.
50
- # @return [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContribution>]
50
+ # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContributions]
51
51
  attr_reader :taxes_and_contributions
52
52
  # The total amount to be paid for the energy invoice.
53
53
  # @return [Mindee::Parsing::Standard::AmountField]
@@ -62,30 +62,56 @@ module Mindee
62
62
  # @param prediction [Hash]
63
63
  # @param page_id [Integer, nil]
64
64
  def initialize(prediction, page_id)
65
- super()
66
- @contract_id = StringField.new(prediction['contract_id'], page_id)
67
- @delivery_point = StringField.new(prediction['delivery_point'], page_id)
68
- @due_date = DateField.new(prediction['due_date'], page_id)
69
- @energy_consumer = EnergyBillV1EnergyConsumer.new(prediction['energy_consumer'], page_id)
70
- @energy_supplier = EnergyBillV1EnergySupplier.new(prediction['energy_supplier'], page_id)
71
- @energy_usage = []
72
- prediction['energy_usage'].each do |item|
73
- @energy_usage.push(EnergyBillV1EnergyUsage.new(item, page_id))
74
- end
75
- @invoice_date = DateField.new(prediction['invoice_date'], page_id)
76
- @invoice_number = StringField.new(prediction['invoice_number'], page_id)
77
- @meter_details = EnergyBillV1MeterDetail.new(prediction['meter_details'], page_id)
78
- @subscription = []
79
- prediction['subscription'].each do |item|
80
- @subscription.push(EnergyBillV1Subscription.new(item, page_id))
81
- end
82
- @taxes_and_contributions = []
83
- prediction['taxes_and_contributions'].each do |item|
84
- @taxes_and_contributions.push(EnergyBillV1TaxesAndContribution.new(item, page_id))
85
- end
86
- @total_amount = AmountField.new(prediction['total_amount'], page_id)
87
- @total_before_taxes = AmountField.new(prediction['total_before_taxes'], page_id)
88
- @total_taxes = AmountField.new(prediction['total_taxes'], page_id)
65
+ super
66
+ @contract_id = Parsing::Standard::StringField.new(
67
+ prediction['contract_id'],
68
+ page_id
69
+ )
70
+ @delivery_point = Parsing::Standard::StringField.new(
71
+ prediction['delivery_point'],
72
+ page_id
73
+ )
74
+ @due_date = Parsing::Standard::DateField.new(
75
+ prediction['due_date'],
76
+ page_id
77
+ )
78
+ @energy_consumer = Product::FR::EnergyBill::EnergyBillV1EnergyConsumer.new(
79
+ prediction['energy_consumer'],
80
+ page_id
81
+ )
82
+ @energy_supplier = Product::FR::EnergyBill::EnergyBillV1EnergySupplier.new(
83
+ prediction['energy_supplier'],
84
+ page_id
85
+ )
86
+ @energy_usage = Product::FR::EnergyBill::EnergyBillV1EnergyUsages.new(prediction['energy_usage'], page_id)
87
+ @invoice_date = Parsing::Standard::DateField.new(
88
+ prediction['invoice_date'],
89
+ page_id
90
+ )
91
+ @invoice_number = Parsing::Standard::StringField.new(
92
+ prediction['invoice_number'],
93
+ page_id
94
+ )
95
+ @meter_details = Product::FR::EnergyBill::EnergyBillV1MeterDetail.new(
96
+ prediction['meter_details'],
97
+ page_id
98
+ )
99
+ @subscription = Product::FR::EnergyBill::EnergyBillV1Subscriptions.new(prediction['subscription'], page_id)
100
+ @taxes_and_contributions = Product::FR::EnergyBill::EnergyBillV1TaxesAndContributions.new(
101
+ prediction['taxes_and_contributions'], page_id
102
+ )
103
+ @total_amount = Parsing::Standard::AmountField.new(
104
+ prediction['total_amount'],
105
+ page_id
106
+ )
107
+ @total_before_taxes = Parsing::Standard::AmountField.new(
108
+ prediction['total_before_taxes'],
109
+ page_id
110
+ )
111
+ @total_taxes = Parsing::Standard::AmountField.new(
112
+ prediction['total_taxes'],
113
+ page_id
114
+ )
89
115
  end
90
116
 
91
117
  # @return [String]
@@ -19,7 +19,7 @@ module Mindee
19
19
  # @param prediction [Hash]
20
20
  # @param page_id [Integer, nil]
21
21
  def initialize(prediction, page_id)
22
- super(prediction, page_id)
22
+ super
23
23
  @address = prediction['address']
24
24
  @name = prediction['name']
25
25
  @page_id = page_id
@@ -19,7 +19,7 @@ module Mindee
19
19
  # @param prediction [Hash]
20
20
  # @param page_id [Integer, nil]
21
21
  def initialize(prediction, page_id)
22
- super(prediction, page_id)
22
+ super
23
23
  @address = prediction['address']
24
24
  @name = prediction['name']
25
25
  @page_id = page_id