mindee 3.7.0 → 3.9.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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -1
  3. data/CHANGELOG.md +12 -1
  4. data/docs/expense_receipts_v5.md +7 -0
  5. data/docs/financial_document_v1.md +68 -9
  6. data/docs/invoices_v4.md +42 -6
  7. data/lib/mindee/product/barcode_reader/barcode_reader_v1.rb +1 -1
  8. data/lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb +1 -1
  9. data/lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb +1 -1
  10. data/lib/mindee/product/cropper/cropper_v1.rb +1 -1
  11. data/lib/mindee/product/cropper/cropper_v1_document.rb +1 -1
  12. data/lib/mindee/product/cropper/cropper_v1_page.rb +1 -1
  13. data/lib/mindee/product/eu/driver_license/driver_license_v1.rb +1 -1
  14. data/lib/mindee/product/eu/driver_license/driver_license_v1_document.rb +1 -1
  15. data/lib/mindee/product/eu/driver_license/driver_license_v1_page.rb +1 -1
  16. data/lib/mindee/product/eu/license_plate/license_plate_v1.rb +1 -1
  17. data/lib/mindee/product/eu/license_plate/license_plate_v1_document.rb +1 -1
  18. data/lib/mindee/product/eu/license_plate/license_plate_v1_page.rb +1 -1
  19. data/lib/mindee/product/financial_document/financial_document_v1.rb +1 -1
  20. data/lib/mindee/product/financial_document/financial_document_v1_document.rb +37 -2
  21. data/lib/mindee/product/financial_document/financial_document_v1_page.rb +1 -1
  22. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1.rb +1 -1
  23. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rb +1 -1
  24. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rb +1 -1
  25. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb +1 -1
  26. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb +1 -1
  27. data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb +1 -1
  28. data/lib/mindee/product/fr/carte_grise/carte_grise_v1.rb +1 -1
  29. data/lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb +1 -1
  30. data/lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb +1 -1
  31. data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1.rb +1 -1
  32. data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb +1 -1
  33. data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb +1 -1
  34. data/lib/mindee/product/fr/id_card/id_card_v1.rb +1 -1
  35. data/lib/mindee/product/fr/id_card/id_card_v1_document.rb +1 -1
  36. data/lib/mindee/product/fr/id_card/id_card_v1_page.rb +1 -1
  37. data/lib/mindee/product/fr/id_card/id_card_v2.rb +1 -1
  38. data/lib/mindee/product/fr/id_card/id_card_v2_document.rb +1 -1
  39. data/lib/mindee/product/fr/id_card/id_card_v2_page.rb +1 -1
  40. data/lib/mindee/product/international_id/international_id_v2.rb +1 -1
  41. data/lib/mindee/product/international_id/international_id_v2_document.rb +1 -1
  42. data/lib/mindee/product/international_id/international_id_v2_page.rb +1 -1
  43. data/lib/mindee/product/invoice/invoice_v4.rb +1 -1
  44. data/lib/mindee/product/invoice/invoice_v4_document.rb +21 -1
  45. data/lib/mindee/product/invoice/invoice_v4_page.rb +1 -1
  46. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb +1 -1
  47. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb +1 -1
  48. data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb +1 -1
  49. data/lib/mindee/product/passport/passport_v1.rb +1 -1
  50. data/lib/mindee/product/passport/passport_v1_document.rb +1 -1
  51. data/lib/mindee/product/passport/passport_v1_page.rb +1 -1
  52. data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb +1 -1
  53. data/lib/mindee/product/proof_of_address/proof_of_address_v1_document.rb +1 -1
  54. data/lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb +1 -1
  55. data/lib/mindee/product/receipt/receipt_v5.rb +1 -1
  56. data/lib/mindee/product/receipt/receipt_v5_document.rb +6 -1
  57. data/lib/mindee/product/receipt/receipt_v5_page.rb +1 -1
  58. data/lib/mindee/product/resume/resume_v1.rb +1 -1
  59. data/lib/mindee/product/resume/resume_v1_document.rb +1 -1
  60. data/lib/mindee/product/resume/resume_v1_page.rb +1 -1
  61. data/lib/mindee/product/us/bank_check/bank_check_v1.rb +1 -1
  62. data/lib/mindee/product/us/bank_check/bank_check_v1_document.rb +1 -1
  63. data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb +1 -1
  64. data/lib/mindee/product/us/driver_license/driver_license_v1.rb +1 -1
  65. data/lib/mindee/product/us/driver_license/driver_license_v1_document.rb +1 -1
  66. data/lib/mindee/product/us/driver_license/driver_license_v1_page.rb +1 -1
  67. data/lib/mindee/product/us/w9/w9_v1.rb +1 -1
  68. data/lib/mindee/product/us/w9/w9_v1_document.rb +1 -1
  69. data/lib/mindee/product/us/w9/w9_v1_page.rb +1 -1
  70. data/lib/mindee/version.rb +1 -1
  71. metadata +2 -2
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module BankAccountDetails
10
- # Bank Account Details V1 page.
10
+ # Bank Account Details API version 1.0 page data.
11
11
  class BankAccountDetailsV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module FR
