factpulse 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (671) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +17 -0
  3. data/Gemfile +9 -0
  4. data/Gemfile.lock +74 -0
  5. data/LICENSE +21 -0
  6. data/README.md +220 -0
  7. data/Rakefile +10 -0
  8. data/docs/AFNORAcknowledgement.md +20 -0
  9. data/docs/AFNORAcknowledgementDetail.md +24 -0
  10. data/docs/AFNORAddressEdit.md +30 -0
  11. data/docs/AFNORAddressPatch.md +30 -0
  12. data/docs/AFNORAddressPut.md +30 -0
  13. data/docs/AFNORAddressRead.md +32 -0
  14. data/docs/AFNORAlgorithm.md +15 -0
  15. data/docs/AFNORContainsOperator.md +15 -0
  16. data/docs/AFNORCreateDirectoryLineBody.md +20 -0
  17. data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +24 -0
  18. data/docs/AFNORCreateDirectoryLineBodyPeriod.md +20 -0
  19. data/docs/AFNORCreateRoutingCodeBody.md +32 -0
  20. data/docs/AFNORCredentials.md +22 -0
  21. data/docs/AFNORDestination.md +26 -0
  22. data/docs/AFNORDiffusionStatus.md +15 -0
  23. data/docs/AFNORDirectoryLineField.md +15 -0
  24. data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md +32 -0
  25. data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +20 -0
  26. data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md +28 -0
  27. data/docs/AFNORDirectoryLinePost201Response.md +22 -0
  28. data/docs/AFNORDirectoryLineSearchPost200Response.md +22 -0
  29. data/docs/AFNOREntityType.md +15 -0
  30. data/docs/AFNORError.md +26 -0
  31. data/docs/AFNORFacilityAdministrativeStatus.md +15 -0
  32. data/docs/AFNORFacilityNature.md +15 -0
  33. data/docs/AFNORFacilityPayloadHistory.md +34 -0
  34. data/docs/AFNORFacilityPayloadHistoryUleB2gAdditionalData.md +28 -0
  35. data/docs/AFNORFacilityPayloadIncluded.md +32 -0
  36. data/docs/AFNORFacilityType.md +15 -0
  37. data/docs/AFNORFlow.md +38 -0
  38. data/docs/AFNORFlowAckStatus.md +15 -0
  39. data/docs/AFNORFlowDirection.md +15 -0
  40. data/docs/AFNORFlowInfo.md +28 -0
  41. data/docs/AFNORFlowProfile.md +15 -0
  42. data/docs/AFNORFlowSyntax.md +15 -0
  43. data/docs/AFNORFlowType.md +15 -0
  44. data/docs/AFNORFullFlowInfo.md +32 -0
  45. data/docs/AFNORHealthCheckResponse.md +22 -0
  46. data/docs/AFNORLegalUnitAdministrativeStatus.md +15 -0
  47. data/docs/AFNORLegalUnitPayloadHistory.md +24 -0
  48. data/docs/AFNORLegalUnitPayloadIncluded.md +24 -0
  49. data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +22 -0
  50. data/docs/AFNORPDPPAApi.md +150 -0
  51. data/docs/AFNORPDPPADirectoryServiceApi.md +1223 -0
  52. data/docs/AFNORPDPPAFlowServiceApi.md +270 -0
  53. data/docs/AFNORPlatformStatus.md +15 -0
  54. data/docs/AFNORProcessingRule.md +15 -0
  55. data/docs/AFNORReasonCode.md +49 -0
  56. data/docs/AFNORReasonCodeEnum.md +15 -0
  57. data/docs/AFNORRecipientPlatformType.md +15 -0
  58. data/docs/AFNORResult.md +32 -0
  59. data/docs/AFNORRoutingCodeAdministrativeStatus.md +15 -0
  60. data/docs/AFNORRoutingCodeField.md +15 -0
  61. data/docs/AFNORRoutingCodePayloadHistoryLegalUnitFacility.md +34 -0
  62. data/docs/AFNORRoutingCodePost201Response.md +22 -0
  63. data/docs/AFNORRoutingCodeSearch.md +28 -0
  64. data/docs/AFNORRoutingCodeSearchFilters.md +30 -0
  65. data/docs/AFNORRoutingCodeSearchFiltersAdministrativeStatus.md +20 -0
  66. data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +20 -0
  67. data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +20 -0
  68. data/docs/AFNORRoutingCodeSearchPost200Response.md +22 -0
  69. data/docs/AFNORRoutingCodeSearchSortingInner.md +20 -0
  70. data/docs/AFNORSearchDirectoryLine.md +26 -0
  71. data/docs/AFNORSearchDirectoryLineFilters.md +26 -0
  72. data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +20 -0
  73. data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +20 -0
  74. data/docs/AFNORSearchDirectoryLineSortingInner.md +20 -0
  75. data/docs/AFNORSearchFlowContent.md +22 -0
  76. data/docs/AFNORSearchFlowFilters.md +30 -0
  77. data/docs/AFNORSearchFlowParams.md +20 -0
  78. data/docs/AFNORSearchSiren.md +26 -0
  79. data/docs/AFNORSearchSirenFilters.md +24 -0
  80. data/docs/AFNORSearchSirenFiltersAdministrativeStatus.md +20 -0
  81. data/docs/AFNORSearchSirenFiltersBusinessName.md +20 -0
  82. data/docs/AFNORSearchSirenFiltersEntityType.md +20 -0
  83. data/docs/AFNORSearchSirenFiltersSiren.md +20 -0
  84. data/docs/AFNORSearchSirenSortingInner.md +20 -0
  85. data/docs/AFNORSearchSiret.md +28 -0
  86. data/docs/AFNORSearchSiretFilters.md +34 -0
  87. data/docs/AFNORSearchSiretFiltersAddressLines.md +20 -0
  88. data/docs/AFNORSearchSiretFiltersAdministrativeStatus.md +20 -0
  89. data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +20 -0
  90. data/docs/AFNORSearchSiretFiltersFacilityType.md +20 -0
  91. data/docs/AFNORSearchSiretFiltersLocality.md +20 -0
  92. data/docs/AFNORSearchSiretFiltersName.md +20 -0
  93. data/docs/AFNORSearchSiretFiltersPostalCode.md +20 -0
  94. data/docs/AFNORSearchSiretFiltersSiret.md +20 -0
  95. data/docs/AFNORSearchSiretSortingInner.md +20 -0
  96. data/docs/AFNORSirenField.md +15 -0
  97. data/docs/AFNORSirenSearchPost200Response.md +22 -0
  98. data/docs/AFNORSiretField.md +15 -0
  99. data/docs/AFNORSiretSearchPost200Response.md +22 -0
  100. data/docs/AFNORSortingOrder.md +15 -0
  101. data/docs/AFNORStrictOperator.md +15 -0
  102. data/docs/AFNORUpdatePatchDirectoryLineBody.md +18 -0
  103. data/docs/AFNORUpdatePatchRoutingCodeBody.md +24 -0
  104. data/docs/AFNORUpdatePutRoutingCodeBody.md +24 -0
  105. data/docs/AFNORWebhookCallbackContent.md +18 -0
  106. data/docs/APIError.md +22 -0
  107. data/docs/APIProfile.md +15 -0
  108. data/docs/AcknowledgmentStatus.md +15 -0
  109. data/docs/ActionCodeInfo.md +22 -0
  110. data/docs/ActionCodesResponse.md +22 -0
  111. data/docs/AdditionalDocument.md +26 -0
  112. data/docs/AggregatedPaymentInput.md +22 -0
  113. data/docs/AggregatedTransactionInput.md +32 -0
  114. data/docs/AllowanceCharge.md +32 -0
  115. data/docs/AllowanceChargeReasonCode.md +15 -0
  116. data/docs/AllowanceReasonCode.md +15 -0
  117. data/docs/AllowanceTotalAmount.md +15 -0
  118. data/docs/Amount.md +15 -0
  119. data/docs/Amount1.md +15 -0
  120. data/docs/Amount2.md +15 -0
  121. data/docs/AmountDue.md +15 -0
  122. data/docs/AsyncTaskStatus.md +22 -0
  123. data/docs/AsyncTasksApi.md +82 -0
  124. data/docs/BaseAmount.md +15 -0
  125. data/docs/BoundingBoxSchema.md +30 -0
  126. data/docs/Buyercountry.md +15 -0
  127. data/docs/CeleryStatus.md +15 -0
  128. data/docs/CertificateInfoResponse.md +40 -0
  129. data/docs/ChargeTotalAmount.md +15 -0
  130. data/docs/ChorusProApi.md +1207 -0
  131. data/docs/ChorusProCredentials.md +26 -0
  132. data/docs/ChorusProDestination.md +20 -0
  133. data/docs/ChorusProResult.md +22 -0
  134. data/docs/ClientActivateResponse.md +22 -0
  135. data/docs/ClientCreateRequest.md +22 -0
  136. data/docs/ClientDetail.md +38 -0
  137. data/docs/ClientListResponse.md +24 -0
  138. data/docs/ClientManagementApi.md +921 -0
  139. data/docs/ClientSummary.md +38 -0
  140. data/docs/ClientUpdateRequest.md +22 -0
  141. data/docs/Contact.md +24 -0
  142. data/docs/ConvertResumeRequest.md +18 -0
  143. data/docs/ConvertSuccessResponse.md +36 -0
  144. data/docs/ConvertValidationFailedResponse.md +34 -0
  145. data/docs/CountryCode.md +15 -0
  146. data/docs/CreateAggregatedReportRequest.md +36 -0
  147. data/docs/CreateCDARRequest.md +52 -0
  148. data/docs/CreateEReportingRequest.md +38 -0
  149. data/docs/Currency.md +15 -0
  150. data/docs/CurrencyCode.md +15 -0
  151. data/docs/DeliveryParty.md +24 -0
  152. data/docs/Destination.md +79 -0
  153. data/docs/DocType.md +15 -0
  154. data/docs/DocumentTypeInfo.md +22 -0
  155. data/docs/DownloadsApi.md +161 -0
  156. data/docs/EReportingFlowType.md +15 -0
  157. data/docs/EReportingValidationError.md +22 -0
  158. data/docs/ElectronicAddress.md +20 -0
  159. data/docs/ElectronicSignatureApi.md +339 -0
  160. data/docs/Encaisseamount.md +15 -0
  161. data/docs/Encaisseamount1.md +15 -0
  162. data/docs/EncaisseeRequest.md +40 -0
  163. data/docs/EnrichedInvoiceInfo.md +32 -0
  164. data/docs/ErrorLevel.md +15 -0
  165. data/docs/ErrorSource.md +15 -0
  166. data/docs/ExtractionInfo.md +24 -0
  167. data/docs/FacturXConversionApi.md +319 -0
  168. data/docs/FacturXGenerationApi.md +254 -0
  169. data/docs/FacturXInvoice.md +76 -0
  170. data/docs/FacturXPDFInfo.md +22 -0
  171. data/docs/FacturXPDFXMLVerificationApi.md +240 -0
  172. data/docs/FacturXValidationApi.md +256 -0
  173. data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +15 -0
  174. data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
  175. data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
  176. data/docs/FieldStatus.md +15 -0
  177. data/docs/FileInfo.md +20 -0
  178. data/docs/FilesInfo.md +20 -0
  179. data/docs/FlowDirection.md +15 -0
  180. data/docs/FlowProfile.md +15 -0
  181. data/docs/FlowSummary.md +32 -0
  182. data/docs/FlowSyntax.md +15 -0
  183. data/docs/FlowType.md +15 -0
  184. data/docs/Flux10EReportingApi.md +814 -0
  185. data/docs/Flux6InvoiceLifecycleCDARApi.md +698 -0
  186. data/docs/GenerateAggregatedReportResponse.md +30 -0
  187. data/docs/GenerateCDARResponse.md +26 -0
  188. data/docs/GenerateCertificateRequest.md +38 -0
  189. data/docs/GenerateCertificateResponse.md +32 -0
  190. data/docs/GenerateEReportingResponse.md +26 -0
  191. data/docs/GetChorusProIdRequest.md +22 -0
  192. data/docs/GetChorusProIdResponse.md +24 -0
  193. data/docs/GetInvoiceRequest.md +20 -0
  194. data/docs/GetInvoiceResponse.md +34 -0
  195. data/docs/GetStructureRequest.md +22 -0
  196. data/docs/GetStructureResponse.md +34 -0
  197. data/docs/GlobalAllowanceAmount.md +15 -0
  198. data/docs/GrossUnitPrice.md +15 -0
  199. data/docs/HTTPValidationError.md +18 -0
  200. data/docs/HealthApi.md +203 -0
  201. data/docs/IncomingInvoice.md +54 -0
  202. data/docs/IncomingSupplier.md +32 -0
  203. data/docs/InvoiceFormat.md +15 -0
  204. data/docs/InvoiceInput.md +50 -0
  205. data/docs/InvoiceLine.md +84 -0
  206. data/docs/InvoiceLineAllowanceAmount.md +15 -0
  207. data/docs/InvoiceNote.md +20 -0
  208. data/docs/InvoicePaymentInput.md +26 -0
  209. data/docs/InvoiceReferences.md +52 -0
  210. data/docs/InvoiceStatus.md +22 -0
  211. data/docs/InvoiceTotals.md +38 -0
  212. data/docs/InvoiceTotalsPrepayment.md +15 -0
  213. data/docs/InvoiceTypeCode.md +15 -0
  214. data/docs/InvoiceTypeCodeOutput.md +15 -0
  215. data/docs/InvoicingFramework.md +24 -0
  216. data/docs/InvoicingFrameworkCode.md +15 -0
  217. data/docs/IssuerRoleCode.md +15 -0
  218. data/docs/KeyRotationRequest.md +20 -0
  219. data/docs/KeyRotationResponse.md +24 -0
  220. data/docs/LineNetAmount.md +15 -0
  221. data/docs/LineSubType.md +15 -0
  222. data/docs/LineTotalAmount.md +15 -0
  223. data/docs/LocationInner.md +15 -0
  224. data/docs/MandatoryNoteSchema.md +30 -0
  225. data/docs/ManualRate.md +15 -0
  226. data/docs/ManualVatRate.md +15 -0
  227. data/docs/MissingField.md +28 -0
  228. data/docs/OperationNature.md +15 -0
  229. data/docs/OutputFormat.md +15 -0
  230. data/docs/PDFValidationResultAPI.md +62 -0
  231. data/docs/PDPConfigResponse.md +46 -0
  232. data/docs/PDPConfigUpdateRequest.md +30 -0
  233. data/docs/PDPCredentials.md +26 -0
  234. data/docs/PageDimensionsSchema.md +20 -0
  235. data/docs/Payee.md +32 -0
  236. data/docs/PaymentAmountByRate.md +20 -0
  237. data/docs/PaymentCard.md +20 -0
  238. data/docs/PaymentMeans.md +15 -0
  239. data/docs/Percentage.md +15 -0
  240. data/docs/PostalAddress.md +30 -0
  241. data/docs/PriceAllowanceAmount.md +15 -0
  242. data/docs/PriceBasisQuantity.md +15 -0
  243. data/docs/ProcessingOptions.md +24 -0
  244. data/docs/ProcessingRule.md +15 -0
  245. data/docs/ProductCharacteristic.md +20 -0
  246. data/docs/ProductClassification.md +22 -0
  247. data/docs/Quantity.md +15 -0
  248. data/docs/Rate.md +15 -0
  249. data/docs/Rate1.md +15 -0
  250. data/docs/ReasonCodeInfo.md +22 -0
  251. data/docs/ReasonCodesResponse.md +22 -0
  252. data/docs/Recipient.md +34 -0
  253. data/docs/RecipientInput.md +26 -0
  254. data/docs/RefuseeRequest.md +40 -0
  255. data/docs/ReportIssuer.md +24 -0
  256. data/docs/ReportPeriod.md +20 -0
  257. data/docs/ReportSender.md +22 -0
  258. data/docs/RoundingAmount.md +15 -0
  259. data/docs/SchematronValidationError.md +32 -0
  260. data/docs/SchemeID.md +15 -0
  261. data/docs/SearchFlowRequest.md +34 -0
  262. data/docs/SearchFlowResponse.md +24 -0
  263. data/docs/SearchServicesResponse.md +24 -0
  264. data/docs/SearchStructureRequest.md +26 -0
  265. data/docs/SearchStructureResponse.md +24 -0
  266. data/docs/SecretStatus.md +24 -0
  267. data/docs/Sellercountry.md +15 -0
  268. data/docs/SignatureInfo.md +22 -0
  269. data/docs/SignatureInfoAPI.md +28 -0
  270. data/docs/SignatureParameters.md +34 -0
  271. data/docs/SimplifiedCDARResponse.md +26 -0
  272. data/docs/SimplifiedInvoiceData.md +42 -0
  273. data/docs/StatusCodeInfo.md +22 -0
  274. data/docs/StatusCodesResponse.md +22 -0
  275. data/docs/StructureInfo.md +26 -0
  276. data/docs/StructureParameters.md +22 -0
  277. data/docs/StructureService.md +24 -0
  278. data/docs/SubmissionMode.md +15 -0
  279. data/docs/SubmitAggregatedReportRequest.md +28 -0
  280. data/docs/SubmitCDARRequest.md +62 -0
  281. data/docs/SubmitCDARResponse.md +24 -0
  282. data/docs/SubmitCDARXMLRequest.md +30 -0
  283. data/docs/SubmitCompleteInvoiceRequest.md +26 -0
  284. data/docs/SubmitCompleteInvoiceResponse.md +34 -0
  285. data/docs/SubmitEReportingRequest.md +28 -0
  286. data/docs/SubmitEReportingResponse.md +32 -0
  287. data/docs/SubmitFlowRequest.md +28 -0
  288. data/docs/SubmitFlowResponse.md +30 -0
  289. data/docs/SubmitGrossAmount.md +15 -0
  290. data/docs/SubmitInvoiceRequest.md +46 -0
  291. data/docs/SubmitInvoiceResponse.md +24 -0
  292. data/docs/SubmitNetAmount.md +15 -0
  293. data/docs/SubmitVatAmount.md +15 -0
  294. data/docs/SupplementaryAttachment.md +26 -0
  295. data/docs/Supplier.md +52 -0
  296. data/docs/TaskResponse.md +18 -0
  297. data/docs/TaxBreakdownInput.md +22 -0
  298. data/docs/TaxDueDateType.md +15 -0
  299. data/docs/TaxRepresentative.md +22 -0
  300. data/docs/TaxableAmount.md +15 -0
  301. data/docs/Taxableamount.md +15 -0
  302. data/docs/Taxamount.md +15 -0
  303. data/docs/Taxamount1.md +15 -0
  304. data/docs/Taxamount2.md +15 -0
  305. data/docs/Taxexclusiveamount.md +15 -0
  306. data/docs/Taxexclusiveamount1.md +15 -0
  307. data/docs/TotalGrossAmount.md +15 -0
  308. data/docs/TotalNetAmount.md +15 -0
  309. data/docs/TotalVATAmount.md +15 -0
  310. data/docs/TransactionCategory.md +15 -0
  311. data/docs/TransmissionTypeCode.md +15 -0
  312. data/docs/UnitNetPrice.md +15 -0
  313. data/docs/UnitOfMeasure.md +15 -0
  314. data/docs/VATAccountingCode.md +15 -0
  315. data/docs/VATAmount.md +15 -0
  316. data/docs/VATCategory.md +15 -0
  317. data/docs/VATLine.md +32 -0
  318. data/docs/VATPointDateCode.md +15 -0
  319. data/docs/ValidateCDARRequest.md +32 -0
  320. data/docs/ValidateCDARResponse.md +22 -0
  321. data/docs/ValidateEReportingRequest.md +18 -0
  322. data/docs/ValidateEReportingResponse.md +28 -0
  323. data/docs/ValidationError.md +22 -0
  324. data/docs/ValidationErrorDetail.md +26 -0
  325. data/docs/ValidationErrorResponse.md +24 -0
  326. data/docs/ValidationInfo.md +28 -0
  327. data/docs/ValidationSuccessResponse.md +18 -0
  328. data/docs/VatRate.md +15 -0
  329. data/docs/VerificationSuccessResponse.md +36 -0
  330. data/docs/VerifiedFieldSchema.md +34 -0
  331. data/docs/WebhookSecretDeleteResponse.md +20 -0
  332. data/docs/WebhookSecretGenerateResponse.md +24 -0
  333. data/docs/WebhookSecretStatusResponse.md +20 -0
  334. data/factpulse.gemspec +39 -0
  335. data/git_push.sh +57 -0
  336. data/lib/factpulse/api/afnorpdppa_api.rb +148 -0
  337. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1183 -0
  338. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +289 -0
  339. data/lib/factpulse/api/async_tasks_api.rb +85 -0
  340. data/lib/factpulse/api/chorus_pro_api.rb +1105 -0
  341. data/lib/factpulse/api/client_management_api.rb +831 -0
  342. data/lib/factpulse/api/downloads_api.rb +151 -0
  343. data/lib/factpulse/api/electronic_signature_api.rb +339 -0
  344. data/lib/factpulse/api/factur_x_conversion_api.rb +306 -0
  345. data/lib/factpulse/api/factur_x_generation_api.rb +254 -0
  346. data/lib/factpulse/api/factur_x_validation_api.rb +256 -0
  347. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +232 -0
  348. data/lib/factpulse/api/flux10_e_reporting_api.rb +777 -0
  349. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +670 -0
  350. data/lib/factpulse/api/health_api.rb +193 -0
  351. data/lib/factpulse/api_client.rb +397 -0
  352. data/lib/factpulse/api_error.rb +58 -0
  353. data/lib/factpulse/api_model_base.rb +88 -0
  354. data/lib/factpulse/configuration.rb +319 -0
  355. data/lib/factpulse/helpers/client.rb +272 -0
  356. data/lib/factpulse/helpers/exceptions.rb +45 -0
  357. data/lib/factpulse/helpers/helpers.rb +14 -0
  358. data/lib/factpulse/models/acknowledgment_status.rb +41 -0
  359. data/lib/factpulse/models/action_code_info.rb +220 -0
  360. data/lib/factpulse/models/action_codes_response.rb +207 -0
  361. data/lib/factpulse/models/additional_document.rb +206 -0
  362. data/lib/factpulse/models/afnor_acknowledgement.rb +216 -0
  363. data/lib/factpulse/models/afnor_acknowledgement_detail.rb +267 -0
  364. data/lib/factpulse/models/afnor_address_edit.rb +353 -0
  365. data/lib/factpulse/models/afnor_address_patch.rb +386 -0
  366. data/lib/factpulse/models/afnor_address_put.rb +435 -0
  367. data/lib/factpulse/models/afnor_address_read.rb +382 -0
  368. data/lib/factpulse/models/afnor_algorithm.rb +43 -0
  369. data/lib/factpulse/models/afnor_contains_operator.rb +39 -0
  370. data/lib/factpulse/models/afnor_create_directory_line_body.rb +156 -0
  371. data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +294 -0
  372. data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +175 -0
  373. data/lib/factpulse/models/afnor_create_routing_code_body.rb +412 -0
  374. data/lib/factpulse/models/afnor_credentials.rb +169 -0
  375. data/lib/factpulse/models/afnor_destination.rb +224 -0
  376. data/lib/factpulse/models/afnor_diffusion_status.rb +40 -0
  377. data/lib/factpulse/models/afnor_directory_line_field.rb +44 -0
  378. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +312 -0
  379. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +178 -0
  380. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +308 -0
  381. data/lib/factpulse/models/afnor_directory_line_post201_response.rb +187 -0
  382. data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +168 -0
  383. data/lib/factpulse/models/afnor_entity_type.rb +40 -0
  384. data/lib/factpulse/models/afnor_error.rb +214 -0
  385. data/lib/factpulse/models/afnor_facility_administrative_status.rb +40 -0
  386. data/lib/factpulse/models/afnor_facility_nature.rb +40 -0
  387. data/lib/factpulse/models/afnor_facility_payload_history.rb +323 -0
  388. data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +198 -0
  389. data/lib/factpulse/models/afnor_facility_payload_included.rb +314 -0
  390. data/lib/factpulse/models/afnor_facility_type.rb +40 -0
  391. data/lib/factpulse/models/afnor_flow.rb +315 -0
  392. data/lib/factpulse/models/afnor_flow_ack_status.rb +41 -0
  393. data/lib/factpulse/models/afnor_flow_direction.rb +40 -0
  394. data/lib/factpulse/models/afnor_flow_info.rb +293 -0
  395. data/lib/factpulse/models/afnor_flow_profile.rb +41 -0
  396. data/lib/factpulse/models/afnor_flow_syntax.rb +43 -0
  397. data/lib/factpulse/models/afnor_flow_type.rb +51 -0
  398. data/lib/factpulse/models/afnor_full_flow_info.rb +339 -0
  399. data/lib/factpulse/models/afnor_health_check_response.rb +220 -0
  400. data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +40 -0
  401. data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +247 -0
  402. data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +247 -0
  403. data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +207 -0
  404. data/lib/factpulse/models/afnor_platform_status.rb +40 -0
  405. data/lib/factpulse/models/afnor_processing_rule.rb +44 -0
  406. data/lib/factpulse/models/afnor_reason_code.rb +105 -0
  407. data/lib/factpulse/models/afnor_reason_code_enum.rb +53 -0
  408. data/lib/factpulse/models/afnor_recipient_platform_type.rb +40 -0
  409. data/lib/factpulse/models/afnor_result.rb +270 -0
  410. data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +40 -0
  411. data/lib/factpulse/models/afnor_routing_code_field.rb +46 -0
  412. data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +366 -0
  413. data/lib/factpulse/models/afnor_routing_code_post201_response.rb +228 -0
  414. data/lib/factpulse/models/afnor_routing_code_search.rb +224 -0
  415. data/lib/factpulse/models/afnor_routing_code_search_filters.rb +201 -0
  416. data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +178 -0
  417. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +209 -0
  418. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +209 -0
  419. data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +168 -0
  420. data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +179 -0
  421. data/lib/factpulse/models/afnor_search_directory_line.rb +191 -0
  422. data/lib/factpulse/models/afnor_search_directory_line_filters.rb +183 -0
  423. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +198 -0
  424. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +198 -0
  425. data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +179 -0
  426. data/lib/factpulse/models/afnor_search_flow_content.rb +168 -0
  427. data/lib/factpulse/models/afnor_search_flow_filters.rb +250 -0
  428. data/lib/factpulse/models/afnor_search_flow_params.rb +195 -0
  429. data/lib/factpulse/models/afnor_search_siren.rb +191 -0
  430. data/lib/factpulse/models/afnor_search_siren_filters.rb +174 -0
  431. data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +178 -0
  432. data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +198 -0
  433. data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +178 -0
  434. data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +209 -0
  435. data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +179 -0
  436. data/lib/factpulse/models/afnor_search_siret.rb +224 -0
  437. data/lib/factpulse/models/afnor_search_siret_filters.rb +219 -0
  438. data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +198 -0
  439. data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +178 -0
  440. data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +198 -0
  441. data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +178 -0
  442. data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +198 -0
  443. data/lib/factpulse/models/afnor_search_siret_filters_name.rb +198 -0
  444. data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +209 -0
  445. data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +209 -0
  446. data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +179 -0
  447. data/lib/factpulse/models/afnor_siren_field.rb +43 -0
  448. data/lib/factpulse/models/afnor_siren_search_post200_response.rb +168 -0
  449. data/lib/factpulse/models/afnor_siret_field.rb +52 -0
  450. data/lib/factpulse/models/afnor_siret_search_post200_response.rb +168 -0
  451. data/lib/factpulse/models/afnor_sorting_order.rb +40 -0
  452. data/lib/factpulse/models/afnor_strict_operator.rb +39 -0
  453. data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +148 -0
  454. data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +258 -0
  455. data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +289 -0
  456. data/lib/factpulse/models/afnor_webhook_callback_content.rb +148 -0
  457. data/lib/factpulse/models/aggregated_payment_input.rb +213 -0
  458. data/lib/factpulse/models/aggregated_transaction_input.rb +349 -0
  459. data/lib/factpulse/models/allowance_charge.rb +274 -0
  460. data/lib/factpulse/models/allowance_charge_reason_code.rb +76 -0
  461. data/lib/factpulse/models/allowance_reason_code.rb +45 -0
  462. data/lib/factpulse/models/allowance_total_amount.rb +104 -0
  463. data/lib/factpulse/models/amount.rb +104 -0
  464. data/lib/factpulse/models/amount1.rb +104 -0
  465. data/lib/factpulse/models/amount2.rb +104 -0
  466. data/lib/factpulse/models/amount_due.rb +104 -0
  467. data/lib/factpulse/models/api_error.rb +205 -0
  468. data/lib/factpulse/models/api_profile.rb +43 -0
  469. data/lib/factpulse/models/async_task_status.rb +227 -0
  470. data/lib/factpulse/models/base_amount.rb +104 -0
  471. data/lib/factpulse/models/bounding_box_schema.rb +332 -0
  472. data/lib/factpulse/models/buyercountry.rb +104 -0
  473. data/lib/factpulse/models/celery_status.rb +43 -0
  474. data/lib/factpulse/models/certificate_info_response.rb +446 -0
  475. data/lib/factpulse/models/charge_total_amount.rb +104 -0
  476. data/lib/factpulse/models/chorus_pro_credentials.rb +259 -0
  477. data/lib/factpulse/models/chorus_pro_destination.rb +194 -0
  478. data/lib/factpulse/models/chorus_pro_result.rb +186 -0
  479. data/lib/factpulse/models/client_activate_response.rb +220 -0
  480. data/lib/factpulse/models/client_create_request.rb +236 -0
  481. data/lib/factpulse/models/client_detail.rb +368 -0
  482. data/lib/factpulse/models/client_list_response.rb +249 -0
  483. data/lib/factpulse/models/client_summary.rb +368 -0
  484. data/lib/factpulse/models/client_update_request.rb +225 -0
  485. data/lib/factpulse/models/contact.rb +179 -0
  486. data/lib/factpulse/models/convert_resume_request.rb +151 -0
  487. data/lib/factpulse/models/convert_success_response.rb +360 -0
  488. data/lib/factpulse/models/convert_validation_failed_response.rb +339 -0
  489. data/lib/factpulse/models/country_code.rb +208 -0
  490. data/lib/factpulse/models/create_aggregated_report_request.rb +320 -0
  491. data/lib/factpulse/models/create_cdar_request.rb +414 -0
  492. data/lib/factpulse/models/create_e_reporting_request.rb +347 -0
  493. data/lib/factpulse/models/currency.rb +104 -0
  494. data/lib/factpulse/models/currency_code.rb +91 -0
  495. data/lib/factpulse/models/delivery_party.rb +179 -0
  496. data/lib/factpulse/models/destination.rb +56 -0
  497. data/lib/factpulse/models/doc_type.rb +42 -0
  498. data/lib/factpulse/models/document_type_info.rb +220 -0
  499. data/lib/factpulse/models/e_reporting_flow_type.rb +42 -0
  500. data/lib/factpulse/models/e_reporting_validation_error.rb +203 -0
  501. data/lib/factpulse/models/electronic_address.rb +198 -0
  502. data/lib/factpulse/models/encaisseamount.rb +104 -0
  503. data/lib/factpulse/models/encaisseamount1.rb +103 -0
  504. data/lib/factpulse/models/encaissee_request.rb +347 -0
  505. data/lib/factpulse/models/enriched_invoice_info.rb +354 -0
  506. data/lib/factpulse/models/error_level.rb +40 -0
  507. data/lib/factpulse/models/error_source.rb +47 -0
  508. data/lib/factpulse/models/extraction_info.rb +217 -0
  509. data/lib/factpulse/models/factur_x_invoice.rb +580 -0
  510. data/lib/factpulse/models/factur_xpdf_info.rb +205 -0
  511. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +43 -0
  512. data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
  513. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
  514. data/lib/factpulse/models/field_status.rb +43 -0
  515. data/lib/factpulse/models/file_info.rb +161 -0
  516. data/lib/factpulse/models/files_info.rb +159 -0
  517. data/lib/factpulse/models/flow_direction.rb +40 -0
  518. data/lib/factpulse/models/flow_profile.rb +41 -0
  519. data/lib/factpulse/models/flow_summary.rb +253 -0
  520. data/lib/factpulse/models/flow_syntax.rb +43 -0
  521. data/lib/factpulse/models/flow_type.rb +51 -0
  522. data/lib/factpulse/models/generate_aggregated_report_response.rb +330 -0
  523. data/lib/factpulse/models/generate_cdar_response.rb +273 -0
  524. data/lib/factpulse/models/generate_certificate_request.rb +323 -0
  525. data/lib/factpulse/models/generate_certificate_response.rb +254 -0
  526. data/lib/factpulse/models/generate_e_reporting_response.rb +274 -0
  527. data/lib/factpulse/models/get_chorus_pro_id_request.rb +188 -0
  528. data/lib/factpulse/models/get_chorus_pro_id_response.rb +230 -0
  529. data/lib/factpulse/models/get_invoice_request.rb +176 -0
  530. data/lib/factpulse/models/get_invoice_response.rb +263 -0
  531. data/lib/factpulse/models/get_structure_request.rb +188 -0
  532. data/lib/factpulse/models/get_structure_response.rb +263 -0
  533. data/lib/factpulse/models/global_allowance_amount.rb +104 -0
  534. data/lib/factpulse/models/gross_unit_price.rb +104 -0
  535. data/lib/factpulse/models/http_validation_error.rb +149 -0
  536. data/lib/factpulse/models/incoming_invoice.rb +489 -0
  537. data/lib/factpulse/models/incoming_supplier.rb +236 -0
  538. data/lib/factpulse/models/invoice_format.rb +41 -0
  539. data/lib/factpulse/models/invoice_input.rb +439 -0
  540. data/lib/factpulse/models/invoice_line.rb +593 -0
  541. data/lib/factpulse/models/invoice_line_allowance_amount.rb +104 -0
  542. data/lib/factpulse/models/invoice_note.rb +176 -0
  543. data/lib/factpulse/models/invoice_payment_input.rb +267 -0
  544. data/lib/factpulse/models/invoice_references.rb +393 -0
  545. data/lib/factpulse/models/invoice_status.rb +203 -0
  546. data/lib/factpulse/models/invoice_totals.rb +312 -0
  547. data/lib/factpulse/models/invoice_totals_prepayment.rb +104 -0
  548. data/lib/factpulse/models/invoice_type_code.rb +54 -0
  549. data/lib/factpulse/models/invoice_type_code_output.rb +54 -0
  550. data/lib/factpulse/models/invoicing_framework.rb +218 -0
  551. data/lib/factpulse/models/invoicing_framework_code.rb +42 -0
  552. data/lib/factpulse/models/issuer_role_code.rb +40 -0
  553. data/lib/factpulse/models/key_rotation_request.rb +211 -0
  554. data/lib/factpulse/models/key_rotation_response.rb +232 -0
  555. data/lib/factpulse/models/line_net_amount.rb +104 -0
  556. data/lib/factpulse/models/line_sub_type.rb +41 -0
  557. data/lib/factpulse/models/line_total_amount.rb +104 -0
  558. data/lib/factpulse/models/location_inner.rb +103 -0
  559. data/lib/factpulse/models/mandatory_note_schema.rb +265 -0
  560. data/lib/factpulse/models/manual_rate.rb +104 -0
  561. data/lib/factpulse/models/manual_vat_rate.rb +104 -0
  562. data/lib/factpulse/models/missing_field.rb +269 -0
  563. data/lib/factpulse/models/operation_nature.rb +52 -0
  564. data/lib/factpulse/models/output_format.rb +40 -0
  565. data/lib/factpulse/models/page_dimensions_schema.rb +193 -0
  566. data/lib/factpulse/models/payee.rb +281 -0
  567. data/lib/factpulse/models/payment_amount_by_rate.rb +191 -0
  568. data/lib/factpulse/models/payment_card.rb +159 -0
  569. data/lib/factpulse/models/payment_means.rb +44 -0
  570. data/lib/factpulse/models/pdf_validation_result_api.rb +523 -0
  571. data/lib/factpulse/models/pdp_config_response.rb +306 -0
  572. data/lib/factpulse/models/pdp_config_update_request.rb +315 -0
  573. data/lib/factpulse/models/pdp_credentials.rb +257 -0
  574. data/lib/factpulse/models/percentage.rb +104 -0
  575. data/lib/factpulse/models/postal_address.rb +209 -0
  576. data/lib/factpulse/models/price_allowance_amount.rb +104 -0
  577. data/lib/factpulse/models/price_basis_quantity.rb +104 -0
  578. data/lib/factpulse/models/processing_options.rb +207 -0
  579. data/lib/factpulse/models/processing_rule.rb +44 -0
  580. data/lib/factpulse/models/product_characteristic.rb +193 -0
  581. data/lib/factpulse/models/product_classification.rb +186 -0
  582. data/lib/factpulse/models/quantity.rb +104 -0
  583. data/lib/factpulse/models/rate.rb +104 -0
  584. data/lib/factpulse/models/rate1.rb +104 -0
  585. data/lib/factpulse/models/reason_code_info.rb +220 -0
  586. data/lib/factpulse/models/reason_codes_response.rb +207 -0
  587. data/lib/factpulse/models/recipient.rb +231 -0
  588. data/lib/factpulse/models/recipient_input.rb +191 -0
  589. data/lib/factpulse/models/refusee_request.rb +346 -0
  590. data/lib/factpulse/models/report_issuer.rb +236 -0
  591. data/lib/factpulse/models/report_period.rb +193 -0
  592. data/lib/factpulse/models/report_sender.rb +221 -0
  593. data/lib/factpulse/models/rounding_amount.rb +104 -0
  594. data/lib/factpulse/models/schematron_validation_error.rb +294 -0
  595. data/lib/factpulse/models/scheme_id.rb +56 -0
  596. data/lib/factpulse/models/search_flow_request.rb +306 -0
  597. data/lib/factpulse/models/search_flow_response.rb +249 -0
  598. data/lib/factpulse/models/search_services_response.rb +217 -0
  599. data/lib/factpulse/models/search_structure_request.rb +191 -0
  600. data/lib/factpulse/models/search_structure_response.rb +216 -0
  601. data/lib/factpulse/models/secret_status.rb +213 -0
  602. data/lib/factpulse/models/sellercountry.rb +104 -0
  603. data/lib/factpulse/models/signature_info.rb +186 -0
  604. data/lib/factpulse/models/signature_info_api.rb +216 -0
  605. data/lib/factpulse/models/signature_parameters.rb +235 -0
  606. data/lib/factpulse/models/simplified_cdar_response.rb +274 -0
  607. data/lib/factpulse/models/simplified_invoice_data.rb +404 -0
  608. data/lib/factpulse/models/status_code_info.rb +220 -0
  609. data/lib/factpulse/models/status_codes_response.rb +207 -0
  610. data/lib/factpulse/models/structure_info.rb +274 -0
  611. data/lib/factpulse/models/structure_parameters.rb +175 -0
  612. data/lib/factpulse/models/structure_service.rb +247 -0
  613. data/lib/factpulse/models/submission_mode.rb +41 -0
  614. data/lib/factpulse/models/submit_aggregated_report_request.rb +216 -0
  615. data/lib/factpulse/models/submit_cdar_request.rb +466 -0
  616. data/lib/factpulse/models/submit_cdar_response.rb +213 -0
  617. data/lib/factpulse/models/submit_cdarxml_request.rb +228 -0
  618. data/lib/factpulse/models/submit_complete_invoice_request.rb +239 -0
  619. data/lib/factpulse/models/submit_complete_invoice_response.rb +355 -0
  620. data/lib/factpulse/models/submit_e_reporting_request.rb +216 -0
  621. data/lib/factpulse/models/submit_e_reporting_response.rb +306 -0
  622. data/lib/factpulse/models/submit_flow_request.rb +238 -0
  623. data/lib/factpulse/models/submit_flow_response.rb +294 -0
  624. data/lib/factpulse/models/submit_gross_amount.rb +104 -0
  625. data/lib/factpulse/models/submit_invoice_request.rb +388 -0
  626. data/lib/factpulse/models/submit_invoice_response.rb +213 -0
  627. data/lib/factpulse/models/submit_net_amount.rb +104 -0
  628. data/lib/factpulse/models/submit_vat_amount.rb +104 -0
  629. data/lib/factpulse/models/supplementary_attachment.rb +274 -0
  630. data/lib/factpulse/models/supplier.rb +337 -0
  631. data/lib/factpulse/models/task_response.rb +166 -0
  632. data/lib/factpulse/models/tax_breakdown_input.rb +217 -0
  633. data/lib/factpulse/models/tax_due_date_type.rb +44 -0
  634. data/lib/factpulse/models/tax_representative.rb +220 -0
  635. data/lib/factpulse/models/taxable_amount.rb +104 -0
  636. data/lib/factpulse/models/taxableamount.rb +104 -0
  637. data/lib/factpulse/models/taxamount.rb +104 -0
  638. data/lib/factpulse/models/taxamount1.rb +104 -0
  639. data/lib/factpulse/models/taxamount2.rb +104 -0
  640. data/lib/factpulse/models/taxexclusiveamount.rb +104 -0
  641. data/lib/factpulse/models/taxexclusiveamount1.rb +104 -0
  642. data/lib/factpulse/models/total_gross_amount.rb +104 -0
  643. data/lib/factpulse/models/total_net_amount.rb +104 -0
  644. data/lib/factpulse/models/total_vat_amount.rb +104 -0
  645. data/lib/factpulse/models/transaction_category.rb +42 -0
  646. data/lib/factpulse/models/transmission_type_code.rb +40 -0
  647. data/lib/factpulse/models/unit_net_price.rb +104 -0
  648. data/lib/factpulse/models/unit_of_measure.rb +44 -0
  649. data/lib/factpulse/models/validate_cdar_request.rb +219 -0
  650. data/lib/factpulse/models/validate_cdar_response.rb +190 -0
  651. data/lib/factpulse/models/validate_e_reporting_request.rb +166 -0
  652. data/lib/factpulse/models/validate_e_reporting_response.rb +271 -0
  653. data/lib/factpulse/models/validation_error.rb +218 -0
  654. data/lib/factpulse/models/validation_error_detail.rb +245 -0
  655. data/lib/factpulse/models/validation_error_response.rb +215 -0
  656. data/lib/factpulse/models/validation_info.rb +255 -0
  657. data/lib/factpulse/models/validation_success_response.rb +166 -0
  658. data/lib/factpulse/models/vat_accounting_code.rb +42 -0
  659. data/lib/factpulse/models/vat_amount.rb +104 -0
  660. data/lib/factpulse/models/vat_category.rb +47 -0
  661. data/lib/factpulse/models/vat_line.rb +272 -0
  662. data/lib/factpulse/models/vat_point_date_code.rb +41 -0
  663. data/lib/factpulse/models/vat_rate.rb +104 -0
  664. data/lib/factpulse/models/verification_success_response.rb +343 -0
  665. data/lib/factpulse/models/verified_field_schema.rb +334 -0
  666. data/lib/factpulse/models/webhook_secret_delete_response.rb +193 -0
  667. data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
  668. data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
  669. data/lib/factpulse/version.rb +15 -0
  670. data/lib/factpulse.rb +369 -0
  671. metadata +806 -0
