factpulse 4.0.3 → 4.3.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 (510) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -5
  3. data/Gemfile.lock +3 -3
  4. data/docs/AFNORBasicAuthentication.md +20 -0
  5. data/docs/AFNORCallbackAuthentication.md +49 -0
  6. data/docs/AFNORCallbackHeader.md +20 -0
  7. data/docs/AFNORCallbackParameters.md +24 -0
  8. data/docs/AFNORCallbackSignature.md +20 -0
  9. data/docs/{AFNORFacilityNature.md → AFNORContainsOrStrictOperator.md} +2 -2
  10. data/docs/AFNORCoreFlowInfo.md +26 -0
  11. data/docs/{AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md → AFNORDirectoryLinePayloadLegalUnitFacilityRoutingCode.md} +5 -5
  12. data/docs/AFNORDirectoryLinePayloadStatusLegalUnitFacilityRoutingCode.md +34 -0
  13. data/docs/AFNORDirectoryLineSearchPost200Response.md +1 -1
  14. data/docs/{AFNORDiffusionStatus.md → AFNORDirectoryLineStatus.md} +2 -2
  15. data/docs/AFNORError.md +4 -4
  16. data/docs/AFNORErrorDetail.md +26 -0
  17. data/docs/AFNORFacilityPayloadHistory.md +3 -3
  18. data/docs/AFNORFacilityPayloadIncluded.md +0 -2
  19. data/docs/AFNORFlow.md +16 -14
  20. data/docs/AFNORFlowExtension.md +26 -0
  21. data/docs/AFNORFlowInfo.md +3 -3
  22. data/docs/AFNORFlowInfoExtension.md +18 -0
  23. data/docs/AFNORFullFlowInfo.md +8 -8
  24. data/docs/AFNORFullFlowInfoExtension.md +20 -0
  25. data/docs/AFNORLegalUnitPayloadHistory.md +3 -1
  26. data/docs/AFNOROAuth2Authentication.md +22 -0
  27. data/docs/AFNORPDPPADirectoryServiceApi.md +4 -648
  28. data/docs/AFNORPDPPAFlowServiceApi.md +320 -1
  29. data/docs/AFNORRoutingCodeSearch.md +1 -1
  30. data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +1 -1
  31. data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +1 -1
  32. data/docs/AFNORSearchDirectoryLine.md +2 -2
  33. data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +1 -1
  34. data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +1 -1
  35. data/docs/AFNORSearchFlowFilters.md +1 -1
  36. data/docs/AFNORSearchSiren.md +1 -1
  37. data/docs/AFNORSearchSirenFiltersBusinessName.md +1 -1
  38. data/docs/AFNORSearchSirenFiltersSiren.md +1 -1
  39. data/docs/AFNORSearchSiret.md +2 -2
  40. data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +1 -1
  41. data/docs/AFNORSearchSiretFiltersFacilityType.md +1 -1
  42. data/docs/AFNORSearchSiretFiltersLocality.md +1 -1
  43. data/docs/AFNORSearchSiretFiltersName.md +1 -1
  44. data/docs/AFNORSearchSiretFiltersPostalCode.md +1 -1
  45. data/docs/AFNORSearchSiretFiltersSiret.md +1 -1
  46. data/docs/AFNORSirenInstructions.md +18 -0
  47. data/docs/AFNORSiretInstructions.md +18 -0
  48. data/docs/{AFNORPlatformStatus.md → AFNORStrictOrStartWithOperator.md} +2 -2
  49. data/docs/AFNORWebhook.md +22 -0
  50. data/docs/AFNORWebhookIdParam.md +18 -0
  51. data/docs/AFNORWebhookMetadata.md +24 -0
  52. data/docs/AFNORWebhookParams.md +20 -0
  53. data/docs/AFNORWebhookPatchPayload.md +22 -0
  54. data/docs/AsyncTasksApi.md +225 -0
  55. data/docs/ChorusProCredentials.md +8 -8
  56. data/docs/ChorusProDestination.md +1 -1
  57. data/docs/ClientManagementApi.md +20 -20
  58. data/docs/ConversionErrorResult.md +30 -0
  59. data/docs/ConversionExtractionInfo.md +20 -0
  60. data/docs/ConversionPendingInputResult.md +30 -0
  61. data/docs/ConversionSuccessTaskResult.md +36 -0
  62. data/docs/ConversionTaskStatus.md +22 -0
  63. data/docs/ConversionTaskStatusResult.md +85 -0
  64. data/docs/ConversionValidationFailedResult.md +34 -0
  65. data/docs/DownloadsApi.md +4 -4
  66. data/docs/FacturXConversionApi.md +75 -0
  67. data/docs/FacturXInvoice.md +1 -1
  68. data/docs/FacturXPDFXMLVerificationApi.md +75 -0
  69. data/docs/FacturXValidationApi.md +0 -81
  70. data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +24 -0
  71. data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
  72. data/docs/Flux6InvoiceLifecycleCDARApi.md +82 -0
  73. data/docs/GenerationSuccessResult.md +24 -0
  74. data/docs/GenerationTaskStatus.md +22 -0
  75. data/docs/GenerationTaskStatusResult.md +79 -0
  76. data/docs/GetChorusProIdRequest.md +1 -1
  77. data/docs/GetInvoiceRequest.md +1 -1
  78. data/docs/GetStructureRequest.md +1 -1
  79. data/docs/HealthApi.md +0 -124
  80. data/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md} +21 -21
  81. data/docs/InvoiceLifecycle.md +24 -0
  82. data/docs/InvoicingFramework.md +1 -1
  83. data/docs/LifecycleEvent.md +38 -0
  84. data/docs/LifecycleResponse.md +22 -0
  85. data/docs/ParseApi.md +161 -0
  86. data/docs/ParseFacturXResponse.md +26 -0
  87. data/docs/ReferencesApi.md +74 -0
  88. data/docs/SearchStructureRequest.md +1 -1
  89. data/docs/SignatureSuccessResult.md +34 -0
  90. data/docs/SignatureTaskStatus.md +22 -0
  91. data/docs/SignatureTaskStatusResult.md +79 -0
  92. data/docs/SubmitCompleteInvoiceResponse.md +3 -1
  93. data/docs/SubmitInvoiceRequest.md +1 -1
  94. data/docs/Supplier.md +1 -1
  95. data/docs/TaskErrorResult.md +26 -0
  96. data/docs/VATEXCodeInfo.md +24 -0
  97. data/docs/VATEXCodesResponse.md +22 -0
  98. data/docs/ValidateCDARResponse.md +2 -2
  99. data/docs/ValidationApi.md +88 -0
  100. data/docs/ValidationErrorResponse.md +2 -8
  101. data/docs/ValidationSuccessTaskResult.md +20 -0
  102. data/docs/ValidationTaskStatus.md +22 -0
  103. data/docs/ValidationTaskStatusResult.md +79 -0
  104. data/docs/VerificationSuccessTaskResult.md +20 -0
  105. data/docs/VerificationTypedTaskStatus.md +22 -0
  106. data/docs/VerificationTypedTaskStatusResult.md +79 -0
  107. data/factpulse.gemspec +3 -3
  108. data/lib/factpulse/api/afnorpdppa_api.rb +2 -2
  109. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +5 -623
  110. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +305 -2
  111. data/lib/factpulse/api/async_tasks_api.rb +191 -2
  112. data/lib/factpulse/api/chorus_pro_api.rb +2 -2
  113. data/lib/factpulse/api/client_management_api.rb +22 -22
  114. data/lib/factpulse/api/downloads_api.rb +6 -6
  115. data/lib/factpulse/api/electronic_signature_api.rb +2 -2
  116. data/lib/factpulse/api/factur_x_conversion_api.rb +65 -2
  117. data/lib/factpulse/api/factur_x_validation_api.rb +2 -77
  118. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +65 -2
  119. data/lib/factpulse/api/flux10_e_reporting_api.rb +2 -2
  120. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +85 -2
  121. data/lib/factpulse/api/health_api.rb +2 -116
  122. data/lib/factpulse/api/{factur_x_generation_api.rb → invoice_generation_api.rb} +23 -23
  123. data/lib/factpulse/api/parse_api.rb +163 -0
  124. data/lib/factpulse/api/references_api.rb +82 -0
  125. data/lib/factpulse/api/validation_api.rb +97 -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/models/acknowledgment_status.rb +2 -2
  131. data/lib/factpulse/models/action_code_info.rb +2 -2
  132. data/lib/factpulse/models/action_codes_response.rb +2 -2
  133. data/lib/factpulse/models/additional_document.rb +2 -2
  134. data/lib/factpulse/models/afnor_acknowledgement.rb +2 -2
  135. data/lib/factpulse/models/afnor_acknowledgement_detail.rb +2 -2
  136. data/lib/factpulse/models/afnor_address_read.rb +2 -2
  137. data/lib/factpulse/models/afnor_algorithm.rb +6 -5
  138. data/lib/factpulse/models/afnor_basic_authentication.rb +190 -0
  139. data/lib/factpulse/models/afnor_callback_authentication.rb +105 -0
  140. data/lib/factpulse/models/afnor_callback_header.rb +190 -0
  141. data/lib/factpulse/models/afnor_callback_parameters.rb +193 -0
  142. data/lib/factpulse/models/afnor_callback_signature.rb +213 -0
  143. data/lib/factpulse/models/afnor_contains_operator.rb +2 -2
  144. data/lib/factpulse/models/afnor_contains_or_strict_operator.rb +40 -0
  145. data/lib/factpulse/models/afnor_core_flow_info.rb +270 -0
  146. data/lib/factpulse/models/afnor_credentials.rb +2 -2
  147. data/lib/factpulse/models/afnor_destination.rb +2 -2
  148. data/lib/factpulse/models/afnor_directory_line_field.rb +3 -4
  149. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +2 -2
  150. data/lib/factpulse/models/{afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb → afnor_directory_line_payload_legal_unit_facility_routing_code.rb} +38 -16
  151. data/lib/factpulse/models/afnor_directory_line_payload_status_legal_unit_facility_routing_code.rb +343 -0
  152. data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +3 -3
  153. data/lib/factpulse/models/afnor_directory_line_status.rb +41 -0
  154. data/lib/factpulse/models/afnor_entity_type.rb +2 -2
  155. data/lib/factpulse/models/afnor_error.rb +32 -41
  156. data/lib/factpulse/models/afnor_error_detail.rb +237 -0
  157. data/lib/factpulse/models/afnor_facility_administrative_status.rb +2 -2
  158. data/lib/factpulse/models/afnor_facility_payload_history.rb +13 -13
  159. data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +2 -2
  160. data/lib/factpulse/models/afnor_facility_payload_included.rb +3 -12
  161. data/lib/factpulse/models/afnor_facility_type.rb +2 -2
  162. data/lib/factpulse/models/afnor_flow.rb +220 -59
  163. data/lib/factpulse/models/afnor_flow_ack_status.rb +2 -2
  164. data/lib/factpulse/models/afnor_flow_direction.rb +2 -2
  165. data/lib/factpulse/models/afnor_flow_extension.rb +295 -0
  166. data/lib/factpulse/models/afnor_flow_info.rb +22 -6
  167. data/lib/factpulse/models/afnor_flow_info_extension.rb +170 -0
  168. data/lib/factpulse/models/afnor_flow_profile.rb +2 -2
  169. data/lib/factpulse/models/afnor_flow_syntax.rb +2 -2
  170. data/lib/factpulse/models/afnor_flow_type.rb +2 -2
  171. data/lib/factpulse/models/afnor_full_flow_info.rb +81 -48
  172. data/lib/factpulse/models/afnor_full_flow_info_extension.rb +202 -0
  173. data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
  174. data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +2 -2
  175. data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +15 -6
  176. data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +2 -2
  177. data/lib/factpulse/models/afnor_processing_rule.rb +6 -3
  178. data/lib/factpulse/models/afnor_reason_code.rb +2 -2
  179. data/lib/factpulse/models/afnor_reason_code_enum.rb +2 -2
  180. data/lib/factpulse/models/afnor_recipient_platform_type.rb +2 -2
  181. data/lib/factpulse/models/afnor_result.rb +2 -2
  182. data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +2 -2
  183. data/lib/factpulse/models/afnor_routing_code_field.rb +3 -4
  184. data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +2 -2
  185. data/lib/factpulse/models/afnor_routing_code_search.rb +2 -2
  186. data/lib/factpulse/models/afnor_routing_code_search_filters.rb +2 -2
  187. data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +2 -2
  188. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +3 -3
  189. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +3 -3
  190. data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +2 -2
  191. data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +2 -2
  192. data/lib/factpulse/models/afnor_search_directory_line.rb +2 -2
  193. data/lib/factpulse/models/afnor_search_directory_line_filters.rb +2 -2
  194. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +3 -3
  195. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +3 -3
  196. data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +2 -2
  197. data/lib/factpulse/models/afnor_search_flow_content.rb +2 -2
  198. data/lib/factpulse/models/afnor_search_flow_filters.rb +3 -2
  199. data/lib/factpulse/models/afnor_search_flow_params.rb +2 -2
  200. data/lib/factpulse/models/afnor_search_siren.rb +2 -2
  201. data/lib/factpulse/models/afnor_search_siren_filters.rb +2 -2
  202. data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +2 -2
  203. data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +3 -3
  204. data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +2 -2
  205. data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +3 -3
  206. data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +2 -2
  207. data/lib/factpulse/models/afnor_search_siret.rb +2 -2
  208. data/lib/factpulse/models/afnor_search_siret_filters.rb +2 -2
  209. data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
  210. data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +2 -2
  211. data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +3 -3
  212. data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +3 -3
  213. data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +3 -3
  214. data/lib/factpulse/models/afnor_search_siret_filters_name.rb +3 -3
  215. data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +3 -3
  216. data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +3 -3
  217. data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +2 -2
  218. data/lib/factpulse/models/afnor_siren_field.rb +4 -4
  219. data/lib/factpulse/models/afnor_siren_instructions.rb +149 -0
  220. data/lib/factpulse/models/afnor_siren_search_post200_response.rb +2 -2
  221. data/lib/factpulse/models/afnor_siret_field.rb +5 -6
  222. data/lib/factpulse/models/afnor_siret_instructions.rb +149 -0
  223. data/lib/factpulse/models/afnor_siret_search_post200_response.rb +2 -2
  224. data/lib/factpulse/models/afnor_sorting_order.rb +2 -2
  225. data/lib/factpulse/models/afnor_strict_operator.rb +2 -2
  226. data/lib/factpulse/models/afnor_strict_or_start_with_operator.rb +40 -0
  227. data/lib/factpulse/models/afnor_webhook.rb +207 -0
  228. data/lib/factpulse/models/afnor_webhook_id_param.rb +147 -0
  229. data/lib/factpulse/models/afnor_webhook_metadata.rb +230 -0
  230. data/lib/factpulse/models/afnor_webhook_params.rb +190 -0
  231. data/lib/factpulse/models/afnor_webhook_patch_payload.rb +167 -0
  232. data/lib/factpulse/models/afnoro_auth2_authentication.rb +216 -0
  233. data/lib/factpulse/models/aggregated_payment_input.rb +2 -2
  234. data/lib/factpulse/models/aggregated_transaction_input.rb +2 -2
  235. data/lib/factpulse/models/allowance_charge.rb +2 -2
  236. data/lib/factpulse/models/allowance_charge_reason_code.rb +2 -2
  237. data/lib/factpulse/models/allowance_reason_code.rb +2 -2
  238. data/lib/factpulse/models/allowance_total_amount.rb +2 -2
  239. data/lib/factpulse/models/amount.rb +2 -2
  240. data/lib/factpulse/models/amount1.rb +2 -2
  241. data/lib/factpulse/models/amount2.rb +2 -2
  242. data/lib/factpulse/models/amount_due.rb +2 -2
  243. data/lib/factpulse/models/api_error.rb +2 -2
  244. data/lib/factpulse/models/api_profile.rb +2 -2
  245. data/lib/factpulse/models/async_task_status.rb +2 -2
  246. data/lib/factpulse/models/base_amount.rb +2 -2
  247. data/lib/factpulse/models/bounding_box_schema.rb +2 -2
  248. data/lib/factpulse/models/buyercountry.rb +2 -2
  249. data/lib/factpulse/models/celery_status.rb +2 -2
  250. data/lib/factpulse/models/certificate_info_response.rb +2 -2
  251. data/lib/factpulse/models/charge_total_amount.rb +2 -2
  252. data/lib/factpulse/models/chorus_pro_credentials.rb +96 -28
  253. data/lib/factpulse/models/chorus_pro_destination.rb +3 -3
  254. data/lib/factpulse/models/chorus_pro_result.rb +2 -2
  255. data/lib/factpulse/models/client_activate_response.rb +2 -2
  256. data/lib/factpulse/models/client_create_request.rb +2 -2
  257. data/lib/factpulse/models/client_detail.rb +2 -2
  258. data/lib/factpulse/models/client_list_response.rb +2 -2
  259. data/lib/factpulse/models/client_summary.rb +2 -2
  260. data/lib/factpulse/models/client_update_request.rb +2 -2
  261. data/lib/factpulse/models/contact.rb +2 -2
  262. data/lib/factpulse/models/conversion_error_result.rb +277 -0
  263. data/lib/factpulse/models/conversion_extraction_info.rb +176 -0
  264. data/lib/factpulse/models/conversion_pending_input_result.rb +344 -0
  265. data/lib/factpulse/models/conversion_success_task_result.rb +355 -0
  266. data/lib/factpulse/models/conversion_task_status.rb +223 -0
  267. data/lib/factpulse/models/conversion_task_status_result.rb +59 -0
  268. data/lib/factpulse/models/conversion_validation_failed_result.rb +348 -0
  269. data/lib/factpulse/models/convert_resume_request.rb +2 -2
  270. data/lib/factpulse/models/convert_success_response.rb +2 -2
  271. data/lib/factpulse/models/convert_validation_failed_response.rb +2 -2
  272. data/lib/factpulse/models/country_code.rb +2 -2
  273. data/lib/factpulse/models/create_aggregated_report_request.rb +2 -2
  274. data/lib/factpulse/models/create_cdar_request.rb +2 -2
  275. data/lib/factpulse/models/create_e_reporting_request.rb +2 -2
  276. data/lib/factpulse/models/currency.rb +2 -2
  277. data/lib/factpulse/models/currency_code.rb +2 -2
  278. data/lib/factpulse/models/delivery_party.rb +2 -2
  279. data/lib/factpulse/models/destination.rb +2 -2
  280. data/lib/factpulse/models/doc_type.rb +2 -2
  281. data/lib/factpulse/models/document_type_info.rb +2 -2
  282. data/lib/factpulse/models/e_reporting_flow_type.rb +2 -2
  283. data/lib/factpulse/models/e_reporting_validation_error.rb +2 -2
  284. data/lib/factpulse/models/electronic_address.rb +2 -2
  285. data/lib/factpulse/models/encaisseamount.rb +2 -2
  286. data/lib/factpulse/models/encaisseamount1.rb +2 -2
  287. data/lib/factpulse/models/encaissee_request.rb +2 -2
  288. data/lib/factpulse/models/enriched_invoice_info.rb +2 -2
  289. data/lib/factpulse/models/error_level.rb +2 -2
  290. data/lib/factpulse/models/error_source.rb +2 -2
  291. data/lib/factpulse/models/extraction_info.rb +2 -2
  292. data/lib/factpulse/models/factur_x_invoice.rb +3 -19
  293. data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
  294. data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +215 -0
  295. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +2 -2
  296. data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
  297. data/lib/factpulse/models/field_status.rb +2 -2
  298. data/lib/factpulse/models/file_info.rb +2 -2
  299. data/lib/factpulse/models/files_info.rb +2 -2
  300. data/lib/factpulse/models/flow_direction.rb +2 -2
  301. data/lib/factpulse/models/flow_profile.rb +2 -2
  302. data/lib/factpulse/models/flow_summary.rb +2 -2
  303. data/lib/factpulse/models/flow_syntax.rb +2 -2
  304. data/lib/factpulse/models/flow_type.rb +2 -2
  305. data/lib/factpulse/models/generate_aggregated_report_response.rb +2 -2
  306. data/lib/factpulse/models/generate_cdar_response.rb +2 -2
  307. data/lib/factpulse/models/generate_certificate_request.rb +2 -2
  308. data/lib/factpulse/models/generate_certificate_response.rb +2 -2
  309. data/lib/factpulse/models/generate_e_reporting_response.rb +2 -2
  310. data/lib/factpulse/models/generation_success_result.rb +230 -0
  311. data/lib/factpulse/models/generation_task_status.rb +223 -0
  312. data/lib/factpulse/models/generation_task_status_result.rb +55 -0
  313. data/lib/factpulse/models/get_chorus_pro_id_request.rb +3 -3
  314. data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
  315. data/lib/factpulse/models/get_invoice_request.rb +3 -3
  316. data/lib/factpulse/models/get_invoice_response.rb +2 -2
  317. data/lib/factpulse/models/get_structure_request.rb +3 -3
  318. data/lib/factpulse/models/get_structure_response.rb +2 -2
  319. data/lib/factpulse/models/global_allowance_amount.rb +2 -2
  320. data/lib/factpulse/models/gross_unit_price.rb +2 -2
  321. data/lib/factpulse/models/http_validation_error.rb +2 -2
  322. data/lib/factpulse/models/incoming_invoice.rb +2 -2
  323. data/lib/factpulse/models/incoming_supplier.rb +2 -2
  324. data/lib/factpulse/models/invoice_format.rb +2 -2
  325. data/lib/factpulse/models/invoice_input.rb +2 -2
  326. data/lib/factpulse/models/invoice_lifecycle.rb +215 -0
  327. data/lib/factpulse/models/invoice_line.rb +2 -2
  328. data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
  329. data/lib/factpulse/models/invoice_note.rb +2 -2
  330. data/lib/factpulse/models/invoice_payment_input.rb +2 -2
  331. data/lib/factpulse/models/invoice_references.rb +2 -2
  332. data/lib/factpulse/models/invoice_status.rb +2 -2
  333. data/lib/factpulse/models/invoice_totals.rb +2 -2
  334. data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
  335. data/lib/factpulse/models/invoice_type_code.rb +2 -2
  336. data/lib/factpulse/models/invoice_type_code_output.rb +2 -2
  337. data/lib/factpulse/models/invoicing_framework.rb +3 -20
  338. data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
  339. data/lib/factpulse/models/issuer_role_code.rb +2 -2
  340. data/lib/factpulse/models/key_rotation_request.rb +2 -2
  341. data/lib/factpulse/models/key_rotation_response.rb +2 -2
  342. data/lib/factpulse/models/lifecycle_event.rb +300 -0
  343. data/lib/factpulse/models/lifecycle_response.rb +205 -0
  344. data/lib/factpulse/models/line_net_amount.rb +2 -2
  345. data/lib/factpulse/models/line_sub_type.rb +2 -2
  346. data/lib/factpulse/models/line_total_amount.rb +2 -2
  347. data/lib/factpulse/models/location_inner.rb +2 -2
  348. data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
  349. data/lib/factpulse/models/manual_rate.rb +2 -2
  350. data/lib/factpulse/models/manual_vat_rate.rb +2 -2
  351. data/lib/factpulse/models/missing_field.rb +2 -2
  352. data/lib/factpulse/models/operation_nature.rb +2 -2
  353. data/lib/factpulse/models/output_format.rb +5 -3
  354. data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
  355. data/lib/factpulse/models/parse_factur_x_response.rb +249 -0
  356. data/lib/factpulse/models/payee.rb +2 -2
  357. data/lib/factpulse/models/payment_amount_by_rate.rb +2 -2
  358. data/lib/factpulse/models/payment_card.rb +2 -2
  359. data/lib/factpulse/models/payment_means.rb +2 -2
  360. data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
  361. data/lib/factpulse/models/pdp_config_response.rb +2 -2
  362. data/lib/factpulse/models/pdp_config_update_request.rb +2 -2
  363. data/lib/factpulse/models/pdp_credentials.rb +2 -2
  364. data/lib/factpulse/models/percentage.rb +2 -2
  365. data/lib/factpulse/models/postal_address.rb +2 -2
  366. data/lib/factpulse/models/price_allowance_amount.rb +2 -2
  367. data/lib/factpulse/models/price_basis_quantity.rb +2 -2
  368. data/lib/factpulse/models/processing_options.rb +2 -2
  369. data/lib/factpulse/models/processing_rule.rb +6 -3
  370. data/lib/factpulse/models/product_characteristic.rb +2 -2
  371. data/lib/factpulse/models/product_classification.rb +2 -2
  372. data/lib/factpulse/models/quantity.rb +2 -2
  373. data/lib/factpulse/models/rate.rb +2 -2
  374. data/lib/factpulse/models/rate1.rb +2 -2
  375. data/lib/factpulse/models/reason_code_info.rb +2 -2
  376. data/lib/factpulse/models/reason_codes_response.rb +2 -2
  377. data/lib/factpulse/models/recipient.rb +2 -2
  378. data/lib/factpulse/models/recipient_input.rb +2 -2
  379. data/lib/factpulse/models/refusee_request.rb +2 -2
  380. data/lib/factpulse/models/report_issuer.rb +2 -2
  381. data/lib/factpulse/models/report_period.rb +2 -2
  382. data/lib/factpulse/models/report_sender.rb +2 -2
  383. data/lib/factpulse/models/rounding_amount.rb +2 -2
  384. data/lib/factpulse/models/schematron_validation_error.rb +2 -2
  385. data/lib/factpulse/models/scheme_id.rb +2 -2
  386. data/lib/factpulse/models/search_flow_request.rb +2 -2
  387. data/lib/factpulse/models/search_flow_response.rb +2 -2
  388. data/lib/factpulse/models/search_services_response.rb +2 -2
  389. data/lib/factpulse/models/search_structure_request.rb +3 -3
  390. data/lib/factpulse/models/search_structure_response.rb +2 -2
  391. data/lib/factpulse/models/secret_status.rb +2 -2
  392. data/lib/factpulse/models/sellercountry.rb +2 -2
  393. data/lib/factpulse/models/signature_info.rb +2 -2
  394. data/lib/factpulse/models/signature_info_api.rb +2 -2
  395. data/lib/factpulse/models/signature_parameters.rb +2 -2
  396. data/lib/factpulse/models/signature_success_result.rb +394 -0
  397. data/lib/factpulse/models/signature_task_status.rb +223 -0
  398. data/lib/factpulse/models/signature_task_status_result.rb +55 -0
  399. data/lib/factpulse/models/simplified_cdar_response.rb +2 -2
  400. data/lib/factpulse/models/simplified_invoice_data.rb +2 -2
  401. data/lib/factpulse/models/status_code_info.rb +2 -2
  402. data/lib/factpulse/models/status_codes_response.rb +2 -2
  403. data/lib/factpulse/models/structure_info.rb +2 -2
  404. data/lib/factpulse/models/structure_parameters.rb +2 -2
  405. data/lib/factpulse/models/structure_service.rb +2 -2
  406. data/lib/factpulse/models/submission_mode.rb +2 -2
  407. data/lib/factpulse/models/submit_aggregated_report_request.rb +2 -2
  408. data/lib/factpulse/models/submit_cdar_request.rb +2 -2
  409. data/lib/factpulse/models/submit_cdar_response.rb +2 -2
  410. data/lib/factpulse/models/submit_cdarxml_request.rb +2 -2
  411. data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
  412. data/lib/factpulse/models/submit_complete_invoice_response.rb +33 -4
  413. data/lib/factpulse/models/submit_e_reporting_request.rb +2 -2
  414. data/lib/factpulse/models/submit_e_reporting_response.rb +2 -2
  415. data/lib/factpulse/models/submit_flow_request.rb +2 -2
  416. data/lib/factpulse/models/submit_flow_response.rb +2 -2
  417. data/lib/factpulse/models/submit_gross_amount.rb +2 -2
  418. data/lib/factpulse/models/submit_invoice_request.rb +3 -3
  419. data/lib/factpulse/models/submit_invoice_response.rb +2 -2
  420. data/lib/factpulse/models/submit_net_amount.rb +2 -2
  421. data/lib/factpulse/models/submit_vat_amount.rb +2 -2
  422. data/lib/factpulse/models/supplementary_attachment.rb +2 -2
  423. data/lib/factpulse/models/supplier.rb +4 -18
  424. data/lib/factpulse/models/task_error_result.rb +257 -0
  425. data/lib/factpulse/models/task_response.rb +2 -2
  426. data/lib/factpulse/models/tax_breakdown_input.rb +2 -2
  427. data/lib/factpulse/models/tax_due_date_type.rb +2 -2
  428. data/lib/factpulse/models/tax_representative.rb +2 -2
  429. data/lib/factpulse/models/taxable_amount.rb +2 -2
  430. data/lib/factpulse/models/taxableamount.rb +2 -2
  431. data/lib/factpulse/models/taxamount.rb +2 -2
  432. data/lib/factpulse/models/taxamount1.rb +2 -2
  433. data/lib/factpulse/models/taxamount2.rb +2 -2
  434. data/lib/factpulse/models/taxexclusiveamount.rb +2 -2
  435. data/lib/factpulse/models/taxexclusiveamount1.rb +2 -2
  436. data/lib/factpulse/models/total_gross_amount.rb +2 -2
  437. data/lib/factpulse/models/total_net_amount.rb +2 -2
  438. data/lib/factpulse/models/total_vat_amount.rb +2 -2
  439. data/lib/factpulse/models/transaction_category.rb +2 -2
  440. data/lib/factpulse/models/transmission_type_code.rb +2 -2
  441. data/lib/factpulse/models/unit_net_price.rb +2 -2
  442. data/lib/factpulse/models/unit_of_measure.rb +17 -3
  443. data/lib/factpulse/models/validate_cdar_request.rb +2 -2
  444. data/lib/factpulse/models/validate_cdar_response.rb +4 -4
  445. data/lib/factpulse/models/validate_e_reporting_request.rb +2 -2
  446. data/lib/factpulse/models/validate_e_reporting_response.rb +2 -2
  447. data/lib/factpulse/models/validation_error.rb +2 -2
  448. data/lib/factpulse/models/validation_error_detail.rb +2 -2
  449. data/lib/factpulse/models/validation_error_response.rb +22 -69
  450. data/lib/factpulse/models/validation_info.rb +2 -2
  451. data/lib/factpulse/models/validation_success_response.rb +2 -2
  452. data/lib/factpulse/models/validation_success_task_result.rb +210 -0
  453. data/lib/factpulse/models/validation_task_status.rb +223 -0
  454. data/lib/factpulse/models/validation_task_status_result.rb +55 -0
  455. data/lib/factpulse/models/vat_accounting_code.rb +2 -2
  456. data/lib/factpulse/models/vat_amount.rb +2 -2
  457. data/lib/factpulse/models/vat_category.rb +2 -2
  458. data/lib/factpulse/models/vat_line.rb +2 -2
  459. data/lib/factpulse/models/vat_point_date_code.rb +2 -2
  460. data/lib/factpulse/models/vat_rate.rb +2 -2
  461. data/lib/factpulse/models/vatex_code_info.rb +247 -0
  462. data/lib/factpulse/models/vatex_codes_response.rb +204 -0
  463. data/lib/factpulse/models/verification_success_response.rb +2 -2
  464. data/lib/factpulse/models/verification_success_task_result.rb +210 -0
  465. data/lib/factpulse/models/verification_typed_task_status.rb +223 -0
  466. data/lib/factpulse/models/verification_typed_task_status_result.rb +55 -0
  467. data/lib/factpulse/models/verified_field_schema.rb +2 -2
  468. data/lib/factpulse/models/webhook_secret_delete_response.rb +2 -2
  469. data/lib/factpulse/models/webhook_secret_generate_response.rb +2 -2
  470. data/lib/factpulse/models/webhook_secret_status_response.rb +2 -2
  471. data/lib/factpulse/version.rb +3 -3
  472. data/lib/factpulse.rb +57 -24
  473. metadata +167 -101
  474. data/docs/AFNORAddressEdit.md +0 -30
  475. data/docs/AFNORAddressPatch.md +0 -30
  476. data/docs/AFNORAddressPut.md +0 -30
  477. data/docs/AFNORCreateDirectoryLineBody.md +0 -20
  478. data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +0 -24
  479. data/docs/AFNORCreateDirectoryLineBodyPeriod.md +0 -20
  480. data/docs/AFNORCreateRoutingCodeBody.md +0 -32
  481. data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +0 -20
  482. data/docs/AFNORDirectoryLinePost201Response.md +0 -22
  483. data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +0 -22
  484. data/docs/AFNORRoutingCodePost201Response.md +0 -22
  485. data/docs/AFNORUpdatePatchDirectoryLineBody.md +0 -18
  486. data/docs/AFNORUpdatePatchRoutingCodeBody.md +0 -24
  487. data/docs/AFNORUpdatePutRoutingCodeBody.md +0 -24
  488. data/docs/AFNORWebhookCallbackContent.md +0 -18
  489. data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +0 -26
  490. data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +0 -18
  491. data/lib/factpulse/models/afnor_address_edit.rb +0 -353
  492. data/lib/factpulse/models/afnor_address_patch.rb +0 -386
  493. data/lib/factpulse/models/afnor_address_put.rb +0 -435
  494. data/lib/factpulse/models/afnor_create_directory_line_body.rb +0 -156
  495. data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +0 -294
  496. data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +0 -175
  497. data/lib/factpulse/models/afnor_create_routing_code_body.rb +0 -412
  498. data/lib/factpulse/models/afnor_diffusion_status.rb +0 -40
  499. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +0 -178
  500. data/lib/factpulse/models/afnor_directory_line_post201_response.rb +0 -187
  501. data/lib/factpulse/models/afnor_facility_nature.rb +0 -40
  502. data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +0 -207
  503. data/lib/factpulse/models/afnor_platform_status.rb +0 -40
  504. data/lib/factpulse/models/afnor_routing_code_post201_response.rb +0 -228
  505. data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +0 -148
  506. data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +0 -258
  507. data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +0 -289
  508. data/lib/factpulse/models/afnor_webhook_callback_content.rb +0 -148
  509. data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +0 -259
  510. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +0 -168
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -17,6 +17,12 @@ module FactPulse
17
17
  # Identified Flow info: flow info + id + timestamp
