factpulse 2.0.42 → 3.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 (410) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +3 -3
  3. data/Gemfile.lock +3 -3
  4. data/README.md +91 -91
  5. data/docs/{CredentialsAFNOR.md → AFNORCredentials.md} +2 -2
  6. data/docs/{DestinationAFNOR.md → AFNORDestination.md} +4 -4
  7. data/docs/AFNORHealthCheckResponse.md +22 -0
  8. data/docs/AFNORPDPPAApi.md +25 -25
  9. data/docs/AFNORPDPPADirectoryServiceApi.md +19 -19
  10. data/docs/AFNORPDPPAFlowServiceApi.md +16 -16
  11. data/docs/{ResultatAFNOR.md → AFNORResult.md} +5 -5
  12. data/docs/APIError.md +2 -2
  13. data/docs/{MontantTva.md → APIProfile.md} +2 -2
  14. data/docs/{CodeCadreFacturation.md → AcknowledgmentStatus.md} +2 -2
  15. data/docs/{CodeRaisonReduction.md → AllowanceReasonCode.md} +2 -2
  16. data/docs/{ModeDepot.md → AmountDue.md} +2 -2
  17. data/docs/BoundingBoxSchema.md +7 -7
  18. data/docs/{CategorieTVA.md → CeleryStatus.md} +2 -2
  19. data/docs/CertificateInfoResponse.md +20 -20
  20. data/docs/ChorusProApi.md +123 -123
  21. data/docs/ChorusProDestination.md +20 -0
  22. data/docs/ChorusProResult.md +22 -0
  23. data/docs/Destination.md +7 -7
  24. data/docs/{ModePaiement.md → DocumentType.md} +2 -2
  25. data/docs/{AdresseElectronique.md → ElectronicAddress.md} +4 -4
  26. data/docs/EnrichedInvoiceInfo.md +32 -0
  27. data/docs/FacturXPDFInfo.md +22 -0
  28. data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +26 -0
  29. data/docs/{CredentialsChorusPro.md → FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md} +4 -4
  30. data/docs/FactureFacturX.md +30 -30
  31. data/docs/FieldStatus.md +15 -0
  32. data/docs/{DirectionFlux.md → FlowDirection.md} +2 -2
  33. data/docs/FlowProfile.md +15 -0
  34. data/docs/FlowSummary.md +32 -0
  35. data/docs/{ProfilFlux.md → FlowSyntax.md} +2 -2
  36. data/docs/{TypeTVA.md → FlowType.md} +2 -2
  37. data/docs/GenerateCertificateRequest.md +19 -19
  38. data/docs/GenerateCertificateResponse.md +8 -8
  39. data/docs/GetChorusProIdRequest.md +22 -0
  40. data/docs/GetChorusProIdResponse.md +24 -0
  41. data/docs/GetInvoiceRequest.md +20 -0
  42. data/docs/GetInvoiceResponse.md +34 -0
  43. data/docs/GetStructureRequest.md +22 -0
  44. data/docs/GetStructureResponse.md +34 -0
  45. data/docs/GlobalAllowanceAmount.md +15 -0
  46. data/docs/{SantApi.md → HealthApi.md} +23 -23
  47. data/docs/IncomingInvoice.md +54 -0
  48. data/docs/IncomingSupplier.md +32 -0
  49. data/docs/{FormatFacture.md → InvoiceFormat.md} +2 -2
  50. data/docs/InvoiceLine.md +46 -0
  51. data/docs/InvoiceLineAllowanceAmount.md +15 -0
  52. data/docs/InvoiceNote.md +20 -0
  53. data/docs/InvoiceProcessingApi.md +831 -0
  54. data/docs/InvoiceReferences.md +32 -0
  55. data/docs/{StatutFacture.md → InvoiceStatus.md} +5 -5
  56. data/docs/InvoiceTotals.md +30 -0
  57. data/docs/InvoiceTotalsPrepayment.md +15 -0
  58. data/docs/InvoiceTypeCode.md +15 -0
  59. data/docs/InvoicingFramework.md +24 -0
  60. data/docs/InvoicingFrameworkCode.md +15 -0
  61. data/docs/LineNetAmount.md +15 -0
  62. data/docs/MandatoryNoteSchema.md +30 -0
  63. data/docs/ManualRate.md +15 -0
  64. data/docs/ManualVatRate.md +15 -0
  65. data/docs/OperationNature.md +15 -0
  66. data/docs/{FormatSortie.md → OutputFormat.md} +2 -2
  67. data/docs/PDFValidationResultAPI.md +62 -0
  68. data/docs/PDFXMLVerificationApi.md +435 -0
  69. data/docs/PDPCredentials.md +4 -4
  70. data/docs/PageDimensionsSchema.md +20 -0
  71. data/docs/{Beneficiaire.md → Payee.md} +5 -5
  72. data/docs/PaymentMeans.md +15 -0
  73. data/docs/PostalAddress.md +26 -0
  74. data/docs/ProcessingOptions.md +24 -0
  75. data/docs/{Quantite.md → Quantity.md} +2 -2
  76. data/docs/Recipient.md +28 -0
  77. data/docs/SearchFlowRequest.md +34 -0
  78. data/docs/SearchFlowResponse.md +24 -0
  79. data/docs/SearchServicesResponse.md +24 -0
  80. data/docs/SearchStructureRequest.md +26 -0
  81. data/docs/SearchStructureResponse.md +24 -0
  82. data/docs/SignatureInfo.md +2 -2
  83. data/docs/SignatureInfoAPI.md +28 -0
  84. data/docs/SignatureParameters.md +34 -0
  85. data/docs/SimplifiedInvoiceData.md +34 -0
  86. data/docs/StructureInfo.md +10 -10
  87. data/docs/StructureParameters.md +22 -0
  88. data/docs/StructureService.md +24 -0
  89. data/docs/SubmissionMode.md +15 -0
  90. data/docs/SubmitCompleteInvoiceRequest.md +26 -0
  91. data/docs/SubmitCompleteInvoiceResponse.md +34 -0
  92. data/docs/SubmitFlowRequest.md +28 -0
  93. data/docs/SubmitFlowResponse.md +30 -0
  94. data/docs/SubmitInvoiceRequest.md +46 -0
  95. data/docs/SubmitInvoiceResponse.md +24 -0
  96. data/docs/SupplementaryAttachment.md +26 -0
  97. data/docs/Supplier.md +36 -0
  98. data/docs/TaskResponse.md +18 -0
  99. data/docs/TaskStatus.md +22 -0
  100. data/docs/TaxableAmount.md +15 -0
  101. data/docs/TotalGrossAmount.md +15 -0
  102. data/docs/TotalNetAmount.md +15 -0
  103. data/docs/TotalVATAmount.md +15 -0
  104. data/docs/UnitNetPrice.md +15 -0
  105. data/docs/UnitOfMeasure.md +15 -0
  106. data/docs/UserApi.md +74 -0
  107. data/docs/VATAccountingCode.md +15 -0
  108. data/docs/{ProfilAPI.md → VATAmount.md} +2 -2
  109. data/docs/VATCategory.md +15 -0
  110. data/docs/VATLine.md +30 -0
  111. data/docs/ValidationErrorDetail.md +3 -3
  112. data/docs/ValidationErrorResponse.md +18 -0
  113. data/docs/ValidationSuccessResponse.md +18 -0
  114. data/docs/{TypeFlux.md → VatAmount.md} +2 -2
  115. data/docs/VerificationSuccessResponse.md +36 -0
  116. data/docs/VerifiedFieldSchema.md +34 -0
  117. data/factpulse.gemspec +4 -4
  118. data/lib/factpulse/api/afnorpdppa_api.rb +25 -25
  119. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +40 -40
  120. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +16 -16
  121. data/lib/factpulse/api/chorus_pro_api.rb +127 -127
  122. data/lib/factpulse/api/health_api.rb +136 -0
  123. data/lib/factpulse/api/invoice_processing_api.rb +835 -0
  124. data/lib/factpulse/api/pdfxml_verification_api.rb +430 -0
  125. data/lib/factpulse/api/user_api.rb +79 -0
  126. data/lib/factpulse/api_client.rb +2 -2
  127. data/lib/factpulse/api_error.rb +2 -2
  128. data/lib/factpulse/api_model_base.rb +2 -2
  129. data/lib/factpulse/configuration.rb +2 -2
  130. data/lib/factpulse/helpers/client.rb +182 -182
  131. data/lib/factpulse/helpers/exceptions.rb +2 -2
  132. data/lib/factpulse/helpers/helpers.rb +5 -5
  133. data/lib/factpulse/models/acknowledgment_status.rb +41 -0
  134. data/lib/factpulse/models/afnor_credentials.rb +169 -0
  135. data/lib/factpulse/models/{destination_afnor.rb → afnor_destination.rb} +10 -10
  136. data/lib/factpulse/models/{reponse_healthcheck_afnor.rb → afnor_health_check_response.rb} +9 -9
  137. data/lib/factpulse/models/{resultat_afnor.rb → afnor_result.rb} +13 -13
  138. data/lib/factpulse/models/allowance_reason_code.rb +45 -0
  139. data/lib/factpulse/models/amount_due.rb +104 -0
  140. data/lib/factpulse/models/api_error.rb +5 -5
  141. data/lib/factpulse/models/api_profile.rb +42 -0
  142. data/lib/factpulse/models/bounding_box_schema.rb +10 -10
  143. data/lib/factpulse/models/celery_status.rb +43 -0
  144. data/lib/factpulse/models/certificate_info_response.rb +164 -164
  145. data/lib/factpulse/models/{destination_chorus_pro.rb → chorus_pro_destination.rb} +7 -7
  146. data/lib/factpulse/models/chorus_pro_result.rb +186 -0
  147. data/lib/factpulse/models/destination.rb +7 -7
  148. data/lib/factpulse/models/document_type.rb +43 -0
  149. data/lib/factpulse/models/electronic_address.rb +196 -0
  150. data/lib/factpulse/models/enriched_invoice_info.rb +348 -0
  151. data/lib/factpulse/models/error_level.rb +2 -2
  152. data/lib/factpulse/models/error_source.rb +2 -2
  153. data/lib/factpulse/models/factur_xpdf_info.rb +205 -0
  154. data/lib/factpulse/models/{chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb} +11 -11
  155. data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
  156. data/lib/factpulse/models/facture_factur_x.rb +160 -160
  157. data/lib/factpulse/models/field_status.rb +43 -0
  158. data/lib/factpulse/models/flow_direction.rb +40 -0
  159. data/lib/factpulse/models/flow_profile.rb +41 -0
  160. data/lib/factpulse/models/flow_summary.rb +251 -0
  161. data/lib/factpulse/models/flow_syntax.rb +43 -0
  162. data/lib/factpulse/models/flow_type.rb +43 -0
  163. data/lib/factpulse/models/generate_certificate_request.rb +106 -106
  164. data/lib/factpulse/models/generate_certificate_response.rb +47 -47
  165. data/lib/factpulse/models/get_chorus_pro_id_request.rb +188 -0
  166. data/lib/factpulse/models/get_chorus_pro_id_response.rb +230 -0
  167. data/lib/factpulse/models/get_invoice_request.rb +176 -0
  168. data/lib/factpulse/models/get_invoice_response.rb +261 -0
  169. data/lib/factpulse/models/get_structure_request.rb +188 -0
  170. data/lib/factpulse/models/get_structure_response.rb +261 -0
  171. data/lib/factpulse/models/global_allowance_amount.rb +104 -0
  172. data/lib/factpulse/models/http_validation_error.rb +2 -2
  173. data/lib/factpulse/models/incoming_invoice.rb +522 -0
  174. data/lib/factpulse/models/incoming_supplier.rb +236 -0
  175. data/lib/factpulse/models/invoice_format.rb +41 -0
  176. data/lib/factpulse/models/invoice_line.rb +389 -0
  177. data/lib/factpulse/models/invoice_line_allowance_amount.rb +104 -0
  178. data/lib/factpulse/models/invoice_note.rb +175 -0
  179. data/lib/factpulse/models/invoice_references.rb +290 -0
  180. data/lib/factpulse/models/invoice_status.rb +203 -0
  181. data/lib/factpulse/models/invoice_totals.rb +272 -0
  182. data/lib/factpulse/models/invoice_totals_prepayment.rb +104 -0
  183. data/lib/factpulse/models/invoice_type_code.rb +70 -0
  184. data/lib/factpulse/models/invoicing_framework.rb +217 -0
  185. data/lib/factpulse/models/invoicing_framework_code.rb +46 -0
  186. data/lib/factpulse/models/line_net_amount.rb +104 -0
  187. data/lib/factpulse/models/mandatory_note_schema.rb +265 -0
  188. data/lib/factpulse/models/manual_rate.rb +104 -0
  189. data/lib/factpulse/models/manual_vat_rate.rb +104 -0
  190. data/lib/factpulse/models/operation_nature.rb +52 -0
  191. data/lib/factpulse/models/output_format.rb +40 -0
  192. data/lib/factpulse/models/page_dimensions_schema.rb +193 -0
  193. data/lib/factpulse/models/{beneficiaire.rb → payee.rb} +15 -15
  194. data/lib/factpulse/models/payment_means.rb +50 -0
  195. data/lib/factpulse/models/pdf_validation_result_api.rb +523 -0
  196. data/lib/factpulse/models/pdp_credentials.rb +7 -7
  197. data/lib/factpulse/models/postal_address.rb +189 -0
  198. data/lib/factpulse/models/processing_options.rb +207 -0
  199. data/lib/factpulse/models/quantity.rb +104 -0
  200. data/lib/factpulse/models/recipient.rb +201 -0
  201. data/lib/factpulse/models/scheme_id.rb +2 -2
  202. data/lib/factpulse/models/search_flow_request.rb +306 -0
  203. data/lib/factpulse/models/search_flow_response.rb +249 -0
  204. data/lib/factpulse/models/search_services_response.rb +214 -0
  205. data/lib/factpulse/models/search_structure_request.rb +191 -0
  206. data/lib/factpulse/models/search_structure_response.rb +216 -0
  207. data/lib/factpulse/models/signature_info.rb +20 -20
  208. data/lib/factpulse/models/signature_info_api.rb +216 -0
  209. data/lib/factpulse/models/signature_parameters.rb +235 -0
  210. data/lib/factpulse/models/simplified_invoice_data.rb +342 -0
  211. data/lib/factpulse/models/structure_info.rb +84 -84
  212. data/lib/factpulse/models/structure_parameters.rb +175 -0
  213. data/lib/factpulse/models/structure_service.rb +247 -0
  214. data/lib/factpulse/models/submission_mode.rb +44 -0
  215. data/lib/factpulse/models/submit_complete_invoice_request.rb +239 -0
  216. data/lib/factpulse/models/submit_complete_invoice_response.rb +355 -0
  217. data/lib/factpulse/models/submit_flow_request.rb +238 -0
  218. data/lib/factpulse/models/submit_flow_response.rb +294 -0
  219. data/lib/factpulse/models/submit_invoice_request.rb +388 -0
  220. data/lib/factpulse/models/submit_invoice_response.rb +213 -0
  221. data/lib/factpulse/models/supplementary_attachment.rb +269 -0
  222. data/lib/factpulse/models/supplier.rb +257 -0
  223. data/lib/factpulse/models/task_response.rb +166 -0
  224. data/lib/factpulse/models/task_status.rb +227 -0
  225. data/lib/factpulse/models/taxable_amount.rb +104 -0
  226. data/lib/factpulse/models/total_gross_amount.rb +104 -0
  227. data/lib/factpulse/models/total_net_amount.rb +104 -0
  228. data/lib/factpulse/models/total_vat_amount.rb +104 -0
  229. data/lib/factpulse/models/unit_net_price.rb +104 -0
  230. data/lib/factpulse/models/unit_of_measure.rb +50 -0
  231. data/lib/factpulse/models/validation_error.rb +2 -2
  232. data/lib/factpulse/models/validation_error_detail.rb +6 -6
  233. data/lib/factpulse/models/validation_error_loc_inner.rb +2 -2
  234. data/lib/factpulse/models/validation_error_response.rb +168 -0
  235. data/lib/factpulse/models/validation_success_response.rb +166 -0
  236. data/lib/factpulse/models/vat_accounting_code.rb +46 -0
  237. data/lib/factpulse/models/vat_amount.rb +104 -0
  238. data/lib/factpulse/models/vat_category.rb +47 -0
  239. data/lib/factpulse/models/vat_line.rb +262 -0
  240. data/lib/factpulse/models/verification_success_response.rb +343 -0
  241. data/lib/factpulse/models/verified_field_schema.rb +334 -0
  242. data/lib/factpulse/version.rb +3 -3
  243. data/lib/factpulse.rb +99 -99
  244. metadata +250 -257
  245. data/docs/AdressePostale.md +0 -26
  246. data/docs/CadreDeFacturation.md +0 -24
  247. data/docs/ChampVerifieSchema.md +0 -34
  248. data/docs/ChorusProCredentials.md +0 -26
  249. data/docs/ConsulterFactureRequest.md +0 -20
  250. data/docs/ConsulterFactureResponse.md +0 -34
  251. data/docs/ConsulterStructureRequest.md +0 -22
  252. data/docs/ConsulterStructureResponse.md +0 -34
  253. data/docs/Destinataire.md +0 -28
  254. data/docs/DestinationChorusPro.md +0 -20
  255. data/docs/DimensionPageSchema.md +0 -20
  256. data/docs/DonneesFactureSimplifiees.md +0 -34
  257. data/docs/FactureEnrichieInfo.md +0 -32
  258. data/docs/FactureEntrante.md +0 -54
  259. data/docs/FluxResume.md +0 -32
  260. data/docs/Fournisseur.md +0 -36
  261. data/docs/FournisseurEntrant.md +0 -32
  262. data/docs/InformationSignatureAPI.md +0 -28
  263. data/docs/LigneDePoste.md +0 -46
  264. data/docs/LigneDePosteMontantRemiseHt.md +0 -15
  265. data/docs/LigneDePosteTauxTvaManuel.md +0 -15
  266. data/docs/LigneDeTVA.md +0 -30
  267. data/docs/MontantAPayer.md +0 -15
  268. data/docs/MontantBaseHt.md +0 -15
  269. data/docs/MontantHtTotal.md +0 -15
  270. data/docs/MontantRemiseGlobaleTtc.md +0 -15
  271. data/docs/MontantTotal.md +0 -30
  272. data/docs/MontantTotalAcompte.md +0 -15
  273. data/docs/MontantTotalLigneHt.md +0 -15
  274. data/docs/MontantTtcTotal.md +0 -15
  275. data/docs/MontantTvaLigne.md +0 -15
  276. data/docs/MontantTvaTotal.md +0 -15
  277. data/docs/MontantUnitaireHt.md +0 -15
  278. data/docs/NatureOperation.md +0 -15
  279. data/docs/Note.md +0 -20
  280. data/docs/NoteObligatoireSchema.md +0 -30
  281. data/docs/ObtenirIdChorusProRequest.md +0 -22
  282. data/docs/ObtenirIdChorusProResponse.md +0 -24
  283. data/docs/OptionsProcessing.md +0 -24
  284. data/docs/PDFFacturXInfo.md +0 -22
  285. data/docs/ParametresSignature.md +0 -34
  286. data/docs/ParametresStructure.md +0 -22
  287. data/docs/PieceJointeComplementaire.md +0 -26
  288. data/docs/RechercherServicesResponse.md +0 -24
  289. data/docs/RechercherStructureRequest.md +0 -26
  290. data/docs/RechercherStructureResponse.md +0 -24
  291. data/docs/References.md +0 -32
  292. data/docs/ReponseHealthcheckAFNOR.md +0 -22
  293. data/docs/ReponseRechercheFlux.md +0 -24
  294. data/docs/ReponseSoumissionFlux.md +0 -30
  295. data/docs/ReponseTache.md +0 -18
  296. data/docs/ReponseValidationErreur.md +0 -18
  297. data/docs/ReponseValidationSucces.md +0 -18
  298. data/docs/ReponseVerificationSucces.md +0 -36
  299. data/docs/RequeteRechercheFlux.md +0 -34
  300. data/docs/RequeteSoumissionFlux.md +0 -28
  301. data/docs/ResultatChorusPro.md +0 -22
  302. data/docs/ResultatValidationPDFAPI.md +0 -62
  303. data/docs/ServiceStructure.md +0 -24
  304. data/docs/SoumettreFactureCompleteRequest.md +0 -26
  305. data/docs/SoumettreFactureCompleteResponse.md +0 -34
  306. data/docs/SoumettreFactureRequest.md +0 -46
  307. data/docs/SoumettreFactureResponse.md +0 -24
  308. data/docs/StatutAcquittement.md +0 -15
  309. data/docs/StatutCelery.md +0 -15
  310. data/docs/StatutChampAPI.md +0 -15
  311. data/docs/StatutTache.md +0 -22
  312. data/docs/SyntaxeFlux.md +0 -15
  313. data/docs/Tauxmanuel.md +0 -15
  314. data/docs/TraitementFactureApi.md +0 -831
  315. data/docs/TypeDocument.md +0 -15
  316. data/docs/TypeFacture.md +0 -15
  317. data/docs/Unite.md +0 -15
  318. data/docs/UtilisateurApi.md +0 -74
  319. data/docs/VrificationPDFXMLApi.md +0 -435
  320. data/lib/factpulse/api/sant_api.rb +0 -136
  321. data/lib/factpulse/api/traitement_facture_api.rb +0 -835
  322. data/lib/factpulse/api/utilisateur_api.rb +0 -79
  323. data/lib/factpulse/api/vrification_pdfxml_api.rb +0 -430
  324. data/lib/factpulse/models/adresse_electronique.rb +0 -196
  325. data/lib/factpulse/models/adresse_postale.rb +0 -189
  326. data/lib/factpulse/models/cadre_de_facturation.rb +0 -217
  327. data/lib/factpulse/models/categorie_tva.rb +0 -47
  328. data/lib/factpulse/models/champ_verifie_schema.rb +0 -334
  329. data/lib/factpulse/models/code_cadre_facturation.rb +0 -42
  330. data/lib/factpulse/models/code_raison_reduction.rb +0 -45
  331. data/lib/factpulse/models/consulter_facture_request.rb +0 -176
  332. data/lib/factpulse/models/consulter_facture_response.rb +0 -261
  333. data/lib/factpulse/models/consulter_structure_request.rb +0 -188
  334. data/lib/factpulse/models/consulter_structure_response.rb +0 -261
  335. data/lib/factpulse/models/credentials_afnor.rb +0 -169
  336. data/lib/factpulse/models/credentials_chorus_pro.rb +0 -191
  337. data/lib/factpulse/models/destinataire.rb +0 -201
  338. data/lib/factpulse/models/dimension_page_schema.rb +0 -193
  339. data/lib/factpulse/models/direction_flux.rb +0 -40
  340. data/lib/factpulse/models/donnees_facture_simplifiees.rb +0 -342
  341. data/lib/factpulse/models/facture_enrichie_info.rb +0 -348
  342. data/lib/factpulse/models/facture_entrante.rb +0 -522
  343. data/lib/factpulse/models/flux_resume.rb +0 -251
  344. data/lib/factpulse/models/format_facture.rb +0 -41
  345. data/lib/factpulse/models/format_sortie.rb +0 -40
  346. data/lib/factpulse/models/fournisseur.rb +0 -257
  347. data/lib/factpulse/models/fournisseur_entrant.rb +0 -236
  348. data/lib/factpulse/models/information_signature_api.rb +0 -216
  349. data/lib/factpulse/models/ligne_de_poste.rb +0 -390
  350. data/lib/factpulse/models/ligne_de_poste_montant_remise_ht.rb +0 -104
  351. data/lib/factpulse/models/ligne_de_poste_taux_tva_manuel.rb +0 -104
  352. data/lib/factpulse/models/ligne_de_tva.rb +0 -262
  353. data/lib/factpulse/models/mode_depot.rb +0 -41
  354. data/lib/factpulse/models/mode_paiement.rb +0 -44
  355. data/lib/factpulse/models/montant_a_payer.rb +0 -104
  356. data/lib/factpulse/models/montant_base_ht.rb +0 -104
  357. data/lib/factpulse/models/montant_ht_total.rb +0 -104
  358. data/lib/factpulse/models/montant_remise_globale_ttc.rb +0 -104
  359. data/lib/factpulse/models/montant_total.rb +0 -272
  360. data/lib/factpulse/models/montant_total_acompte.rb +0 -104
  361. data/lib/factpulse/models/montant_total_ligne_ht.rb +0 -104
  362. data/lib/factpulse/models/montant_ttc_total.rb +0 -104
  363. data/lib/factpulse/models/montant_tva.rb +0 -104
  364. data/lib/factpulse/models/montant_tva_ligne.rb +0 -104
  365. data/lib/factpulse/models/montant_tva_total.rb +0 -104
  366. data/lib/factpulse/models/montant_unitaire_ht.rb +0 -104
  367. data/lib/factpulse/models/nature_operation.rb +0 -52
  368. data/lib/factpulse/models/note.rb +0 -175
  369. data/lib/factpulse/models/note_obligatoire_schema.rb +0 -265
  370. data/lib/factpulse/models/obtenir_id_chorus_pro_request.rb +0 -188
  371. data/lib/factpulse/models/obtenir_id_chorus_pro_response.rb +0 -230
  372. data/lib/factpulse/models/options_processing.rb +0 -207
  373. data/lib/factpulse/models/parametres_signature.rb +0 -235
  374. data/lib/factpulse/models/parametres_structure.rb +0 -175
  375. data/lib/factpulse/models/pdf_factur_x_info.rb +0 -205
  376. data/lib/factpulse/models/piece_jointe_complementaire.rb +0 -269
  377. data/lib/factpulse/models/profil_api.rb +0 -42
  378. data/lib/factpulse/models/profil_flux.rb +0 -41
  379. data/lib/factpulse/models/quantite.rb +0 -104
  380. data/lib/factpulse/models/rechercher_services_response.rb +0 -214
  381. data/lib/factpulse/models/rechercher_structure_request.rb +0 -191
  382. data/lib/factpulse/models/rechercher_structure_response.rb +0 -216
  383. data/lib/factpulse/models/references.rb +0 -290
  384. data/lib/factpulse/models/reponse_recherche_flux.rb +0 -249
  385. data/lib/factpulse/models/reponse_soumission_flux.rb +0 -294
  386. data/lib/factpulse/models/reponse_tache.rb +0 -165
  387. data/lib/factpulse/models/reponse_validation_erreur.rb +0 -167
  388. data/lib/factpulse/models/reponse_validation_succes.rb +0 -165
  389. data/lib/factpulse/models/reponse_verification_succes.rb +0 -343
  390. data/lib/factpulse/models/requete_recherche_flux.rb +0 -306
  391. data/lib/factpulse/models/requete_soumission_flux.rb +0 -238
  392. data/lib/factpulse/models/resultat_chorus_pro.rb +0 -186
  393. data/lib/factpulse/models/resultat_validation_pdfapi.rb +0 -523
  394. data/lib/factpulse/models/service_structure.rb +0 -247
  395. data/lib/factpulse/models/soumettre_facture_complete_request.rb +0 -239
  396. data/lib/factpulse/models/soumettre_facture_complete_response.rb +0 -355
  397. data/lib/factpulse/models/soumettre_facture_request.rb +0 -388
  398. data/lib/factpulse/models/soumettre_facture_response.rb +0 -213
  399. data/lib/factpulse/models/statut_acquittement.rb +0 -41
  400. data/lib/factpulse/models/statut_celery.rb +0 -43
  401. data/lib/factpulse/models/statut_champ_api.rb +0 -43
  402. data/lib/factpulse/models/statut_facture.rb +0 -203
  403. data/lib/factpulse/models/statut_tache.rb +0 -226
  404. data/lib/factpulse/models/syntaxe_flux.rb +0 -43
  405. data/lib/factpulse/models/tauxmanuel.rb +0 -104
  406. data/lib/factpulse/models/type_document.rb +0 -43
  407. data/lib/factpulse/models/type_facture.rb +0 -54
  408. data/lib/factpulse/models/type_flux.rb +0 -43
  409. data/lib/factpulse/models/type_tva.rb +0 -42
  410. data/lib/factpulse/models/unite.rb +0 -44