10
10
  # Bank Account Details module.
11
11
  module BankAccountDetails
12
- # Bank Account Details V2 prediction inference.
12
+ # Bank Account Details API version 2 inference prediction.
13
13
  class BankAccountDetailsV2 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'bank_account_details'
15
15
  @endpoint_version = '2'
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module BankAccountDetails
10
- # Bank Account Details V2 document prediction.
10
+ # Bank Account Details API version 2.0 document data.
11
11
  class BankAccountDetailsV2Document < Mindee::Parsing::Common::Prediction
12
12
  include Mindee::Parsing::Standard
13
13
  # Full extraction of the account holders names.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module BankAccountDetails
10
- # Bank Account Details V2 page.
10
+ # Bank Account Details API version 2.0 page data.
11
11
  class BankAccountDetailsV2Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module FR
10
10
  # Carte Grise module.
11
11
  module CarteGrise
12
- # Carte Grise V1 prediction inference.
12
+ # Carte Grise API version 1 inference prediction.
13
13
  class CarteGriseV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'carte_grise'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module FR
8
8
  module CarteGrise
9
- # Carte Grise V1 document prediction.
9
+ # Carte Grise API version 1.1 document data.
10
10
  class CarteGriseV1Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The vehicle's license plate number.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module CarteGrise
10
- # Carte Grise V1 page.
10
+ # Carte Grise API version 1.1 page data.
11
11
  class CarteGriseV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module FR
10
10
  # Carte Vitale module.
11
11
  module CarteVitale
12
- # Carte Vitale V1 prediction inference.
12
+ # Carte Vitale API version 1 inference prediction.
13
13
  class CarteVitaleV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'carte_vitale'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module FR
8
8
  module CarteVitale
9
- # Carte Vitale V1 document prediction.
9
+ # Carte Vitale API version 1.1 document data.
10
10
  class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The given name(s) of the card holder.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module CarteVitale
10
- # Carte Vitale V1 page.
10
+ # Carte Vitale API version 1.1 page data.
11
11
  class CarteVitaleV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module FR
10
10
  # Carte Nationale d'Identité module.
11
11
  module IdCard
12
- # Carte Nationale d'Identité V1 prediction inference.
12
+ # Carte Nationale d'Identité API version 1 inference prediction.
13
13
  class IdCardV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'idcard_fr'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module FR
8
8
  module IdCard
9
- # Carte Nationale d'Identité V1 document prediction.
9
+ # Carte Nationale d'Identité API version 1.1 document data.
10
10
  class IdCardV1Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The name of the issuing authority.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module IdCard
10
- # Carte Nationale d'Identité V1 page.
10
+ # Carte Nationale d'Identité API version 1.1 page data.
11
11
  class IdCardV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module FR
10
10
  # Carte Nationale d'Identité module.
11
11
  module IdCard
12
- # Carte Nationale d'Identité V2 prediction inference.
12
+ # Carte Nationale d'Identité API version 2 inference prediction.
13
13
  class IdCardV2 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'idcard_fr'
15
15
  @endpoint_version = '2'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module FR
8
8
  module IdCard
9
- # Carte Nationale d'Identité V2 document prediction.
9
+ # Carte Nationale d'Identité API version 2.0 document data.
10
10
  class IdCardV2Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The alternate name of the card holder.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module FR
9
9
  module IdCard
10
- # Carte Nationale d'Identité V2 page.
10
+ # Carte Nationale d'Identité API version 2.0 page data.
11
11
  class IdCardV2Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # International ID module.
10
10
  module InternationalId
11
- # International ID V2 prediction inference.
11
+ # International ID API version 2 inference prediction.
12
12
  class InternationalIdV2 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'international_id'
14
14
  @endpoint_version = '2'
@@ -5,7 +5,7 @@ require_relative '../../parsing'
5
5
  module Mindee
6
6
  module Product
7
7
  module InternationalId