18
18
  class AFNORFullFlowInfo < ApiModelBase
19
19
  # Unique identifier supporting UUID but not only, for flexibility purpose
20
+ attr_accessor :flow_id
21
+
22
+ # The flow submission date and time (the date and time when the flow was created on the system) This property should be used by the API consumer as a time reference to avoid clock synchronization issues
23
+ attr_accessor :submitted_at
24
+
25
+ # The tracking id is an external identifier and is used to track the flow by the sender
20
26
  attr_accessor :tracking_id
21
27
 
22
28
  # Name of the file
@@ -28,14 +34,9 @@ module FactPulse
28
34
 
29
35
  attr_accessor :flow_profile
30
36
 
37
+ # The sha256 is the fingerprint of the attached file: - if provided in the request: it should be checked once received - if not provided in the request: it may be computed and returned in the response
31
38
  attr_accessor :sha256
32
39
 
33
- # Unique identifier supporting UUID but not only, for flexibility purpose
34
- attr_accessor :flow_id
35
-
36
- # The flow submission date and time (the date and time when the flow was created on the system) This property should be used by the API consumer as a time reference to avoid clock synchronization issues
37
- attr_accessor :submitted_at
38
-
39
40
  class EnumAttributeValidator
40
41
  attr_reader :datatype
41
42
  attr_reader :allowable_values
