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
@@ -0,0 +1,232 @@
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
+ # Response from key rotation operation.
18
+ class KeyRotationResponse < ApiModelBase
19
+ # Whether rotation was successful
20
+ attr_accessor :success
21
+
22
+ # Result message
23
+ attr_accessor :message
24
+
25
+ # Number of secrets that were rotated
26
+ attr_accessor :rotated_count
27
+
28
+ attr_accessor :partial_errors
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'success' => :'success',
34
+ :'message' => :'message',
35
+ :'rotated_count' => :'rotatedCount',
36
+ :'partial_errors' => :'partialErrors'
37
+ }
38
+ end
39
+
40
+ # Returns attribute mapping this model knows about
41
+ def self.acceptable_attribute_map
42
+ attribute_map
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ acceptable_attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'success' => :'Boolean',
54
+ :'message' => :'String',
55
+ :'rotated_count' => :'Integer',
56
+ :'partial_errors' => :'Array<String>'
57
+ }
58
+ end
59
+
60
+ # List of attributes with nullable: true
61
+ def self.openapi_nullable
62
+ Set.new([
63
+ :'partial_errors'
64
+ ])
65
+ end
66
+
67
+ # Initializes the object
68
+ # @param [Hash] attributes Model attributes in the form of hash
69
+ def initialize(attributes = {})
70
+ if (!attributes.is_a?(Hash))
71
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::KeyRotationResponse` initialize method"
72
+ end
73
+
74
+ # check to see if the attribute exists and convert string to symbol for hash key
75
+ acceptable_attribute_map = self.class.acceptable_attribute_map
76
+ attributes = attributes.each_with_object({}) { |(k, v), h|
77
+ if (!acceptable_attribute_map.key?(k.to_sym))
78
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::KeyRotationResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
79
+ end
80
+ h[k.to_sym] = v
81
+ }
82
+
83
+ if attributes.key?(:'success')
84
+ self.success = attributes[:'success']
85
+ else
86
+ self.success = nil
87
+ end
88
+
89
+ if attributes.key?(:'message')
90
+ self.message = attributes[:'message']
91
+ else
92
+ self.message = nil
93
+ end
94
+
95
+ if attributes.key?(:'rotated_count')
96
+ self.rotated_count = attributes[:'rotated_count']
97
+ else
98
+ self.rotated_count = nil
99
+ end
100
+
101
+ if attributes.key?(:'partial_errors')
102
+ if (value = attributes[:'partial_errors']).is_a?(Array)
103
+ self.partial_errors = value
104
+ end
105
+ end
106
+ end
107
+
108
+ # Show invalid properties with the reasons. Usually used together with valid?
109
+ # @return Array for valid properties with the reasons
110
+ def list_invalid_properties
111
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
112
+ invalid_properties = Array.new
113
+ if @success.nil?
114
+ invalid_properties.push('invalid value for "success", success cannot be nil.')
115
+ end
116
+
117
+ if @message.nil?
118
+ invalid_properties.push('invalid value for "message", message cannot be nil.')
119
+ end
120
+
121
+ if @rotated_count.nil?
122
+ invalid_properties.push('invalid value for "rotated_count", rotated_count cannot be nil.')
123
+ end
124
+
125
+ invalid_properties
126
+ end
127
+
128
+ # Check to see if the all the properties in the model are valid
129
+ # @return true if the model is valid
130
+ def valid?
131
+ warn '[DEPRECATED] the `valid?` method is obsolete'
132
+ return false if @success.nil?
133
+ return false if @message.nil?
134
+ return false if @rotated_count.nil?
135
+ true
136
+ end
137
+
138
+ # Custom attribute writer method with validation
139
+ # @param [Object] success Value to be assigned
140
+ def success=(success)
141
+ if success.nil?
142
+ fail ArgumentError, 'success cannot be nil'
143
+ end
144
+
145
+ @success = success
146
+ end
147
+
148
+ # Custom attribute writer method with validation
149
+ # @param [Object] message Value to be assigned
150
+ def message=(message)
151
+ if message.nil?
152
+ fail ArgumentError, 'message cannot be nil'
153
+ end
154
+
155
+ @message = message
156
+ end
157
+
158
+ # Custom attribute writer method with validation
159
+ # @param [Object] rotated_count Value to be assigned
160
+ def rotated_count=(rotated_count)
161
+ if rotated_count.nil?
162
+ fail ArgumentError, 'rotated_count cannot be nil'
163
+ end
164
+
165
+ @rotated_count = rotated_count
166
+ end
167
+
168
+ # Checks equality by comparing each attribute.
169
+ # @param [Object] Object to be compared
170
+ def ==(o)
171
+ return true if self.equal?(o)
172
+ self.class == o.class &&
173
+ success == o.success &&
174
+ message == o.message &&
175
+ rotated_count == o.rotated_count &&
176
+ partial_errors == o.partial_errors
177
+ end
178
+
179
+ # @see the `==` method
180
+ # @param [Object] Object to be compared
181
+ def eql?(o)
182
+ self == o
183
+ end
184
+
185
+ # Calculates hash code according to all attributes.
186
+ # @return [Integer] Hash code
187
+ def hash
188
+ [success, message, rotated_count, partial_errors].hash
189
+ end
190
+
191
+ # Builds the object from hash
192
+ # @param [Hash] attributes Model attributes in the form of hash
193
+ # @return [Object] Returns the model itself
194
+ def self.build_from_hash(attributes)
195
+ return nil unless attributes.is_a?(Hash)
196
+ attributes = attributes.transform_keys(&:to_sym)
197
+ transformed_hash = {}
198
+ openapi_types.each_pair do |key, type|
199
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
200
+ transformed_hash["#{key}"] = nil
201
+ elsif type =~ /\AArray<(.*)>/i
202
+ # check to ensure the input is an array given that the attribute
203
+ # is documented as an array but the input is not
204
+ if attributes[attribute_map[key]].is_a?(Array)
205
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
206
+ end
207
+ elsif !attributes[attribute_map[key]].nil?
208
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
209
+ end
210
+ end
211
+ new(transformed_hash)
212
+ end
213
+
214
+ # Returns the object in the form of hash
215
+ # @return [Hash] Returns the object in the form of hash
216
+ def to_hash
217
+ hash = {}
218
+ self.class.attribute_map.each_pair do |attr, param|
219
+ value = self.send(attr)
220
+ if value.nil?
221
+ is_nullable = self.class.openapi_nullable.include?(attr)
222
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
223
+ end
224
+
225
+ hash[param] = _to_hash(value)
226
+ end
227
+ hash
228
+ end
229
+
230
+ end
231
+
232
+ end
@@ -0,0 +1,300 @@
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
+ # Evenement de cycle de vie d'une facture.
18
+ class LifecycleEvent < ApiModelBase
19
+ # ID du flux lifecycle
20
+ attr_accessor :flow_id
21
+
22
+ # Code statut (200-601)
23
+ attr_accessor :status_code
24
+
25
+ attr_accessor :status_description
26
+
27
+ attr_accessor :ack_status
28
+
29
+ attr_accessor :at
30
+
31
+ attr_accessor :document_id
32
+
33
+ attr_accessor :amount
34
+
35
+ attr_accessor :currency
36
+
37
+ attr_accessor :issuer_siren
38
+
39
+ attr_accessor :issuer_role
40
+
41
+ attr_accessor :reason_code
42
+
43
+ # Attribute mapping from ruby-style variable name to JSON key.
44
+ def self.attribute_map
45
+ {
46
+ :'flow_id' => :'flowId',
47
+ :'status_code' => :'statusCode',
48
+ :'status_description' => :'statusDescription',
49
+ :'ack_status' => :'ackStatus',
50
+ :'at' => :'at',
51
+ :'document_id' => :'documentId',
52
+ :'amount' => :'amount',
53
+ :'currency' => :'currency',
54
+ :'issuer_siren' => :'issuerSiren',
55
+ :'issuer_role' => :'issuerRole',
56
+ :'reason_code' => :'reasonCode'
57
+ }
58
+ end
59
+
60
+ # Returns attribute mapping this model knows about
61
+ def self.acceptable_attribute_map
62
+ attribute_map
63
+ end
64
+
65
+ # Returns all the JSON keys this model knows about
66
+ def self.acceptable_attributes
67
+ acceptable_attribute_map.values
68
+ end
69
+
70
+ # Attribute type mapping.
71
+ def self.openapi_types
72
+ {
73
+ :'flow_id' => :'String',
74
+ :'status_code' => :'String',
75
+ :'status_description' => :'String',
76
+ :'ack_status' => :'String',
77
+ :'at' => :'String',
78
+ :'document_id' => :'String',
79
+ :'amount' => :'String',
80
+ :'currency' => :'String',
81
+ :'issuer_siren' => :'String',
82
+ :'issuer_role' => :'String',
83
+ :'reason_code' => :'String'
84
+ }
85
+ end
86
+
87
+ # List of attributes with nullable: true
88
+ def self.openapi_nullable
89
+ Set.new([
90
+ :'status_description',
91
+ :'ack_status',
92
+ :'at',
93
+ :'document_id',
94
+ :'amount',
95
+ :'currency',
96
+ :'issuer_siren',
97
+ :'issuer_role',
98
+ :'reason_code'
99
+ ])
100
+ end
101
+
102
+ # Initializes the object
103
+ # @param [Hash] attributes Model attributes in the form of hash
104
+ def initialize(attributes = {})
105
+ if (!attributes.is_a?(Hash))
106
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::LifecycleEvent` initialize method"
107
+ end
108
+
109
+ # check to see if the attribute exists and convert string to symbol for hash key
110
+ acceptable_attribute_map = self.class.acceptable_attribute_map
111
+ attributes = attributes.each_with_object({}) { |(k, v), h|
112
+ if (!acceptable_attribute_map.key?(k.to_sym))
113
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::LifecycleEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
114
+ end
115
+ h[k.to_sym] = v
116
+ }
117
+
118
+ if attributes.key?(:'flow_id')
119
+ self.flow_id = attributes[:'flow_id']
120
+ else
121
+ self.flow_id = nil
122
+ end
123
+
124
+ if attributes.key?(:'status_code')
125
+ self.status_code = attributes[:'status_code']
126
+ else
127
+ self.status_code = nil
128
+ end
129
+
130
+ if attributes.key?(:'status_description')
131
+ self.status_description = attributes[:'status_description']
132
+ end
133
+
134
+ if attributes.key?(:'ack_status')
135
+ self.ack_status = attributes[:'ack_status']
136
+ end
137
+
138
+ if attributes.key?(:'at')
139
+ self.at = attributes[:'at']
140
+ end
141
+
142
+ if attributes.key?(:'document_id')
143
+ self.document_id = attributes[:'document_id']
144
+ end
145
+
146
+ if attributes.key?(:'amount')
147
+ self.amount = attributes[:'amount']
148
+ end
149
+
150
+ if attributes.key?(:'currency')
151
+ self.currency = attributes[:'currency']
152
+ end
153
+
154
+ if attributes.key?(:'issuer_siren')
155
+ self.issuer_siren = attributes[:'issuer_siren']
156
+ end
157
+
158
+ if attributes.key?(:'issuer_role')
159
+ self.issuer_role = attributes[:'issuer_role']
160
+ end
161
+
162
+ if attributes.key?(:'reason_code')
163
+ self.reason_code = attributes[:'reason_code']
164
+ end
165
+ end
166
+
167
+ # Show invalid properties with the reasons. Usually used together with valid?
168
+ # @return Array for valid properties with the reasons
169
+ def list_invalid_properties
170
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
171
+ invalid_properties = Array.new
172
+ if @flow_id.nil?
173
+ invalid_properties.push('invalid value for "flow_id", flow_id cannot be nil.')
174
+ end
175
+
176
+ if @status_code.nil?
177
+ invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
178
+ end
179
+
180
+ pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
181
+ if !@amount.nil? && @amount !~ pattern
182
+ invalid_properties.push("invalid value for \"amount\", must conform to the pattern #{pattern}.")
183
+ end
184
+
185
+ invalid_properties
186
+ end
187
+
188
+ # Check to see if the all the properties in the model are valid
189
+ # @return true if the model is valid
190
+ def valid?
191
+ warn '[DEPRECATED] the `valid?` method is obsolete'
192
+ return false if @flow_id.nil?
193
+ return false if @status_code.nil?
194
+ return false if !@amount.nil? && @amount !~ Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
195
+ true
196
+ end
197
+
198
+ # Custom attribute writer method with validation
199
+ # @param [Object] flow_id Value to be assigned
200
+ def flow_id=(flow_id)
201
+ if flow_id.nil?
202
+ fail ArgumentError, 'flow_id cannot be nil'
203
+ end
204
+
205
+ @flow_id = flow_id
206
+ end
207
+
208
+ # Custom attribute writer method with validation
209
+ # @param [Object] status_code Value to be assigned
210
+ def status_code=(status_code)
211
+ if status_code.nil?
212
+ fail ArgumentError, 'status_code cannot be nil'
213
+ end
214
+
215
+ @status_code = status_code
216
+ end
217
+
218
+ # Custom attribute writer method with validation
219
+ # @param [Object] amount Value to be assigned
220
+ def amount=(amount)
221
+ pattern = Regexp.new(/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/)
222
+ if !amount.nil? && amount !~ pattern
223
+ fail ArgumentError, "invalid value for \"amount\", must conform to the pattern #{pattern}."
224
+ end
225
+
226
+ @amount = amount
227
+ end
228
+
229
+ # Checks equality by comparing each attribute.
230
+ # @param [Object] Object to be compared
231
+ def ==(o)
232
+ return true if self.equal?(o)
233
+ self.class == o.class &&
234
+ flow_id == o.flow_id &&
235
+ status_code == o.status_code &&
236
+ status_description == o.status_description &&
237
+ ack_status == o.ack_status &&
238
+ at == o.at &&
239
+ document_id == o.document_id &&
240
+ amount == o.amount &&
241
+ currency == o.currency &&
242
+ issuer_siren == o.issuer_siren &&
243
+ issuer_role == o.issuer_role &&
244
+ reason_code == o.reason_code
245
+ end
246
+
247
+ # @see the `==` method
248
+ # @param [Object] Object to be compared
249
+ def eql?(o)
250
+ self == o
251
+ end
252
+
253
+ # Calculates hash code according to all attributes.
254
+ # @return [Integer] Hash code
255
+ def hash
256
+ [flow_id, status_code, status_description, ack_status, at, document_id, amount, currency, issuer_siren, issuer_role, reason_code].hash
257
+ end
258
+
259
+ # Builds the object from hash
260
+ # @param [Hash] attributes Model attributes in the form of hash
261
+ # @return [Object] Returns the model itself
262
+ def self.build_from_hash(attributes)
263
+ return nil unless attributes.is_a?(Hash)
264
+ attributes = attributes.transform_keys(&:to_sym)
265
+ transformed_hash = {}
266
+ openapi_types.each_pair do |key, type|
267
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
268
+ transformed_hash["#{key}"] = nil
269
+ elsif type =~ /\AArray<(.*)>/i
270
+ # check to ensure the input is an array given that the attribute
271
+ # is documented as an array but the input is not
272
+ if attributes[attribute_map[key]].is_a?(Array)
273
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
274
+ end
275
+ elsif !attributes[attribute_map[key]].nil?
276
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
277
+ end
278
+ end
279
+ new(transformed_hash)
280
+ end
281
+
282
+ # Returns the object in the form of hash
283
+ # @return [Hash] Returns the object in the form of hash
284
+ def to_hash
285
+ hash = {}
286
+ self.class.attribute_map.each_pair do |attr, param|
287
+ value = self.send(attr)
288
+ if value.nil?
289
+ is_nullable = self.class.openapi_nullable.include?(attr)
290
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
291
+ end
292
+
293
+ hash[param] = _to_hash(value)
294
+ end
295
+ hash
296
+ end
297
+
298
+ end
299
+
300
+ end