8
- # International ID V2 document prediction.
8
+ # International ID API version 2.0 document data.
9
9
  class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
10
10
  include Mindee::Parsing::Standard
11
11
  # The physical address of the document holder.
@@ -6,7 +6,7 @@ require_relative 'international_id_v2_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module InternationalId
9
- # International ID V2 page.
9
+ # International ID API version 2.0 page data.
10
10
  class InternationalIdV2Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Invoice module.
10
10
  module Invoice
11
- # Invoice V4 prediction inference.
11
+ # Invoice API version 4 inference prediction.
12
12
  class InvoiceV4 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'invoices'
14
14
  @endpoint_version = '4'
@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_item'
6
6
  module Mindee
7
7
  module Product
8
8
  module Invoice
9
- # Invoice V4 document prediction.
9
+ # Invoice API version 4.6 document data.
10
10
  class InvoiceV4Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The customer's address used for billing.
@@ -18,6 +18,9 @@ module Mindee
18
18
  # List of company registrations associated to the customer.
19
19
  # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
20
20
  attr_reader :customer_company_registrations
21
+ # The customer account number or identifier from the supplier.
22
+ # @return [Mindee::Parsing::Standard::StringField]
23
+ attr_reader :customer_id
21
24
  # The name of the customer or client.
22
25
  # @return [Mindee::Parsing::Standard::StringField]
23
26
  attr_reader :customer_name
@@ -51,12 +54,21 @@ module Mindee
51
54
  # List of company registrations associated to the supplier.
52
55
  # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
53
56
  attr_reader :supplier_company_registrations
57
+ # The email of the supplier or merchant.
58
+ # @return [Mindee::Parsing::Standard::StringField]
59
+ attr_reader :supplier_email
54
60
  # The name of the supplier or merchant.
55
61
  # @return [Mindee::Parsing::Standard::StringField]
56
62
  attr_reader :supplier_name
57
63
  # List of payment details associated to the supplier.
58
64
  # @return [Array<Mindee::Parsing::Standard::PaymentDetailsField>]
59
65
  attr_reader :supplier_payment_details
66
+ # The phone number of the supplier or merchant.
67
+ # @return [Mindee::Parsing::Standard::StringField]
68
+ attr_reader :supplier_phone_number
69
+ # The website URL of the supplier or merchant.
70
+ # @return [Mindee::Parsing::Standard::StringField]
71
+ attr_reader :supplier_website
60
72
  # List of tax line details.
61
73
  # @return [Mindee::Parsing::Standard::Taxes]
62
74
  attr_reader :taxes
@@ -80,6 +92,7 @@ module Mindee
80
92
  prediction['customer_company_registrations'].each do |item|
81
93
  @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
82
94
  end
95
+ @customer_id = StringField.new(prediction['customer_id'], page_id)
83
96
  @customer_name = StringField.new(prediction['customer_name'], page_id)
84
97
  @date = DateField.new(prediction['date'], page_id)
85
98
  @document_type = ClassificationField.new(prediction['document_type'], page_id)
@@ -100,11 +113,14 @@ module Mindee
100
113
  prediction['supplier_company_registrations'].each do |item|
101
114
  @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
102
115
  end
116
+ @supplier_email = StringField.new(prediction['supplier_email'], page_id)
103
117
  @supplier_name = StringField.new(prediction['supplier_name'], page_id)
104
118
  @supplier_payment_details = []
105
119
  prediction['supplier_payment_details'].each do |item|
106
120
  @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
107
121
  end
122
+ @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
123
+ @supplier_website = StringField.new(prediction['supplier_website'], page_id)
108
124
  @taxes = Taxes.new(prediction['taxes'], page_id)
109
125
  @total_amount = AmountField.new(prediction['total_amount'], page_id)
110
126
  @total_net = AmountField.new(prediction['total_net'], page_id)
@@ -132,9 +148,13 @@ module Mindee
132
148
  out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
133
149
  out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
134
150
  out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
151
+ out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
152
+ out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
153
+ out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
135
154
  out_str << "\n:Customer Name: #{@customer_name}".rstrip
136
155
  out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
137
156
  out_str << "\n:Customer Address: #{@customer_address}".rstrip
157
+ out_str << "\n:Customer ID: #{@customer_id}".rstrip
138
158
  out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
139
159
  out_str << "\n:Billing Address: #{@billing_address}".rstrip
140
160
  out_str << "\n:Document Type: #{@document_type}".rstrip