@@ -0,0 +1,435 @@
1
+ # FactPulse::PDFXMLVerificationApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_verification_status_api_v1_verification_verify_async_task_id_status_get**](PDFXMLVerificationApi.md#get_verification_status_api_v1_verification_verify_async_task_id_status_get) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification |
8
+ | [**get_verification_status_api_v1_verification_verify_async_task_id_status_get_0**](PDFXMLVerificationApi.md#get_verification_status_api_v1_verification_verify_async_task_id_status_get_0) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification |
9
+ | [**verify_pdf_async_api_v1_verification_verify_async_post**](PDFXMLVerificationApi.md#verify_pdf_async_api_v1_verification_verify_async_post) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous) |
10
+ | [**verify_pdf_async_api_v1_verification_verify_async_post_0**](PDFXMLVerificationApi.md#verify_pdf_async_api_v1_verification_verify_async_post_0) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous) |
11
+ | [**verify_pdf_sync_api_v1_verification_verify_post**](PDFXMLVerificationApi.md#verify_pdf_sync_api_v1_verification_verify_post) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous) |
12
+ | [**verify_pdf_sync_api_v1_verification_verify_post_0**](PDFXMLVerificationApi.md#verify_pdf_sync_api_v1_verification_verify_post_0) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous) |
13
+
14
+
15
+ ## get_verification_status_api_v1_verification_verify_async_task_id_status_get
16
+
17
+ > <TaskStatus> get_verification_status_api_v1_verification_verify_async_task_id_status_get(task_id)
18
+
19
+ Get status of an asynchronous verification
20
+
21
+ Retrieves the status and result of an asynchronous verification task. **Possible statuses:** - `PENDING`: Task waiting in queue - `STARTED`: Task currently running - `SUCCESS`: Task completed successfully (see `result`) - `FAILURE`: System error (unhandled exception) **Note:** The `result.status` field can be \"SUCCESS\" or \"ERROR\" independently of Celery status (which will always be SUCCESS if the task ran).
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'factpulse'
28
+ # setup authorization
29
+ FactPulse.configure do |config|
30
+ # Configure Bearer authorization: HTTPBearer
31
+ config.access_token = 'YOUR_BEARER_TOKEN'
32
+ end
33
+
34
+ api_instance = FactPulse::PDFXMLVerificationApi.new
35
+ task_id = 'task_id_example' # String |
36
+
37
+ begin
38
+ # Get status of an asynchronous verification
39
+ result = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get(task_id)
40
+ p result
41
+ rescue FactPulse::ApiError => e
42
+ puts "Error when calling PDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<TaskStatus>, Integer, Hash)> get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info(task_id)
51
+
52
+ ```ruby
53
+ begin
54
+ # Get status of an asynchronous verification
55
+ data, status_code, headers = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info(task_id)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <TaskStatus>
59
+ rescue FactPulse::ApiError => e
60
+ puts "Error when calling PDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **task_id** | **String** | | |
69
+
70
+ ### Return type
71
+
72
+ [**TaskStatus**](TaskStatus.md)
73
+
74
+ ### Authorization
75
+
76
+ [HTTPBearer](../README.md#HTTPBearer)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## get_verification_status_api_v1_verification_verify_async_task_id_status_get_0
85
+
86
+ > <TaskStatus> get_verification_status_api_v1_verification_verify_async_task_id_status_get_0(task_id)
87
+
88
+ Get status of an asynchronous verification
89
+
90
+ Retrieves the status and result of an asynchronous verification task. **Possible statuses:** - `PENDING`: Task waiting in queue - `STARTED`: Task currently running - `SUCCESS`: Task completed successfully (see `result`) - `FAILURE`: System error (unhandled exception) **Note:** The `result.status` field can be \"SUCCESS\" or \"ERROR\" independently of Celery status (which will always be SUCCESS if the task ran).
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'factpulse'
97
+ # setup authorization
98
+ FactPulse.configure do |config|
99
+ # Configure Bearer authorization: HTTPBearer
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+ end
102
+
103
+ api_instance = FactPulse::PDFXMLVerificationApi.new
104
+ task_id = 'task_id_example' # String |
105
+
106
+ begin
107
+ # Get status of an asynchronous verification
108
+ result = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get_0(task_id)
109
+ p result
110
+ rescue FactPulse::ApiError => e
111
+ puts "Error when calling PDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get_0: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the get_verification_status_api_v1_verification_verify_async_task_id_status_get_0_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<TaskStatus>, Integer, Hash)> get_verification_status_api_v1_verification_verify_async_task_id_status_get_0_with_http_info(task_id)
120
+
121
+ ```ruby
122
+ begin
123
+ # Get status of an asynchronous verification
124
+ data, status_code, headers = api_instance.get_verification_status_api_v1_verification_verify_async_task_id_status_get_0_with_http_info(task_id)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <TaskStatus>
128
+ rescue FactPulse::ApiError => e
129
+ puts "Error when calling PDFXMLVerificationApi->get_verification_status_api_v1_verification_verify_async_task_id_status_get_0_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **task_id** | **String** | | |
138
+
139
+ ### Return type
140
+
141
+ [**TaskStatus**](TaskStatus.md)
142
+
143
+ ### Authorization
144
+
145
+ [HTTPBearer](../README.md#HTTPBearer)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: application/json
151
+
152
+
153
+ ## verify_pdf_async_api_v1_verification_verify_async_post
154
+
155
+ > <TaskResponse> verify_pdf_async_api_v1_verification_verify_async_post(pdf_file, opts)
156
+
157
+ Verify PDF/XML Factur-X compliance (asynchronous)
158
+
159
+ Verifies PDF/XML Factur-X compliance asynchronously. **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result. This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`. **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result. **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn't block the server
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'factpulse'
166
+ # setup authorization
167
+ FactPulse.configure do |config|
168
+ # Configure Bearer authorization: HTTPBearer
169
+ config.access_token = 'YOUR_BEARER_TOKEN'
170
+ end
171
+
172
+ api_instance = FactPulse::PDFXMLVerificationApi.new
173
+ pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
174
+ opts = {
175
+ force_ocr: true # Boolean | Force OCR usage even if PDF contains native text
176
+ }
177
+
178
+ begin
179
+ # Verify PDF/XML Factur-X compliance (asynchronous)
180
+ result = api_instance.verify_pdf_async_api_v1_verification_verify_async_post(pdf_file, opts)
181
+ p result
182
+ rescue FactPulse::ApiError => e
183
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post: #{e}"
184
+ end
185
+ ```
186
+
187
+ #### Using the verify_pdf_async_api_v1_verification_verify_async_post_with_http_info variant
188
+
189
+ This returns an Array which contains the response data, status code and headers.
190
+
191
+ > <Array(<TaskResponse>, Integer, Hash)> verify_pdf_async_api_v1_verification_verify_async_post_with_http_info(pdf_file, opts)
192
+
193
+ ```ruby
194
+ begin
195
+ # Verify PDF/XML Factur-X compliance (asynchronous)
196
+ data, status_code, headers = api_instance.verify_pdf_async_api_v1_verification_verify_async_post_with_http_info(pdf_file, opts)
197
+ p status_code # => 2xx
198
+ p headers # => { ... }
199
+ p data # => <TaskResponse>
200
+ rescue FactPulse::ApiError => e
201
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post_with_http_info: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ | Name | Type | Description | Notes |
208
+ | ---- | ---- | ----------- | ----- |
209
+ | **pdf_file** | **File** | Factur-X PDF file to verify | |
210
+ | **force_ocr** | **Boolean** | Force OCR usage even if PDF contains native text | [optional][default to false] |
211
+
212
+ ### Return type
213
+
214
+ [**TaskResponse**](TaskResponse.md)
215
+
216
+ ### Authorization
217
+
218
+ [HTTPBearer](../README.md#HTTPBearer)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: multipart/form-data
223
+ - **Accept**: application/json
224
+
225
+
226
+ ## verify_pdf_async_api_v1_verification_verify_async_post_0
227
+
228
+ > <TaskResponse> verify_pdf_async_api_v1_verification_verify_async_post_0(pdf_file, opts)
229
+
230
+ Verify PDF/XML Factur-X compliance (asynchronous)
231
+
232
+ Verifies PDF/XML Factur-X compliance asynchronously. **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result. This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`. **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result. **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn't block the server
233
+
234
+ ### Examples
235
+
236
+ ```ruby
237
+ require 'time'
238
+ require 'factpulse'
239
+ # setup authorization
240
+ FactPulse.configure do |config|
241
+ # Configure Bearer authorization: HTTPBearer
242
+ config.access_token = 'YOUR_BEARER_TOKEN'
243
+ end
244
+
245
+ api_instance = FactPulse::PDFXMLVerificationApi.new
246
+ pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
247
+ opts = {
248
+ force_ocr: true # Boolean | Force OCR usage even if PDF contains native text
249
+ }
250
+
251
+ begin
252
+ # Verify PDF/XML Factur-X compliance (asynchronous)
253
+ result = api_instance.verify_pdf_async_api_v1_verification_verify_async_post_0(pdf_file, opts)
254
+ p result
255
+ rescue FactPulse::ApiError => e
256
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post_0: #{e}"
257
+ end
258
+ ```
259
+
260
+ #### Using the verify_pdf_async_api_v1_verification_verify_async_post_0_with_http_info variant
261
+
262
+ This returns an Array which contains the response data, status code and headers.
263
+
264
+ > <Array(<TaskResponse>, Integer, Hash)> verify_pdf_async_api_v1_verification_verify_async_post_0_with_http_info(pdf_file, opts)
265
+
266
+ ```ruby
267
+ begin
268
+ # Verify PDF/XML Factur-X compliance (asynchronous)
269
+ data, status_code, headers = api_instance.verify_pdf_async_api_v1_verification_verify_async_post_0_with_http_info(pdf_file, opts)
270
+ p status_code # => 2xx
271
+ p headers # => { ... }
272
+ p data # => <TaskResponse>
273
+ rescue FactPulse::ApiError => e
274
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_async_api_v1_verification_verify_async_post_0_with_http_info: #{e}"
275
+ end
276
+ ```
277
+
278
+ ### Parameters
279
+
280
+ | Name | Type | Description | Notes |
281
+ | ---- | ---- | ----------- | ----- |
282
+ | **pdf_file** | **File** | Factur-X PDF file to verify | |
283
+ | **force_ocr** | **Boolean** | Force OCR usage even if PDF contains native text | [optional][default to false] |
284
+
285
+ ### Return type
286
+
287
+ [**TaskResponse**](TaskResponse.md)
288
+
289
+ ### Authorization
290
+
291
+ [HTTPBearer](../README.md#HTTPBearer)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: multipart/form-data
296
+ - **Accept**: application/json
297
+
298
+
299
+ ## verify_pdf_sync_api_v1_verification_verify_post
300
+
301
+ > <VerificationSuccessResponse> verify_pdf_sync_api_v1_verification_verify_post(pdf_file)
302
+
303
+ Verify PDF/XML Factur-X compliance (synchronous)
304
+
305
+ Verifies compliance between the PDF and its embedded Factur-X XML. **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will be rejected with a 400 error. This synchronous version uses only native PDF extraction (pdfplumber). For image PDFs requiring OCR, use the `/verify-async` endpoint. **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency
306
+
307
+ ### Examples
308
+
309
+ ```ruby
310
+ require 'time'
311
+ require 'factpulse'
312
+ # setup authorization
313
+ FactPulse.configure do |config|
314
+ # Configure Bearer authorization: HTTPBearer
315
+ config.access_token = 'YOUR_BEARER_TOKEN'
316
+ end
317
+
318
+ api_instance = FactPulse::PDFXMLVerificationApi.new
319
+ pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
320
+
321
+ begin
322
+ # Verify PDF/XML Factur-X compliance (synchronous)
323
+ result = api_instance.verify_pdf_sync_api_v1_verification_verify_post(pdf_file)
324
+ p result
325
+ rescue FactPulse::ApiError => e
326
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the verify_pdf_sync_api_v1_verification_verify_post_with_http_info variant
331
+
332
+ This returns an Array which contains the response data, status code and headers.
333
+
334
+ > <Array(<VerificationSuccessResponse>, Integer, Hash)> verify_pdf_sync_api_v1_verification_verify_post_with_http_info(pdf_file)
335
+
336
+ ```ruby
337
+ begin
338
+ # Verify PDF/XML Factur-X compliance (synchronous)
339
+ data, status_code, headers = api_instance.verify_pdf_sync_api_v1_verification_verify_post_with_http_info(pdf_file)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => <VerificationSuccessResponse>
343
+ rescue FactPulse::ApiError => e
344
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post_with_http_info: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **pdf_file** | **File** | Factur-X PDF file to verify | |
353
+
354
+ ### Return type
355
+
356
+ [**VerificationSuccessResponse**](VerificationSuccessResponse.md)
357
+
358
+ ### Authorization
359
+
360
+ [HTTPBearer](../README.md#HTTPBearer)
361
+
362
+ ### HTTP request headers
363
+
364
+ - **Content-Type**: multipart/form-data
365
+ - **Accept**: application/json
366
+
367
+
368
+ ## verify_pdf_sync_api_v1_verification_verify_post_0
369
+
370
+ > <VerificationSuccessResponse> verify_pdf_sync_api_v1_verification_verify_post_0(pdf_file)
371
+
372
+ Verify PDF/XML Factur-X compliance (synchronous)
373
+
374
+ Verifies compliance between the PDF and its embedded Factur-X XML. **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will be rejected with a 400 error. This synchronous version uses only native PDF extraction (pdfplumber). For image PDFs requiring OCR, use the `/verify-async` endpoint. **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency
375
+
376
+ ### Examples
377
+
378
+ ```ruby
379
+ require 'time'
380
+ require 'factpulse'
381
+ # setup authorization
382
+ FactPulse.configure do |config|
383
+ # Configure Bearer authorization: HTTPBearer
384
+ config.access_token = 'YOUR_BEARER_TOKEN'
385
+ end
386
+
387
+ api_instance = FactPulse::PDFXMLVerificationApi.new
388
+ pdf_file = File.new('/path/to/some/file') # File | Factur-X PDF file to verify
389
+
390
+ begin
391
+ # Verify PDF/XML Factur-X compliance (synchronous)
392
+ result = api_instance.verify_pdf_sync_api_v1_verification_verify_post_0(pdf_file)
393
+ p result
394
+ rescue FactPulse::ApiError => e
395
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post_0: #{e}"
396
+ end
397
+ ```
398
+
399
+ #### Using the verify_pdf_sync_api_v1_verification_verify_post_0_with_http_info variant
400
+
401
+ This returns an Array which contains the response data, status code and headers.
402
+
403
+ > <Array(<VerificationSuccessResponse>, Integer, Hash)> verify_pdf_sync_api_v1_verification_verify_post_0_with_http_info(pdf_file)
404
+
405
+ ```ruby
406
+ begin
407
+ # Verify PDF/XML Factur-X compliance (synchronous)
408
+ data, status_code, headers = api_instance.verify_pdf_sync_api_v1_verification_verify_post_0_with_http_info(pdf_file)
409
+ p status_code # => 2xx
410
+ p headers # => { ... }
411
+ p data # => <VerificationSuccessResponse>
412
+ rescue FactPulse::ApiError => e
413
+ puts "Error when calling PDFXMLVerificationApi->verify_pdf_sync_api_v1_verification_verify_post_0_with_http_info: #{e}"
414
+ end
415
+ ```
416
+
417
+ ### Parameters
418
+
419
+ | Name | Type | Description | Notes |
420
+ | ---- | ---- | ----------- | ----- |
421
+ | **pdf_file** | **File** | Factur-X PDF file to verify | |
422
+
423
+ ### Return type
424
+
425
+ [**VerificationSuccessResponse**](VerificationSuccessResponse.md)
426
+
427
+ ### Authorization
428
+
429
+ [HTTPBearer](../README.md#HTTPBearer)
430
+
431
+ ### HTTP request headers
432
+
433
+ - **Content-Type**: multipart/form-data
434
+ - **Accept**: application/json
435
+
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **flow_service_url** | **String** | URL de base du Flow Service AFNOR | |
7
+ | **flow_service_url** | **String** | Base URL of the AFNOR Flow Service | |
8
8
  | **directory_service_url** | **String** | | [optional] |
9
- | **token_url** | **String** | URL du serveur OAuth2 | |
10
- | **client_id** | **String** | Client ID OAuth2 | |
11
- | **client_secret** | **String** | Client Secret OAuth2 (sensible) | |
9
+ | **token_url** | **String** | OAuth2 server URL | |
10
+ | **client_id** | **String** | OAuth2 Client ID | |
11
+ | **client_secret** | **String** | OAuth2 Client Secret (sensitive) | |
12
12
 
13
13
  ## Example
14
14
 
@@ -0,0 +1,20 @@
1
+ # FactPulse::PageDimensionsSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **width** | **Float** | Width in PDF points | |
8
+ | **height** | **Float** | Height in PDF points | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'factpulse'
14
+
15
+ instance = FactPulse::PageDimensionsSchema.new(
16
+ width: null,
17
+ height: null
18
+ )
19
+ ```
20
+
@@ -1,13 +1,13 @@
1
- # FactPulse::Beneficiaire
1
+ # FactPulse::Payee
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **nom** | **String** | Nom du bénéficiaire (BT-59). Obligatoire. | |
7
+ | **nom** | **String** | Payee name (BT-59). Mandatory. | |
8
8
  | **siret** | **String** | | [optional] |
9
9
  | **siren** | **String** | | [optional] |
10
- | **adresse_electronique** | [**AdresseElectronique**](AdresseElectronique.md) | | [optional] |
10
+ | **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) | | [optional] |
11
11
  | **iban** | **String** | | [optional] |
12
12
  | **bic** | **String** | | [optional] |
13
13
 
@@ -16,11 +16,11 @@
16
16
  ```ruby
17
17
  require 'factpulse'
18
18
 
19
- instance = FactPulse::Beneficiaire.new(
19
+ instance = FactPulse::Payee.new(
20
20
  nom: null,
21
21
  siret: null,
22
22
  siren: null,
23
- adresse_electronique: null,
23
+ electronic_address: null,
24
24
  iban: null,
25
25
  bic: null
26
26
  )
@@ -0,0 +1,15 @@
1
+ # FactPulse::PaymentMeans
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'factpulse'
12
+
13
+ instance = FactPulse::PaymentMeans.new()
14
+ ```
15
+
@@ -0,0 +1,26 @@
1
+ # FactPulse::PostalAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **postal_code** | **String** | | [optional] |
8
+ | **line_one** | **String** | | [optional] |
9
+ | **line_two** | **String** | | [optional] |
10
+ | **city** | **String** | | [optional] |
11
+ | **country_code** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'factpulse'
17
+
18
+ instance = FactPulse::PostalAddress.new(
19
+ postal_code: null,
20
+ line_one: null,
21
+ line_two: null,
22
+ city: null,
23
+ country_code: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # FactPulse::ProcessingOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **facturx_profile** | [**APIProfile**](APIProfile.md) | Factur-X profile to use | [optional] |
8
+ | **auto_enrich** | **Boolean** | Auto-enrich data (Company APIs, Chorus Pro, etc.) | [optional][default to true] |
9
+ | **validate** | **Boolean** | Validate Factur-X XML with Schematron | [optional][default to true] |
10
+ | **verify_destination_parameters** | **Boolean** | Verify required parameters for destination (e.g., service_code for Chorus) | [optional][default to true] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'factpulse'
16
+
17
+ instance = FactPulse::ProcessingOptions.new(
18
+ facturx_profile: null,
19
+ auto_enrich: null,
20
+ validate: null,
21
+ verify_destination_parameters: null
22
+ )
23
+ ```
24
+
@@ -1,4 +1,4 @@
1
- # FactPulse::Quantite
1
+ # FactPulse::Quantity
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'factpulse'
12
12
 
13
- instance = FactPulse::Quantite.new()
13
+ instance = FactPulse::Quantity.new()
14
14
  ```
15
15
 
data/docs/Recipient.md ADDED
@@ -0,0 +1,28 @@
1
+ # FactPulse::Recipient
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) | | |
8
+ | **executing_service_code** | **String** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **siren** | **String** | | [optional] |
11
+ | **siret** | **String** | | [optional] |
12
+ | **postal_address** | [**PostalAddress**](PostalAddress.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'factpulse'
18
+
19
+ instance = FactPulse::Recipient.new(
20
+ electronic_address: null,
21
+ executing_service_code: null,
22
+ name: null,
23
+ siren: null,
24
+ siret: null,
25
+ postal_address: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,34 @@
1
+ # FactPulse::SearchFlowRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **updated_after** | **Time** | | [optional] |
8
+ | **updated_before** | **Time** | | [optional] |
9
+ | **flow_types** | [**Array&lt;FlowType&gt;**](FlowType.md) | | [optional] |
10
+ | **flow_directions** | [**Array&lt;FlowDirection&gt;**](FlowDirection.md) | | [optional] |
11
+ | **tracking_id** | **String** | | [optional] |
12
+ | **flow_id** | **String** | | [optional] |
13
+ | **acknowledgment_status** | [**AcknowledgmentStatus**](AcknowledgmentStatus.md) | | [optional] |
14
+ | **offset** | **Integer** | Offset for pagination | [optional][default to 0] |
15
+ | **limit** | **Integer** | Maximum number of results (max 100) | [optional][default to 25] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'factpulse'
21
+
22
+ instance = FactPulse::SearchFlowRequest.new(
23
+ updated_after: null,
24
+ updated_before: null,
25
+ flow_types: null,
26
+ flow_directions: null,
27
+ tracking_id: null,
28
+ flow_id: null,
29
+ acknowledgment_status: null,
30
+ offset: null,
31
+ limit: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,24 @@
1
+ # FactPulse::SearchFlowResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Total number of results | |
8
+ | **offset** | **Integer** | Applied offset | |
9
+ | **limit** | **Integer** | Results limit | |
10
+ | **results** | [**Array&lt;FlowSummary&gt;**](FlowSummary.md) | List of found flows | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'factpulse'
16
+
17
+ instance = FactPulse::SearchFlowResponse.new(
18
+ total: null,
19
+ offset: null,
20
+ limit: null,
21
+ results: null
22
+ )
23
+ ```
24
+