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,151 @@
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 'cgi'
14
+
15
+ module FactPulse
16
+ class DownloadsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Check if a file exists
23
+ # Check if a temporary file exists and get its metadata without downloading. Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time **Security**: Requires authentication, only file owner can check.
24
+ # @param download_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Object]
27
+ def check_file_api_v1_download_download_id_head(download_id, opts = {})
28
+ data, _status_code, _headers = check_file_api_v1_download_download_id_head_with_http_info(download_id, opts)
29
+ data
30
+ end
31
+
32
+ # Check if a file exists
33
+ # Check if a temporary file exists and get its metadata without downloading. Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time **Security**: Requires authentication, only file owner can check.
34
+ # @param download_id [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
37
+ def check_file_api_v1_download_download_id_head_with_http_info(download_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: DownloadsApi.check_file_api_v1_download_download_id_head ...'
40
+ end
41
+ # verify the required parameter 'download_id' is set
42
+ if @api_client.config.client_side_validation && download_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.check_file_api_v1_download_download_id_head"
44
+ end
45
+ # resource path
46
+ local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'Object'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"DownloadsApi.check_file_api_v1_download_download_id_head",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: DownloadsApi#check_file_api_v1_download_download_id_head\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # Download a temporary file
86
+ # Download a file stored temporarily after asynchronous processing. **Usage**: - This URL is provided in webhook notifications when using `webhook_mode: \"download_url\"` - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
87
+ # @param download_id [String]
88
+ # @param [Hash] opts the optional parameters
89
+ # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
90
+ # @return [Object]
91
+ def download_file_api_v1_download_download_id_get(download_id, opts = {})
92
+ data, _status_code, _headers = download_file_api_v1_download_download_id_get_with_http_info(download_id, opts)
93
+ data
94
+ end
95
+
96
+ # Download a temporary file
97
+ # Download a file stored temporarily after asynchronous processing. **Usage**: - This URL is provided in webhook notifications when using &#x60;webhook_mode: \&quot;download_url\&quot;&#x60; - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
98
+ # @param download_id [String]
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
101
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
102
+ def download_file_api_v1_download_download_id_get_with_http_info(download_id, opts = {})
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug 'Calling API: DownloadsApi.download_file_api_v1_download_download_id_get ...'
105
+ end
106
+ # verify the required parameter 'download_id' is set
107
+ if @api_client.config.client_side_validation && download_id.nil?
108
+ fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.download_file_api_v1_download_download_id_get"
109
+ end
110
+ # resource path
111
+ local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
112
+
113
+ # query parameters
114
+ query_params = opts[:query_params] || {}
115
+ query_params[:'delete_after'] = opts[:'delete_after'] if !opts[:'delete_after'].nil?
116
+
117
+ # header parameters
118
+ header_params = opts[:header_params] || {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf', 'application/xml', 'application/octet-stream']) unless header_params['Accept']
121
+
122
+ # form parameters
123
+ form_params = opts[:form_params] || {}
124
+
125
+ # http body (model)
126
+ post_body = opts[:debug_body]
127
+
128
+ # return_type
129
+ return_type = opts[:debug_return_type] || 'Object'
130
+
131
+ # auth_names
132
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
133
+
134
+ new_options = opts.merge(
135
+ :operation => :"DownloadsApi.download_file_api_v1_download_download_id_get",
136
+ :header_params => header_params,
137
+ :query_params => query_params,
138
+ :form_params => form_params,
139
+ :body => post_body,
140
+ :auth_names => auth_names,
141
+ :return_type => return_type
142
+ )
143
+
144
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
145
+ if @api_client.config.debugging
146
+ @api_client.config.logger.debug "API called: DownloadsApi#download_file_api_v1_download_download_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
147
+ end
148
+ return data, status_code, headers
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,339 @@
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 'cgi'
14
+
15
+ module FactPulse
16
+ class ElectronicSignatureApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Generate a self-signed X.509 test certificate
23
+ # Generates a self-signed X.509 certificate for PDF electronic signature testing. **⚠️ WARNING: TEST certificate only!** This certificate is: - ✅ Suitable for testing and development - ✅ Compatible with PDF signing (PAdES) - ✅ Compliant with eIDAS **SES** level (Simple Electronic Signature) - ❌ **NEVER usable in production** - ❌ **Not recognized** by browsers and PDF readers - ❌ **No legal value** ## eIDAS levels - **SES** (Simple): Self-signed certificate ← Generated by this endpoint - **AdES** (Advanced): Commercial CA certificate (Let's Encrypt, etc.) - **QES** (Qualified): Qualified certificate from QTSP (CertEurope, Universign, etc.) ## Usage Once generated, the certificate can be: 1. **Saved in Django** (recommended): - Django Admin > Signing Certificates - Upload `certificate_pem` and `private_key_pem` 2. **Used directly**: - Sign a PDF with `/sign-pdf` - The certificate will be automatically used ## Example call ```bash curl -X POST \"https://factpulse.fr/api/v1/processing/generate-test-certificate\" \\ -H \"Authorization: Bearer eyJ0eXAi...\" \\ -H \"Content-Type: application/json\" \\ -d '{ \"cn\": \"Test Client XYZ\", \"organization\": \"Client XYZ Ltd\", \"email\": \"contact@xyz.com\", \"validity_days\": 365 }' ``` ## Use cases - PDF signature testing in development - Electronic signature POC - Training and demos - Automated integration tests ## Technical compliance Certificate generated with: - RSA key 2048 or 4096 bits - SHA-256 algorithm - Key Usage extensions: `digitalSignature`, `contentCommitment` (non-repudiation) - Extended Key Usage extensions: `codeSigning`, `emailProtection` - Validity: 1 day to 10 years (configurable) - Format: PEM (certificate and key) - Optional: PKCS#12 (.p12)
24
+ # @param generate_certificate_request [GenerateCertificateRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [GenerateCertificateResponse]
27
+ def generate_test_certificate_api_v1_processing_generate_test_certificate_post(generate_certificate_request, opts = {})
28
+ data, _status_code, _headers = generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info(generate_certificate_request, opts)
29
+ data
30
+ end
31
+
32
+ # Generate a self-signed X.509 test certificate
33
+ # Generates a self-signed X.509 certificate for PDF electronic signature testing. **⚠️ WARNING: TEST certificate only!** This certificate is: - ✅ Suitable for testing and development - ✅ Compatible with PDF signing (PAdES) - ✅ Compliant with eIDAS **SES** level (Simple Electronic Signature) - ❌ **NEVER usable in production** - ❌ **Not recognized** by browsers and PDF readers - ❌ **No legal value** ## eIDAS levels - **SES** (Simple): Self-signed certificate ← Generated by this endpoint - **AdES** (Advanced): Commercial CA certificate (Let&#39;s Encrypt, etc.) - **QES** (Qualified): Qualified certificate from QTSP (CertEurope, Universign, etc.) ## Usage Once generated, the certificate can be: 1. **Saved in Django** (recommended): - Django Admin &gt; Signing Certificates - Upload &#x60;certificate_pem&#x60; and &#x60;private_key_pem&#x60; 2. **Used directly**: - Sign a PDF with &#x60;/sign-pdf&#x60; - The certificate will be automatically used ## Example call &#x60;&#x60;&#x60;bash curl -X POST \&quot;https://factpulse.fr/api/v1/processing/generate-test-certificate\&quot; \\ -H \&quot;Authorization: Bearer eyJ0eXAi...\&quot; \\ -H \&quot;Content-Type: application/json\&quot; \\ -d &#39;{ \&quot;cn\&quot;: \&quot;Test Client XYZ\&quot;, \&quot;organization\&quot;: \&quot;Client XYZ Ltd\&quot;, \&quot;email\&quot;: \&quot;contact@xyz.com\&quot;, \&quot;validity_days\&quot;: 365 }&#39; &#x60;&#x60;&#x60; ## Use cases - PDF signature testing in development - Electronic signature POC - Training and demos - Automated integration tests ## Technical compliance Certificate generated with: - RSA key 2048 or 4096 bits - SHA-256 algorithm - Key Usage extensions: &#x60;digitalSignature&#x60;, &#x60;contentCommitment&#x60; (non-repudiation) - Extended Key Usage extensions: &#x60;codeSigning&#x60;, &#x60;emailProtection&#x60; - Validity: 1 day to 10 years (configurable) - Format: PEM (certificate and key) - Optional: PKCS#12 (.p12)
34
+ # @param generate_certificate_request [GenerateCertificateRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(GenerateCertificateResponse, Integer, Hash)>] GenerateCertificateResponse data, response status code and response headers
37
+ def generate_test_certificate_api_v1_processing_generate_test_certificate_post_with_http_info(generate_certificate_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ElectronicSignatureApi.generate_test_certificate_api_v1_processing_generate_test_certificate_post ...'
40
+ end
41
+ # verify the required parameter 'generate_certificate_request' is set
42
+ if @api_client.config.client_side_validation && generate_certificate_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'generate_certificate_request' when calling ElectronicSignatureApi.generate_test_certificate_api_v1_processing_generate_test_certificate_post"
44
+ end
45
+ # resource path
46
+ local_var_path = '/api/v1/processing/generate-test-certificate'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(generate_certificate_request)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'GenerateCertificateResponse'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"ElectronicSignatureApi.generate_test_certificate_api_v1_processing_generate_test_certificate_post",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: ElectronicSignatureApi#generate_test_certificate_api_v1_processing_generate_test_certificate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Sign a PDF with client's certificate (PAdES-B-LT)
91
+ # Signs an uploaded PDF with the electronic certificate configured for the client (via client_uid from JWT). **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **eIDAS levels**: SES (self-signed), AdES (commercial CA), QES (PSCO - out of scope). **Security**: Double authentication X-Internal-Secret + JWT Bearer to retrieve the certificate. **⚠️ Legal disclaimer**: Generated signatures are electronic seals as defined by the eIDAS regulation. The level of legal validity depends on the certificate used (SES/AdES/QES). FactPulse does not provide QES qualified certificates - you must obtain a certificate from a PSCO (qualified Trust Service Provider) for maximum legal validity.
92
+ # @param pdf_file [File] PDF file to sign (will be processed and returned signed in base64)
93
+ # @param [Hash] opts the optional parameters
94
+ # @option opts [String] :reason
95
+ # @option opts [String] :location
96
+ # @option opts [String] :contact
97
+ # @option opts [String] :field_name PDF signature field name (default to 'FactPulseSignature')
98
+ # @option opts [Boolean] :use_pades_lt Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. (default to false)
99
+ # @option opts [Boolean] :use_timestamp Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) (default to true)
100
+ # @return [Object]
101
+ def sign_pdf_api_v1_processing_sign_pdf_post(pdf_file, opts = {})
102
+ data, _status_code, _headers = sign_pdf_api_v1_processing_sign_pdf_post_with_http_info(pdf_file, opts)
103
+ data
104
+ end
105
+
106
+ # Sign a PDF with client&#39;s certificate (PAdES-B-LT)
107
+ # Signs an uploaded PDF with the electronic certificate configured for the client (via client_uid from JWT). **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **eIDAS levels**: SES (self-signed), AdES (commercial CA), QES (PSCO - out of scope). **Security**: Double authentication X-Internal-Secret + JWT Bearer to retrieve the certificate. **⚠️ Legal disclaimer**: Generated signatures are electronic seals as defined by the eIDAS regulation. The level of legal validity depends on the certificate used (SES/AdES/QES). FactPulse does not provide QES qualified certificates - you must obtain a certificate from a PSCO (qualified Trust Service Provider) for maximum legal validity.
108
+ # @param pdf_file [File] PDF file to sign (will be processed and returned signed in base64)
109
+ # @param [Hash] opts the optional parameters
110
+ # @option opts [String] :reason
111
+ # @option opts [String] :location
112
+ # @option opts [String] :contact
113
+ # @option opts [String] :field_name PDF signature field name (default to 'FactPulseSignature')
114
+ # @option opts [Boolean] :use_pades_lt Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. (default to false)
115
+ # @option opts [Boolean] :use_timestamp Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) (default to true)
116
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
117
+ def sign_pdf_api_v1_processing_sign_pdf_post_with_http_info(pdf_file, opts = {})
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug 'Calling API: ElectronicSignatureApi.sign_pdf_api_v1_processing_sign_pdf_post ...'
120
+ end
121
+ # verify the required parameter 'pdf_file' is set
122
+ if @api_client.config.client_side_validation && pdf_file.nil?
123
+ fail ArgumentError, "Missing the required parameter 'pdf_file' when calling ElectronicSignatureApi.sign_pdf_api_v1_processing_sign_pdf_post"
124
+ end
125
+ # resource path
126
+ local_var_path = '/api/v1/processing/sign-pdf'
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ # HTTP header 'Accept' (if needed)
134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
135
+ # HTTP header 'Content-Type'
136
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
137
+ if !content_type.nil?
138
+ header_params['Content-Type'] = content_type
139
+ end
140
+
141
+ # form parameters
142
+ form_params = opts[:form_params] || {}
143
+ form_params['pdf_file'] = pdf_file
144
+ form_params['reason'] = opts[:'reason'] if !opts[:'reason'].nil?
145
+ form_params['location'] = opts[:'location'] if !opts[:'location'].nil?
146
+ form_params['contact'] = opts[:'contact'] if !opts[:'contact'].nil?
147
+ form_params['field_name'] = opts[:'field_name'] if !opts[:'field_name'].nil?
148
+ form_params['use_pades_lt'] = opts[:'use_pades_lt'] if !opts[:'use_pades_lt'].nil?
149
+ form_params['use_timestamp'] = opts[:'use_timestamp'] if !opts[:'use_timestamp'].nil?
150
+
151
+ # http body (model)
152
+ post_body = opts[:debug_body]
153
+
154
+ # return_type
155
+ return_type = opts[:debug_return_type] || 'Object'
156
+
157
+ # auth_names
158
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
159
+
160
+ new_options = opts.merge(
161
+ :operation => :"ElectronicSignatureApi.sign_pdf_api_v1_processing_sign_pdf_post",
162
+ :header_params => header_params,
163
+ :query_params => query_params,
164
+ :form_params => form_params,
165
+ :body => post_body,
166
+ :auth_names => auth_names,
167
+ :return_type => return_type
168
+ )
169
+
170
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug "API called: ElectronicSignatureApi#sign_pdf_api_v1_processing_sign_pdf_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
173
+ end
174
+ return data, status_code, headers
175
+ end
176
+
177
+ # Sign a PDF asynchronously (Celery)
178
+ # Signs an uploaded PDF asynchronously via a Celery task. **Difference with /sign-pdf**: - `/sign-pdf`: Synchronous signature (blocking until completion) - `/sign-pdf-async`: Asynchronous signature (returns immediately with task_id) **Async advantages**: - No timeout for large files - No blocking of FastAPI worker - Progress tracking via task_id - Ideal for batch processing **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **⚠️ Legal disclaimer**: Same as /sign-pdf (see that endpoint's documentation).
179
+ # @param pdf_file [File] PDF file to sign (processed asynchronously)
180
+ # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :callback_url
182
+ # @option opts [String] :webhook_mode Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) (default to 'inline')
183
+ # @option opts [String] :reason
184
+ # @option opts [String] :location
185
+ # @option opts [String] :contact
186
+ # @option opts [String] :field_name PDF signature field name (default to 'FactPulseSignature')
187
+ # @option opts [Boolean] :use_pades_lt Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. (default to false)
188
+ # @option opts [Boolean] :use_timestamp Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) (default to true)
189
+ # @return [Object]
190
+ def sign_pdf_async_api_v1_processing_sign_pdf_async_post(pdf_file, opts = {})
191
+ data, _status_code, _headers = sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info(pdf_file, opts)
192
+ data
193
+ end
194
+
195
+ # Sign a PDF asynchronously (Celery)
196
+ # Signs an uploaded PDF asynchronously via a Celery task. **Difference with /sign-pdf**: - &#x60;/sign-pdf&#x60;: Synchronous signature (blocking until completion) - &#x60;/sign-pdf-async&#x60;: Asynchronous signature (returns immediately with task_id) **Async advantages**: - No timeout for large files - No blocking of FastAPI worker - Progress tracking via task_id - Ideal for batch processing **Supported standards**: PAdES-B-B, PAdES-B-T (timestamping), PAdES-B-LT (long-term archiving). **⚠️ Legal disclaimer**: Same as /sign-pdf (see that endpoint&#39;s documentation).
197
+ # @param pdf_file [File] PDF file to sign (processed asynchronously)
198
+ # @param [Hash] opts the optional parameters
199
+ # @option opts [String] :callback_url
200
+ # @option opts [String] :webhook_mode Webhook content delivery: &#39;inline&#39; (base64 in payload) or &#39;download_url&#39; (temporary URL, 1h TTL) (default to 'inline')
201
+ # @option opts [String] :reason
202
+ # @option opts [String] :location
203
+ # @option opts [String] :contact
204
+ # @option opts [String] :field_name PDF signature field name (default to 'FactPulseSignature')
205
+ # @option opts [Boolean] :use_pades_lt Enable PAdES-B-LT (long-term archiving with embedded validation data). REQUIRES a certificate with OCSP/CRL access. (default to false)
206
+ # @option opts [Boolean] :use_timestamp Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) (default to true)
207
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
208
+ def sign_pdf_async_api_v1_processing_sign_pdf_async_post_with_http_info(pdf_file, opts = {})
209
+ if @api_client.config.debugging
210
+ @api_client.config.logger.debug 'Calling API: ElectronicSignatureApi.sign_pdf_async_api_v1_processing_sign_pdf_async_post ...'
211
+ end
212
+ # verify the required parameter 'pdf_file' is set
213
+ if @api_client.config.client_side_validation && pdf_file.nil?
214
+ fail ArgumentError, "Missing the required parameter 'pdf_file' when calling ElectronicSignatureApi.sign_pdf_async_api_v1_processing_sign_pdf_async_post"
215
+ end
216
+ # resource path
217
+ local_var_path = '/api/v1/processing/sign-pdf-async'
218
+
219
+ # query parameters
220
+ query_params = opts[:query_params] || {}
221
+
222
+ # header parameters
223
+ header_params = opts[:header_params] || {}
224
+ # HTTP header 'Accept' (if needed)
225
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
226
+ # HTTP header 'Content-Type'
227
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
228
+ if !content_type.nil?
229
+ header_params['Content-Type'] = content_type
230
+ end
231
+
232
+ # form parameters
233
+ form_params = opts[:form_params] || {}
234
+ form_params['pdf_file'] = pdf_file
235
+ form_params['callback_url'] = opts[:'callback_url'] if !opts[:'callback_url'].nil?
236
+ form_params['webhook_mode'] = opts[:'webhook_mode'] if !opts[:'webhook_mode'].nil?
237
+ form_params['reason'] = opts[:'reason'] if !opts[:'reason'].nil?
238
+ form_params['location'] = opts[:'location'] if !opts[:'location'].nil?
239
+ form_params['contact'] = opts[:'contact'] if !opts[:'contact'].nil?
240
+ form_params['field_name'] = opts[:'field_name'] if !opts[:'field_name'].nil?
241
+ form_params['use_pades_lt'] = opts[:'use_pades_lt'] if !opts[:'use_pades_lt'].nil?
242
+ form_params['use_timestamp'] = opts[:'use_timestamp'] if !opts[:'use_timestamp'].nil?
243
+
244
+ # http body (model)
245
+ post_body = opts[:debug_body]
246
+
247
+ # return_type
248
+ return_type = opts[:debug_return_type] || 'Object'
249
+
250
+ # auth_names
251
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
252
+
253
+ new_options = opts.merge(
254
+ :operation => :"ElectronicSignatureApi.sign_pdf_async_api_v1_processing_sign_pdf_async_post",
255
+ :header_params => header_params,
256
+ :query_params => query_params,
257
+ :form_params => form_params,
258
+ :body => post_body,
259
+ :auth_names => auth_names,
260
+ :return_type => return_type
261
+ )
262
+
263
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug "API called: ElectronicSignatureApi#sign_pdf_async_api_v1_processing_sign_pdf_async_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
266
+ end
267
+ return data, status_code, headers
268
+ end
269
+
270
+ # Validate electronic signatures of a PDF
271
+ # Validates electronic signatures present in an uploaded PDF. **Verifications performed**: - Presence of signatures - Document integrity (not modified since signing) - Certificate validity - Chain of trust (if available) - Presence of timestamp (PAdES-B-T) - Validation data (PAdES-B-LT) **Supported standards**: PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note**: This validation is technical (cryptographic integrity). Legal validity depends on the eIDAS level of the certificate (SES/AdES/QES) and the context of use.
272
+ # @param pdf_file [File] PDF file to validate (will be analyzed to detect and validate signatures)
273
+ # @param [Hash] opts the optional parameters
274
+ # @return [Object]
275
+ def validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post(pdf_file, opts = {})
276
+ data, _status_code, _headers = validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info(pdf_file, opts)
277
+ data
278
+ end
279
+
280
+ # Validate electronic signatures of a PDF
281
+ # Validates electronic signatures present in an uploaded PDF. **Verifications performed**: - Presence of signatures - Document integrity (not modified since signing) - Certificate validity - Chain of trust (if available) - Presence of timestamp (PAdES-B-T) - Validation data (PAdES-B-LT) **Supported standards**: PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note**: This validation is technical (cryptographic integrity). Legal validity depends on the eIDAS level of the certificate (SES/AdES/QES) and the context of use.
282
+ # @param pdf_file [File] PDF file to validate (will be analyzed to detect and validate signatures)
283
+ # @param [Hash] opts the optional parameters
284
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
285
+ def validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post_with_http_info(pdf_file, opts = {})
286
+ if @api_client.config.debugging
287
+ @api_client.config.logger.debug 'Calling API: ElectronicSignatureApi.validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post ...'
288
+ end
289
+ # verify the required parameter 'pdf_file' is set
290
+ if @api_client.config.client_side_validation && pdf_file.nil?
291
+ fail ArgumentError, "Missing the required parameter 'pdf_file' when calling ElectronicSignatureApi.validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post"
292
+ end
293
+ # resource path
294
+ local_var_path = '/api/v1/processing/validate-pdf-signature'
295
+
296
+ # query parameters
297
+ query_params = opts[:query_params] || {}
298
+
299
+ # header parameters
300
+ header_params = opts[:header_params] || {}
301
+ # HTTP header 'Accept' (if needed)
302
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
303
+ # HTTP header 'Content-Type'
304
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
305
+ if !content_type.nil?
306
+ header_params['Content-Type'] = content_type
307
+ end
308
+
309
+ # form parameters
310
+ form_params = opts[:form_params] || {}
311
+ form_params['pdf_file'] = pdf_file
312
+
313
+ # http body (model)
314
+ post_body = opts[:debug_body]
315
+
316
+ # return_type
317
+ return_type = opts[:debug_return_type] || 'Object'
318
+
319
+ # auth_names
320
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
321
+
322
+ new_options = opts.merge(
323
+ :operation => :"ElectronicSignatureApi.validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post",
324
+ :header_params => header_params,
325
+ :query_params => query_params,
326
+ :form_params => form_params,
327
+ :body => post_body,
328
+ :auth_names => auth_names,
329
+ :return_type => return_type
330
+ )
331
+
332
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
333
+ if @api_client.config.debugging
334
+ @api_client.config.logger.debug "API called: ElectronicSignatureApi#validate_pdf_signature_endpoint_api_v1_processing_validate_pdf_signature_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
335
+ end
336
+ return data, status_code, headers
337
+ end
338
+ end
339
+ end