@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module Invoice
9
- # Invoice V4 page.
9
+ # Invoice API version 4.6 page data.
10
10
  class InvoiceV4Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Multi Receipts Detector module.
10
10
  module MultiReceiptsDetector
11
- # Multi Receipts Detector V1 prediction inference.
11
+ # Multi Receipts Detector API version 1 inference prediction.
12
12
  class MultiReceiptsDetectorV1 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'multi_receipts_detector'
14
14
  @endpoint_version = '1'
@@ -5,7 +5,7 @@ require_relative '../../parsing'
5
5
  module Mindee
6
6
  module Product
7
7
  module MultiReceiptsDetector
8
- # Multi Receipts Detector V1 document prediction.
8
+ # Multi Receipts Detector API version 1.0 document data.
9
9
  class MultiReceiptsDetectorV1Document < Mindee::Parsing::Common::Prediction
10
10
  include Mindee::Parsing::Standard
11
11
  # Positions of the receipts on the document.
@@ -6,7 +6,7 @@ require_relative 'multi_receipts_detector_v1_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module MultiReceiptsDetector
9
- # Multi Receipts Detector V1 page.
9
+ # Multi Receipts Detector API version 1.0 page data.
10
10
  class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Passport module.
10
10
  module Passport
11
- # Passport V1 prediction inference.
11
+ # Passport API version 1 inference prediction.
12
12
  class PassportV1 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'passport'
14
14
  @endpoint_version = '1'
@@ -5,7 +5,7 @@ require_relative '../../parsing'
5
5
  module Mindee
6
6
  module Product
7
7
  module Passport
8
- # Passport V1 document prediction.
8
+ # Passport API version 1.1 document data.
9
9
  class PassportV1Document < Mindee::Parsing::Common::Prediction
10
10
  include Mindee::Parsing::Standard
11
11
  # The date of birth of the passport holder.
@@ -6,7 +6,7 @@ require_relative 'passport_v1_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module Passport
9
- # Passport V1 page.
9
+ # Passport API version 1.1 page data.
10
10
  class PassportV1Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Proof of Address module.
10
10
  module ProofOfAddress
11
- # Proof of Address V1 prediction inference.
11
+ # Proof of Address API version 1 inference prediction.
12
12
  class ProofOfAddressV1 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'proof_of_address'
14
14
  @endpoint_version = '1'
@@ -5,7 +5,7 @@ require_relative '../../parsing'
5
5
  module Mindee
6
6
  module Product
7
7
  module ProofOfAddress
8
- # Proof of Address V1 document prediction.
8
+ # Proof of Address API version 1.1 document data.
9
9
  class ProofOfAddressV1Document < Mindee::Parsing::Common::Prediction
10
10
  include Mindee::Parsing::Standard
11
11
  # The date the document was issued.
@@ -6,7 +6,7 @@ require_relative 'proof_of_address_v1_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module ProofOfAddress
9
- # Proof of Address V1 page.
9
+ # Proof of Address API version 1.1 page data.
10
10
  class ProofOfAddressV1Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Receipt module.
10
10
  module Receipt
11
- # Receipt V5 prediction inference.
11
+ # Receipt API version 5 inference prediction.
12
12
  class ReceiptV5 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'expense_receipts'
14
14
  @endpoint_version = '5'
@@ -6,7 +6,7 @@ require_relative 'receipt_v5_line_item'
6
6
  module Mindee
7
7
  module Product
8
8
  module Receipt
9
- # Receipt V5 document prediction.
9
+ # Receipt API version 5.2 document data.
10
10
  class ReceiptV5Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The purchase category among predefined classes.
@@ -24,6 +24,9 @@ module Mindee
24
24
  # The locale detected on the document.
25
25
  # @return [Mindee::Parsing::Standard::LocaleField]
26
26
  attr_reader :locale
27
+ # The receipt number or identifier.
28
+ # @return [Mindee::Parsing::Standard::StringField]
29
+ attr_reader :receipt_number
27
30
  # The purchase subcategory among predefined classes for transport and food.
28
31
  # @return [Mindee::Parsing::Standard::ClassificationField]
29
32
  attr_reader :subcategory
@@ -70,6 +73,7 @@ module Mindee
70
73
  @line_items.push(ReceiptV5LineItem.new(item, page_id))
71
74
  end
72
75
  @locale = LocaleField.new(prediction['locale'], page_id)
76
+ @receipt_number = StringField.new(prediction['receipt_number'], page_id)
73
77
  @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
74
78
  @supplier_address = StringField.new(prediction['supplier_address'], page_id)
