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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +74 -0
- data/LICENSE +21 -0
- data/README.md +220 -0
- data/Rakefile +10 -0
- data/docs/AFNORAcknowledgement.md +20 -0
- data/docs/AFNORAcknowledgementDetail.md +24 -0
- data/docs/AFNORAddressEdit.md +30 -0
- data/docs/AFNORAddressPatch.md +30 -0
- data/docs/AFNORAddressPut.md +30 -0
- data/docs/AFNORAddressRead.md +32 -0
- data/docs/AFNORAlgorithm.md +15 -0
- data/docs/AFNORContainsOperator.md +15 -0
- data/docs/AFNORCreateDirectoryLineBody.md +20 -0
- data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +24 -0
- data/docs/AFNORCreateDirectoryLineBodyPeriod.md +20 -0
- data/docs/AFNORCreateRoutingCodeBody.md +32 -0
- data/docs/AFNORCredentials.md +22 -0
- data/docs/AFNORDestination.md +26 -0
- data/docs/AFNORDiffusionStatus.md +15 -0
- data/docs/AFNORDirectoryLineField.md +15 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md +32 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +20 -0
- data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md +28 -0
- data/docs/AFNORDirectoryLinePost201Response.md +22 -0
- data/docs/AFNORDirectoryLineSearchPost200Response.md +22 -0
- data/docs/AFNOREntityType.md +15 -0
- data/docs/AFNORError.md +26 -0
- data/docs/AFNORFacilityAdministrativeStatus.md +15 -0
- data/docs/AFNORFacilityNature.md +15 -0
- data/docs/AFNORFacilityPayloadHistory.md +34 -0
- data/docs/AFNORFacilityPayloadHistoryUleB2gAdditionalData.md +28 -0
- data/docs/AFNORFacilityPayloadIncluded.md +32 -0
- data/docs/AFNORFacilityType.md +15 -0
- data/docs/AFNORFlow.md +38 -0
- data/docs/AFNORFlowAckStatus.md +15 -0
- data/docs/AFNORFlowDirection.md +15 -0
- data/docs/AFNORFlowInfo.md +28 -0
- data/docs/AFNORFlowProfile.md +15 -0
- data/docs/AFNORFlowSyntax.md +15 -0
- data/docs/AFNORFlowType.md +15 -0
- data/docs/AFNORFullFlowInfo.md +32 -0
- data/docs/AFNORHealthCheckResponse.md +22 -0
- data/docs/AFNORLegalUnitAdministrativeStatus.md +15 -0
- data/docs/AFNORLegalUnitPayloadHistory.md +24 -0
- data/docs/AFNORLegalUnitPayloadIncluded.md +24 -0
- data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +22 -0
- data/docs/AFNORPDPPAApi.md +150 -0
- data/docs/AFNORPDPPADirectoryServiceApi.md +1223 -0
- data/docs/AFNORPDPPAFlowServiceApi.md +270 -0
- data/docs/AFNORPlatformStatus.md +15 -0
- data/docs/AFNORProcessingRule.md +15 -0
- data/docs/AFNORReasonCode.md +49 -0
- data/docs/AFNORReasonCodeEnum.md +15 -0
- data/docs/AFNORRecipientPlatformType.md +15 -0
- data/docs/AFNORResult.md +32 -0
- data/docs/AFNORRoutingCodeAdministrativeStatus.md +15 -0
- data/docs/AFNORRoutingCodeField.md +15 -0
- data/docs/AFNORRoutingCodePayloadHistoryLegalUnitFacility.md +34 -0
- data/docs/AFNORRoutingCodePost201Response.md +22 -0
- data/docs/AFNORRoutingCodeSearch.md +28 -0
- data/docs/AFNORRoutingCodeSearchFilters.md +30 -0
- data/docs/AFNORRoutingCodeSearchFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +20 -0
- data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +20 -0
- data/docs/AFNORRoutingCodeSearchPost200Response.md +22 -0
- data/docs/AFNORRoutingCodeSearchSortingInner.md +20 -0
- data/docs/AFNORSearchDirectoryLine.md +26 -0
- data/docs/AFNORSearchDirectoryLineFilters.md +26 -0
- data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +20 -0
- data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +20 -0
- data/docs/AFNORSearchDirectoryLineSortingInner.md +20 -0
- data/docs/AFNORSearchFlowContent.md +22 -0
- data/docs/AFNORSearchFlowFilters.md +30 -0
- data/docs/AFNORSearchFlowParams.md +20 -0
- data/docs/AFNORSearchSiren.md +26 -0
- data/docs/AFNORSearchSirenFilters.md +24 -0
- data/docs/AFNORSearchSirenFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORSearchSirenFiltersBusinessName.md +20 -0
- data/docs/AFNORSearchSirenFiltersEntityType.md +20 -0
- data/docs/AFNORSearchSirenFiltersSiren.md +20 -0
- data/docs/AFNORSearchSirenSortingInner.md +20 -0
- data/docs/AFNORSearchSiret.md +28 -0
- data/docs/AFNORSearchSiretFilters.md +34 -0
- data/docs/AFNORSearchSiretFiltersAddressLines.md +20 -0
- data/docs/AFNORSearchSiretFiltersAdministrativeStatus.md +20 -0
- data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +20 -0
- data/docs/AFNORSearchSiretFiltersFacilityType.md +20 -0
- data/docs/AFNORSearchSiretFiltersLocality.md +20 -0
- data/docs/AFNORSearchSiretFiltersName.md +20 -0
- data/docs/AFNORSearchSiretFiltersPostalCode.md +20 -0
- data/docs/AFNORSearchSiretFiltersSiret.md +20 -0
- data/docs/AFNORSearchSiretSortingInner.md +20 -0
- data/docs/AFNORSirenField.md +15 -0
- data/docs/AFNORSirenSearchPost200Response.md +22 -0
- data/docs/AFNORSiretField.md +15 -0
- data/docs/AFNORSiretSearchPost200Response.md +22 -0
- data/docs/AFNORSortingOrder.md +15 -0
- data/docs/AFNORStrictOperator.md +15 -0
- data/docs/AFNORUpdatePatchDirectoryLineBody.md +18 -0
- data/docs/AFNORUpdatePatchRoutingCodeBody.md +24 -0
- data/docs/AFNORUpdatePutRoutingCodeBody.md +24 -0
- data/docs/AFNORWebhookCallbackContent.md +18 -0
- data/docs/APIError.md +22 -0
- data/docs/APIProfile.md +15 -0
- data/docs/AcknowledgmentStatus.md +15 -0
- data/docs/ActionCodeInfo.md +22 -0
- data/docs/ActionCodesResponse.md +22 -0
- data/docs/AdditionalDocument.md +26 -0
- data/docs/AggregatedPaymentInput.md +22 -0
- data/docs/AggregatedTransactionInput.md +32 -0
- data/docs/AllowanceCharge.md +32 -0
- data/docs/AllowanceChargeReasonCode.md +15 -0
- data/docs/AllowanceReasonCode.md +15 -0
- data/docs/AllowanceTotalAmount.md +15 -0
- data/docs/Amount.md +15 -0
- data/docs/Amount1.md +15 -0
- data/docs/Amount2.md +15 -0
- data/docs/AmountDue.md +15 -0
- data/docs/AsyncTaskStatus.md +22 -0
- data/docs/AsyncTasksApi.md +82 -0
- data/docs/BaseAmount.md +15 -0
- data/docs/BoundingBoxSchema.md +30 -0
- data/docs/Buyercountry.md +15 -0
- data/docs/CeleryStatus.md +15 -0
- data/docs/CertificateInfoResponse.md +40 -0
- data/docs/ChargeTotalAmount.md +15 -0
- data/docs/ChorusProApi.md +1207 -0
- data/docs/ChorusProCredentials.md +26 -0
- data/docs/ChorusProDestination.md +20 -0
- data/docs/ChorusProResult.md +22 -0
- data/docs/ClientActivateResponse.md +22 -0
- data/docs/ClientCreateRequest.md +22 -0
- data/docs/ClientDetail.md +38 -0
- data/docs/ClientListResponse.md +24 -0
- data/docs/ClientManagementApi.md +921 -0
- data/docs/ClientSummary.md +38 -0
- data/docs/ClientUpdateRequest.md +22 -0
- data/docs/Contact.md +24 -0
- data/docs/ConvertResumeRequest.md +18 -0
- data/docs/ConvertSuccessResponse.md +36 -0
- data/docs/ConvertValidationFailedResponse.md +34 -0
- data/docs/CountryCode.md +15 -0
- data/docs/CreateAggregatedReportRequest.md +36 -0
- data/docs/CreateCDARRequest.md +52 -0
- data/docs/CreateEReportingRequest.md +38 -0
- data/docs/Currency.md +15 -0
- data/docs/CurrencyCode.md +15 -0
- data/docs/DeliveryParty.md +24 -0
- data/docs/Destination.md +79 -0
- data/docs/DocType.md +15 -0
- data/docs/DocumentTypeInfo.md +22 -0
- data/docs/DownloadsApi.md +161 -0
- data/docs/EReportingFlowType.md +15 -0
- data/docs/EReportingValidationError.md +22 -0
- data/docs/ElectronicAddress.md +20 -0
- data/docs/ElectronicSignatureApi.md +339 -0
- data/docs/Encaisseamount.md +15 -0
- data/docs/Encaisseamount1.md +15 -0
- data/docs/EncaisseeRequest.md +40 -0
- data/docs/EnrichedInvoiceInfo.md +32 -0
- data/docs/ErrorLevel.md +15 -0
- data/docs/ErrorSource.md +15 -0
- data/docs/ExtractionInfo.md +24 -0
- data/docs/FacturXConversionApi.md +319 -0
- data/docs/FacturXGenerationApi.md +254 -0
- data/docs/FacturXInvoice.md +76 -0
- data/docs/FacturXPDFInfo.md +22 -0
- data/docs/FacturXPDFXMLVerificationApi.md +240 -0
- data/docs/FacturXValidationApi.md +256 -0
- data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
- data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
- data/docs/FieldStatus.md +15 -0
- data/docs/FileInfo.md +20 -0
- data/docs/FilesInfo.md +20 -0
- data/docs/FlowDirection.md +15 -0
- data/docs/FlowProfile.md +15 -0
- data/docs/FlowSummary.md +32 -0
- data/docs/FlowSyntax.md +15 -0
- data/docs/FlowType.md +15 -0
- data/docs/Flux10EReportingApi.md +814 -0
- data/docs/Flux6InvoiceLifecycleCDARApi.md +698 -0
- data/docs/GenerateAggregatedReportResponse.md +30 -0
- data/docs/GenerateCDARResponse.md +26 -0
- data/docs/GenerateCertificateRequest.md +38 -0
- data/docs/GenerateCertificateResponse.md +32 -0
- data/docs/GenerateEReportingResponse.md +26 -0
- data/docs/GetChorusProIdRequest.md +22 -0
- data/docs/GetChorusProIdResponse.md +24 -0
- data/docs/GetInvoiceRequest.md +20 -0
- data/docs/GetInvoiceResponse.md +34 -0
- data/docs/GetStructureRequest.md +22 -0
- data/docs/GetStructureResponse.md +34 -0
- data/docs/GlobalAllowanceAmount.md +15 -0
- data/docs/GrossUnitPrice.md +15 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +203 -0
- data/docs/IncomingInvoice.md +54 -0
- data/docs/IncomingSupplier.md +32 -0
- data/docs/InvoiceFormat.md +15 -0
- data/docs/InvoiceInput.md +50 -0
- data/docs/InvoiceLine.md +84 -0
- data/docs/InvoiceLineAllowanceAmount.md +15 -0
- data/docs/InvoiceNote.md +20 -0
- data/docs/InvoicePaymentInput.md +26 -0
- data/docs/InvoiceReferences.md +52 -0
- data/docs/InvoiceStatus.md +22 -0
- data/docs/InvoiceTotals.md +38 -0
- data/docs/InvoiceTotalsPrepayment.md +15 -0
- data/docs/InvoiceTypeCode.md +15 -0
- data/docs/InvoiceTypeCodeOutput.md +15 -0
- data/docs/InvoicingFramework.md +24 -0
- data/docs/InvoicingFrameworkCode.md +15 -0
- data/docs/IssuerRoleCode.md +15 -0
- data/docs/KeyRotationRequest.md +20 -0
- data/docs/KeyRotationResponse.md +24 -0
- data/docs/LineNetAmount.md +15 -0
- data/docs/LineSubType.md +15 -0
- data/docs/LineTotalAmount.md +15 -0
- data/docs/LocationInner.md +15 -0
- data/docs/MandatoryNoteSchema.md +30 -0
- data/docs/ManualRate.md +15 -0
- data/docs/ManualVatRate.md +15 -0
- data/docs/MissingField.md +28 -0
- data/docs/OperationNature.md +15 -0
- data/docs/OutputFormat.md +15 -0
- data/docs/PDFValidationResultAPI.md +62 -0
- data/docs/PDPConfigResponse.md +46 -0
- data/docs/PDPConfigUpdateRequest.md +30 -0
- data/docs/PDPCredentials.md +26 -0
- data/docs/PageDimensionsSchema.md +20 -0
- data/docs/Payee.md +32 -0
- data/docs/PaymentAmountByRate.md +20 -0
- data/docs/PaymentCard.md +20 -0
- data/docs/PaymentMeans.md +15 -0
- data/docs/Percentage.md +15 -0
- data/docs/PostalAddress.md +30 -0
- data/docs/PriceAllowanceAmount.md +15 -0
- data/docs/PriceBasisQuantity.md +15 -0
- data/docs/ProcessingOptions.md +24 -0
- data/docs/ProcessingRule.md +15 -0
- data/docs/ProductCharacteristic.md +20 -0
- data/docs/ProductClassification.md +22 -0
- data/docs/Quantity.md +15 -0
- data/docs/Rate.md +15 -0
- data/docs/Rate1.md +15 -0
- data/docs/ReasonCodeInfo.md +22 -0
- data/docs/ReasonCodesResponse.md +22 -0
- data/docs/Recipient.md +34 -0
- data/docs/RecipientInput.md +26 -0
- data/docs/RefuseeRequest.md +40 -0
- data/docs/ReportIssuer.md +24 -0
- data/docs/ReportPeriod.md +20 -0
- data/docs/ReportSender.md +22 -0
- data/docs/RoundingAmount.md +15 -0
- data/docs/SchematronValidationError.md +32 -0
- data/docs/SchemeID.md +15 -0
- data/docs/SearchFlowRequest.md +34 -0
- data/docs/SearchFlowResponse.md +24 -0
- data/docs/SearchServicesResponse.md +24 -0
- data/docs/SearchStructureRequest.md +26 -0
- data/docs/SearchStructureResponse.md +24 -0
- data/docs/SecretStatus.md +24 -0
- data/docs/Sellercountry.md +15 -0
- data/docs/SignatureInfo.md +22 -0
- data/docs/SignatureInfoAPI.md +28 -0
- data/docs/SignatureParameters.md +34 -0
- data/docs/SimplifiedCDARResponse.md +26 -0
- data/docs/SimplifiedInvoiceData.md +42 -0
- data/docs/StatusCodeInfo.md +22 -0
- data/docs/StatusCodesResponse.md +22 -0
- data/docs/StructureInfo.md +26 -0
- data/docs/StructureParameters.md +22 -0
- data/docs/StructureService.md +24 -0
- data/docs/SubmissionMode.md +15 -0
- data/docs/SubmitAggregatedReportRequest.md +28 -0
- data/docs/SubmitCDARRequest.md +62 -0
- data/docs/SubmitCDARResponse.md +24 -0
- data/docs/SubmitCDARXMLRequest.md +30 -0
- data/docs/SubmitCompleteInvoiceRequest.md +26 -0
- data/docs/SubmitCompleteInvoiceResponse.md +34 -0
- data/docs/SubmitEReportingRequest.md +28 -0
- data/docs/SubmitEReportingResponse.md +32 -0
- data/docs/SubmitFlowRequest.md +28 -0
- data/docs/SubmitFlowResponse.md +30 -0
- data/docs/SubmitGrossAmount.md +15 -0
- data/docs/SubmitInvoiceRequest.md +46 -0
- data/docs/SubmitInvoiceResponse.md +24 -0
- data/docs/SubmitNetAmount.md +15 -0
- data/docs/SubmitVatAmount.md +15 -0
- data/docs/SupplementaryAttachment.md +26 -0
- data/docs/Supplier.md +52 -0
- data/docs/TaskResponse.md +18 -0
- data/docs/TaxBreakdownInput.md +22 -0
- data/docs/TaxDueDateType.md +15 -0
- data/docs/TaxRepresentative.md +22 -0
- data/docs/TaxableAmount.md +15 -0
- data/docs/Taxableamount.md +15 -0
- data/docs/Taxamount.md +15 -0
- data/docs/Taxamount1.md +15 -0
- data/docs/Taxamount2.md +15 -0
- data/docs/Taxexclusiveamount.md +15 -0
- data/docs/Taxexclusiveamount1.md +15 -0
- data/docs/TotalGrossAmount.md +15 -0
- data/docs/TotalNetAmount.md +15 -0
- data/docs/TotalVATAmount.md +15 -0
- data/docs/TransactionCategory.md +15 -0
- data/docs/TransmissionTypeCode.md +15 -0
- data/docs/UnitNetPrice.md +15 -0
- data/docs/UnitOfMeasure.md +15 -0
- data/docs/VATAccountingCode.md +15 -0
- data/docs/VATAmount.md +15 -0
- data/docs/VATCategory.md +15 -0
- data/docs/VATLine.md +32 -0
- data/docs/VATPointDateCode.md +15 -0
- data/docs/ValidateCDARRequest.md +32 -0
- data/docs/ValidateCDARResponse.md +22 -0
- data/docs/ValidateEReportingRequest.md +18 -0
- data/docs/ValidateEReportingResponse.md +28 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorDetail.md +26 -0
- data/docs/ValidationErrorResponse.md +24 -0
- data/docs/ValidationInfo.md +28 -0
- data/docs/ValidationSuccessResponse.md +18 -0
- data/docs/VatRate.md +15 -0
- data/docs/VerificationSuccessResponse.md +36 -0
- data/docs/VerifiedFieldSchema.md +34 -0
- data/docs/WebhookSecretDeleteResponse.md +20 -0
- data/docs/WebhookSecretGenerateResponse.md +24 -0
- data/docs/WebhookSecretStatusResponse.md +20 -0
- data/factpulse.gemspec +39 -0
- data/git_push.sh +57 -0
- data/lib/factpulse/api/afnorpdppa_api.rb +148 -0
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1183 -0
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +289 -0
- data/lib/factpulse/api/async_tasks_api.rb +85 -0
- data/lib/factpulse/api/chorus_pro_api.rb +1105 -0
- data/lib/factpulse/api/client_management_api.rb +831 -0
- data/lib/factpulse/api/downloads_api.rb +151 -0
- data/lib/factpulse/api/electronic_signature_api.rb +339 -0
- data/lib/factpulse/api/factur_x_conversion_api.rb +306 -0
- data/lib/factpulse/api/factur_x_generation_api.rb +254 -0
- data/lib/factpulse/api/factur_x_validation_api.rb +256 -0
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +232 -0
- data/lib/factpulse/api/flux10_e_reporting_api.rb +777 -0
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +670 -0
- data/lib/factpulse/api/health_api.rb +193 -0
- data/lib/factpulse/api_client.rb +397 -0
- data/lib/factpulse/api_error.rb +58 -0
- data/lib/factpulse/api_model_base.rb +88 -0
- data/lib/factpulse/configuration.rb +319 -0
- data/lib/factpulse/helpers/client.rb +272 -0
- data/lib/factpulse/helpers/exceptions.rb +45 -0
- data/lib/factpulse/helpers/helpers.rb +14 -0
- data/lib/factpulse/models/acknowledgment_status.rb +41 -0
- data/lib/factpulse/models/action_code_info.rb +220 -0
- data/lib/factpulse/models/action_codes_response.rb +207 -0
- data/lib/factpulse/models/additional_document.rb +206 -0
- data/lib/factpulse/models/afnor_acknowledgement.rb +216 -0
- data/lib/factpulse/models/afnor_acknowledgement_detail.rb +267 -0
- data/lib/factpulse/models/afnor_address_edit.rb +353 -0
- data/lib/factpulse/models/afnor_address_patch.rb +386 -0
- data/lib/factpulse/models/afnor_address_put.rb +435 -0
- data/lib/factpulse/models/afnor_address_read.rb +382 -0
- data/lib/factpulse/models/afnor_algorithm.rb +43 -0
- data/lib/factpulse/models/afnor_contains_operator.rb +39 -0
- data/lib/factpulse/models/afnor_create_directory_line_body.rb +156 -0
- data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +294 -0
- data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +175 -0
- data/lib/factpulse/models/afnor_create_routing_code_body.rb +412 -0
- data/lib/factpulse/models/afnor_credentials.rb +169 -0
- data/lib/factpulse/models/afnor_destination.rb +224 -0
- data/lib/factpulse/models/afnor_diffusion_status.rb +40 -0
- data/lib/factpulse/models/afnor_directory_line_field.rb +44 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +312 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +178 -0
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +308 -0
- data/lib/factpulse/models/afnor_directory_line_post201_response.rb +187 -0
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_entity_type.rb +40 -0
- data/lib/factpulse/models/afnor_error.rb +214 -0
- data/lib/factpulse/models/afnor_facility_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_facility_nature.rb +40 -0
- data/lib/factpulse/models/afnor_facility_payload_history.rb +323 -0
- data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +198 -0
- data/lib/factpulse/models/afnor_facility_payload_included.rb +314 -0
- data/lib/factpulse/models/afnor_facility_type.rb +40 -0
- data/lib/factpulse/models/afnor_flow.rb +315 -0
- data/lib/factpulse/models/afnor_flow_ack_status.rb +41 -0
- data/lib/factpulse/models/afnor_flow_direction.rb +40 -0
- data/lib/factpulse/models/afnor_flow_info.rb +293 -0
- data/lib/factpulse/models/afnor_flow_profile.rb +41 -0
- data/lib/factpulse/models/afnor_flow_syntax.rb +43 -0
- data/lib/factpulse/models/afnor_flow_type.rb +51 -0
- data/lib/factpulse/models/afnor_full_flow_info.rb +339 -0
- data/lib/factpulse/models/afnor_health_check_response.rb +220 -0
- data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +247 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +247 -0
- data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +207 -0
- data/lib/factpulse/models/afnor_platform_status.rb +40 -0
- data/lib/factpulse/models/afnor_processing_rule.rb +44 -0
- data/lib/factpulse/models/afnor_reason_code.rb +105 -0
- data/lib/factpulse/models/afnor_reason_code_enum.rb +53 -0
- data/lib/factpulse/models/afnor_recipient_platform_type.rb +40 -0
- data/lib/factpulse/models/afnor_result.rb +270 -0
- data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +40 -0
- data/lib/factpulse/models/afnor_routing_code_field.rb +46 -0
- data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +366 -0
- data/lib/factpulse/models/afnor_routing_code_post201_response.rb +228 -0
- data/lib/factpulse/models/afnor_routing_code_search.rb +224 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters.rb +201 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +209 -0
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +209 -0
- data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_directory_line.rb +191 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters.rb +183 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +198 -0
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +198 -0
- data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_flow_content.rb +168 -0
- data/lib/factpulse/models/afnor_search_flow_filters.rb +250 -0
- data/lib/factpulse/models/afnor_search_flow_params.rb +195 -0
- data/lib/factpulse/models/afnor_search_siren.rb +191 -0
- data/lib/factpulse/models/afnor_search_siren_filters.rb +174 -0
- data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +198 -0
- data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +178 -0
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +209 -0
- data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_search_siret.rb +224 -0
- data/lib/factpulse/models/afnor_search_siret_filters.rb +219 -0
- data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +178 -0
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +178 -0
- data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +198 -0
- data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +209 -0
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +209 -0
- data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +179 -0
- data/lib/factpulse/models/afnor_siren_field.rb +43 -0
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_siret_field.rb +52 -0
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +168 -0
- data/lib/factpulse/models/afnor_sorting_order.rb +40 -0
- data/lib/factpulse/models/afnor_strict_operator.rb +39 -0
- data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +148 -0
- data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +258 -0
- data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +289 -0
- data/lib/factpulse/models/afnor_webhook_callback_content.rb +148 -0
- data/lib/factpulse/models/aggregated_payment_input.rb +213 -0
- data/lib/factpulse/models/aggregated_transaction_input.rb +349 -0
- data/lib/factpulse/models/allowance_charge.rb +274 -0
- data/lib/factpulse/models/allowance_charge_reason_code.rb +76 -0
- data/lib/factpulse/models/allowance_reason_code.rb +45 -0
- data/lib/factpulse/models/allowance_total_amount.rb +104 -0
- data/lib/factpulse/models/amount.rb +104 -0
- data/lib/factpulse/models/amount1.rb +104 -0
- data/lib/factpulse/models/amount2.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +104 -0
- data/lib/factpulse/models/api_error.rb +205 -0
- data/lib/factpulse/models/api_profile.rb +43 -0
- data/lib/factpulse/models/async_task_status.rb +227 -0
- data/lib/factpulse/models/base_amount.rb +104 -0
- data/lib/factpulse/models/bounding_box_schema.rb +332 -0
- data/lib/factpulse/models/buyercountry.rb +104 -0
- data/lib/factpulse/models/celery_status.rb +43 -0
- data/lib/factpulse/models/certificate_info_response.rb +446 -0
- data/lib/factpulse/models/charge_total_amount.rb +104 -0
- data/lib/factpulse/models/chorus_pro_credentials.rb +259 -0
- data/lib/factpulse/models/chorus_pro_destination.rb +194 -0
- data/lib/factpulse/models/chorus_pro_result.rb +186 -0
- data/lib/factpulse/models/client_activate_response.rb +220 -0
- data/lib/factpulse/models/client_create_request.rb +236 -0
- data/lib/factpulse/models/client_detail.rb +368 -0
- data/lib/factpulse/models/client_list_response.rb +249 -0
- data/lib/factpulse/models/client_summary.rb +368 -0
- data/lib/factpulse/models/client_update_request.rb +225 -0
- data/lib/factpulse/models/contact.rb +179 -0
- data/lib/factpulse/models/convert_resume_request.rb +151 -0
- data/lib/factpulse/models/convert_success_response.rb +360 -0
- data/lib/factpulse/models/convert_validation_failed_response.rb +339 -0
- data/lib/factpulse/models/country_code.rb +208 -0
- data/lib/factpulse/models/create_aggregated_report_request.rb +320 -0
- data/lib/factpulse/models/create_cdar_request.rb +414 -0
- data/lib/factpulse/models/create_e_reporting_request.rb +347 -0
- data/lib/factpulse/models/currency.rb +104 -0
- data/lib/factpulse/models/currency_code.rb +91 -0
- data/lib/factpulse/models/delivery_party.rb +179 -0
- data/lib/factpulse/models/destination.rb +56 -0
- data/lib/factpulse/models/doc_type.rb +42 -0
- data/lib/factpulse/models/document_type_info.rb +220 -0
- data/lib/factpulse/models/e_reporting_flow_type.rb +42 -0
- data/lib/factpulse/models/e_reporting_validation_error.rb +203 -0
- data/lib/factpulse/models/electronic_address.rb +198 -0
- data/lib/factpulse/models/encaisseamount.rb +104 -0
- data/lib/factpulse/models/encaisseamount1.rb +103 -0
- data/lib/factpulse/models/encaissee_request.rb +347 -0
- data/lib/factpulse/models/enriched_invoice_info.rb +354 -0
- data/lib/factpulse/models/error_level.rb +40 -0
- data/lib/factpulse/models/error_source.rb +47 -0
- data/lib/factpulse/models/extraction_info.rb +217 -0
- data/lib/factpulse/models/factur_x_invoice.rb +580 -0
- data/lib/factpulse/models/factur_xpdf_info.rb +205 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +43 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
- data/lib/factpulse/models/field_status.rb +43 -0
- data/lib/factpulse/models/file_info.rb +161 -0
- data/lib/factpulse/models/files_info.rb +159 -0
- data/lib/factpulse/models/flow_direction.rb +40 -0
- data/lib/factpulse/models/flow_profile.rb +41 -0
- data/lib/factpulse/models/flow_summary.rb +253 -0
- data/lib/factpulse/models/flow_syntax.rb +43 -0
- data/lib/factpulse/models/flow_type.rb +51 -0
- data/lib/factpulse/models/generate_aggregated_report_response.rb +330 -0
- data/lib/factpulse/models/generate_cdar_response.rb +273 -0
- data/lib/factpulse/models/generate_certificate_request.rb +323 -0
- data/lib/factpulse/models/generate_certificate_response.rb +254 -0
- data/lib/factpulse/models/generate_e_reporting_response.rb +274 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +188 -0
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +230 -0
- data/lib/factpulse/models/get_invoice_request.rb +176 -0
- data/lib/factpulse/models/get_invoice_response.rb +263 -0
- data/lib/factpulse/models/get_structure_request.rb +188 -0
- data/lib/factpulse/models/get_structure_response.rb +263 -0
- data/lib/factpulse/models/global_allowance_amount.rb +104 -0
- data/lib/factpulse/models/gross_unit_price.rb +104 -0
- data/lib/factpulse/models/http_validation_error.rb +149 -0
- data/lib/factpulse/models/incoming_invoice.rb +489 -0
- data/lib/factpulse/models/incoming_supplier.rb +236 -0
- data/lib/factpulse/models/invoice_format.rb +41 -0
- data/lib/factpulse/models/invoice_input.rb +439 -0
- data/lib/factpulse/models/invoice_line.rb +593 -0
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +104 -0
- data/lib/factpulse/models/invoice_note.rb +176 -0
- data/lib/factpulse/models/invoice_payment_input.rb +267 -0
- data/lib/factpulse/models/invoice_references.rb +393 -0
- data/lib/factpulse/models/invoice_status.rb +203 -0
- data/lib/factpulse/models/invoice_totals.rb +312 -0
- data/lib/factpulse/models/invoice_totals_prepayment.rb +104 -0
- data/lib/factpulse/models/invoice_type_code.rb +54 -0
- data/lib/factpulse/models/invoice_type_code_output.rb +54 -0
- data/lib/factpulse/models/invoicing_framework.rb +218 -0
- data/lib/factpulse/models/invoicing_framework_code.rb +42 -0
- data/lib/factpulse/models/issuer_role_code.rb +40 -0
- data/lib/factpulse/models/key_rotation_request.rb +211 -0
- data/lib/factpulse/models/key_rotation_response.rb +232 -0
- data/lib/factpulse/models/line_net_amount.rb +104 -0
- data/lib/factpulse/models/line_sub_type.rb +41 -0
- data/lib/factpulse/models/line_total_amount.rb +104 -0
- data/lib/factpulse/models/location_inner.rb +103 -0
- data/lib/factpulse/models/mandatory_note_schema.rb +265 -0
- data/lib/factpulse/models/manual_rate.rb +104 -0
- data/lib/factpulse/models/manual_vat_rate.rb +104 -0
- data/lib/factpulse/models/missing_field.rb +269 -0
- data/lib/factpulse/models/operation_nature.rb +52 -0
- data/lib/factpulse/models/output_format.rb +40 -0
- data/lib/factpulse/models/page_dimensions_schema.rb +193 -0
- data/lib/factpulse/models/payee.rb +281 -0
- data/lib/factpulse/models/payment_amount_by_rate.rb +191 -0
- data/lib/factpulse/models/payment_card.rb +159 -0
- data/lib/factpulse/models/payment_means.rb +44 -0
- data/lib/factpulse/models/pdf_validation_result_api.rb +523 -0
- data/lib/factpulse/models/pdp_config_response.rb +306 -0
- data/lib/factpulse/models/pdp_config_update_request.rb +315 -0
- data/lib/factpulse/models/pdp_credentials.rb +257 -0
- data/lib/factpulse/models/percentage.rb +104 -0
- data/lib/factpulse/models/postal_address.rb +209 -0
- data/lib/factpulse/models/price_allowance_amount.rb +104 -0
- data/lib/factpulse/models/price_basis_quantity.rb +104 -0
- data/lib/factpulse/models/processing_options.rb +207 -0
- data/lib/factpulse/models/processing_rule.rb +44 -0
- data/lib/factpulse/models/product_characteristic.rb +193 -0
- data/lib/factpulse/models/product_classification.rb +186 -0
- data/lib/factpulse/models/quantity.rb +104 -0
- data/lib/factpulse/models/rate.rb +104 -0
- data/lib/factpulse/models/rate1.rb +104 -0
- data/lib/factpulse/models/reason_code_info.rb +220 -0
- data/lib/factpulse/models/reason_codes_response.rb +207 -0
- data/lib/factpulse/models/recipient.rb +231 -0
- data/lib/factpulse/models/recipient_input.rb +191 -0
- data/lib/factpulse/models/refusee_request.rb +346 -0
- data/lib/factpulse/models/report_issuer.rb +236 -0
- data/lib/factpulse/models/report_period.rb +193 -0
- data/lib/factpulse/models/report_sender.rb +221 -0
- data/lib/factpulse/models/rounding_amount.rb +104 -0
- data/lib/factpulse/models/schematron_validation_error.rb +294 -0
- data/lib/factpulse/models/scheme_id.rb +56 -0
- data/lib/factpulse/models/search_flow_request.rb +306 -0
- data/lib/factpulse/models/search_flow_response.rb +249 -0
- data/lib/factpulse/models/search_services_response.rb +217 -0
- data/lib/factpulse/models/search_structure_request.rb +191 -0
- data/lib/factpulse/models/search_structure_response.rb +216 -0
- data/lib/factpulse/models/secret_status.rb +213 -0
- data/lib/factpulse/models/sellercountry.rb +104 -0
- data/lib/factpulse/models/signature_info.rb +186 -0
- data/lib/factpulse/models/signature_info_api.rb +216 -0
- data/lib/factpulse/models/signature_parameters.rb +235 -0
- data/lib/factpulse/models/simplified_cdar_response.rb +274 -0
- data/lib/factpulse/models/simplified_invoice_data.rb +404 -0
- data/lib/factpulse/models/status_code_info.rb +220 -0
- data/lib/factpulse/models/status_codes_response.rb +207 -0
- data/lib/factpulse/models/structure_info.rb +274 -0
- data/lib/factpulse/models/structure_parameters.rb +175 -0
- data/lib/factpulse/models/structure_service.rb +247 -0
- data/lib/factpulse/models/submission_mode.rb +41 -0
- data/lib/factpulse/models/submit_aggregated_report_request.rb +216 -0
- data/lib/factpulse/models/submit_cdar_request.rb +466 -0
- data/lib/factpulse/models/submit_cdar_response.rb +213 -0
- data/lib/factpulse/models/submit_cdarxml_request.rb +228 -0
- data/lib/factpulse/models/submit_complete_invoice_request.rb +239 -0
- data/lib/factpulse/models/submit_complete_invoice_response.rb +355 -0
- data/lib/factpulse/models/submit_e_reporting_request.rb +216 -0
- data/lib/factpulse/models/submit_e_reporting_response.rb +306 -0
- data/lib/factpulse/models/submit_flow_request.rb +238 -0
- data/lib/factpulse/models/submit_flow_response.rb +294 -0
- data/lib/factpulse/models/submit_gross_amount.rb +104 -0
- data/lib/factpulse/models/submit_invoice_request.rb +388 -0
- data/lib/factpulse/models/submit_invoice_response.rb +213 -0
- data/lib/factpulse/models/submit_net_amount.rb +104 -0
- data/lib/factpulse/models/submit_vat_amount.rb +104 -0
- data/lib/factpulse/models/supplementary_attachment.rb +274 -0
- data/lib/factpulse/models/supplier.rb +337 -0
- data/lib/factpulse/models/task_response.rb +166 -0
- data/lib/factpulse/models/tax_breakdown_input.rb +217 -0
- data/lib/factpulse/models/tax_due_date_type.rb +44 -0
- data/lib/factpulse/models/tax_representative.rb +220 -0
- data/lib/factpulse/models/taxable_amount.rb +104 -0
- data/lib/factpulse/models/taxableamount.rb +104 -0
- data/lib/factpulse/models/taxamount.rb +104 -0
- data/lib/factpulse/models/taxamount1.rb +104 -0
- data/lib/factpulse/models/taxamount2.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount1.rb +104 -0
- data/lib/factpulse/models/total_gross_amount.rb +104 -0
- data/lib/factpulse/models/total_net_amount.rb +104 -0
- data/lib/factpulse/models/total_vat_amount.rb +104 -0
- data/lib/factpulse/models/transaction_category.rb +42 -0
- data/lib/factpulse/models/transmission_type_code.rb +40 -0
- data/lib/factpulse/models/unit_net_price.rb +104 -0
- data/lib/factpulse/models/unit_of_measure.rb +44 -0
- data/lib/factpulse/models/validate_cdar_request.rb +219 -0
- data/lib/factpulse/models/validate_cdar_response.rb +190 -0
- data/lib/factpulse/models/validate_e_reporting_request.rb +166 -0
- data/lib/factpulse/models/validate_e_reporting_response.rb +271 -0
- data/lib/factpulse/models/validation_error.rb +218 -0
- data/lib/factpulse/models/validation_error_detail.rb +245 -0
- data/lib/factpulse/models/validation_error_response.rb +215 -0
- data/lib/factpulse/models/validation_info.rb +255 -0
- data/lib/factpulse/models/validation_success_response.rb +166 -0
- data/lib/factpulse/models/vat_accounting_code.rb +42 -0
- data/lib/factpulse/models/vat_amount.rb +104 -0
- data/lib/factpulse/models/vat_category.rb +47 -0
- data/lib/factpulse/models/vat_line.rb +272 -0
- data/lib/factpulse/models/vat_point_date_code.rb +41 -0
- data/lib/factpulse/models/vat_rate.rb +104 -0
- data/lib/factpulse/models/verification_success_response.rb +343 -0
- data/lib/factpulse/models/verified_field_schema.rb +334 -0
- data/lib/factpulse/models/webhook_secret_delete_response.rb +193 -0
- data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
- data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
- data/lib/factpulse/version.rb +15 -0
- data/lib/factpulse.rb +369 -0
- 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 'cgi'
|
|
14
|
+
|
|
15
|
+
module FactPulse
|
|
16
|
+
class HealthApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get current user information
|
|
23
|
+
# Returns information about the authenticated user. This endpoint allows you to: - Verify that authentication works - Get connected account details - Test JWT token validity - Check your consumption quota **Requires valid authentication.**
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [Object]
|
|
26
|
+
def get_user_info_api_v1_me_get(opts = {})
|
|
27
|
+
data, _status_code, _headers = get_user_info_api_v1_me_get_with_http_info(opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Get current user information
|
|
32
|
+
# Returns information about the authenticated user. This endpoint allows you to: - Verify that authentication works - Get connected account details - Test JWT token validity - Check your consumption quota **Requires valid authentication.**
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
35
|
+
def get_user_info_api_v1_me_get_with_http_info(opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: HealthApi.get_user_info_api_v1_me_get ...'
|
|
38
|
+
end
|
|
39
|
+
# resource path
|
|
40
|
+
local_var_path = '/api/v1/me'
|
|
41
|
+
|
|
42
|
+
# query parameters
|
|
43
|
+
query_params = opts[:query_params] || {}
|
|
44
|
+
|
|
45
|
+
# header parameters
|
|
46
|
+
header_params = opts[:header_params] || {}
|
|
47
|
+
# HTTP header 'Accept' (if needed)
|
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
49
|
+
|
|
50
|
+
# form parameters
|
|
51
|
+
form_params = opts[:form_params] || {}
|
|
52
|
+
|
|
53
|
+
# http body (model)
|
|
54
|
+
post_body = opts[:debug_body]
|
|
55
|
+
|
|
56
|
+
# return_type
|
|
57
|
+
return_type = opts[:debug_return_type] || 'Object'
|
|
58
|
+
|
|
59
|
+
# auth_names
|
|
60
|
+
auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
|
|
61
|
+
|
|
62
|
+
new_options = opts.merge(
|
|
63
|
+
:operation => :"HealthApi.get_user_info_api_v1_me_get",
|
|
64
|
+
:header_params => header_params,
|
|
65
|
+
:query_params => query_params,
|
|
66
|
+
:form_params => form_params,
|
|
67
|
+
:body => post_body,
|
|
68
|
+
:auth_names => auth_names,
|
|
69
|
+
:return_type => return_type
|
|
70
|
+
)
|
|
71
|
+
|
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
73
|
+
if @api_client.config.debugging
|
|
74
|
+
@api_client.config.logger.debug "API called: HealthApi#get_user_info_api_v1_me_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
|
+
end
|
|
76
|
+
return data, status_code, headers
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Docker healthcheck endpoint
|
|
80
|
+
# Healthcheck endpoint for Docker and load balancers. Useful for: - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Availability monitoring - Zero downtime deployment Returns a 200 code if the API is operational.
|
|
81
|
+
# @param [Hash] opts the optional parameters
|
|
82
|
+
# @return [Object]
|
|
83
|
+
def healthcheck_healthcheck_get(opts = {})
|
|
84
|
+
data, _status_code, _headers = healthcheck_healthcheck_get_with_http_info(opts)
|
|
85
|
+
data
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Docker healthcheck endpoint
|
|
89
|
+
# Healthcheck endpoint for Docker and load balancers. Useful for: - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Availability monitoring - Zero downtime deployment Returns a 200 code if the API is operational.
|
|
90
|
+
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
92
|
+
def healthcheck_healthcheck_get_with_http_info(opts = {})
|
|
93
|
+
if @api_client.config.debugging
|
|
94
|
+
@api_client.config.logger.debug 'Calling API: HealthApi.healthcheck_healthcheck_get ...'
|
|
95
|
+
end
|
|
96
|
+
# resource path
|
|
97
|
+
local_var_path = '/healthcheck'
|
|
98
|
+
|
|
99
|
+
# query parameters
|
|
100
|
+
query_params = opts[:query_params] || {}
|
|
101
|
+
|
|
102
|
+
# header parameters
|
|
103
|
+
header_params = opts[:header_params] || {}
|
|
104
|
+
# HTTP header 'Accept' (if needed)
|
|
105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
106
|
+
|
|
107
|
+
# form parameters
|
|
108
|
+
form_params = opts[:form_params] || {}
|
|
109
|
+
|
|
110
|
+
# http body (model)
|
|
111
|
+
post_body = opts[:debug_body]
|
|
112
|
+
|
|
113
|
+
# return_type
|
|
114
|
+
return_type = opts[:debug_return_type] || 'Object'
|
|
115
|
+
|
|
116
|
+
# auth_names
|
|
117
|
+
auth_names = opts[:debug_auth_names] || []
|
|
118
|
+
|
|
119
|
+
new_options = opts.merge(
|
|
120
|
+
:operation => :"HealthApi.healthcheck_healthcheck_get",
|
|
121
|
+
:header_params => header_params,
|
|
122
|
+
:query_params => query_params,
|
|
123
|
+
:form_params => form_params,
|
|
124
|
+
:body => post_body,
|
|
125
|
+
:auth_names => auth_names,
|
|
126
|
+
:return_type => return_type
|
|
127
|
+
)
|
|
128
|
+
|
|
129
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
130
|
+
if @api_client.config.debugging
|
|
131
|
+
@api_client.config.logger.debug "API called: HealthApi#healthcheck_healthcheck_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
132
|
+
end
|
|
133
|
+
return data, status_code, headers
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# Check API status
|
|
137
|
+
# Health check endpoint to verify the API is responding. Useful for: - Availability monitoring - Integration tests - Load balancers
|
|
138
|
+
# @param [Hash] opts the optional parameters
|
|
139
|
+
# @return [Object]
|
|
140
|
+
def root_get(opts = {})
|
|
141
|
+
data, _status_code, _headers = root_get_with_http_info(opts)
|
|
142
|
+
data
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Check API status
|
|
146
|
+
# Health check endpoint to verify the API is responding. Useful for: - Availability monitoring - Integration tests - Load balancers
|
|
147
|
+
# @param [Hash] opts the optional parameters
|
|
148
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
149
|
+
def root_get_with_http_info(opts = {})
|
|
150
|
+
if @api_client.config.debugging
|
|
151
|
+
@api_client.config.logger.debug 'Calling API: HealthApi.root_get ...'
|
|
152
|
+
end
|
|
153
|
+
# resource path
|
|
154
|
+
local_var_path = '/'
|
|
155
|
+
|
|
156
|
+
# query parameters
|
|
157
|
+
query_params = opts[:query_params] || {}
|
|
158
|
+
|
|
159
|
+
# header parameters
|
|
160
|
+
header_params = opts[:header_params] || {}
|
|
161
|
+
# HTTP header 'Accept' (if needed)
|
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
163
|
+
|
|
164
|
+
# form parameters
|
|
165
|
+
form_params = opts[:form_params] || {}
|
|
166
|
+
|
|
167
|
+
# http body (model)
|
|
168
|
+
post_body = opts[:debug_body]
|
|
169
|
+
|
|
170
|
+
# return_type
|
|
171
|
+
return_type = opts[:debug_return_type] || 'Object'
|
|
172
|
+
|
|
173
|
+
# auth_names
|
|
174
|
+
auth_names = opts[:debug_auth_names] || []
|
|
175
|
+
|
|
176
|
+
new_options = opts.merge(
|
|
177
|
+
:operation => :"HealthApi.root_get",
|
|
178
|
+
:header_params => header_params,
|
|
179
|
+
:query_params => query_params,
|
|
180
|
+
:form_params => form_params,
|
|
181
|
+
:body => post_body,
|
|
182
|
+
:auth_names => auth_names,
|
|
183
|
+
:return_type => return_type
|
|
184
|
+
)
|
|
185
|
+
|
|
186
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
187
|
+
if @api_client.config.debugging
|
|
188
|
+
@api_client.config.logger.debug "API called: HealthApi#root_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
189
|
+
end
|
|
190
|
+
return data, status_code, headers
|
|
191
|
+
end
|
|
192
|
+
end
|
|
193
|
+
end
|
|
@@ -0,0 +1,397 @@
|
|
|
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 'json'
|
|
15
|
+
require 'logger'
|
|
16
|
+
require 'tempfile'
|
|
17
|
+
require 'time'
|
|
18
|
+
require 'typhoeus'
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
module FactPulse
|
|
22
|
+
class ApiClient
|
|
23
|
+
# The Configuration object holding settings to be used in the API client.
|
|
24
|
+
attr_accessor :config
|
|
25
|
+
|
|
26
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
|
27
|
+
#
|
|
28
|
+
# @return [Hash]
|
|
29
|
+
attr_accessor :default_headers
|
|
30
|
+
|
|
31
|
+
# Initializes the ApiClient
|
|
32
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
33
|
+
def initialize(config = Configuration.default)
|
|
34
|
+
@config = config
|
|
35
|
+
@user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
|
|
36
|
+
@default_headers = {
|
|
37
|
+
'Content-Type' => 'application/json',
|
|
38
|
+
'User-Agent' => @user_agent
|
|
39
|
+
}
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def self.default
|
|
43
|
+
@@default ||= ApiClient.new
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Call an API with given options.
|
|
47
|
+
#
|
|
48
|
+
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
|
49
|
+
# the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
|
|
50
|
+
def call_api(http_method, path, opts = {})
|
|
51
|
+
request = build_request(http_method, path, opts)
|
|
52
|
+
tempfile = nil
|
|
53
|
+
(download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
|
|
54
|
+
response = request.run
|
|
55
|
+
|
|
56
|
+
if @config.debugging
|
|
57
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
unless response.success?
|
|
61
|
+
if response.timed_out?
|
|
62
|
+
fail ApiError.new('Connection timed out')
|
|
63
|
+
elsif response.code == 0
|
|
64
|
+
# Errors from libcurl will be made visible here
|
|
65
|
+
fail ApiError.new(:code => 0,
|
|
66
|
+
:message => response.return_message)
|
|
67
|
+
else
|
|
68
|
+
fail ApiError.new(:code => response.code,
|
|
69
|
+
:response_headers => response.headers,
|
|
70
|
+
:response_body => response.body),
|
|
71
|
+
response.status_message
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
if opts[:return_type] == 'File'
|
|
76
|
+
data = tempfile
|
|
77
|
+
elsif opts[:return_type]
|
|
78
|
+
data = deserialize(response, opts[:return_type])
|
|
79
|
+
else
|
|
80
|
+
data = nil
|
|
81
|
+
end
|
|
82
|
+
return data, response.code, response.headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Builds the HTTP request
|
|
86
|
+
#
|
|
87
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
|
88
|
+
# @param [String] path URL path (e.g. /account/new)
|
|
89
|
+
# @option opts [Hash] :header_params Header parameters
|
|
90
|
+
# @option opts [Hash] :query_params Query parameters
|
|
91
|
+
# @option opts [Hash] :form_params Query parameters
|
|
92
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
|
93
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
|
94
|
+
def build_request(http_method, path, opts = {})
|
|
95
|
+
url = build_request_url(path, opts)
|
|
96
|
+
http_method = http_method.to_sym.downcase
|
|
97
|
+
|
|
98
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
|
99
|
+
query_params = opts[:query_params] || {}
|
|
100
|
+
form_params = opts[:form_params] || {}
|
|
101
|
+
follow_location = opts[:follow_location] || true
|
|
102
|
+
|
|
103
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
|
104
|
+
|
|
105
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
|
106
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
|
107
|
+
|
|
108
|
+
req_opts = {
|
|
109
|
+
:method => http_method,
|
|
110
|
+
:headers => header_params,
|
|
111
|
+
:params => query_params,
|
|
112
|
+
:params_encoding => @config.params_encoding,
|
|
113
|
+
:timeout => @config.timeout,
|
|
114
|
+
:ssl_verifypeer => @config.verify_ssl,
|
|
115
|
+
:ssl_verifyhost => _verify_ssl_host,
|
|
116
|
+
:sslcert => @config.cert_file,
|
|
117
|
+
:sslkey => @config.key_file,
|
|
118
|
+
:verbose => @config.debugging,
|
|
119
|
+
:followlocation => follow_location
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
# set custom cert, if provided
|
|
123
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
|
124
|
+
|
|
125
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
|
126
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
|
127
|
+
req_opts.update :body => req_body
|
|
128
|
+
if @config.debugging
|
|
129
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
Typhoeus::Request.new(url, req_opts)
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# Builds the HTTP request body
|
|
137
|
+
#
|
|
138
|
+
# @param [Hash] header_params Header parameters
|
|
139
|
+
# @param [Hash] form_params Query parameters
|
|
140
|
+
# @param [Object] body HTTP body (JSON/XML)
|
|
141
|
+
# @return [String] HTTP body data in the form of string
|
|
142
|
+
def build_request_body(header_params, form_params, body)
|
|
143
|
+
# http form
|
|
144
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
|
145
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
|
146
|
+
data = {}
|
|
147
|
+
form_params.each do |key, value|
|
|
148
|
+
case value
|
|
149
|
+
when ::File, ::Array, nil
|
|
150
|
+
# let typhoeus handle File, Array and nil parameters
|
|
151
|
+
data[key] = value
|
|
152
|
+
else
|
|
153
|
+
data[key] = value.to_s
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
elsif body
|
|
157
|
+
data = body.is_a?(String) ? body : body.to_json
|
|
158
|
+
else
|
|
159
|
+
data = nil
|
|
160
|
+
end
|
|
161
|
+
data
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
|
165
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
|
166
|
+
# The response body is written to the file in chunks in order to handle files which
|
|
167
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
|
168
|
+
# process can use.
|
|
169
|
+
#
|
|
170
|
+
# @see Configuration#temp_folder_path
|
|
171
|
+
#
|
|
172
|
+
# @return [Tempfile] the tempfile generated
|
|
173
|
+
def download_file(request)
|
|
174
|
+
tempfile = nil
|
|
175
|
+
encoding = nil
|
|
176
|
+
request.on_headers do |response|
|
|
177
|
+
content_disposition = response.headers['Content-Disposition']
|
|
178
|
+
if content_disposition && content_disposition =~ /filename=/i
|
|
179
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
|
180
|
+
prefix = sanitize_filename(filename)
|
|
181
|
+
else
|
|
182
|
+
prefix = 'download-'
|
|
183
|
+
end
|
|
184
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
|
185
|
+
encoding = response.body.encoding
|
|
186
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
|
187
|
+
end
|
|
188
|
+
request.on_body do |chunk|
|
|
189
|
+
chunk.force_encoding(encoding)
|
|
190
|
+
tempfile.write(chunk)
|
|
191
|
+
end
|
|
192
|
+
request.on_complete do
|
|
193
|
+
if !tempfile
|
|
194
|
+
fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
|
|
195
|
+
end
|
|
196
|
+
tempfile.close
|
|
197
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
|
198
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
|
199
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
|
200
|
+
"explicitly with `tempfile.delete`"
|
|
201
|
+
yield tempfile if block_given?
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Check if the given MIME is a JSON MIME.
|
|
206
|
+
# JSON MIME examples:
|
|
207
|
+
# application/json
|
|
208
|
+
# application/json; charset=UTF8
|
|
209
|
+
# APPLICATION/JSON
|
|
210
|
+
# */*
|
|
211
|
+
# @param [String] mime MIME
|
|
212
|
+
# @return [Boolean] True if the MIME is application/json
|
|
213
|
+
def json_mime?(mime)
|
|
214
|
+
(mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Deserialize the response to the given return type.
|
|
218
|
+
#
|
|
219
|
+
# @param [Response] response HTTP response
|
|
220
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
|
221
|
+
def deserialize(response, return_type)
|
|
222
|
+
body = response.body
|
|
223
|
+
return nil if body.nil? || body.empty?
|
|
224
|
+
|
|
225
|
+
# return response body directly for String return type
|
|
226
|
+
return body.to_s if return_type == 'String'
|
|
227
|
+
|
|
228
|
+
# ensuring a default content type
|
|
229
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
|
230
|
+
|
|
231
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
|
232
|
+
|
|
233
|
+
begin
|
|
234
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
|
235
|
+
rescue JSON::ParserError => e
|
|
236
|
+
if %w(String Date Time).include?(return_type)
|
|
237
|
+
data = body
|
|
238
|
+
else
|
|
239
|
+
raise e
|
|
240
|
+
end
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
convert_to_type data, return_type
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Convert data to the given return type.
|
|
247
|
+
# @param [Object] data Data to be converted
|
|
248
|
+
# @param [String] return_type Return type
|
|
249
|
+
# @return [Mixed] Data in a particular type
|
|
250
|
+
def convert_to_type(data, return_type)
|
|
251
|
+
return nil if data.nil?
|
|
252
|
+
case return_type
|
|
253
|
+
when 'String'
|
|
254
|
+
data.to_s
|
|
255
|
+
when 'Integer'
|
|
256
|
+
data.to_i
|
|
257
|
+
when 'Float'
|
|
258
|
+
data.to_f
|
|
259
|
+
when 'Boolean'
|
|
260
|
+
data == true
|
|
261
|
+
when 'Time'
|
|
262
|
+
# parse date time (expecting ISO 8601 format)
|
|
263
|
+
Time.parse data
|
|
264
|
+
when 'Date'
|
|
265
|
+
# parse date time (expecting ISO 8601 format)
|
|
266
|
+
Date.parse data
|
|
267
|
+
when 'Object'
|
|
268
|
+
# generic object (usually a Hash), return directly
|
|
269
|
+
data
|
|
270
|
+
when /\AArray<(.+)>\z/
|
|
271
|
+
# e.g. Array<Pet>
|
|
272
|
+
sub_type = $1
|
|
273
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
|
274
|
+
when /\AHash\<String, (.+)\>\z/
|
|
275
|
+
# e.g. Hash<String, Integer>
|
|
276
|
+
sub_type = $1
|
|
277
|
+
{}.tap do |hash|
|
|
278
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
|
279
|
+
end
|
|
280
|
+
else
|
|
281
|
+
# models (e.g. Pet) or oneOf/anyOf
|
|
282
|
+
klass = FactPulse.const_get(return_type)
|
|
283
|
+
if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of)
|
|
284
|
+
klass.build(data)
|
|
285
|
+
else
|
|
286
|
+
klass.build_from_hash(data)
|
|
287
|
+
end
|
|
288
|
+
end
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# Sanitize filename by removing path.
|
|
292
|
+
# e.g. ../../sun.gif becomes sun.gif
|
|
293
|
+
#
|
|
294
|
+
# @param [String] filename the filename to be sanitized
|
|
295
|
+
# @return [String] the sanitized filename
|
|
296
|
+
def sanitize_filename(filename)
|
|
297
|
+
filename.split(/[\/\\]/).last
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
def build_request_url(path, opts = {})
|
|
301
|
+
# Add leading and trailing slashes to path
|
|
302
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
|
303
|
+
@config.base_url(opts[:operation]) + path
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# Update header and query params based on authentication settings.
|
|
307
|
+
#
|
|
308
|
+
# @param [Hash] header_params Header parameters
|
|
309
|
+
# @param [Hash] query_params Query parameters
|
|
310
|
+
# @param [String] auth_names Authentication scheme name
|
|
311
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
|
312
|
+
Array(auth_names).each do |auth_name|
|
|
313
|
+
auth_setting = @config.auth_settings[auth_name]
|
|
314
|
+
next unless auth_setting
|
|
315
|
+
case auth_setting[:in]
|
|
316
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
|
317
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
|
318
|
+
else fail ArgumentError, 'Authentication token must be in `query` or `header`'
|
|
319
|
+
end
|
|
320
|
+
end
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Sets user agent in HTTP header
|
|
324
|
+
#
|
|
325
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
|
326
|
+
def user_agent=(user_agent)
|
|
327
|
+
@user_agent = user_agent
|
|
328
|
+
@default_headers['User-Agent'] = @user_agent
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
# Return Accept header based on an array of accepts provided.
|
|
332
|
+
# @param [Array] accepts array for Accept
|
|
333
|
+
# @return [String] the Accept header (e.g. application/json)
|
|
334
|
+
def select_header_accept(accepts)
|
|
335
|
+
return nil if accepts.nil? || accepts.empty?
|
|
336
|
+
# use JSON when present, otherwise use all of the provided
|
|
337
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
|
338
|
+
json_accept || accepts.join(',')
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
# Return Content-Type header based on an array of content types provided.
|
|
342
|
+
# @param [Array] content_types array for Content-Type
|
|
343
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
|
344
|
+
def select_header_content_type(content_types)
|
|
345
|
+
# return nil by default
|
|
346
|
+
return if content_types.nil? || content_types.empty?
|
|
347
|
+
# use JSON when present, otherwise use the first one
|
|
348
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
|
349
|
+
json_content_type || content_types.first
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
|
353
|
+
# @param [Object] model object to be converted into JSON string
|
|
354
|
+
# @return [String] JSON string representation of the object
|
|
355
|
+
def object_to_http_body(model)
|
|
356
|
+
return model if model.nil? || model.is_a?(String)
|
|
357
|
+
local_body = nil
|
|
358
|
+
if model.is_a?(Array)
|
|
359
|
+
local_body = model.map { |m| object_to_hash(m) }
|
|
360
|
+
else
|
|
361
|
+
local_body = object_to_hash(model)
|
|
362
|
+
end
|
|
363
|
+
local_body.to_json
|
|
364
|
+
end
|
|
365
|
+
|
|
366
|
+
# Convert object(non-array) to hash.
|
|
367
|
+
# @param [Object] obj object to be converted into JSON string
|
|
368
|
+
# @return [String] JSON string representation of the object
|
|
369
|
+
def object_to_hash(obj)
|
|
370
|
+
if obj.respond_to?(:to_hash)
|
|
371
|
+
obj.to_hash
|
|
372
|
+
else
|
|
373
|
+
obj
|
|
374
|
+
end
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# Build parameter value according to the given collection format.
|
|
378
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
|
379
|
+
def build_collection_param(param, collection_format)
|
|
380
|
+
case collection_format
|
|
381
|
+
when :csv
|
|
382
|
+
param.join(',')
|
|
383
|
+
when :ssv
|
|
384
|
+
param.join(' ')
|
|
385
|
+
when :tsv
|
|
386
|
+
param.join("\t")
|
|
387
|
+
when :pipes
|
|
388
|
+
param.join('|')
|
|
389
|
+
when :multi
|
|
390
|
+
# return the array directly as typhoeus will handle it as expected
|
|
391
|
+
param
|
|
392
|
+
else
|
|
393
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
|
394
|
+
end
|
|
395
|
+
end
|
|
396
|
+
end
|
|
397
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
class ApiError < StandardError
|
|
15
|
+
attr_reader :code, :response_headers, :response_body
|
|
16
|
+
|
|
17
|
+
# Usage examples:
|
|
18
|
+
# ApiError.new
|
|
19
|
+
# ApiError.new("message")
|
|
20
|
+
# ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
|
|
21
|
+
# ApiError.new(:code => 404, :message => "Not Found")
|
|
22
|
+
def initialize(arg = nil)
|
|
23
|
+
if arg.is_a? Hash
|
|
24
|
+
if arg.key?(:message) || arg.key?('message')
|
|
25
|
+
super(arg[:message] || arg['message'])
|
|
26
|
+
else
|
|
27
|
+
super arg
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
arg.each do |k, v|
|
|
31
|
+
instance_variable_set "@#{k}", v
|
|
32
|
+
end
|
|
33
|
+
else
|
|
34
|
+
super arg
|
|
35
|
+
@message = arg
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Override to_s to display a friendly error message
|
|
40
|
+
def to_s
|
|
41
|
+
message
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def message
|
|
45
|
+
if @message.nil?
|
|
46
|
+
msg = "Error message: the server returns an error"
|
|
47
|
+
else
|
|
48
|
+
msg = @message
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
msg += "\nHTTP status code: #{code}" if code
|
|
52
|
+
msg += "\nResponse headers: #{response_headers}" if response_headers
|
|
53
|
+
msg += "\nResponse body: #{response_body}" if response_body
|
|
54
|
+
|
|
55
|
+
msg
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|