@@ -61,14 +62,14 @@ module FactPulse
61
62
  # Attribute mapping from ruby-style variable name to JSON key.
62
63
  def self.attribute_map
63
64
  {
65
+ :'flow_id' => :'flowId',
66
+ :'submitted_at' => :'submittedAt',
64
67
  :'tracking_id' => :'trackingId',
65
68
  :'name' => :'name',
66
69
  :'processing_rule' => :'processingRule',
67
70
  :'flow_syntax' => :'flowSyntax',
68
71
  :'flow_profile' => :'flowProfile',
69
- :'sha256' => :'sha256',
70
- :'flow_id' => :'flowId',
71
- :'submitted_at' => :'submittedAt'
72
+ :'sha256' => :'sha256'
72
73
  }
73
74
  end
74
75
 
@@ -85,14 +86,14 @@ module FactPulse
85
86
  # Attribute type mapping.
86
87
  def self.openapi_types
87
88
  {
89
+ :'flow_id' => :'String',
90
+ :'submitted_at' => :'Time',
88
91
  :'tracking_id' => :'String',
89
92
  :'name' => :'String',
90
93
  :'processing_rule' => :'AFNORProcessingRule',
91
94
  :'flow_syntax' => :'AFNORFlowSyntax',
92
95
  :'flow_profile' => :'AFNORFlowProfile',
93
- :'sha256' => :'String',
94
- :'flow_id' => :'String',
95
- :'submitted_at' => :'Time'
96
+ :'sha256' => :'String'
96
97
  }