@@ -0,0 +1,193 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
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.20.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FactPulse
17
+ # Response after deleting webhook secret.
18
+ class WebhookSecretDeleteResponse < ApiModelBase
19
+ # Whether the secret was deleted successfully
20
+ attr_accessor :success
21
+
22
+ # Result message
23
+ attr_accessor :message
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'success' => :'success',
29
+ :'message' => :'message'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'success' => :'Boolean',
47
+ :'message' => :'String'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::WebhookSecretDeleteResponse` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ acceptable_attribute_map = self.class.acceptable_attribute_map
66
+ attributes = attributes.each_with_object({}) { |(k, v), h|
67
+ if (!acceptable_attribute_map.key?(k.to_sym))
68
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::WebhookSecretDeleteResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
69
+ end
70
+ h[k.to_sym] = v
71
+ }
72
+
73
+ if attributes.key?(:'success')
74
+ self.success = attributes[:'success']
75
+ else
76
+ self.success = nil
77
+ end
78
+
79
+ if attributes.key?(:'message')
80
+ self.message = attributes[:'message']
81
+ else
82
+ self.message = nil
83
+ end
84
+ end
85
+
86
+ # Show invalid properties with the reasons. Usually used together with valid?
87
+ # @return Array for valid properties with the reasons
88
+ def list_invalid_properties
89
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
90
+ invalid_properties = Array.new
91
+ if @success.nil?
92
+ invalid_properties.push('invalid value for "success", success cannot be nil.')
93
+ end
94
+
95
+ if @message.nil?
96
+ invalid_properties.push('invalid value for "message", message cannot be nil.')
97
+ end
98
+
99
+ invalid_properties
100
+ end
101
+
102
+ # Check to see if the all the properties in the model are valid
103
+ # @return true if the model is valid
104
+ def valid?
105
+ warn '[DEPRECATED] the `valid?` method is obsolete'
106
+ return false if @success.nil?
107
+ return false if @message.nil?
108
+ true
109
+ end
110
+
111
+ # Custom attribute writer method with validation
112
+ # @param [Object] success Value to be assigned
113
+ def success=(success)
114
+ if success.nil?
115
+ fail ArgumentError, 'success cannot be nil'
116
+ end
117
+
118
+ @success = success
119
+ end
120
+
121
+ # Custom attribute writer method with validation
122
+ # @param [Object] message Value to be assigned
123
+ def message=(message)
124
+ if message.nil?
125
+ fail ArgumentError, 'message cannot be nil'
126
+ end
127
+
128
+ @message = message
129
+ end
130
+
131
+ # Checks equality by comparing each attribute.
132
+ # @param [Object] Object to be compared
133
+ def ==(o)
134
+ return true if self.equal?(o)
135
+ self.class == o.class &&
136
+ success == o.success &&
137
+ message == o.message
138
+ end
139
+
140
+ # @see the `==` method
141
+ # @param [Object] Object to be compared
142
+ def eql?(o)
143
+ self == o
144
+ end
145
+
146
+ # Calculates hash code according to all attributes.
147
+ # @return [Integer] Hash code
148
+ def hash
149
+ [success, message].hash
150
+ end
151
+
152
+ # Builds the object from hash
153
+ # @param [Hash] attributes Model attributes in the form of hash
154
+ # @return [Object] Returns the model itself
155
+ def self.build_from_hash(attributes)
156
+ return nil unless attributes.is_a?(Hash)
157
+ attributes = attributes.transform_keys(&:to_sym)
158
+ transformed_hash = {}
159
+ openapi_types.each_pair do |key, type|
160
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
161
+ transformed_hash["#{key}"] = nil
162
+ elsif type =~ /\AArray<(.*)>/i
163
+ # check to ensure the input is an array given that the attribute
164
+ # is documented as an array but the input is not
165
+ if attributes[attribute_map[key]].is_a?(Array)
166
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
167
+ end
168
+ elsif !attributes[attribute_map[key]].nil?
169
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
170
+ end
171
+ end
172
+ new(transformed_hash)
173
+ end
174
+
175
+ # Returns the object in the form of hash
176
+ # @return [Hash] Returns the object in the form of hash
177
+ def to_hash
178
+ hash = {}
179
+ self.class.attribute_map.each_pair do |attr, param|
180
+ value = self.send(attr)
181
+ if value.nil?
182
+ is_nullable = self.class.openapi_nullable.include?(attr)
183
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
184
+ end
185
+
186
+ hash[param] = _to_hash(value)
187
+ end
188
+ hash
189
+ end
190
+
191
+ end
192
+
193
+ end
@@ -0,0 +1,247 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
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.20.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FactPulse
17
+ # Response after generating a webhook secret.
18
+ class WebhookSecretGenerateResponse < ApiModelBase
19
+ # Whether the secret was generated successfully
20
+ attr_accessor :success
21
+
22
+ # The generated webhook secret (save it, it will never be shown again)
23
+ attr_accessor :webhook_secret
24
+
25
+ # Result message
26
+ attr_accessor :message
27
+
28
+ # When the secret was created
29
+ attr_accessor :created_at
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'success' => :'success',
35
+ :'webhook_secret' => :'webhookSecret',
36
+ :'message' => :'message',
37
+ :'created_at' => :'createdAt'
38
+ }
39
+ end
40
+
41
+ # Returns attribute mapping this model knows about
42
+ def self.acceptable_attribute_map
43
+ attribute_map
44
+ end
45
+
46
+ # Returns all the JSON keys this model knows about
47
+ def self.acceptable_attributes
48
+ acceptable_attribute_map.values
49
+ end
50
+
51
+ # Attribute type mapping.
52
+ def self.openapi_types
53
+ {
54
+ :'success' => :'Boolean',
55
+ :'webhook_secret' => :'String',
56
+ :'message' => :'String',
57
+ :'created_at' => :'Time'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
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::WebhookSecretGenerateResponse` 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::WebhookSecretGenerateResponse`. 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?(:'webhook_secret')
90
+ self.webhook_secret = attributes[:'webhook_secret']
91
+ else
92
+ self.webhook_secret = nil
93
+ end
94
+
95
+ if attributes.key?(:'message')
96
+ self.message = attributes[:'message']
97
+ else
98
+ self.message = nil
99
+ end
100
+
101
+ if attributes.key?(:'created_at')
102
+ self.created_at = attributes[:'created_at']
103
+ else
104
+ self.created_at = nil
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 @webhook_secret.nil?
118
+ invalid_properties.push('invalid value for "webhook_secret", webhook_secret cannot be nil.')
119
+ end
120
+
121
+ if @message.nil?
122
+ invalid_properties.push('invalid value for "message", message cannot be nil.')
123
+ end
124
+
125
+ if @created_at.nil?
126
+ invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
127
+ end
128
+
129
+ invalid_properties
130
+ end
131
+
132
+ # Check to see if the all the properties in the model are valid
133
+ # @return true if the model is valid
134
+ def valid?
135
+ warn '[DEPRECATED] the `valid?` method is obsolete'
136
+ return false if @success.nil?
137
+ return false if @webhook_secret.nil?
138
+ return false if @message.nil?
139
+ return false if @created_at.nil?
140
+ true
141
+ end
142
+
143
+ # Custom attribute writer method with validation
144
+ # @param [Object] success Value to be assigned
145
+ def success=(success)
146
+ if success.nil?
147
+ fail ArgumentError, 'success cannot be nil'
148
+ end
149
+
150
+ @success = success
151
+ end
152
+
153
+ # Custom attribute writer method with validation
154
+ # @param [Object] webhook_secret Value to be assigned
155
+ def webhook_secret=(webhook_secret)
156
+ if webhook_secret.nil?
157
+ fail ArgumentError, 'webhook_secret cannot be nil'
158
+ end
159
+
160
+ @webhook_secret = webhook_secret
161
+ end
162
+
163
+ # Custom attribute writer method with validation
164
+ # @param [Object] message Value to be assigned
165
+ def message=(message)
166
+ if message.nil?
167
+ fail ArgumentError, 'message cannot be nil'
168
+ end
169
+
170
+ @message = message
171
+ end
172
+
173
+ # Custom attribute writer method with validation
174
+ # @param [Object] created_at Value to be assigned
175
+ def created_at=(created_at)
176
+ if created_at.nil?
177
+ fail ArgumentError, 'created_at cannot be nil'
178
+ end
179
+
180
+ @created_at = created_at
181
+ end
182
+
183
+ # Checks equality by comparing each attribute.
184
+ # @param [Object] Object to be compared
185
+ def ==(o)
186
+ return true if self.equal?(o)
187
+ self.class == o.class &&
188
+ success == o.success &&
189
+ webhook_secret == o.webhook_secret &&
190
+ message == o.message &&
191
+ created_at == o.created_at
192
+ end
193
+
194
+ # @see the `==` method
195
+ # @param [Object] Object to be compared
196
+ def eql?(o)
197
+ self == o
198
+ end
199
+
200
+ # Calculates hash code according to all attributes.
201
+ # @return [Integer] Hash code
202
+ def hash
203
+ [success, webhook_secret, message, created_at].hash
204
+ end
205
+
206
+ # Builds the object from hash
207
+ # @param [Hash] attributes Model attributes in the form of hash
208
+ # @return [Object] Returns the model itself
209
+ def self.build_from_hash(attributes)
210
+ return nil unless attributes.is_a?(Hash)
211
+ attributes = attributes.transform_keys(&:to_sym)
212
+ transformed_hash = {}
213
+ openapi_types.each_pair do |key, type|
214
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
215
+ transformed_hash["#{key}"] = nil
216
+ elsif type =~ /\AArray<(.*)>/i
217
+ # check to ensure the input is an array given that the attribute
218
+ # is documented as an array but the input is not
219
+ if attributes[attribute_map[key]].is_a?(Array)
220
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
221
+ end
222
+ elsif !attributes[attribute_map[key]].nil?
223
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
224
+ end
225
+ end
226
+ new(transformed_hash)
227
+ end
228
+
229
+ # Returns the object in the form of hash
230
+ # @return [Hash] Returns the object in the form of hash
231
+ def to_hash
232
+ hash = {}
233
+ self.class.attribute_map.each_pair do |attr, param|
234
+ value = self.send(attr)
235
+ if value.nil?
236
+ is_nullable = self.class.openapi_nullable.include?(attr)
237
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
238
+ end
239
+
240
+ hash[param] = _to_hash(value)
241
+ end
242
+ hash
243
+ end
244
+
245
+ end
246
+
247
+ end
@@ -0,0 +1,176 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
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.20.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FactPulse
17
+ # Webhook secret status for a client.
18
+ class WebhookSecretStatusResponse < ApiModelBase
19
+ # Whether a webhook secret is configured
20
+ attr_accessor :has_secret
21
+
22
+ attr_accessor :created_at
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'has_secret' => :'hasSecret',
28
+ :'created_at' => :'createdAt'
29
+ }
30
+ end
31
+
32
+ # Returns attribute mapping this model knows about
33
+ def self.acceptable_attribute_map
34
+ attribute_map
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ acceptable_attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'has_secret' => :'Boolean',
46
+ :'created_at' => :'Time'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ :'created_at'
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::WebhookSecretStatusResponse` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ acceptable_attribute_map = self.class.acceptable_attribute_map
66
+ attributes = attributes.each_with_object({}) { |(k, v), h|
67
+ if (!acceptable_attribute_map.key?(k.to_sym))
68
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::WebhookSecretStatusResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
69
+ end
70
+ h[k.to_sym] = v
71
+ }
72
+
73
+ if attributes.key?(:'has_secret')
74
+ self.has_secret = attributes[:'has_secret']
75
+ else
76
+ self.has_secret = nil
77
+ end
78
+
79
+ if attributes.key?(:'created_at')
80
+ self.created_at = attributes[:'created_at']
81
+ end
82
+ end
83
+
84
+ # Show invalid properties with the reasons. Usually used together with valid?
85
+ # @return Array for valid properties with the reasons
86
+ def list_invalid_properties
87
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
88
+ invalid_properties = Array.new
89
+ if @has_secret.nil?
90
+ invalid_properties.push('invalid value for "has_secret", has_secret cannot be nil.')
91
+ end
92
+
93
+ invalid_properties
94
+ end
95
+
96
+ # Check to see if the all the properties in the model are valid
97
+ # @return true if the model is valid
98
+ def valid?
99
+ warn '[DEPRECATED] the `valid?` method is obsolete'
100
+ return false if @has_secret.nil?
101
+ true
102
+ end
103
+
104
+ # Custom attribute writer method with validation
105
+ # @param [Object] has_secret Value to be assigned
106
+ def has_secret=(has_secret)
107
+ if has_secret.nil?
108
+ fail ArgumentError, 'has_secret cannot be nil'
109
+ end
110
+
111
+ @has_secret = has_secret
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ has_secret == o.has_secret &&
120
+ created_at == o.created_at
121
+ end
122
+
123
+ # @see the `==` method
124
+ # @param [Object] Object to be compared
125
+ def eql?(o)
126
+ self == o
127
+ end
128
+
129
+ # Calculates hash code according to all attributes.
130
+ # @return [Integer] Hash code
131
+ def hash
132
+ [has_secret, created_at].hash
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def self.build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ transformed_hash = {}
142
+ openapi_types.each_pair do |key, type|
143
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
144
+ transformed_hash["#{key}"] = nil
145
+ elsif type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[attribute_map[key]].is_a?(Array)
149
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
150
+ end
151
+ elsif !attributes[attribute_map[key]].nil?
152
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
153
+ end
154
+ end
155
+ new(transformed_hash)
156
+ end
157
+
158
+ # Returns the object in the form of hash
159
+ # @return [Hash] Returns the object in the form of hash
160
+ def to_hash
161
+ hash = {}
162
+ self.class.attribute_map.each_pair do |attr, param|
163
+ value = self.send(attr)
164
+ if value.nil?
165
+ is_nullable = self.class.openapi_nullable.include?(attr)
166
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
167
+ end
168
+
169
+ hash[param] = _to_hash(value)
170
+ end
171
+ hash
172
+ end
173
+
174
+ end
175
+
176
+ end
@@ -0,0 +1,15 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
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.20.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ module FactPulse
14
+ VERSION = '0.1.0'
15
+ end