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,30 @@
1
+ # FactPulse::ConversionPendingInputResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional][default to 'PENDING_INPUT'] |
8
+ | **conversion_id** | **String** | | |
9
+ | **message** | **String** | | |
10
+ | **missing_fields** | **Array<String>** | | |
11
+ | **extracted_data** | **Hash<String, Object>** | | |
12
+ | **confidence_score** | **Float** | | |
13
+ | **processing_time_ms** | **Integer** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'factpulse'
19
+
20
+ instance = FactPulse::ConversionPendingInputResult.new(
21
+ status: null,
22
+ conversion_id: null,
23
+ message: null,
24
+ missing_fields: null,
25
+ extracted_data: null,
26
+ confidence_score: null,
27
+ processing_time_ms: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,36 @@
1
+ # FactPulse::ConversionSuccessTaskResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional][default to 'SUCCESS'] |
8
+ | **conversion_id** | **String** | | |
9
+ | **document_type_code** | **Integer** | | |
10
+ | **profile** | **String** | | |
11
+ | **extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) | | |
12
+ | **processing_time_ms** | **Integer** | | |
13
+ | **pdf_regenerated** | **Boolean** | | [optional][default to false] |
14
+ | **pdf_regenerated_reason** | **String** | | [optional] |
15
+ | **content_b64** | **String** | | [optional] |
16
+ | **xml_content** | **String** | | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'factpulse'
22
+
23
+ instance = FactPulse::ConversionSuccessTaskResult.new(
24
+ status: null,
25
+ conversion_id: null,
26
+ document_type_code: null,
27
+ profile: null,
28
+ extraction: null,
29
+ processing_time_ms: null,
30
+ pdf_regenerated: null,
31
+ pdf_regenerated_reason: null,
32
+ content_b64: null,
33
+ xml_content: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,22 @@
1
+ # FactPulse::ConversionTaskStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **task_id** | **String** | | |
8
+ | **status** | [**CeleryStatus**](CeleryStatus.md) | | |
9
+ | **result** | [**ConversionTaskStatusResult**](ConversionTaskStatusResult.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'factpulse'
15
+
16
+ instance = FactPulse::ConversionTaskStatus.new(
17
+ task_id: null,
18
+ status: null,
19
+ result: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,85 @@
1
+ # FactPulse::ConversionTaskStatusResult
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'factpulse'
13
+
14
+ FactPulse::ConversionTaskStatusResult.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'ConversionErrorResult',
18
+ # :'ConversionPendingInputResult',
19
+ # :'ConversionSuccessTaskResult',
20
+ # :'ConversionValidationFailedResult'
21
+ # ]
22
+ ```
23
+
24
+ ### `openapi_discriminator_name`
25
+
26
+ Returns the discriminator's property name.
27
+
28
+ #### Example
29
+
30
+ ```ruby
31
+ require 'factpulse'
32
+
33
+ FactPulse::ConversionTaskStatusResult.openapi_discriminator_name
34
+ # => :'status'
35
+ ```
36
+
37
+ ### `openapi_discriminator_name`
38
+
39
+ Returns the discriminator's mapping.
40
+
41
+ #### Example
42
+
43
+ ```ruby
44
+ require 'factpulse'
45
+
46
+ FactPulse::ConversionTaskStatusResult.openapi_discriminator_mapping
47
+ # =>
48
+ # {
49
+ # :'ERROR' => :'ConversionErrorResult',
50
+ # :'PENDING_INPUT' => :'ConversionPendingInputResult',
51
+ # :'SUCCESS' => :'ConversionSuccessTaskResult',
52
+ # :'VALIDATION_FAILED' => :'ConversionValidationFailedResult'
53
+ # }
54
+ ```
55
+
56
+ ### build
57
+
58
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
59
+
60
+ #### Example
61
+
62
+ ```ruby
63
+ require 'factpulse'
64
+
65
+ FactPulse::ConversionTaskStatusResult.build(data)
66
+ # => #<ConversionErrorResult:0x00007fdd4aab02a0>
67
+
68
+ FactPulse::ConversionTaskStatusResult.build(data_that_doesnt_match)
69
+ # => nil
70
+ ```
71
+
72
+ #### Parameters
73
+
74
+ | Name | Type | Description |
75
+ | ---- | ---- | ----------- |
76
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
77
+
78
+ #### Return type
79
+
80
+ - `ConversionErrorResult`
81
+ - `ConversionPendingInputResult`
82
+ - `ConversionSuccessTaskResult`
83
+ - `ConversionValidationFailedResult`
84
+ - `nil` (if no type matches)
85
+
@@ -0,0 +1,34 @@
1
+ # FactPulse::ConversionValidationFailedResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional][default to &#39;VALIDATION_FAILED&#39;] |
8
+ | **conversion_id** | **String** | | |
9
+ | **message** | **String** | | |
10
+ | **extracted_data** | **Hash&lt;String, Object&gt;** | | |
11
+ | **extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) | | [optional] |
12
+ | **validation_errors** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
13
+ | **profile** | **String** | | |
14
+ | **processing_time_ms** | **Integer** | | |
15
+ | **correction_attempted** | **Boolean** | | [optional][default to false] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'factpulse'
21
+
22
+ instance = FactPulse::ConversionValidationFailedResult.new(
23
+ status: null,
24
+ conversion_id: null,
25
+ message: null,
26
+ extracted_data: null,
27
+ extraction: null,
28
+ validation_errors: null,
29
+ profile: null,
30
+ processing_time_ms: null,
31
+ correction_attempted: null
32
+ )
33
+ ```
34
+
@@ -5,6 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **overrides** | **Hash&lt;String, Object&gt;** | Sous-ensemble de FacturXInvoice a mettre a jour (merge profond) | [optional] |
8
+ | **callback_url** | **String** | | [optional] |
9
+ | **webhook_mode** | **String** | Mode de livraison webhook: &#39;inline&#39; ou &#39;download_url&#39; | [optional][default to &#39;inline&#39;] |
8
10
 
9
11
  ## Example
10
12
 
@@ -12,7 +14,9 @@
12
14
  require 'factpulse'
13
15
 
14
16
  instance = FactPulse::ConvertResumeRequest.new(
15
- overrides: null
17
+ overrides: null,
18
+ callback_url: null,
19
+ webhook_mode: null
16
20
  )
17
21
  ```
18
22
 
data/docs/DownloadsApi.md CHANGED
@@ -23,12 +23,17 @@ require 'time'
23
23
  require 'factpulse'
24
24
  # setup authorization
25
25
  FactPulse.configure do |config|
26
+ # Configure API key authorization: APIKeyHeader
27
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
30
+
26
31
  # Configure Bearer authorization: HTTPBearer
27
32
  config.access_token = 'YOUR_BEARER_TOKEN'
28
33
  end
29
34
 
30
35
  api_instance = FactPulse::DownloadsApi.new
31
- download_id = 'download_id_example' # String |
36
+ download_id = 'download_id_example' # String | Unique identifier of the temporary file to check
32
37
 
33
38
  begin
34
39
  # Check if a file exists
@@ -61,7 +66,7 @@ end
61
66
 
62
67
  | Name | Type | Description | Notes |
63
68
  | ---- | ---- | ----------- | ----- |
64
- | **download_id** | **String** | | |
69
+ | **download_id** | **String** | Unique identifier of the temporary file to check | |
65
70
 
66
71
  ### Return type
67
72
 
@@ -69,7 +74,7 @@ end
69
74
 
70
75
  ### Authorization
71
76
 
72
- [HTTPBearer](../README.md#HTTPBearer)
77
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
73
78
 
74
79
  ### HTTP request headers
75
80
 
@@ -92,12 +97,17 @@ require 'time'
92
97
  require 'factpulse'
93
98
  # setup authorization
94
99
  FactPulse.configure do |config|
100
+ # Configure API key authorization: APIKeyHeader
101
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
104
+
95
105
  # Configure Bearer authorization: HTTPBearer
96
106
  config.access_token = 'YOUR_BEARER_TOKEN'
97
107
  end
98
108
 
99
109
  api_instance = FactPulse::DownloadsApi.new
100
- download_id = 'download_id_example' # String |
110
+ download_id = 'download_id_example' # String | Unique identifier of the temporary file to download
101
111
  opts = {
102
112
  delete_after: true # Boolean | If true, delete the file after download (one-time download)
103
113
  }
@@ -133,7 +143,7 @@ end
133
143
 
134
144
  | Name | Type | Description | Notes |
135
145
  | ---- | ---- | ----------- | ----- |
136
- | **download_id** | **String** | | |
146
+ | **download_id** | **String** | Unique identifier of the temporary file to download | |
137
147
  | **delete_after** | **Boolean** | If true, delete the file after download (one-time download) | [optional][default to false] |
138
148
 
139
149
  ### Return type
@@ -142,7 +152,7 @@ end
142
152
 
143
153
  ### Authorization
144
154
 
145
- [HTTPBearer](../README.md#HTTPBearer)
155
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
146
156
 
147
157
  ### HTTP request headers
148
158
 
@@ -25,6 +25,11 @@ require 'time'
25
25
  require 'factpulse'
26
26
  # setup authorization
27
27
  FactPulse.configure do |config|
28
+ # Configure API key authorization: APIKeyHeader
29
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
32
+
28
33
  # Configure Bearer authorization: HTTPBearer
29
34
  config.access_token = 'YOUR_BEARER_TOKEN'
30
35
  end
@@ -71,7 +76,7 @@ end
71
76
 
72
77
  ### Authorization
73
78
 
74
- [HTTPBearer](../README.md#HTTPBearer)
79
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
75
80
 
76
81
  ### HTTP request headers
77
82
 
@@ -94,6 +99,11 @@ require 'time'
94
99
  require 'factpulse'
95
100
  # setup authorization
96
101
  FactPulse.configure do |config|
102
+ # Configure API key authorization: APIKeyHeader
103
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
106
+
97
107
  # Configure Bearer authorization: HTTPBearer
98
108
  config.access_token = 'YOUR_BEARER_TOKEN'
99
109
  end
@@ -154,7 +164,7 @@ end
154
164
 
155
165
  ### Authorization
156
166
 
157
- [HTTPBearer](../README.md#HTTPBearer)
167
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
158
168
 
159
169
  ### HTTP request headers
160
170
 
@@ -177,6 +187,11 @@ require 'time'
177
187
  require 'factpulse'
178
188
  # setup authorization
179
189
  FactPulse.configure do |config|
190
+ # Configure API key authorization: APIKeyHeader
191
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
192
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
193
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
194
+
180
195
  # Configure Bearer authorization: HTTPBearer
181
196
  config.access_token = 'YOUR_BEARER_TOKEN'
182
197
  end
@@ -241,7 +256,7 @@ end
241
256
 
242
257
  ### Authorization
243
258
 
244
- [HTTPBearer](../README.md#HTTPBearer)
259
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
245
260
 
246
261
  ### HTTP request headers
247
262
 
@@ -264,6 +279,11 @@ require 'time'
264
279
  require 'factpulse'
265
280
  # setup authorization
266
281
  FactPulse.configure do |config|
282
+ # Configure API key authorization: APIKeyHeader
283
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
284
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
285
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
286
+
267
287
  # Configure Bearer authorization: HTTPBearer
268
288
  config.access_token = 'YOUR_BEARER_TOKEN'
269
289
  end
@@ -310,7 +330,7 @@ end
310
330
 
311
331
  ### Authorization
312
332
 
313
- [HTTPBearer](../README.md#HTTPBearer)
333
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
314
334
 
315
335
  ### HTTP request headers
316
336
 
@@ -7,7 +7,9 @@ All URIs are relative to *https://factpulse.fr*
7
7
  | [**convert_document_async_api_v1_convert_async_post**](FacturXConversionApi.md#convert_document_async_api_v1_convert_async_post) | **POST** /api/v1/convert/async | Convert a document to Factur-X (async mode) |
8
8
  | [**download_file_api_v1_convert_conversion_id_download_filename_get**](FacturXConversionApi.md#download_file_api_v1_convert_conversion_id_download_filename_get) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Download a generated file |
9
9
  | [**get_conversion_status_api_v1_convert_conversion_id_status_get**](FacturXConversionApi.md#get_conversion_status_api_v1_convert_conversion_id_status_get) | **GET** /api/v1/convert/{conversion_id}/status | Check conversion status |
10
+ | [**get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get**](FacturXConversionApi.md#get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get) | **GET** /api/v1/convert/tasks/{task_id}/conversion-status | Get typed conversion task status |
10
11
  | [**resume_conversion_api_v1_convert_conversion_id_resume_post**](FacturXConversionApi.md#resume_conversion_api_v1_convert_conversion_id_resume_post) | **POST** /api/v1/convert/{conversion_id}/resume | Resume a conversion with corrections |
12
+ | [**resume_conversion_async_api_v1_convert_conversion_id_resume_async_post**](FacturXConversionApi.md#resume_conversion_async_api_v1_convert_conversion_id_resume_async_post) | **POST** /api/v1/convert/{conversion_id}/resume/async | Resume a conversion asynchronously |
11
13
 
12
14
 
13
15
  ## convert_document_async_api_v1_convert_async_post
@@ -25,6 +27,11 @@ require 'time'
25
27
  require 'factpulse'
26
28
  # setup authorization
27
29
  FactPulse.configure do |config|
30
+ # Configure API key authorization: APIKeyHeader
31
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
34
+
28
35
  # Configure Bearer authorization: HTTPBearer
29
36
  config.access_token = 'YOUR_BEARER_TOKEN'
30
37
  end
@@ -79,7 +86,7 @@ end
79
86
 
80
87
  ### Authorization
81
88
 
82
- [HTTPBearer](../README.md#HTTPBearer)
89
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
83
90
 
84
91
  ### HTTP request headers
85
92
 
@@ -102,6 +109,11 @@ require 'time'
102
109
  require 'factpulse'
103
110
  # setup authorization
104
111
  FactPulse.configure do |config|
112
+ # Configure API key authorization: APIKeyHeader
113
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
114
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
115
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
116
+
105
117
  # Configure Bearer authorization: HTTPBearer
106
118
  config.access_token = 'YOUR_BEARER_TOKEN'
107
119
  end
@@ -150,7 +162,7 @@ end
150
162
 
151
163
  ### Authorization
152
164
 
153
- [HTTPBearer](../README.md#HTTPBearer)
165
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
154
166
 
155
167
  ### HTTP request headers
156
168
 
@@ -173,6 +185,11 @@ require 'time'
173
185
  require 'factpulse'
174
186
  # setup authorization
175
187
  FactPulse.configure do |config|
188
+ # Configure API key authorization: APIKeyHeader
189
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
190
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
191
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
192
+
176
193
  # Configure Bearer authorization: HTTPBearer
177
194
  config.access_token = 'YOUR_BEARER_TOKEN'
178
195
  end
@@ -219,7 +236,81 @@ end
219
236
 
220
237
  ### Authorization
221
238
 
222
- [HTTPBearer](../README.md#HTTPBearer)
239
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: Not defined
244
+ - **Accept**: application/json
245
+
246
+
247
+ ## get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get
248
+
249
+ > <ConversionTaskStatus> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
250
+
251
+ Get typed conversion task status
252
+
253
+ Typed status endpoint for document conversion tasks. Returns a strongly-typed `result` discriminated on `result.status`: - **SUCCESS**: `ConversionSuccessTaskResult` - **PENDING_INPUT**: `ConversionPendingInputResult` (missing fields) - **VALIDATION_FAILED**: `ConversionValidationFailedResult` - **ERROR**: `ConversionErrorResult`
254
+
255
+ ### Examples
256
+
257
+ ```ruby
258
+ require 'time'
259
+ require 'factpulse'
260
+ # setup authorization
261
+ FactPulse.configure do |config|
262
+ # Configure API key authorization: APIKeyHeader
263
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
264
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
265
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
266
+
267
+ # Configure Bearer authorization: HTTPBearer
268
+ config.access_token = 'YOUR_BEARER_TOKEN'
269
+ end
270
+
271
+ api_instance = FactPulse::FacturXConversionApi.new
272
+ task_id = 'task_id_example' # String | Celery task ID returned by POST /convert
273
+
274
+ begin
275
+ # Get typed conversion task status
276
+ result = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
277
+ p result
278
+ rescue FactPulse::ApiError => e
279
+ puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get: #{e}"
280
+ end
281
+ ```
282
+
283
+ #### Using the get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info variant
284
+
285
+ This returns an Array which contains the response data, status code and headers.
286
+
287
+ > <Array(<ConversionTaskStatus>, Integer, Hash)> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
288
+
289
+ ```ruby
290
+ begin
291
+ # Get typed conversion task status
292
+ data, status_code, headers = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
293
+ p status_code # => 2xx
294
+ p headers # => { ... }
295
+ p data # => <ConversionTaskStatus>
296
+ rescue FactPulse::ApiError => e
297
+ puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info: #{e}"
298
+ end
299
+ ```
300
+
301
+ ### Parameters
302
+
303
+ | Name | Type | Description | Notes |
304
+ | ---- | ---- | ----------- | ----- |
305
+ | **task_id** | **String** | Celery task ID returned by POST /convert | |
306
+
307
+ ### Return type
308
+
309
+ [**ConversionTaskStatus**](ConversionTaskStatus.md)
310
+
311
+ ### Authorization
312
+
313
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
223
314
 
224
315
  ### HTTP request headers
225
316
 
@@ -242,6 +333,11 @@ require 'time'
242
333
  require 'factpulse'
243
334
  # setup authorization
244
335
  FactPulse.configure do |config|
336
+ # Configure API key authorization: APIKeyHeader
337
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
340
+
245
341
  # Configure Bearer authorization: HTTPBearer
246
342
  config.access_token = 'YOUR_BEARER_TOKEN'
247
343
  end
@@ -290,7 +386,83 @@ end
290
386
 
291
387
  ### Authorization
292
388
 
293
- [HTTPBearer](../README.md#HTTPBearer)
389
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
390
+
391
+ ### HTTP request headers
392
+
393
+ - **Content-Type**: application/json
394
+ - **Accept**: application/json
395
+
396
+
397
+ ## resume_conversion_async_api_v1_convert_conversion_id_resume_async_post
398
+
399
+ > Object resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
400
+
401
+ Resume a conversion asynchronously
402
+
403
+ Resume a conversion after completing missing data or correcting errors (async mode). The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery. ## Workflow 1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion ## Possible responses - **202**: Task accepted, processing - **404**: Conversion not found or expired
404
+
405
+ ### Examples
406
+
407
+ ```ruby
408
+ require 'time'
409
+ require 'factpulse'
410
+ # setup authorization
411
+ FactPulse.configure do |config|
412
+ # Configure API key authorization: APIKeyHeader
413
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
414
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
415
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
416
+
417
+ # Configure Bearer authorization: HTTPBearer
418
+ config.access_token = 'YOUR_BEARER_TOKEN'
419
+ end
420
+
421
+ api_instance = FactPulse::FacturXConversionApi.new
422
+ conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
423
+ convert_resume_request = FactPulse::ConvertResumeRequest.new # ConvertResumeRequest |
424
+
425
+ begin
426
+ # Resume a conversion asynchronously
427
+ result = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
428
+ p result
429
+ rescue FactPulse::ApiError => e
430
+ puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post: #{e}"
431
+ end
432
+ ```
433
+
434
+ #### Using the resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info variant
435
+
436
+ This returns an Array which contains the response data, status code and headers.
437
+
438
+ > <Array(Object, Integer, Hash)> resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
439
+
440
+ ```ruby
441
+ begin
442
+ # Resume a conversion asynchronously
443
+ data, status_code, headers = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
444
+ p status_code # => 2xx
445
+ p headers # => { ... }
446
+ p data # => Object
447
+ rescue FactPulse::ApiError => e
448
+ puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info: #{e}"
449
+ end
450
+ ```
451
+
452
+ ### Parameters
453
+
454
+ | Name | Type | Description | Notes |
455
+ | ---- | ---- | ----------- | ----- |
456
+ | **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) | |
457
+ | **convert_resume_request** | [**ConvertResumeRequest**](ConvertResumeRequest.md) | | |
458
+
459
+ ### Return type
460
+
461
+ **Object**
462
+
463
+ ### Authorization
464
+
465
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
294
466
 
295
467
  ### HTTP request headers
296
468
 
@@ -10,7 +10,7 @@
10
10
  | **submission_mode** | [**SubmissionMode**](SubmissionMode.md) | | [optional] |
11
11
  | **recipient** | [**Recipient**](Recipient.md) | | |
12
12
  | **supplier** | [**Supplier**](Supplier.md) | | |
13
- | **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) | | |
13
+ | **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) | | [optional] |
14
14
  | **references** | [**InvoiceReferences**](InvoiceReferences.md) | | |
15
15
  | **totals** | [**InvoiceTotals**](InvoiceTotals.md) | | |
16
16
  | **invoice_lines** | [**Array&lt;InvoiceLine&gt;**](InvoiceLine.md) | | [optional] |