97
98
  end
98
99
 
@@ -105,7 +106,8 @@ module FactPulse
105
106
  # List of class defined in allOf (OpenAPI v3)
106
107
  def self.openapi_all_of
107
108
  [
108
- :'AFNORFlowInfo'
109
+ :'AFNORFlowInfo',
110
+ :'AFNORFullFlowInfoExtension'
109
111
  ]
110
112
  end
111
113
 
@@ -125,12 +127,26 @@ module FactPulse
125
127
  h[k.to_sym] = v
126
128
  }
127
129
 
130
+ if attributes.key?(:'flow_id')
131
+ self.flow_id = attributes[:'flow_id']
132
+ else
133
+ self.flow_id = nil
134
+ end
135
+
136
+ if attributes.key?(:'submitted_at')
137
+ self.submitted_at = attributes[:'submitted_at']
138
+ else
139
+ self.submitted_at = nil
140
+ end
141
+
128
142
  if attributes.key?(:'tracking_id')
129
143
  self.tracking_id = attributes[:'tracking_id']
130
144
  end
131
145
 
132
146
  if attributes.key?(:'name')
133
147
  self.name = attributes[:'name']
148
+ else
149
+ self.name = nil
134
150
  end
135
151
 
136
152
  if attributes.key?(:'processing_rule')