75
79
  @supplier_company_registrations = []
@@ -106,6 +110,7 @@ module Mindee
106
110
  out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
107
111
  out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
108
112
  out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
113
+ out_str << "\n:Receipt Number: #{@receipt_number}".rstrip
109
114
  out_str << "\n:Line Items:"
110
115
  out_str << line_items
111
116
  out_str[1..].to_s
@@ -6,7 +6,7 @@ require_relative 'receipt_v5_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module Receipt
9
- # Receipt V5 page.
9
+ # Receipt API version 5.2 page data.
10
10
  class ReceiptV5Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -8,7 +8,7 @@ module Mindee
8
8
  module Product
9
9
  # Resume module.
10
10
  module Resume
11
- # Resume V1 prediction inference.
11
+ # Resume API version 1 inference prediction.
12
12
  class ResumeV1 < Mindee::Parsing::Common::Inference
13
13
  @endpoint_name = 'resume'
14
14
  @endpoint_version = '1'
@@ -10,7 +10,7 @@ require_relative 'resume_v1_certificate'
10
10
  module Mindee
11
11
  module Product
12
12
  module Resume
13
- # Resume V1 document prediction.
13
+ # Resume API version 1.0 document data.
14
14
  class ResumeV1Document < Mindee::Parsing::Common::Prediction
15
15
  include Mindee::Parsing::Standard
16
16
  # The location information of the candidate, including city, state, and country.
@@ -6,7 +6,7 @@ require_relative 'resume_v1_document'
6
6
  module Mindee
7
7
  module Product
8
8
  module Resume
9
- # Resume V1 page.
9
+ # Resume API version 1.0 page data.
10
10
  class ResumeV1Page < Mindee::Parsing::Common::Page
11
11
  # @param prediction [Hash]
12
12
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module US
10
10
  # Bank Check module.
11
11
  module BankCheck
12
- # Bank Check V1 prediction inference.
12
+ # Bank Check API version 1 inference prediction.
13
13
  class BankCheckV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'bank_check'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module US
8
8
  module BankCheck
9
- # Bank Check V1 document prediction.
9
+ # Bank Check API version 1.1 document data.
10
10
  class BankCheckV1Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # The check payer's account number.
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module US
9
9
  module BankCheck
10
- # Bank Check V1 page.
10
+ # Bank Check API version 1.1 page data.
11
11
  class BankCheckV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module US
10
10
  # Driver License module.
11
11
  module DriverLicense
12
- # Driver License V1 prediction inference.
12
+ # Driver License API version 1 inference prediction.
13
13
  class DriverLicenseV1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'us_driver_license'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module US
8
8
  module DriverLicense
9
- # Driver License V1 document prediction.
9
+ # Driver License API version 1.1 document data.
10
10
  class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
11
11
  include Mindee::Parsing::Standard
12
12
  # US driver license holders address
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module US
9
9
  module DriverLicense
10
- # Driver License V1 page.
10
+ # Driver License API version 1.1 page data.
11
11
  class DriverLicenseV1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -9,7 +9,7 @@ module Mindee
9
9
  module US
10
10
  # W9 module.
11
11
  module W9
12
- # W9 V1 prediction inference.
12
+ # W9 API version 1 inference prediction.
13
13
  class W9V1 < Mindee::Parsing::Common::Inference
14
14
  @endpoint_name = 'us_w9'
15
15
  @endpoint_version = '1'
@@ -6,7 +6,7 @@ module Mindee
6
6
  module Product
7
7
  module US
8
8
  module W9
9
- # W9 V1 document prediction.
9
+ # W9 API version 1.0 document data.
10
10
  class W9V1Document < Mindee::Parsing::Common::Prediction
11
11
  end
12
12
  end
@@ -7,7 +7,7 @@ module Mindee
7
7
  module Product
8
8
  module US
9
9
  module W9
10
- # W9 V1 page.
10
+ # W9 API version 1.0 page data.
11
11
  class W9V1Page < Mindee::Parsing::Common::Page
12
12
  # @param prediction [Hash]
13
13
  def initialize(prediction)
@@ -3,7 +3,7 @@
3
3
  # Mindee
4
4
  module Mindee
5
5
  # Current version.
6
- VERSION = '3.7.0'
6
+ VERSION = '3.9.0'
7
7
 
8
8
  # Finds and return the current platform.
9
9
  # @return [String]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mindee
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.7.0
4
+ version: 3.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mindee, SA
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-28 00:00:00.000000000 Z
11
+ date: 2024-05-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: marcel