factpulse 4.0.2 → 4.1.2

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 (434) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -4
  3. data/Gemfile.lock +3 -3
  4. data/README.md +12 -0
  5. data/docs/AFNORErrorDetail.md +26 -0
  6. data/docs/AFNORPDPPAApi.md +9 -2
  7. data/docs/AsyncTasksApi.md +231 -1
  8. data/docs/ChorusProApi.md +96 -16
  9. data/docs/ClientManagementApi.md +371 -25
  10. data/docs/ConversionErrorResult.md +30 -0
  11. data/docs/ConversionExtractionInfo.md +20 -0
  12. data/docs/ConversionPendingInputResult.md +30 -0
  13. data/docs/ConversionSuccessTaskResult.md +36 -0
  14. data/docs/ConversionTaskStatus.md +22 -0
  15. data/docs/ConversionTaskStatusResult.md +85 -0
  16. data/docs/ConversionValidationFailedResult.md +34 -0
  17. data/docs/ConvertResumeRequest.md +5 -1
  18. data/docs/DownloadsApi.md +16 -6
  19. data/docs/ElectronicSignatureApi.md +24 -4
  20. data/docs/FacturXConversionApi.md +176 -4
  21. data/docs/FacturXInvoice.md +1 -1
  22. data/docs/FacturXPDFXMLVerificationApi.md +93 -3
  23. data/docs/FacturXValidationApi.md +12 -78
  24. data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
  25. data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
  26. data/docs/Flux10EReportingApi.md +36 -6
  27. data/docs/Flux6InvoiceLifecycleCDARApi.md +100 -3
  28. data/docs/GenerationSuccessResult.md +24 -0
  29. data/docs/GenerationTaskStatus.md +22 -0
  30. data/docs/GenerationTaskStatusResult.md +79 -0
  31. data/docs/HealthApi.md +6 -125
  32. data/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md} +39 -24
  33. data/docs/InvoiceInput.md +1 -1
  34. data/docs/InvoiceLifecycle.md +24 -0
  35. data/docs/InvoicingFramework.md +1 -1
  36. data/docs/KeyRotationRequest.md +20 -0
  37. data/docs/KeyRotationResponse.md +24 -0
  38. data/docs/LifecycleEvent.md +38 -0
  39. data/docs/LifecycleResponse.md +22 -0
  40. data/docs/PDPConfigResponse.md +2 -0
  41. data/docs/PDPConfigUpdateRequest.md +3 -1
  42. data/docs/ParseApi.md +161 -0
  43. data/docs/ParseFacturXResponse.md +26 -0
  44. data/docs/ReferencesApi.md +74 -0
  45. data/docs/SecretStatus.md +5 -1
  46. data/docs/SignatureSuccessResult.md +34 -0
  47. data/docs/SignatureTaskStatus.md +22 -0
  48. data/docs/SignatureTaskStatusResult.md +79 -0
  49. data/docs/SimplifiedInvoiceData.md +1 -1
  50. data/docs/SubmitCompleteInvoiceResponse.md +3 -1
  51. data/docs/Supplier.md +1 -1
  52. data/docs/TaskErrorResult.md +26 -0
  53. data/docs/VATEXCodeInfo.md +24 -0
  54. data/docs/VATEXCodesResponse.md +22 -0
  55. data/docs/ValidateCDARResponse.md +2 -2
  56. data/docs/ValidationApi.md +88 -0
  57. data/docs/ValidationErrorResponse.md +8 -2
  58. data/docs/ValidationSuccessTaskResult.md +20 -0
  59. data/docs/ValidationTaskStatus.md +22 -0
  60. data/docs/ValidationTaskStatusResult.md +79 -0
  61. data/docs/VerificationSuccessTaskResult.md +20 -0
  62. data/docs/VerificationTypedTaskStatus.md +22 -0
  63. data/docs/VerificationTypedTaskStatusResult.md +79 -0
  64. data/docs/WebhookSecretDeleteResponse.md +20 -0
  65. data/docs/WebhookSecretGenerateResponse.md +24 -0
  66. data/docs/WebhookSecretStatusResponse.md +20 -0
  67. data/factpulse.gemspec +3 -3
  68. data/lib/factpulse/api/afnorpdppa_api.rb +6 -3
  69. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +2 -2
  70. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +2 -2
  71. data/lib/factpulse/api/async_tasks_api.rb +192 -3
  72. data/lib/factpulse/api/chorus_pro_api.rb +18 -18
  73. data/lib/factpulse/api/client_management_api.rb +290 -24
  74. data/lib/factpulse/api/downloads_api.rb +8 -8
  75. data/lib/factpulse/api/electronic_signature_api.rb +6 -6
  76. data/lib/factpulse/api/factur_x_conversion_api.rb +143 -6
  77. data/lib/factpulse/api/factur_x_validation_api.rb +4 -79
  78. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +68 -5
  79. data/lib/factpulse/api/flux10_e_reporting_api.rb +8 -8
  80. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +88 -5
  81. data/lib/factpulse/api/health_api.rb +3 -117
  82. data/lib/factpulse/api/{factur_x_generation_api.rb → invoice_generation_api.rb} +26 -26
  83. data/lib/factpulse/api/parse_api.rb +163 -0
  84. data/lib/factpulse/api/references_api.rb +82 -0
  85. data/lib/factpulse/api/validation_api.rb +97 -0
  86. data/lib/factpulse/api_client.rb +2 -2
  87. data/lib/factpulse/api_error.rb +2 -2
  88. data/lib/factpulse/api_model_base.rb +2 -2
  89. data/lib/factpulse/configuration.rb +9 -2
  90. data/lib/factpulse/models/acknowledgment_status.rb +2 -2
  91. data/lib/factpulse/models/action_code_info.rb +2 -2
  92. data/lib/factpulse/models/action_codes_response.rb +2 -2
  93. data/lib/factpulse/models/additional_document.rb +2 -2
  94. data/lib/factpulse/models/afnor_acknowledgement.rb +2 -2
  95. data/lib/factpulse/models/afnor_acknowledgement_detail.rb +2 -2
  96. data/lib/factpulse/models/afnor_address_edit.rb +2 -2
  97. data/lib/factpulse/models/afnor_address_patch.rb +2 -2
  98. data/lib/factpulse/models/afnor_address_put.rb +2 -2
  99. data/lib/factpulse/models/afnor_address_read.rb +2 -2
  100. data/lib/factpulse/models/afnor_algorithm.rb +2 -2
  101. data/lib/factpulse/models/afnor_contains_operator.rb +2 -2
  102. data/lib/factpulse/models/afnor_create_directory_line_body.rb +2 -2
  103. data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +2 -2
  104. data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +2 -2
  105. data/lib/factpulse/models/afnor_create_routing_code_body.rb +2 -2
  106. data/lib/factpulse/models/afnor_credentials.rb +2 -2
  107. data/lib/factpulse/models/afnor_destination.rb +2 -2
  108. data/lib/factpulse/models/afnor_diffusion_status.rb +2 -2
  109. data/lib/factpulse/models/afnor_directory_line_field.rb +2 -2
  110. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +2 -2
  111. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +2 -2
  112. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +2 -2
  113. data/lib/factpulse/models/afnor_directory_line_post201_response.rb +2 -2
  114. data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +2 -2
  115. data/lib/factpulse/models/afnor_entity_type.rb +2 -2
  116. data/lib/factpulse/models/afnor_error.rb +2 -2
  117. data/lib/factpulse/models/afnor_error_detail.rb +237 -0
  118. data/lib/factpulse/models/afnor_facility_administrative_status.rb +2 -2
  119. data/lib/factpulse/models/afnor_facility_nature.rb +2 -2
  120. data/lib/factpulse/models/afnor_facility_payload_history.rb +2 -2
  121. data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +2 -2
  122. data/lib/factpulse/models/afnor_facility_payload_included.rb +2 -2
  123. data/lib/factpulse/models/afnor_facility_type.rb +2 -2
  124. data/lib/factpulse/models/afnor_flow.rb +2 -2
  125. data/lib/factpulse/models/afnor_flow_ack_status.rb +2 -2
  126. data/lib/factpulse/models/afnor_flow_direction.rb +2 -2
  127. data/lib/factpulse/models/afnor_flow_info.rb +2 -2
  128. data/lib/factpulse/models/afnor_flow_profile.rb +2 -2
  129. data/lib/factpulse/models/afnor_flow_syntax.rb +2 -2
  130. data/lib/factpulse/models/afnor_flow_type.rb +2 -2
  131. data/lib/factpulse/models/afnor_full_flow_info.rb +2 -2
  132. data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
  133. data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +2 -2
  134. data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +2 -2
  135. data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +2 -2
  136. data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +2 -2
  137. data/lib/factpulse/models/afnor_platform_status.rb +2 -2
  138. data/lib/factpulse/models/afnor_processing_rule.rb +2 -2
  139. data/lib/factpulse/models/afnor_reason_code.rb +2 -2
  140. data/lib/factpulse/models/afnor_reason_code_enum.rb +2 -2
  141. data/lib/factpulse/models/afnor_recipient_platform_type.rb +2 -2
  142. data/lib/factpulse/models/afnor_result.rb +2 -2
  143. data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +2 -2
  144. data/lib/factpulse/models/afnor_routing_code_field.rb +2 -2
  145. data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +2 -2
  146. data/lib/factpulse/models/afnor_routing_code_post201_response.rb +2 -2
  147. data/lib/factpulse/models/afnor_routing_code_search.rb +2 -2
  148. data/lib/factpulse/models/afnor_routing_code_search_filters.rb +2 -2
  149. data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +2 -2
  150. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +2 -2
  151. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +2 -2
  152. data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +2 -2
  153. data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +2 -2
  154. data/lib/factpulse/models/afnor_search_directory_line.rb +2 -2
  155. data/lib/factpulse/models/afnor_search_directory_line_filters.rb +2 -2
  156. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +2 -2
  157. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +2 -2
  158. data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +2 -2
  159. data/lib/factpulse/models/afnor_search_flow_content.rb +2 -2
  160. data/lib/factpulse/models/afnor_search_flow_filters.rb +2 -2
  161. data/lib/factpulse/models/afnor_search_flow_params.rb +2 -2
  162. data/lib/factpulse/models/afnor_search_siren.rb +2 -2
  163. data/lib/factpulse/models/afnor_search_siren_filters.rb +2 -2
  164. data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +2 -2
  165. data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +2 -2
  166. data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +2 -2
  167. data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +2 -2
  168. data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +2 -2
  169. data/lib/factpulse/models/afnor_search_siret.rb +2 -2
  170. data/lib/factpulse/models/afnor_search_siret_filters.rb +2 -2
  171. data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
  172. data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +2 -2
  173. data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +2 -2
  174. data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +2 -2
  175. data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +2 -2
  176. data/lib/factpulse/models/afnor_search_siret_filters_name.rb +2 -2
  177. data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +2 -2
  178. data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +2 -2
  179. data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +2 -2
  180. data/lib/factpulse/models/afnor_siren_field.rb +2 -2
  181. data/lib/factpulse/models/afnor_siren_search_post200_response.rb +2 -2
  182. data/lib/factpulse/models/afnor_siret_field.rb +2 -2
  183. data/lib/factpulse/models/afnor_siret_search_post200_response.rb +2 -2
  184. data/lib/factpulse/models/afnor_sorting_order.rb +2 -2
  185. data/lib/factpulse/models/afnor_strict_operator.rb +2 -2
  186. data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +2 -2
  187. data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +2 -2
  188. data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +2 -2
  189. data/lib/factpulse/models/afnor_webhook_callback_content.rb +2 -2
  190. data/lib/factpulse/models/aggregated_payment_input.rb +2 -2
  191. data/lib/factpulse/models/aggregated_transaction_input.rb +2 -2
  192. data/lib/factpulse/models/allowance_charge.rb +2 -2
  193. data/lib/factpulse/models/allowance_charge_reason_code.rb +2 -2
  194. data/lib/factpulse/models/allowance_reason_code.rb +2 -2
  195. data/lib/factpulse/models/allowance_total_amount.rb +2 -2
  196. data/lib/factpulse/models/amount.rb +2 -2
  197. data/lib/factpulse/models/amount1.rb +2 -2
  198. data/lib/factpulse/models/amount2.rb +2 -2
  199. data/lib/factpulse/models/amount_due.rb +2 -2
  200. data/lib/factpulse/models/api_error.rb +2 -2
  201. data/lib/factpulse/models/api_profile.rb +2 -2
  202. data/lib/factpulse/models/async_task_status.rb +2 -2
  203. data/lib/factpulse/models/base_amount.rb +2 -2
  204. data/lib/factpulse/models/bounding_box_schema.rb +2 -2
  205. data/lib/factpulse/models/buyercountry.rb +2 -2
  206. data/lib/factpulse/models/celery_status.rb +2 -2
  207. data/lib/factpulse/models/certificate_info_response.rb +2 -2
  208. data/lib/factpulse/models/charge_total_amount.rb +2 -2
  209. data/lib/factpulse/models/chorus_pro_credentials.rb +2 -2
  210. data/lib/factpulse/models/chorus_pro_destination.rb +2 -2
  211. data/lib/factpulse/models/chorus_pro_result.rb +2 -2
  212. data/lib/factpulse/models/client_activate_response.rb +2 -2
  213. data/lib/factpulse/models/client_create_request.rb +2 -2
  214. data/lib/factpulse/models/client_detail.rb +2 -2
  215. data/lib/factpulse/models/client_list_response.rb +2 -2
  216. data/lib/factpulse/models/client_summary.rb +2 -2
  217. data/lib/factpulse/models/client_update_request.rb +2 -2
  218. data/lib/factpulse/models/contact.rb +2 -2
  219. data/lib/factpulse/models/conversion_error_result.rb +277 -0
  220. data/lib/factpulse/models/conversion_extraction_info.rb +176 -0
  221. data/lib/factpulse/models/conversion_pending_input_result.rb +344 -0
  222. data/lib/factpulse/models/conversion_success_task_result.rb +355 -0
  223. data/lib/factpulse/models/conversion_task_status.rb +223 -0
  224. data/lib/factpulse/models/conversion_task_status_result.rb +59 -0
  225. data/lib/factpulse/models/conversion_validation_failed_result.rb +348 -0
  226. data/lib/factpulse/models/convert_resume_request.rb +29 -7
  227. data/lib/factpulse/models/convert_success_response.rb +2 -2
  228. data/lib/factpulse/models/convert_validation_failed_response.rb +2 -2
  229. data/lib/factpulse/models/country_code.rb +2 -2
  230. data/lib/factpulse/models/create_aggregated_report_request.rb +2 -2
  231. data/lib/factpulse/models/create_cdar_request.rb +2 -2
  232. data/lib/factpulse/models/create_e_reporting_request.rb +2 -2
  233. data/lib/factpulse/models/currency.rb +2 -2
  234. data/lib/factpulse/models/currency_code.rb +2 -2
  235. data/lib/factpulse/models/delivery_party.rb +2 -2
  236. data/lib/factpulse/models/destination.rb +2 -2
  237. data/lib/factpulse/models/doc_type.rb +2 -2
  238. data/lib/factpulse/models/document_type_info.rb +2 -2
  239. data/lib/factpulse/models/e_reporting_flow_type.rb +2 -2
  240. data/lib/factpulse/models/e_reporting_validation_error.rb +2 -2
  241. data/lib/factpulse/models/electronic_address.rb +2 -2
  242. data/lib/factpulse/models/encaisseamount.rb +2 -2
  243. data/lib/factpulse/models/encaisseamount1.rb +2 -2
  244. data/lib/factpulse/models/encaissee_request.rb +2 -2
  245. data/lib/factpulse/models/enriched_invoice_info.rb +2 -2
  246. data/lib/factpulse/models/error_level.rb +2 -2
  247. data/lib/factpulse/models/error_source.rb +2 -2
  248. data/lib/factpulse/models/extraction_info.rb +2 -2
  249. data/lib/factpulse/models/factur_x_invoice.rb +3 -19
  250. data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
  251. data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
  252. data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +2 -2
  253. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
  254. data/lib/factpulse/models/field_status.rb +2 -2
  255. data/lib/factpulse/models/file_info.rb +2 -2
  256. data/lib/factpulse/models/files_info.rb +2 -2
  257. data/lib/factpulse/models/flow_direction.rb +2 -2
  258. data/lib/factpulse/models/flow_profile.rb +2 -2
  259. data/lib/factpulse/models/flow_summary.rb +2 -2
  260. data/lib/factpulse/models/flow_syntax.rb +2 -2
  261. data/lib/factpulse/models/flow_type.rb +2 -2
  262. data/lib/factpulse/models/generate_aggregated_report_response.rb +2 -2
  263. data/lib/factpulse/models/generate_cdar_response.rb +2 -2
  264. data/lib/factpulse/models/generate_certificate_request.rb +2 -2
  265. data/lib/factpulse/models/generate_certificate_response.rb +2 -2
  266. data/lib/factpulse/models/generate_e_reporting_response.rb +2 -2
  267. data/lib/factpulse/models/generation_success_result.rb +230 -0
  268. data/lib/factpulse/models/generation_task_status.rb +223 -0
  269. data/lib/factpulse/models/generation_task_status_result.rb +55 -0
  270. data/lib/factpulse/models/get_chorus_pro_id_request.rb +2 -2
  271. data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
  272. data/lib/factpulse/models/get_invoice_request.rb +2 -2
  273. data/lib/factpulse/models/get_invoice_response.rb +2 -2
  274. data/lib/factpulse/models/get_structure_request.rb +2 -2
  275. data/lib/factpulse/models/get_structure_response.rb +2 -2
  276. data/lib/factpulse/models/global_allowance_amount.rb +2 -2
  277. data/lib/factpulse/models/gross_unit_price.rb +2 -2
  278. data/lib/factpulse/models/http_validation_error.rb +2 -2
  279. data/lib/factpulse/models/incoming_invoice.rb +2 -2
  280. data/lib/factpulse/models/incoming_supplier.rb +2 -2
  281. data/lib/factpulse/models/invoice_format.rb +2 -2
  282. data/lib/factpulse/models/invoice_input.rb +3 -3
  283. data/lib/factpulse/models/invoice_lifecycle.rb +215 -0
  284. data/lib/factpulse/models/invoice_line.rb +2 -2
  285. data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
  286. data/lib/factpulse/models/invoice_note.rb +2 -2
  287. data/lib/factpulse/models/invoice_payment_input.rb +2 -2
  288. data/lib/factpulse/models/invoice_references.rb +2 -2
  289. data/lib/factpulse/models/invoice_status.rb +2 -2
  290. data/lib/factpulse/models/invoice_totals.rb +2 -2
  291. data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
  292. data/lib/factpulse/models/invoice_type_code.rb +8 -19
  293. data/lib/factpulse/models/invoice_type_code_output.rb +2 -2
  294. data/lib/factpulse/models/invoicing_framework.rb +3 -20
  295. data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
  296. data/lib/factpulse/models/issuer_role_code.rb +2 -2
  297. data/lib/factpulse/models/key_rotation_request.rb +211 -0
  298. data/lib/factpulse/models/key_rotation_response.rb +232 -0
  299. data/lib/factpulse/models/lifecycle_event.rb +300 -0
  300. data/lib/factpulse/models/lifecycle_response.rb +205 -0
  301. data/lib/factpulse/models/line_net_amount.rb +2 -2
  302. data/lib/factpulse/models/line_sub_type.rb +2 -2
  303. data/lib/factpulse/models/line_total_amount.rb +2 -2
  304. data/lib/factpulse/models/location_inner.rb +2 -2
  305. data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
  306. data/lib/factpulse/models/manual_rate.rb +2 -2
  307. data/lib/factpulse/models/manual_vat_rate.rb +2 -2
  308. data/lib/factpulse/models/missing_field.rb +2 -2
  309. data/lib/factpulse/models/operation_nature.rb +2 -2
  310. data/lib/factpulse/models/output_format.rb +5 -3
  311. data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
  312. data/lib/factpulse/models/parse_factur_x_response.rb +249 -0
  313. data/lib/factpulse/models/payee.rb +2 -2
  314. data/lib/factpulse/models/payment_amount_by_rate.rb +2 -2
  315. data/lib/factpulse/models/payment_card.rb +2 -2
  316. data/lib/factpulse/models/payment_means.rb +2 -2
  317. data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
  318. data/lib/factpulse/models/pdp_config_response.rb +13 -3
  319. data/lib/factpulse/models/pdp_config_update_request.rb +51 -7
  320. data/lib/factpulse/models/pdp_credentials.rb +2 -2
  321. data/lib/factpulse/models/percentage.rb +2 -2
  322. data/lib/factpulse/models/postal_address.rb +2 -2
  323. data/lib/factpulse/models/price_allowance_amount.rb +2 -2
  324. data/lib/factpulse/models/price_basis_quantity.rb +2 -2
  325. data/lib/factpulse/models/processing_options.rb +2 -2
  326. data/lib/factpulse/models/processing_rule.rb +2 -2
  327. data/lib/factpulse/models/product_characteristic.rb +2 -2
  328. data/lib/factpulse/models/product_classification.rb +2 -2
  329. data/lib/factpulse/models/quantity.rb +2 -2
  330. data/lib/factpulse/models/rate.rb +2 -2
  331. data/lib/factpulse/models/rate1.rb +2 -2
  332. data/lib/factpulse/models/reason_code_info.rb +2 -2
  333. data/lib/factpulse/models/reason_codes_response.rb +2 -2
  334. data/lib/factpulse/models/recipient.rb +2 -2
  335. data/lib/factpulse/models/recipient_input.rb +2 -2
  336. data/lib/factpulse/models/refusee_request.rb +2 -2
  337. data/lib/factpulse/models/report_issuer.rb +2 -2
  338. data/lib/factpulse/models/report_period.rb +2 -2
  339. data/lib/factpulse/models/report_sender.rb +2 -2
  340. data/lib/factpulse/models/rounding_amount.rb +2 -2
  341. data/lib/factpulse/models/schematron_validation_error.rb +2 -2
  342. data/lib/factpulse/models/scheme_id.rb +2 -2
  343. data/lib/factpulse/models/search_flow_request.rb +2 -2
  344. data/lib/factpulse/models/search_flow_response.rb +2 -2
  345. data/lib/factpulse/models/search_services_response.rb +2 -2
  346. data/lib/factpulse/models/search_structure_request.rb +2 -2
  347. data/lib/factpulse/models/search_structure_response.rb +2 -2
  348. data/lib/factpulse/models/secret_status.rb +26 -6
  349. data/lib/factpulse/models/sellercountry.rb +2 -2
  350. data/lib/factpulse/models/signature_info.rb +2 -2
  351. data/lib/factpulse/models/signature_info_api.rb +2 -2
  352. data/lib/factpulse/models/signature_parameters.rb +2 -2
  353. data/lib/factpulse/models/signature_success_result.rb +394 -0
  354. data/lib/factpulse/models/signature_task_status.rb +223 -0
  355. data/lib/factpulse/models/signature_task_status_result.rb +55 -0
  356. data/lib/factpulse/models/simplified_cdar_response.rb +2 -2
  357. data/lib/factpulse/models/simplified_invoice_data.rb +3 -3
  358. data/lib/factpulse/models/status_code_info.rb +2 -2
  359. data/lib/factpulse/models/status_codes_response.rb +2 -2
  360. data/lib/factpulse/models/structure_info.rb +2 -2
  361. data/lib/factpulse/models/structure_parameters.rb +2 -2
  362. data/lib/factpulse/models/structure_service.rb +2 -2
  363. data/lib/factpulse/models/submission_mode.rb +2 -2
  364. data/lib/factpulse/models/submit_aggregated_report_request.rb +2 -2
  365. data/lib/factpulse/models/submit_cdar_request.rb +2 -2
  366. data/lib/factpulse/models/submit_cdar_response.rb +2 -2
  367. data/lib/factpulse/models/submit_cdarxml_request.rb +2 -2
  368. data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
  369. data/lib/factpulse/models/submit_complete_invoice_response.rb +33 -4
  370. data/lib/factpulse/models/submit_e_reporting_request.rb +2 -2
  371. data/lib/factpulse/models/submit_e_reporting_response.rb +2 -2
  372. data/lib/factpulse/models/submit_flow_request.rb +2 -2
  373. data/lib/factpulse/models/submit_flow_response.rb +2 -2
  374. data/lib/factpulse/models/submit_gross_amount.rb +2 -2
  375. data/lib/factpulse/models/submit_invoice_request.rb +2 -2
  376. data/lib/factpulse/models/submit_invoice_response.rb +2 -2
  377. data/lib/factpulse/models/submit_net_amount.rb +2 -2
  378. data/lib/factpulse/models/submit_vat_amount.rb +2 -2
  379. data/lib/factpulse/models/supplementary_attachment.rb +2 -2
  380. data/lib/factpulse/models/supplier.rb +4 -18
  381. data/lib/factpulse/models/task_error_result.rb +257 -0
  382. data/lib/factpulse/models/task_response.rb +2 -2
  383. data/lib/factpulse/models/tax_breakdown_input.rb +2 -2
  384. data/lib/factpulse/models/tax_due_date_type.rb +2 -2
  385. data/lib/factpulse/models/tax_representative.rb +2 -2
  386. data/lib/factpulse/models/taxable_amount.rb +2 -2
  387. data/lib/factpulse/models/taxableamount.rb +2 -2
  388. data/lib/factpulse/models/taxamount.rb +2 -2
  389. data/lib/factpulse/models/taxamount1.rb +2 -2
  390. data/lib/factpulse/models/taxamount2.rb +2 -2
  391. data/lib/factpulse/models/taxexclusiveamount.rb +2 -2
  392. data/lib/factpulse/models/taxexclusiveamount1.rb +2 -2
  393. data/lib/factpulse/models/total_gross_amount.rb +2 -2
  394. data/lib/factpulse/models/total_net_amount.rb +2 -2
  395. data/lib/factpulse/models/total_vat_amount.rb +2 -2
  396. data/lib/factpulse/models/transaction_category.rb +2 -2
  397. data/lib/factpulse/models/transmission_type_code.rb +2 -2
  398. data/lib/factpulse/models/unit_net_price.rb +2 -2
  399. data/lib/factpulse/models/unit_of_measure.rb +17 -3
  400. data/lib/factpulse/models/validate_cdar_request.rb +2 -2
  401. data/lib/factpulse/models/validate_cdar_response.rb +4 -4
  402. data/lib/factpulse/models/validate_e_reporting_request.rb +2 -2
  403. data/lib/factpulse/models/validate_e_reporting_response.rb +2 -2
  404. data/lib/factpulse/models/validation_error.rb +2 -2
  405. data/lib/factpulse/models/validation_error_detail.rb +2 -2
  406. data/lib/factpulse/models/validation_error_response.rb +69 -22
  407. data/lib/factpulse/models/validation_info.rb +2 -2
  408. data/lib/factpulse/models/validation_success_response.rb +2 -2
  409. data/lib/factpulse/models/validation_success_task_result.rb +210 -0
  410. data/lib/factpulse/models/validation_task_status.rb +223 -0
  411. data/lib/factpulse/models/validation_task_status_result.rb +55 -0
  412. data/lib/factpulse/models/vat_accounting_code.rb +2 -2
  413. data/lib/factpulse/models/vat_amount.rb +2 -2
  414. data/lib/factpulse/models/vat_category.rb +2 -2
  415. data/lib/factpulse/models/vat_line.rb +2 -2
  416. data/lib/factpulse/models/vat_point_date_code.rb +2 -2
  417. data/lib/factpulse/models/vat_rate.rb +2 -2
  418. data/lib/factpulse/models/vatex_code_info.rb +247 -0
  419. data/lib/factpulse/models/vatex_codes_response.rb +204 -0
  420. data/lib/factpulse/models/verification_success_response.rb +2 -2
  421. data/lib/factpulse/models/verification_success_task_result.rb +210 -0
  422. data/lib/factpulse/models/verification_typed_task_status.rb +223 -0
  423. data/lib/factpulse/models/verification_typed_task_status_result.rb +55 -0
  424. data/lib/factpulse/models/verified_field_schema.rb +2 -2
  425. data/lib/factpulse/models/webhook_secret_delete_response.rb +193 -0
  426. data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
  427. data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
  428. data/lib/factpulse/version.rb +3 -3
  429. data/lib/factpulse.rb +40 -5
  430. metadata +133 -63
  431. data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +0 -24
  432. data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +0 -15
  433. data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +0 -215
  434. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +0 -43