@@ -150,14 +166,6 @@ module FactPulse
150
166
  if attributes.key?(:'sha256')
151
167
  self.sha256 = attributes[:'sha256']
152
168
  end
153
-
154
- if attributes.key?(:'flow_id')
155
- self.flow_id = attributes[:'flow_id']
156
- end
157
-
158
- if attributes.key?(:'submitted_at')
159
- self.submitted_at = attributes[:'submitted_at']
160
- end
161
169
  end
162
170
 
163
171
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -165,11 +173,27 @@ module FactPulse
165
173
  def list_invalid_properties
166
174
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
167
175
  invalid_properties = Array.new
176
+ if @flow_id.nil?
177
+ invalid_properties.push('invalid value for "flow_id", flow_id cannot be nil.')
178
+ end
179
+
180
+ if @flow_id.to_s.length > 36
181
+ invalid_properties.push('invalid value for "flow_id", the character length must be smaller than or equal to 36.')
182
+ end
183
+
184
+ if @submitted_at.nil?
185
+ invalid_properties.push('invalid value for "submitted_at", submitted_at cannot be nil.')
186
+ end
187
+
168
188
  if !@tracking_id.nil? && @tracking_id.to_s.length > 36
169
189
  invalid_properties.push('invalid value for "tracking_id", the character length must be smaller than or equal to 36.')
170
190
  end
171
191
 
172
- if !@name.nil? && @name.to_s.length > 255
192
+ if @name.nil?
193
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
194
+ end
195
+
196
+ if @name.to_s.length > 255
173
197
  invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
174
198
  end
175
199
 
@@ -182,10 +206,6 @@ module FactPulse
182
206
  invalid_properties.push("invalid value for \"sha256\", must conform to the pattern #{pattern}.")
183
207
  end
184
208
 
185
- if !@flow_id.nil? && @flow_id.to_s.length > 36
186
- invalid_properties.push('invalid value for "flow_id", the character length must be smaller than or equal to 36.')
187
- end
188
-
189
209
  invalid_properties
190
210
  end
191
211
 
@@ -193,14 +213,41 @@ module FactPulse
193
213
  # @return true if the model is valid
194
214
  def valid?
195
215
  warn '[DEPRECATED] the `valid?` method is obsolete'
216
+ return false if @flow_id.nil?
217
+ return false if @flow_id.to_s.length > 36
218
+ return false if @submitted_at.nil?
196
219
  return false if !@tracking_id.nil? && @tracking_id.to_s.length > 36
197
- return false if !@name.nil? && @name.to_s.length > 255
220
+ return false if @name.nil?
221
+ return false if @name.to_s.length > 255
198
222
  return false if @flow_syntax.nil?