@@ -5,6 +5,7 @@ All URIs are relative to *https://factpulse.fr*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**get_verification_status_api_v1_verification_verify_async_task_id_status_get**](FacturXPDFXMLVerificationApi.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_typed_status_api_v1_verification_verify_async_task_id_typed_status_get**](FacturXPDFXMLVerificationApi.md#get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get) | **GET** /api/v1/verification/verify-async/{task_id}/typed-status | Get typed status of an asynchronous verification |
8
9
  | [**verify_pdf_async_api_v1_verification_verify_async_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_async_api_v1_verification_verify_async_post) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous) |
9
10
  | [**verify_pdf_sync_api_v1_verification_verify_post**](FacturXPDFXMLVerificationApi.md#verify_pdf_sync_api_v1_verification_verify_post) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous) |
10
11
 
@@ -24,6 +25,11 @@ require 'time'
24
25
  require 'factpulse'
25
26
  # setup authorization
26
27
  FactPulse.configure do |config|
28
+ # Configure API key authorization: APIKeyHeader
29
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
32
+
27
33
  # Configure Bearer authorization: HTTPBearer
28
34
  config.access_token = 'YOUR_BEARER_TOKEN'
29
35
  end
@@ -70,7 +76,81 @@ end
70
76
 
71
77
  ### Authorization
72
78
 
73
- [HTTPBearer](../README.md#HTTPBearer)
79
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get
88
+
89
+ > <VerificationTypedTaskStatus> get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get(task_id)
90
+
91
+ Get typed status of an asynchronous verification
92
+
93
+ Typed status endpoint for async verification tasks. Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `VerificationSuccessTaskResult` with `verification_result` - **ERROR**: `TaskErrorResult` in AFNOR format
94
+
95
+ ### Examples
96
+
97
+ ```ruby
98
+ require 'time'
99
+ require 'factpulse'
100
+ # setup authorization
101
+ FactPulse.configure do |config|
102
+ # Configure API key authorization: APIKeyHeader
103
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
106
+
107
+ # Configure Bearer authorization: HTTPBearer
108
+ config.access_token = 'YOUR_BEARER_TOKEN'
109
+ end
110
+
111
+ api_instance = FactPulse::FacturXPDFXMLVerificationApi.new
112
+ task_id = 'task_id_example' # String | Celery task ID returned by /verify-async endpoint
113
+
114
+ begin
115
+ # Get typed status of an asynchronous verification
116
+ result = api_instance.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get(task_id)
117
+ p result
118
+ rescue FactPulse::ApiError => e
119
+ puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get: #{e}"
120
+ end
121
+ ```
122
+
123
+ #### Using the get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info variant
124
+
125
+ This returns an Array which contains the response data, status code and headers.
126
+
127
+ > <Array(<VerificationTypedTaskStatus>, Integer, Hash)> get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id)
128
+
129
+ ```ruby
130
+ begin
131
+ # Get typed status of an asynchronous verification
132
+ data, status_code, headers = api_instance.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id)
133
+ p status_code # => 2xx
134
+ p headers # => { ... }
135
+ p data # => <VerificationTypedTaskStatus>
136
+ rescue FactPulse::ApiError => e
137
+ puts "Error when calling FacturXPDFXMLVerificationApi->get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Name | Type | Description | Notes |
144
+ | ---- | ---- | ----------- | ----- |
145
+ | **task_id** | **String** | Celery task ID returned by /verify-async endpoint | |
146
+
147
+ ### Return type
148
+
149
+ [**VerificationTypedTaskStatus**](VerificationTypedTaskStatus.md)
150
+
151
+ ### Authorization
152
+
153
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
74
154
 
75
155
  ### HTTP request headers
76
156
 
@@ -93,6 +173,11 @@ require 'time'
93
173
  require 'factpulse'
94
174
  # setup authorization
95
175
  FactPulse.configure do |config|
176
+ # Configure API key authorization: APIKeyHeader
177
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
178
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
179
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
180
+
96
181
  # Configure Bearer authorization: HTTPBearer
97
182
  config.access_token = 'YOUR_BEARER_TOKEN'
98
183
  end
@@ -147,7 +232,7 @@ end
147
232
 
148
233
  ### Authorization
149
234
 
150
- [HTTPBearer](../README.md#HTTPBearer)
235
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
151
236
 
152
237
  ### HTTP request headers
153
238
 
@@ -170,6 +255,11 @@ require 'time'
170
255
  require 'factpulse'
171
256
  # setup authorization
172
257
  FactPulse.configure do |config|
258
+ # Configure API key authorization: APIKeyHeader
259
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
260
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
261
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
262
+
173
263
  # Configure Bearer authorization: HTTPBearer
174
264
  config.access_token = 'YOUR_BEARER_TOKEN'
175
265
  end
@@ -216,7 +306,7 @@ end
216
306
 
217
307
  ### Authorization
218
308
 
219
- [HTTPBearer](../README.md#HTTPBearer)
309
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
220
310
 
221
311
  ### HTTP request headers
222
312
 
@@ -6,7 +6,6 @@ All URIs are relative to *https://factpulse.fr*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post**](FacturXValidationApi.md#validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post) | **POST** /api/v1/processing/validate-facturx-pdf | Validate a complete Factur-X PDF |
8
8
  | [**validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post**](FacturXValidationApi.md#validate_facturx_pdf_async_api_v1_processing_validate_facturx_async_post) | **POST** /api/v1/processing/validate-facturx-async | Validate a Factur-X PDF (asynchronous with polling) |
9
- | [**validate_xml_api_v1_processing_validate_xml_post**](FacturXValidationApi.md#validate_xml_api_v1_processing_validate_xml_post) | **POST** /api/v1/processing/validate-xml | Validate an existing Factur-X XML |
10
9
 
11
10
 
12
11
  ## validate_facturx_pdf_api_v1_processing_validate_facturx_pdf_post
@@ -24,6 +23,11 @@ require 'time'
24
23
  require 'factpulse'
25
24
  # setup authorization
26
25
  FactPulse.configure do |config|
26
+ # Configure API key authorization: APIKeyHeader
27
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
30
+
27
31
  # Configure Bearer authorization: HTTPBearer
28
32
  config.access_token = 'YOUR_BEARER_TOKEN'
29
33
  end
@@ -78,7 +82,7 @@ end
78
82
 
79
83
  ### Authorization
80
84
 
81
- [HTTPBearer](../README.md#HTTPBearer)
85
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
82
86
 
83
87
  ### HTTP request headers
84
88
 
@@ -101,6 +105,11 @@ require 'time'
101
105
  require 'factpulse'
102
106
  # setup authorization
103
107
  FactPulse.configure do |config|
108
+ # Configure API key authorization: APIKeyHeader
109
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
110
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
111
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
112
+
104
113
  # Configure Bearer authorization: HTTPBearer
105
114
  config.access_token = 'YOUR_BEARER_TOKEN'
106
115
  end
@@ -157,82 +166,7 @@ end
157
166
 
158
167
  ### Authorization
159
168
 
160
- [HTTPBearer](../README.md#HTTPBearer)
161
-
162
- ### HTTP request headers
163
-
164
- - **Content-Type**: multipart/form-data
165
- - **Accept**: application/json
166
-
167
-
168
- ## validate_xml_api_v1_processing_validate_xml_post
169
-
170
- > <ValidationSuccessResponse> validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
171
-
172
- Validate an existing Factur-X XML
173
-
174
- Validates a Factur-X XML file against Schematron business rules according to EN 16931 standard. ## Applied Standard **Schematron ISO/IEC 19757-3**: Business rules validation language for XML - Semantic validation (beyond XSD syntax) - European EN 16931 business rules - French-specific Factur-X rules - Arithmetic calculations and data consistency ## Profiles and validated rules ### MINIMUM (45 rules) - Unique invoice identifier - Dates (issue, due date) - Party identifiers (SIRET/SIREN) - Total gross amount ### BASIC (102 rules) - All MINIMUM rules - Detailed invoice lines - Basic VAT calculations - Payment methods - References (order, contract) ### EN16931 (178 rules) - All BASIC rules - **European rules (BR-xx)**: 81 business rules - **French rules (FR-xx)**: 12 France-specific rules - **Advanced calculations (CR-xx)**: 32 calculation rules - **Standardized codes (CL-xx)**: 52 code lists ### EXTENDED (210+ rules) - All EN16931 rules - Logistics information - Advanced accounting data - Multiple external references ## Checks performed ### 1. Syntax validation - Correct XML parsing (UTF-8, well-formed) - UN/CEFACT namespaces present - Hierarchical structure respected ### 2. Business rules (BR-xx) Examples: - `BR-1`: Invoice total must equal sum of line totals + document-level amounts - `BR-CO-10`: Sum of VAT base amounts must equal invoice net total - `BR-16`: Invoice currency code must be in ISO 4217 list ### 3. French rules (FR-xx) Examples: - `FR-1`: Supplier SIRET must have 14 digits - `FR-2`: Customer SIRET must have 14 digits (if present) - `FR-5`: Intra-EU VAT number must be in format FRxx999999999 ### 4. Calculation rules (CR-xx) - Net + VAT = Gross amounts - Sum of lines = Document total - Discounts and surcharges correctly applied - Compliant rounding (2 decimals for amounts) ### 5. Standardized codes (CL-xx) - ISO 3166-1 alpha-2 country codes - ISO 4217 currency codes - UN/ECE Rec 20 measurement units - VAT codes (types, categories, exemptions) - SchemeID for identifiers (0002=SIREN, 0009=SIRET, etc.) ## Validation process 1. **XSLT loading**: Schematron file converted to XSLT (Saxon-HE) 2. **Transformation**: Rules applied to XML 3. **Results analysis**: Extraction of errors (`failed-assert`) and warnings (`successful-report`) 4. **Report**: Structured list of non-conformities ## Responses **200 OK**: Compliant XML ```json { \"message\": \"XML is compliant with EN16931 profile\" } ``` **400 Bad Request**: Non-compliant XML ```json { \"detail\": [ \"[BR-1] Invoice total (120.00) does not match calculated sum (100.00 + 20.00)\", \"[FR-1] Supplier SIRET must contain exactly 14 digits\" ] } ``` ## Use cases - **Pre-validation**: Verify XML before PDF/A integration - **Debugging**: Precisely identify generation errors - **Testing**: Validate test or example XMLs - **Compliance**: Ensure European and French rules are met - **Development**: Quick testing without PDF generation ## Processing time - MINIMUM profile: ~0.5 second - EN16931 profile: ~1-2 seconds - EXTENDED profile: ~2-3 seconds
175
-
176
- ### Examples
177
-
178
- ```ruby
179
- require 'time'
180
- require 'factpulse'
181
- # setup authorization
182
- FactPulse.configure do |config|
183
- # Configure Bearer authorization: HTTPBearer
184
- config.access_token = 'YOUR_BEARER_TOKEN'
185
- end
186
-
187
- api_instance = FactPulse::FacturXValidationApi.new
188
- xml_file = File.new('/path/to/some/file') # File | Factur-X XML file to validate (.xml format).
189
- opts = {
190
- profile: FactPulse::APIProfile::MINIMUM, # APIProfile | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
191
- skip_br_fr: true # Boolean |
192
- }
193
-
194
- begin
195
- # Validate an existing Factur-X XML
196
- result = api_instance.validate_xml_api_v1_processing_validate_xml_post(xml_file, opts)
197
- p result
198
- rescue FactPulse::ApiError => e
199
- puts "Error when calling FacturXValidationApi->validate_xml_api_v1_processing_validate_xml_post: #{e}"
200
- end
201
- ```
202
-
203
- #### Using the validate_xml_api_v1_processing_validate_xml_post_with_http_info variant
204
-
205
- This returns an Array which contains the response data, status code and headers.
206
-
207
- > <Array(<ValidationSuccessResponse>, Integer, Hash)> validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
208
-
209
- ```ruby
210
- begin
211
- # Validate an existing Factur-X XML
212
- data, status_code, headers = api_instance.validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
213
- p status_code # => 2xx
214
- p headers # => { ... }
215
- p data # => <ValidationSuccessResponse>
216
- rescue FactPulse::ApiError => e
217
- puts "Error when calling FacturXValidationApi->validate_xml_api_v1_processing_validate_xml_post_with_http_info: #{e}"
218
- end
219
- ```
220
-
221
- ### Parameters
222
-
223
- | Name | Type | Description | Notes |
224
- | ---- | ---- | ----------- | ----- |
225
- | **xml_file** | **File** | Factur-X XML file to validate (.xml format). | |
226
- | **profile** | [**APIProfile**](APIProfile.md) | Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). | [optional] |
227
- | **skip_br_fr** | **Boolean** | | [optional] |
228
-
229
- ### Return type
230
-
231
- [**ValidationSuccessResponse**](ValidationSuccessResponse.md)
232
-
233
- ### Authorization
234
-
235
- [HTTPBearer](../README.md#HTTPBearer)
169
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
236
170
 
237
171
  ### HTTP request headers
238
172
 
@@ -0,0 +1,15 @@
1
+ # FactPulse::FactureElectroniqueModelsInvoiceTypeCode
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'factpulse'
12
+
13
+ instance = FactPulse::FactureElectroniqueModelsInvoiceTypeCode.new()
14
+ ```
15
+
@@ -0,0 +1,18 @@
1
+ # FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **detail** | **Array&lt;String&gt;** | List of detected validation errors. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'factpulse'
13
+
14
+ instance = FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.new(
15
+ detail: null
16
+ )
17
+ ```
18
+
@@ -32,6 +32,11 @@ require 'time'
32
32
  require 'factpulse'
33
33
  # setup authorization
34
34
  FactPulse.configure do |config|
35
+ # Configure API key authorization: APIKeyHeader
36
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
39
+
35
40
  # Configure Bearer authorization: HTTPBearer
36
41
  config.access_token = 'YOUR_BEARER_TOKEN'
37
42
  end
@@ -78,7 +83,7 @@ end
78
83
 
79
84
  ### Authorization
80
85
 
81
- [HTTPBearer](../README.md#HTTPBearer)
86
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
82
87
 
83
88
  ### HTTP request headers
84
89
 
@@ -101,6 +106,11 @@ require 'time'
101
106
  require 'factpulse'
102
107
  # setup authorization
103
108
  FactPulse.configure do |config|
109
+ # Configure API key authorization: APIKeyHeader
110
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
111
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
112
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
113
+
104
114
  # Configure Bearer authorization: HTTPBearer
105
115
  config.access_token = 'YOUR_BEARER_TOKEN'
106
116
  end
@@ -147,7 +157,7 @@ end
147
157
 
148
158
  ### Authorization
149
159
 
150
- [HTTPBearer](../README.md#HTTPBearer)
160
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
151
161
 
152
162
  ### HTTP request headers
153
163
 
@@ -170,6 +180,11 @@ require 'time'
170
180
  require 'factpulse'
171
181
  # setup authorization
172
182
  FactPulse.configure do |config|
183
+ # Configure API key authorization: APIKeyHeader
184
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
187
+
173
188
  # Configure Bearer authorization: HTTPBearer
174
189
  config.access_token = 'YOUR_BEARER_TOKEN'
175
190
  end
@@ -219,7 +234,7 @@ nil (empty response body)
219
234
 
220
235
  ### Authorization
221
236
 
222
- [HTTPBearer](../README.md#HTTPBearer)
237
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
223
238
 
224
239
  ### HTTP request headers
225
240
 
@@ -585,6 +600,11 @@ require 'time'
585
600
  require 'factpulse'
586
601
  # setup authorization
587
602
  FactPulse.configure do |config|
603
+ # Configure API key authorization: APIKeyHeader
604
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
605
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
606
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
607
+
588
608
  # Configure Bearer authorization: HTTPBearer
589
609
  config.access_token = 'YOUR_BEARER_TOKEN'
590
610
  end
@@ -631,7 +651,7 @@ end
631
651
 
632
652
  ### Authorization
633
653
 
634
- [HTTPBearer](../README.md#HTTPBearer)
654
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
635
655
 
636
656
  ### HTTP request headers
637
657
 
@@ -654,6 +674,11 @@ require 'time'
654
674
  require 'factpulse'
655
675
  # setup authorization
656
676
  FactPulse.configure do |config|
677
+ # Configure API key authorization: APIKeyHeader
678
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
679
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
680
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
681
+
657
682
  # Configure Bearer authorization: HTTPBearer
658
683
  config.access_token = 'YOUR_BEARER_TOKEN'
659
684
  end
@@ -700,7 +725,7 @@ end
700
725
 
701
726
  ### Authorization
702
727
 
703
- [HTTPBearer](../README.md#HTTPBearer)
728
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
704
729
 
705
730
  ### HTTP request headers
706
731
 
@@ -723,6 +748,11 @@ require 'time'
723
748
  require 'factpulse'
724
749
  # setup authorization
725
750
  FactPulse.configure do |config|
751
+ # Configure API key authorization: APIKeyHeader
752
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
753
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
754
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
755
+
726
756
  # Configure Bearer authorization: HTTPBearer
727
757
  config.access_token = 'YOUR_BEARER_TOKEN'
728
758
  end
@@ -775,7 +805,7 @@ end
775
805
 
776
806
  ### Authorization
777
807
 
778
- [HTTPBearer](../README.md#HTTPBearer)
808
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
779
809
 
780
810
  ### HTTP request headers
781
811
 
@@ -6,6 +6,7 @@ All URIs are relative to *https://factpulse.fr*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**generate_cdar_api_v1_cdar_generate_post**](Flux6InvoiceLifecycleCDARApi.md#generate_cdar_api_v1_cdar_generate_post) | **POST** /api/v1/cdar/generate | Generate a CDAR message |
8
8
  | [**get_action_codes_api_v1_cdar_action_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_action_codes_api_v1_cdar_action_codes_get) | **GET** /api/v1/cdar/action-codes | List of CDAR action codes |
9
+ | [**get_lifecycle_api_v1_cdar_lifecycle_get**](Flux6InvoiceLifecycleCDARApi.md#get_lifecycle_api_v1_cdar_lifecycle_get) | **GET** /api/v1/cdar/lifecycle | [Simplified] Get lifecycle events for invoices |
9
10
  | [**get_reason_codes_api_v1_cdar_reason_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_reason_codes_api_v1_cdar_reason_codes_get) | **GET** /api/v1/cdar/reason-codes | List of CDAR reason codes |
10
11
  | [**get_status_codes_api_v1_cdar_status_codes_get**](Flux6InvoiceLifecycleCDARApi.md#get_status_codes_api_v1_cdar_status_codes_get) | **GET** /api/v1/cdar/status-codes | List of CDAR status codes |
11
12
  | [**submit_cdar_api_v1_cdar_submit_post**](Flux6InvoiceLifecycleCDARApi.md#submit_cdar_api_v1_cdar_submit_post) | **POST** /api/v1/cdar/submit | Generate and submit a CDAR message |
@@ -31,6 +32,11 @@ require 'time'
31
32
  require 'factpulse'
32
33
  # setup authorization
33
34
  FactPulse.configure do |config|
35
+ # Configure API key authorization: APIKeyHeader
36
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
39
+
34
40
  # Configure Bearer authorization: HTTPBearer
35
41
  config.access_token = 'YOUR_BEARER_TOKEN'
36
42
  end
@@ -77,7 +83,7 @@ end
77
83
 
78
84
  ### Authorization
79
85
 
80
- [HTTPBearer](../README.md#HTTPBearer)
86
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
81
87
 
82
88
  ### HTTP request headers
83
89
 
@@ -146,6 +152,87 @@ No authorization required
146
152
  - **Accept**: application/json
147
153
 
148
154
 
155
+ ## get_lifecycle_api_v1_cdar_lifecycle_get
156
+
157
+ > <LifecycleResponse> get_lifecycle_api_v1_cdar_lifecycle_get(opts)
158
+
159
+ [Simplified] Get lifecycle events for invoices
160
+
161
+ Returns lifecycle events (CDAR) grouped by invoice reference. **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically **Parameters:** - `days`: Number of days to look back (default: 7) - `invoiceId`: Optional filter on a specific invoice reference **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
162
+
163
+ ### Examples
164
+
165
+ ```ruby
166
+ require 'time'
167
+ require 'factpulse'
168
+ # setup authorization
169
+ FactPulse.configure do |config|
170
+ # Configure Bearer authorization: HTTPBearer
171
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
+ end
173
+
174
+ api_instance = FactPulse::Flux6InvoiceLifecycleCDARApi.new
175
+ opts = {
176
+ days: 56, # Integer | Number of days to look back
177
+ invoice_id: 'invoice_id_example', # String | Filter by invoice reference
178
+ pdp_flow_service_url: 'pdp_flow_service_url_example', # String | PDP Flow Service URL
179
+ pdp_token_url: 'pdp_token_url_example', # String | PDP OAuth token URL
180
+ pdp_client_id: 'pdp_client_id_example', # String | PDP Client ID
181
+ pdp_client_secret: 'pdp_client_secret_example' # String | PDP Client Secret
182
+ }
183
+
184
+ begin
185
+ # [Simplified] Get lifecycle events for invoices
186
+ result = api_instance.get_lifecycle_api_v1_cdar_lifecycle_get(opts)
187
+ p result
188
+ rescue FactPulse::ApiError => e
189
+ puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_lifecycle_api_v1_cdar_lifecycle_get: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<LifecycleResponse>, Integer, Hash)> get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts)
198
+
199
+ ```ruby
200
+ begin
201
+ # [Simplified] Get lifecycle events for invoices
202
+ data, status_code, headers = api_instance.get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <LifecycleResponse>
206
+ rescue FactPulse::ApiError => e
207
+ puts "Error when calling Flux6InvoiceLifecycleCDARApi->get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **days** | **Integer** | Number of days to look back | [optional][default to 7] |
216
+ | **invoice_id** | **String** | Filter by invoice reference | [optional] |
217
+ | **pdp_flow_service_url** | **String** | PDP Flow Service URL | [optional] |
218
+ | **pdp_token_url** | **String** | PDP OAuth token URL | [optional] |
219
+ | **pdp_client_id** | **String** | PDP Client ID | [optional] |
220
+ | **pdp_client_secret** | **String** | PDP Client Secret | [optional] |
221
+
222
+ ### Return type
223
+
224
+ [**LifecycleResponse**](LifecycleResponse.md)
225
+
226
+ ### Authorization
227
+
228
+ [HTTPBearer](../README.md#HTTPBearer)
229
+
230
+ ### HTTP request headers
231
+
232
+ - **Content-Type**: Not defined
233
+ - **Accept**: application/json
234
+
235
+
149
236
  ## get_reason_codes_api_v1_cdar_reason_codes_get
150
237
 
151
238
  > <ReasonCodesResponse> get_reason_codes_api_v1_cdar_reason_codes_get
@@ -559,6 +646,11 @@ require 'time'
559
646
  require 'factpulse'
560
647
  # setup authorization
561
648
  FactPulse.configure do |config|
649
+ # Configure API key authorization: APIKeyHeader
650
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
651
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
652
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
653
+
562
654
  # Configure Bearer authorization: HTTPBearer
563
655
  config.access_token = 'YOUR_BEARER_TOKEN'
564
656
  end
@@ -605,7 +697,7 @@ end
605
697
 
606
698
  ### Authorization
607
699
 
608
- [HTTPBearer](../README.md#HTTPBearer)
700
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
609
701
 
610
702
  ### HTTP request headers
611
703
 
@@ -628,6 +720,11 @@ require 'time'
628
720
  require 'factpulse'
629
721
  # setup authorization
630
722
  FactPulse.configure do |config|
723
+ # Configure API key authorization: APIKeyHeader
724
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
725
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
726
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
727
+
631
728
  # Configure Bearer authorization: HTTPBearer
632
729
  config.access_token = 'YOUR_BEARER_TOKEN'
633
730
  end
@@ -674,7 +771,7 @@ end
674
771
 
675
772
  ### Authorization
676
773
 
677
- [HTTPBearer](../README.md#HTTPBearer)
774
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
678
775
 
679
776
  ### HTTP request headers
680
777
 
@@ -0,0 +1,24 @@
1
+ # FactPulse::GenerationSuccessResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional][default to &#39;SUCCESS&#39;] |
8
+ | **content_b64** | **String** | | [optional] |
9
+ | **xml_content** | **String** | | [optional] |
10
+ | **filename** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'factpulse'
16
+
17
+ instance = FactPulse::GenerationSuccessResult.new(
18
+ status: null,
19
+ content_b64: null,
20
+ xml_content: null,
21
+ filename: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # FactPulse::GenerationTaskStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **task_id** | **String** | | |
8
+ | **status** | [**CeleryStatus**](CeleryStatus.md) | | |
9
+ | **result** | [**GenerationTaskStatusResult**](GenerationTaskStatusResult.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'factpulse'
15
+
16
+ instance = FactPulse::GenerationTaskStatus.new(
17
+ task_id: null,
18
+ status: null,
19
+ result: null
20
+ )
21
+ ```
22
+