199
223
  return false if !@sha256.nil? && @sha256 !~ Regexp.new(/^[a-f0-9]{64}$/)
200
- return false if !@flow_id.nil? && @flow_id.to_s.length > 36
201
224
  true
202
225
  end
203
226
 
227
+ # Custom attribute writer method with validation
228
+ # @param [Object] flow_id Value to be assigned
229
+ def flow_id=(flow_id)
230
+ if flow_id.nil?
231
+ fail ArgumentError, 'flow_id cannot be nil'
232
+ end
233
+
234
+ if flow_id.to_s.length > 36
235
+ fail ArgumentError, 'invalid value for "flow_id", the character length must be smaller than or equal to 36.'
236
+ end
237
+
238
+ @flow_id = flow_id
239
+ end
240
+
241
+ # Custom attribute writer method with validation
242
+ # @param [Object] submitted_at Value to be assigned
243
+ def submitted_at=(submitted_at)
244
+ if submitted_at.nil?
245
+ fail ArgumentError, 'submitted_at cannot be nil'
246
+ end
247
+
248
+ @submitted_at = submitted_at
249
+ end
250
+
204
251
  # Custom attribute writer method with validation
205
252
  # @param [Object] tracking_id Value to be assigned
206
253
  def tracking_id=(tracking_id)
@@ -254,33 +301,19 @@ module FactPulse
254
301
  @sha256 = sha256
255
302
  end
256
303
 
257
- # Custom attribute writer method with validation
258
- # @param [Object] flow_id Value to be assigned
259
- def flow_id=(flow_id)
260
- if flow_id.nil?
261
- fail ArgumentError, 'flow_id cannot be nil'
262
- end
263
-
264
- if flow_id.to_s.length > 36
265
- fail ArgumentError, 'invalid value for "flow_id", the character length must be smaller than or equal to 36.'
266
- end
267
-
268
- @flow_id = flow_id
269
- end
270
-
271
304
  # Checks equality by comparing each attribute.
272
305
  # @param [Object] Object to be compared
273
306
  def ==(o)
274
307
  return true if self.equal?(o)
275
308
  self.class == o.class &&
309
+ flow_id == o.flow_id &&
310
+ submitted_at == o.submitted_at &&
276
311
  tracking_id == o.tracking_id &&
277
312
  name == o.name &&
278
313
  processing_rule == o.processing_rule &&
279
314
  flow_syntax == o.flow_syntax &&
280
315
  flow_profile == o.flow_profile &&
281
- sha256 == o.sha256 &&
282
- flow_id == o.flow_id &&
283
- submitted_at == o.submitted_at
316
+ sha256 == o.sha256
284
317
  end
285
318
 
286
319
  # @see the `==` method
@@ -292,7 +325,7 @@ module FactPulse
292
325
  # Calculates hash code according to all attributes.
293
326
  # @return [Integer] Hash code
294
327
  def hash
295
- [tracking_id, name, processing_rule, flow_syntax, flow_profile, sha256, flow_id, submitted_at].hash
328
+ [flow_id, submitted_at, tracking_id, name, processing_rule, flow_syntax, flow_profile, sha256].hash
296
329
  end
297
330
 
298
331
  # Builds the object from hash
@@ -0,0 +1,202 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: contact@factpulse.fr
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.21.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FactPulse
17
+ # Extension schema to build FFullFlowInfo, Flow schemas
18
+ class AFNORFullFlowInfoExtension < ApiModelBase
19
+ # Unique identifier supporting UUID but not only, for flexibility purpose
20
+ attr_accessor :flow_id
21
+
22
+ # The flow submission date and time (the date and time when the flow was created on the system) This property should be used by the API consumer as a time reference to avoid clock synchronization issues
23
+ attr_accessor :submitted_at
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'flow_id' => :'flowId',
29
+ :'submitted_at' => :'submittedAt'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'flow_id' => :'String',
47
+ :'submitted_at' => :'Time'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::AFNORFullFlowInfoExtension` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ acceptable_attribute_map = self.class.acceptable_attribute_map
66
+ attributes = attributes.each_with_object({}) { |(k, v), h|
67
+ if (!acceptable_attribute_map.key?(k.to_sym))
68
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::AFNORFullFlowInfoExtension`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
69
+ end
70
+ h[k.to_sym] = v
71
+ }
72
+
73
+ if attributes.key?(:'flow_id')
74
+ self.flow_id = attributes[:'flow_id']
75
+ else
76
+ self.flow_id = nil
77
+ end
78
+
79
+ if attributes.key?(:'submitted_at')
80
+ self.submitted_at = attributes[:'submitted_at']
81
+ else
82
+ self.submitted_at = nil
83
+ end
84
+ end
85
+
86
+ # Show invalid properties with the reasons. Usually used together with valid?
87
+ # @return Array for valid properties with the reasons
88
+ def list_invalid_properties
89
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
90
+ invalid_properties = Array.new
91
+ if @flow_id.nil?
92
+ invalid_properties.push('invalid value for "flow_id", flow_id cannot be nil.')
93
+ end
94
+
95
+ if @flow_id.to_s.length > 36
96
+ invalid_properties.push('invalid value for "flow_id", the character length must be smaller than or equal to 36.')
97
+ end
98
+
99
+ if @submitted_at.nil?
100
+ invalid_properties.push('invalid value for "submitted_at", submitted_at cannot be nil.')
101
+ end
102
+
103
+ invalid_properties
104
+ end
105
+
106
+ # Check to see if the all the properties in the model are valid
107
+ # @return true if the model is valid
108
+ def valid?
109
+ warn '[DEPRECATED] the `valid?` method is obsolete'
110
+ return false if @flow_id.nil?
111
+ return false if @flow_id.to_s.length > 36
112
+ return false if @submitted_at.nil?
113
+ true
114
+ end
115
+
116
+ # Custom attribute writer method with validation
117
+ # @param [Object] flow_id Value to be assigned
118
+ def flow_id=(flow_id)
119
+ if flow_id.nil?
120
+ fail ArgumentError, 'flow_id cannot be nil'
121
+ end
122
+
123
+ if flow_id.to_s.length > 36
124
+ fail ArgumentError, 'invalid value for "flow_id", the character length must be smaller than or equal to 36.'
125
+ end
126
+
127
+ @flow_id = flow_id
128
+ end
129
+
130
+ # Custom attribute writer method with validation
131
+ # @param [Object] submitted_at Value to be assigned
132
+ def submitted_at=(submitted_at)
133
+ if submitted_at.nil?
134
+ fail ArgumentError, 'submitted_at cannot be nil'
135
+ end
136
+
137
+ @submitted_at = submitted_at
138
+ end
139
+
140
+ # Checks equality by comparing each attribute.
141
+ # @param [Object] Object to be compared
142
+ def ==(o)
143
+ return true if self.equal?(o)
144
+ self.class == o.class &&
145
+ flow_id == o.flow_id &&
146
+ submitted_at == o.submitted_at
147
+ end
148
+
149
+ # @see the `==` method
150
+ # @param [Object] Object to be compared
151
+ def eql?(o)
152
+ self == o
153
+ end
154
+
155
+ # Calculates hash code according to all attributes.
156
+ # @return [Integer] Hash code
157
+ def hash
158
+ [flow_id, submitted_at].hash
159
+ end
160
+
161
+ # Builds the object from hash
162
+ # @param [Hash] attributes Model attributes in the form of hash
163
+ # @return [Object] Returns the model itself
164
+ def self.build_from_hash(attributes)
165
+ return nil unless attributes.is_a?(Hash)
166
+ attributes = attributes.transform_keys(&:to_sym)
167
+ transformed_hash = {}
168
+ openapi_types.each_pair do |key, type|
169
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
170
+ transformed_hash["#{key}"] = nil
171
+ elsif type =~ /\AArray<(.*)>/i
172
+ # check to ensure the input is an array given that the attribute
173
+ # is documented as an array but the input is not
174
+ if attributes[attribute_map[key]].is_a?(Array)
175
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
176
+ end
177
+ elsif !attributes[attribute_map[key]].nil?
178
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
179
+ end
180
+ end
181
+ new(transformed_hash)
182
+ end
183
+
184
+ # Returns the object in the form of hash
185
+ # @return [Hash] Returns the object in the form of hash
186
+ def to_hash
187
+ hash = {}
188
+ self.class.attribute_map.each_pair do |attr, param|
189
+ value = self.send(attr)
190
+ if value.nil?
191
+ is_nullable = self.class.openapi_nullable.include?(attr)
192
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
193
+ end
194
+
195
+ hash[param] = _to_hash(value)
196
+ end
197
+ hash
198
+ end
199
+
200
+ end
201
+
202
+ end
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12