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,921 @@
|
|
|
1
|
+
# FactPulse::ClientManagementApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://factpulse.fr*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**activate_client_api_v1_clients_uid_activer_post**](ClientManagementApi.md#activate_client_api_v1_clients_uid_activer_post) | **POST** /api/v1/clients/{uid}/activer | Activate a client |
|
|
8
|
+
| [**create_client_api_v1_clients_post**](ClientManagementApi.md#create_client_api_v1_clients_post) | **POST** /api/v1/clients | Create a client |
|
|
9
|
+
| [**deactivate_client_api_v1_clients_uid_desactiver_post**](ClientManagementApi.md#deactivate_client_api_v1_clients_uid_desactiver_post) | **POST** /api/v1/clients/{uid}/desactiver | Deactivate a client |
|
|
10
|
+
| [**delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete**](ClientManagementApi.md#delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete) | **DELETE** /api/v1/clients/{uid}/webhook-secret | Delete webhook secret |
|
|
11
|
+
| [**generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post**](ClientManagementApi.md#generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post) | **POST** /api/v1/clients/{uid}/webhook-secret/generate | Generate webhook secret |
|
|
12
|
+
| [**get_client_api_v1_clients_uid_get**](ClientManagementApi.md#get_client_api_v1_clients_uid_get) | **GET** /api/v1/clients/{uid} | Get client details |
|
|
13
|
+
| [**get_pdp_config_api_v1_clients_uid_pdp_config_get**](ClientManagementApi.md#get_pdp_config_api_v1_clients_uid_pdp_config_get) | **GET** /api/v1/clients/{uid}/pdp-config | Get client PDP configuration |
|
|
14
|
+
| [**get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get**](ClientManagementApi.md#get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get) | **GET** /api/v1/clients/{uid}/webhook-secret/status | Get webhook secret status |
|
|
15
|
+
| [**list_clients_api_v1_clients_get**](ClientManagementApi.md#list_clients_api_v1_clients_get) | **GET** /api/v1/clients | List clients |
|
|
16
|
+
| [**rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post**](ClientManagementApi.md#rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post) | **POST** /api/v1/clients/{uid}/rotate-encryption-key | Rotate client encryption key |
|
|
17
|
+
| [**update_client_api_v1_clients_uid_patch**](ClientManagementApi.md#update_client_api_v1_clients_uid_patch) | **PATCH** /api/v1/clients/{uid} | Update a client |
|
|
18
|
+
| [**update_pdp_config_api_v1_clients_uid_pdp_config_put**](ClientManagementApi.md#update_pdp_config_api_v1_clients_uid_pdp_config_put) | **PUT** /api/v1/clients/{uid}/pdp-config | Configure client PDP |
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## activate_client_api_v1_clients_uid_activer_post
|
|
22
|
+
|
|
23
|
+
> <ClientActivateResponse> activate_client_api_v1_clients_uid_activer_post(uid)
|
|
24
|
+
|
|
25
|
+
Activate a client
|
|
26
|
+
|
|
27
|
+
Activate a deactivated client. **Scope**: Client level (JWT with client_uid that must match {uid})
|
|
28
|
+
|
|
29
|
+
### Examples
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'time'
|
|
33
|
+
require 'factpulse'
|
|
34
|
+
# setup authorization
|
|
35
|
+
FactPulse.configure do |config|
|
|
36
|
+
# Configure API key authorization: APIKeyHeader
|
|
37
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
39
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
40
|
+
|
|
41
|
+
# Configure Bearer authorization: HTTPBearer
|
|
42
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
46
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
47
|
+
|
|
48
|
+
begin
|
|
49
|
+
# Activate a client
|
|
50
|
+
result = api_instance.activate_client_api_v1_clients_uid_activer_post(uid)
|
|
51
|
+
p result
|
|
52
|
+
rescue FactPulse::ApiError => e
|
|
53
|
+
puts "Error when calling ClientManagementApi->activate_client_api_v1_clients_uid_activer_post: #{e}"
|
|
54
|
+
end
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Using the activate_client_api_v1_clients_uid_activer_post_with_http_info variant
|
|
58
|
+
|
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
|
60
|
+
|
|
61
|
+
> <Array(<ClientActivateResponse>, Integer, Hash)> activate_client_api_v1_clients_uid_activer_post_with_http_info(uid)
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
begin
|
|
65
|
+
# Activate a client
|
|
66
|
+
data, status_code, headers = api_instance.activate_client_api_v1_clients_uid_activer_post_with_http_info(uid)
|
|
67
|
+
p status_code # => 2xx
|
|
68
|
+
p headers # => { ... }
|
|
69
|
+
p data # => <ClientActivateResponse>
|
|
70
|
+
rescue FactPulse::ApiError => e
|
|
71
|
+
puts "Error when calling ClientManagementApi->activate_client_api_v1_clients_uid_activer_post_with_http_info: #{e}"
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
| Name | Type | Description | Notes |
|
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
|
79
|
+
| **uid** | **String** | | |
|
|
80
|
+
|
|
81
|
+
### Return type
|
|
82
|
+
|
|
83
|
+
[**ClientActivateResponse**](ClientActivateResponse.md)
|
|
84
|
+
|
|
85
|
+
### Authorization
|
|
86
|
+
|
|
87
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
88
|
+
|
|
89
|
+
### HTTP request headers
|
|
90
|
+
|
|
91
|
+
- **Content-Type**: Not defined
|
|
92
|
+
- **Accept**: application/json
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
## create_client_api_v1_clients_post
|
|
96
|
+
|
|
97
|
+
> <ClientDetail> create_client_api_v1_clients_post(client_create_request)
|
|
98
|
+
|
|
99
|
+
Create a client
|
|
100
|
+
|
|
101
|
+
Create a new client for the account. **Scope**: Account level (JWT without client_uid) **Fields**: - `name`: Client name (required) - `description`: Optional description - `siret`: Optional SIRET (14 digits)
|
|
102
|
+
|
|
103
|
+
### Examples
|
|
104
|
+
|
|
105
|
+
```ruby
|
|
106
|
+
require 'time'
|
|
107
|
+
require 'factpulse'
|
|
108
|
+
# setup authorization
|
|
109
|
+
FactPulse.configure do |config|
|
|
110
|
+
# Configure API key authorization: APIKeyHeader
|
|
111
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
112
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
113
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
114
|
+
|
|
115
|
+
# Configure Bearer authorization: HTTPBearer
|
|
116
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
120
|
+
client_create_request = FactPulse::ClientCreateRequest.new({name: 'name_example'}) # ClientCreateRequest |
|
|
121
|
+
|
|
122
|
+
begin
|
|
123
|
+
# Create a client
|
|
124
|
+
result = api_instance.create_client_api_v1_clients_post(client_create_request)
|
|
125
|
+
p result
|
|
126
|
+
rescue FactPulse::ApiError => e
|
|
127
|
+
puts "Error when calling ClientManagementApi->create_client_api_v1_clients_post: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### Using the create_client_api_v1_clients_post_with_http_info variant
|
|
132
|
+
|
|
133
|
+
This returns an Array which contains the response data, status code and headers.
|
|
134
|
+
|
|
135
|
+
> <Array(<ClientDetail>, Integer, Hash)> create_client_api_v1_clients_post_with_http_info(client_create_request)
|
|
136
|
+
|
|
137
|
+
```ruby
|
|
138
|
+
begin
|
|
139
|
+
# Create a client
|
|
140
|
+
data, status_code, headers = api_instance.create_client_api_v1_clients_post_with_http_info(client_create_request)
|
|
141
|
+
p status_code # => 2xx
|
|
142
|
+
p headers # => { ... }
|
|
143
|
+
p data # => <ClientDetail>
|
|
144
|
+
rescue FactPulse::ApiError => e
|
|
145
|
+
puts "Error when calling ClientManagementApi->create_client_api_v1_clients_post_with_http_info: #{e}"
|
|
146
|
+
end
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
| Name | Type | Description | Notes |
|
|
152
|
+
| ---- | ---- | ----------- | ----- |
|
|
153
|
+
| **client_create_request** | [**ClientCreateRequest**](ClientCreateRequest.md) | | |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**ClientDetail**](ClientDetail.md)
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: application/json
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
## deactivate_client_api_v1_clients_uid_desactiver_post
|
|
170
|
+
|
|
171
|
+
> <ClientActivateResponse> deactivate_client_api_v1_clients_uid_desactiver_post(uid)
|
|
172
|
+
|
|
173
|
+
Deactivate a client
|
|
174
|
+
|
|
175
|
+
Deactivate an active client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Note**: A deactivated client cannot be used for API calls (AFNOR, Chorus Pro, etc.).
|
|
176
|
+
|
|
177
|
+
### Examples
|
|
178
|
+
|
|
179
|
+
```ruby
|
|
180
|
+
require 'time'
|
|
181
|
+
require 'factpulse'
|
|
182
|
+
# setup authorization
|
|
183
|
+
FactPulse.configure do |config|
|
|
184
|
+
# Configure API key authorization: APIKeyHeader
|
|
185
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
186
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
187
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
188
|
+
|
|
189
|
+
# Configure Bearer authorization: HTTPBearer
|
|
190
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
194
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
# Deactivate a client
|
|
198
|
+
result = api_instance.deactivate_client_api_v1_clients_uid_desactiver_post(uid)
|
|
199
|
+
p result
|
|
200
|
+
rescue FactPulse::ApiError => e
|
|
201
|
+
puts "Error when calling ClientManagementApi->deactivate_client_api_v1_clients_uid_desactiver_post: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
#### Using the deactivate_client_api_v1_clients_uid_desactiver_post_with_http_info variant
|
|
206
|
+
|
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
|
208
|
+
|
|
209
|
+
> <Array(<ClientActivateResponse>, Integer, Hash)> deactivate_client_api_v1_clients_uid_desactiver_post_with_http_info(uid)
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
begin
|
|
213
|
+
# Deactivate a client
|
|
214
|
+
data, status_code, headers = api_instance.deactivate_client_api_v1_clients_uid_desactiver_post_with_http_info(uid)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => <ClientActivateResponse>
|
|
218
|
+
rescue FactPulse::ApiError => e
|
|
219
|
+
puts "Error when calling ClientManagementApi->deactivate_client_api_v1_clients_uid_desactiver_post_with_http_info: #{e}"
|
|
220
|
+
end
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **uid** | **String** | | |
|
|
228
|
+
|
|
229
|
+
### Return type
|
|
230
|
+
|
|
231
|
+
[**ClientActivateResponse**](ClientActivateResponse.md)
|
|
232
|
+
|
|
233
|
+
### Authorization
|
|
234
|
+
|
|
235
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: Not defined
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete
|
|
244
|
+
|
|
245
|
+
> <WebhookSecretDeleteResponse> delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete(uid)
|
|
246
|
+
|
|
247
|
+
Delete webhook secret
|
|
248
|
+
|
|
249
|
+
Delete the webhook secret for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **After deletion**: Webhooks for this client will use the global server key for HMAC signature instead of a client-specific key.
|
|
250
|
+
|
|
251
|
+
### Examples
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
require 'time'
|
|
255
|
+
require 'factpulse'
|
|
256
|
+
# setup authorization
|
|
257
|
+
FactPulse.configure do |config|
|
|
258
|
+
# Configure API key authorization: APIKeyHeader
|
|
259
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
260
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
261
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
262
|
+
|
|
263
|
+
# Configure Bearer authorization: HTTPBearer
|
|
264
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
268
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Delete webhook secret
|
|
272
|
+
result = api_instance.delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete(uid)
|
|
273
|
+
p result
|
|
274
|
+
rescue FactPulse::ApiError => e
|
|
275
|
+
puts "Error when calling ClientManagementApi->delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(<WebhookSecretDeleteResponse>, Integer, Hash)> delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info(uid)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Delete webhook secret
|
|
288
|
+
data, status_code, headers = api_instance.delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info(uid)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => <WebhookSecretDeleteResponse>
|
|
292
|
+
rescue FactPulse::ApiError => e
|
|
293
|
+
puts "Error when calling ClientManagementApi->delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **uid** | **String** | | |
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
[**WebhookSecretDeleteResponse**](WebhookSecretDeleteResponse.md)
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: Not defined
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
## generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post
|
|
318
|
+
|
|
319
|
+
> <WebhookSecretGenerateResponse> generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post(uid)
|
|
320
|
+
|
|
321
|
+
Generate webhook secret
|
|
322
|
+
|
|
323
|
+
Generate or regenerate the webhook secret for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Important**: Save the returned secret immediately - it will never be shown again. The secret is used to sign webhooks sent by the server (HMAC-SHA256). **If a secret already exists**: It will be replaced by the new one.
|
|
324
|
+
|
|
325
|
+
### Examples
|
|
326
|
+
|
|
327
|
+
```ruby
|
|
328
|
+
require 'time'
|
|
329
|
+
require 'factpulse'
|
|
330
|
+
# setup authorization
|
|
331
|
+
FactPulse.configure do |config|
|
|
332
|
+
# Configure API key authorization: APIKeyHeader
|
|
333
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
335
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
336
|
+
|
|
337
|
+
# Configure Bearer authorization: HTTPBearer
|
|
338
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
342
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
343
|
+
|
|
344
|
+
begin
|
|
345
|
+
# Generate webhook secret
|
|
346
|
+
result = api_instance.generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post(uid)
|
|
347
|
+
p result
|
|
348
|
+
rescue FactPulse::ApiError => e
|
|
349
|
+
puts "Error when calling ClientManagementApi->generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post: #{e}"
|
|
350
|
+
end
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
#### Using the generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info variant
|
|
354
|
+
|
|
355
|
+
This returns an Array which contains the response data, status code and headers.
|
|
356
|
+
|
|
357
|
+
> <Array(<WebhookSecretGenerateResponse>, Integer, Hash)> generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info(uid)
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
begin
|
|
361
|
+
# Generate webhook secret
|
|
362
|
+
data, status_code, headers = api_instance.generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info(uid)
|
|
363
|
+
p status_code # => 2xx
|
|
364
|
+
p headers # => { ... }
|
|
365
|
+
p data # => <WebhookSecretGenerateResponse>
|
|
366
|
+
rescue FactPulse::ApiError => e
|
|
367
|
+
puts "Error when calling ClientManagementApi->generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info: #{e}"
|
|
368
|
+
end
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Parameters
|
|
372
|
+
|
|
373
|
+
| Name | Type | Description | Notes |
|
|
374
|
+
| ---- | ---- | ----------- | ----- |
|
|
375
|
+
| **uid** | **String** | | |
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
[**WebhookSecretGenerateResponse**](WebhookSecretGenerateResponse.md)
|
|
380
|
+
|
|
381
|
+
### Authorization
|
|
382
|
+
|
|
383
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
384
|
+
|
|
385
|
+
### HTTP request headers
|
|
386
|
+
|
|
387
|
+
- **Content-Type**: Not defined
|
|
388
|
+
- **Accept**: application/json
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
## get_client_api_v1_clients_uid_get
|
|
392
|
+
|
|
393
|
+
> <ClientDetail> get_client_api_v1_clients_uid_get(uid)
|
|
394
|
+
|
|
395
|
+
Get client details
|
|
396
|
+
|
|
397
|
+
Get details of a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Security**: If the JWT contains a client_uid, it must match the {uid} in the URL, otherwise a 403 error is returned.
|
|
398
|
+
|
|
399
|
+
### Examples
|
|
400
|
+
|
|
401
|
+
```ruby
|
|
402
|
+
require 'time'
|
|
403
|
+
require 'factpulse'
|
|
404
|
+
# setup authorization
|
|
405
|
+
FactPulse.configure do |config|
|
|
406
|
+
# Configure API key authorization: APIKeyHeader
|
|
407
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
408
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
409
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
410
|
+
|
|
411
|
+
# Configure Bearer authorization: HTTPBearer
|
|
412
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
413
|
+
end
|
|
414
|
+
|
|
415
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
416
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
417
|
+
|
|
418
|
+
begin
|
|
419
|
+
# Get client details
|
|
420
|
+
result = api_instance.get_client_api_v1_clients_uid_get(uid)
|
|
421
|
+
p result
|
|
422
|
+
rescue FactPulse::ApiError => e
|
|
423
|
+
puts "Error when calling ClientManagementApi->get_client_api_v1_clients_uid_get: #{e}"
|
|
424
|
+
end
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
#### Using the get_client_api_v1_clients_uid_get_with_http_info variant
|
|
428
|
+
|
|
429
|
+
This returns an Array which contains the response data, status code and headers.
|
|
430
|
+
|
|
431
|
+
> <Array(<ClientDetail>, Integer, Hash)> get_client_api_v1_clients_uid_get_with_http_info(uid)
|
|
432
|
+
|
|
433
|
+
```ruby
|
|
434
|
+
begin
|
|
435
|
+
# Get client details
|
|
436
|
+
data, status_code, headers = api_instance.get_client_api_v1_clients_uid_get_with_http_info(uid)
|
|
437
|
+
p status_code # => 2xx
|
|
438
|
+
p headers # => { ... }
|
|
439
|
+
p data # => <ClientDetail>
|
|
440
|
+
rescue FactPulse::ApiError => e
|
|
441
|
+
puts "Error when calling ClientManagementApi->get_client_api_v1_clients_uid_get_with_http_info: #{e}"
|
|
442
|
+
end
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
### Parameters
|
|
446
|
+
|
|
447
|
+
| Name | Type | Description | Notes |
|
|
448
|
+
| ---- | ---- | ----------- | ----- |
|
|
449
|
+
| **uid** | **String** | | |
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**ClientDetail**](ClientDetail.md)
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: Not defined
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
## get_pdp_config_api_v1_clients_uid_pdp_config_get
|
|
466
|
+
|
|
467
|
+
> <PDPConfigResponse> get_pdp_config_api_v1_clients_uid_pdp_config_get(uid)
|
|
468
|
+
|
|
469
|
+
Get client PDP configuration
|
|
470
|
+
|
|
471
|
+
Get the PDP (PA/PDP) configuration for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Security**: The client secret is never returned. Only a status (`secretStatus`) indicates whether a secret is configured. **Response**: - If configured: all config details (URLs, client_id, secret status) - If not configured: `isConfigured: false` with a message
|
|
472
|
+
|
|
473
|
+
### Examples
|
|
474
|
+
|
|
475
|
+
```ruby
|
|
476
|
+
require 'time'
|
|
477
|
+
require 'factpulse'
|
|
478
|
+
# setup authorization
|
|
479
|
+
FactPulse.configure do |config|
|
|
480
|
+
# Configure API key authorization: APIKeyHeader
|
|
481
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
482
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
483
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
484
|
+
|
|
485
|
+
# Configure Bearer authorization: HTTPBearer
|
|
486
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
490
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
491
|
+
|
|
492
|
+
begin
|
|
493
|
+
# Get client PDP configuration
|
|
494
|
+
result = api_instance.get_pdp_config_api_v1_clients_uid_pdp_config_get(uid)
|
|
495
|
+
p result
|
|
496
|
+
rescue FactPulse::ApiError => e
|
|
497
|
+
puts "Error when calling ClientManagementApi->get_pdp_config_api_v1_clients_uid_pdp_config_get: #{e}"
|
|
498
|
+
end
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
#### Using the get_pdp_config_api_v1_clients_uid_pdp_config_get_with_http_info variant
|
|
502
|
+
|
|
503
|
+
This returns an Array which contains the response data, status code and headers.
|
|
504
|
+
|
|
505
|
+
> <Array(<PDPConfigResponse>, Integer, Hash)> get_pdp_config_api_v1_clients_uid_pdp_config_get_with_http_info(uid)
|
|
506
|
+
|
|
507
|
+
```ruby
|
|
508
|
+
begin
|
|
509
|
+
# Get client PDP configuration
|
|
510
|
+
data, status_code, headers = api_instance.get_pdp_config_api_v1_clients_uid_pdp_config_get_with_http_info(uid)
|
|
511
|
+
p status_code # => 2xx
|
|
512
|
+
p headers # => { ... }
|
|
513
|
+
p data # => <PDPConfigResponse>
|
|
514
|
+
rescue FactPulse::ApiError => e
|
|
515
|
+
puts "Error when calling ClientManagementApi->get_pdp_config_api_v1_clients_uid_pdp_config_get_with_http_info: #{e}"
|
|
516
|
+
end
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
### Parameters
|
|
520
|
+
|
|
521
|
+
| Name | Type | Description | Notes |
|
|
522
|
+
| ---- | ---- | ----------- | ----- |
|
|
523
|
+
| **uid** | **String** | | |
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
[**PDPConfigResponse**](PDPConfigResponse.md)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: Not defined
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
## get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get
|
|
540
|
+
|
|
541
|
+
> <WebhookSecretStatusResponse> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
|
|
542
|
+
|
|
543
|
+
Get webhook secret status
|
|
544
|
+
|
|
545
|
+
Check if a webhook secret is configured for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `hasSecret`: Whether a webhook secret is configured - `createdAt`: When the secret was created (if exists) **Note**: The secret value is never returned, only its status.
|
|
546
|
+
|
|
547
|
+
### Examples
|
|
548
|
+
|
|
549
|
+
```ruby
|
|
550
|
+
require 'time'
|
|
551
|
+
require 'factpulse'
|
|
552
|
+
# setup authorization
|
|
553
|
+
FactPulse.configure do |config|
|
|
554
|
+
# Configure API key authorization: APIKeyHeader
|
|
555
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
556
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
557
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
558
|
+
|
|
559
|
+
# Configure Bearer authorization: HTTPBearer
|
|
560
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
564
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
565
|
+
|
|
566
|
+
begin
|
|
567
|
+
# Get webhook secret status
|
|
568
|
+
result = api_instance.get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
|
|
569
|
+
p result
|
|
570
|
+
rescue FactPulse::ApiError => e
|
|
571
|
+
puts "Error when calling ClientManagementApi->get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get: #{e}"
|
|
572
|
+
end
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
#### Using the get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info variant
|
|
576
|
+
|
|
577
|
+
This returns an Array which contains the response data, status code and headers.
|
|
578
|
+
|
|
579
|
+
> <Array(<WebhookSecretStatusResponse>, Integer, Hash)> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info(uid)
|
|
580
|
+
|
|
581
|
+
```ruby
|
|
582
|
+
begin
|
|
583
|
+
# Get webhook secret status
|
|
584
|
+
data, status_code, headers = api_instance.get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info(uid)
|
|
585
|
+
p status_code # => 2xx
|
|
586
|
+
p headers # => { ... }
|
|
587
|
+
p data # => <WebhookSecretStatusResponse>
|
|
588
|
+
rescue FactPulse::ApiError => e
|
|
589
|
+
puts "Error when calling ClientManagementApi->get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info: #{e}"
|
|
590
|
+
end
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
| Name | Type | Description | Notes |
|
|
596
|
+
| ---- | ---- | ----------- | ----- |
|
|
597
|
+
| **uid** | **String** | | |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
[**WebhookSecretStatusResponse**](WebhookSecretStatusResponse.md)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: application/json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
## list_clients_api_v1_clients_get
|
|
614
|
+
|
|
615
|
+
> <ClientListResponse> list_clients_api_v1_clients_get(opts)
|
|
616
|
+
|
|
617
|
+
List clients
|
|
618
|
+
|
|
619
|
+
Paginated list of clients for the account. **Scope**: Account level (JWT without client_uid) **Pagination**: - `page`: Page number (default: 1) - `pageSize`: Page size (default: 20, max: 100)
|
|
620
|
+
|
|
621
|
+
### Examples
|
|
622
|
+
|
|
623
|
+
```ruby
|
|
624
|
+
require 'time'
|
|
625
|
+
require 'factpulse'
|
|
626
|
+
# setup authorization
|
|
627
|
+
FactPulse.configure do |config|
|
|
628
|
+
# Configure API key authorization: APIKeyHeader
|
|
629
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
630
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
631
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
632
|
+
|
|
633
|
+
# Configure Bearer authorization: HTTPBearer
|
|
634
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
638
|
+
opts = {
|
|
639
|
+
page: 56, # Integer | Page number
|
|
640
|
+
page_size: 56 # Integer | Page size
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
begin
|
|
644
|
+
# List clients
|
|
645
|
+
result = api_instance.list_clients_api_v1_clients_get(opts)
|
|
646
|
+
p result
|
|
647
|
+
rescue FactPulse::ApiError => e
|
|
648
|
+
puts "Error when calling ClientManagementApi->list_clients_api_v1_clients_get: #{e}"
|
|
649
|
+
end
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
#### Using the list_clients_api_v1_clients_get_with_http_info variant
|
|
653
|
+
|
|
654
|
+
This returns an Array which contains the response data, status code and headers.
|
|
655
|
+
|
|
656
|
+
> <Array(<ClientListResponse>, Integer, Hash)> list_clients_api_v1_clients_get_with_http_info(opts)
|
|
657
|
+
|
|
658
|
+
```ruby
|
|
659
|
+
begin
|
|
660
|
+
# List clients
|
|
661
|
+
data, status_code, headers = api_instance.list_clients_api_v1_clients_get_with_http_info(opts)
|
|
662
|
+
p status_code # => 2xx
|
|
663
|
+
p headers # => { ... }
|
|
664
|
+
p data # => <ClientListResponse>
|
|
665
|
+
rescue FactPulse::ApiError => e
|
|
666
|
+
puts "Error when calling ClientManagementApi->list_clients_api_v1_clients_get_with_http_info: #{e}"
|
|
667
|
+
end
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
### Parameters
|
|
671
|
+
|
|
672
|
+
| Name | Type | Description | Notes |
|
|
673
|
+
| ---- | ---- | ----------- | ----- |
|
|
674
|
+
| **page** | **Integer** | Page number | [optional][default to 1] |
|
|
675
|
+
| **page_size** | **Integer** | Page size | [optional][default to 20] |
|
|
676
|
+
|
|
677
|
+
### Return type
|
|
678
|
+
|
|
679
|
+
[**ClientListResponse**](ClientListResponse.md)
|
|
680
|
+
|
|
681
|
+
### Authorization
|
|
682
|
+
|
|
683
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
684
|
+
|
|
685
|
+
### HTTP request headers
|
|
686
|
+
|
|
687
|
+
- **Content-Type**: Not defined
|
|
688
|
+
- **Accept**: application/json
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
## rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post
|
|
692
|
+
|
|
693
|
+
> <KeyRotationResponse> rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post(uid, key_rotation_request)
|
|
694
|
+
|
|
695
|
+
Rotate client encryption key
|
|
696
|
+
|
|
697
|
+
Rotate the client encryption key for all secrets in double encryption mode. **Scope**: Client level (JWT with client_uid that must match {uid}) **What this does**: 1. Decrypts all secrets (PDP, Chorus Pro) using the old key 2. Re-encrypts them using the new key 3. Saves to database **Important notes**: - Both keys must be base64-encoded AES-256 keys (32 bytes each) - The old key becomes invalid immediately after rotation - Only secrets encrypted with `encryptionMode: \"double\"` are affected - If the client has no double-encrypted secrets, returns 404 **Security**: - The old key must be valid (decryption is verified) - If decryption fails, rotation is aborted (atomic operation) - Neither key is logged or stored by the server
|
|
698
|
+
|
|
699
|
+
### Examples
|
|
700
|
+
|
|
701
|
+
```ruby
|
|
702
|
+
require 'time'
|
|
703
|
+
require 'factpulse'
|
|
704
|
+
# setup authorization
|
|
705
|
+
FactPulse.configure do |config|
|
|
706
|
+
# Configure API key authorization: APIKeyHeader
|
|
707
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
708
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
709
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
710
|
+
|
|
711
|
+
# Configure Bearer authorization: HTTPBearer
|
|
712
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
713
|
+
end
|
|
714
|
+
|
|
715
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
716
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
717
|
+
key_rotation_request = FactPulse::KeyRotationRequest.new({old_key: 'old_key_example', new_key: 'new_key_example'}) # KeyRotationRequest |
|
|
718
|
+
|
|
719
|
+
begin
|
|
720
|
+
# Rotate client encryption key
|
|
721
|
+
result = api_instance.rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post(uid, key_rotation_request)
|
|
722
|
+
p result
|
|
723
|
+
rescue FactPulse::ApiError => e
|
|
724
|
+
puts "Error when calling ClientManagementApi->rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post: #{e}"
|
|
725
|
+
end
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
#### Using the rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info variant
|
|
729
|
+
|
|
730
|
+
This returns an Array which contains the response data, status code and headers.
|
|
731
|
+
|
|
732
|
+
> <Array(<KeyRotationResponse>, Integer, Hash)> rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info(uid, key_rotation_request)
|
|
733
|
+
|
|
734
|
+
```ruby
|
|
735
|
+
begin
|
|
736
|
+
# Rotate client encryption key
|
|
737
|
+
data, status_code, headers = api_instance.rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info(uid, key_rotation_request)
|
|
738
|
+
p status_code # => 2xx
|
|
739
|
+
p headers # => { ... }
|
|
740
|
+
p data # => <KeyRotationResponse>
|
|
741
|
+
rescue FactPulse::ApiError => e
|
|
742
|
+
puts "Error when calling ClientManagementApi->rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info: #{e}"
|
|
743
|
+
end
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
### Parameters
|
|
747
|
+
|
|
748
|
+
| Name | Type | Description | Notes |
|
|
749
|
+
| ---- | ---- | ----------- | ----- |
|
|
750
|
+
| **uid** | **String** | | |
|
|
751
|
+
| **key_rotation_request** | [**KeyRotationRequest**](KeyRotationRequest.md) | | |
|
|
752
|
+
|
|
753
|
+
### Return type
|
|
754
|
+
|
|
755
|
+
[**KeyRotationResponse**](KeyRotationResponse.md)
|
|
756
|
+
|
|
757
|
+
### Authorization
|
|
758
|
+
|
|
759
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
760
|
+
|
|
761
|
+
### HTTP request headers
|
|
762
|
+
|
|
763
|
+
- **Content-Type**: application/json
|
|
764
|
+
- **Accept**: application/json
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
## update_client_api_v1_clients_uid_patch
|
|
768
|
+
|
|
769
|
+
> <ClientDetail> update_client_api_v1_clients_uid_patch(uid, client_update_request)
|
|
770
|
+
|
|
771
|
+
Update a client
|
|
772
|
+
|
|
773
|
+
Update client information (partial update). **Scope**: Client level (JWT with client_uid that must match {uid}) **Updatable fields**: - `name`: Client name - `description`: Description - `siret`: SIRET (14 digits) Only provided fields are updated.
|
|
774
|
+
|
|
775
|
+
### Examples
|
|
776
|
+
|
|
777
|
+
```ruby
|
|
778
|
+
require 'time'
|
|
779
|
+
require 'factpulse'
|
|
780
|
+
# setup authorization
|
|
781
|
+
FactPulse.configure do |config|
|
|
782
|
+
# Configure API key authorization: APIKeyHeader
|
|
783
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
784
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
785
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
786
|
+
|
|
787
|
+
# Configure Bearer authorization: HTTPBearer
|
|
788
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
789
|
+
end
|
|
790
|
+
|
|
791
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
792
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
793
|
+
client_update_request = FactPulse::ClientUpdateRequest.new # ClientUpdateRequest |
|
|
794
|
+
|
|
795
|
+
begin
|
|
796
|
+
# Update a client
|
|
797
|
+
result = api_instance.update_client_api_v1_clients_uid_patch(uid, client_update_request)
|
|
798
|
+
p result
|
|
799
|
+
rescue FactPulse::ApiError => e
|
|
800
|
+
puts "Error when calling ClientManagementApi->update_client_api_v1_clients_uid_patch: #{e}"
|
|
801
|
+
end
|
|
802
|
+
```
|
|
803
|
+
|
|
804
|
+
#### Using the update_client_api_v1_clients_uid_patch_with_http_info variant
|
|
805
|
+
|
|
806
|
+
This returns an Array which contains the response data, status code and headers.
|
|
807
|
+
|
|
808
|
+
> <Array(<ClientDetail>, Integer, Hash)> update_client_api_v1_clients_uid_patch_with_http_info(uid, client_update_request)
|
|
809
|
+
|
|
810
|
+
```ruby
|
|
811
|
+
begin
|
|
812
|
+
# Update a client
|
|
813
|
+
data, status_code, headers = api_instance.update_client_api_v1_clients_uid_patch_with_http_info(uid, client_update_request)
|
|
814
|
+
p status_code # => 2xx
|
|
815
|
+
p headers # => { ... }
|
|
816
|
+
p data # => <ClientDetail>
|
|
817
|
+
rescue FactPulse::ApiError => e
|
|
818
|
+
puts "Error when calling ClientManagementApi->update_client_api_v1_clients_uid_patch_with_http_info: #{e}"
|
|
819
|
+
end
|
|
820
|
+
```
|
|
821
|
+
|
|
822
|
+
### Parameters
|
|
823
|
+
|
|
824
|
+
| Name | Type | Description | Notes |
|
|
825
|
+
| ---- | ---- | ----------- | ----- |
|
|
826
|
+
| **uid** | **String** | | |
|
|
827
|
+
| **client_update_request** | [**ClientUpdateRequest**](ClientUpdateRequest.md) | | |
|
|
828
|
+
|
|
829
|
+
### Return type
|
|
830
|
+
|
|
831
|
+
[**ClientDetail**](ClientDetail.md)
|
|
832
|
+
|
|
833
|
+
### Authorization
|
|
834
|
+
|
|
835
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
836
|
+
|
|
837
|
+
### HTTP request headers
|
|
838
|
+
|
|
839
|
+
- **Content-Type**: application/json
|
|
840
|
+
- **Accept**: application/json
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
## update_pdp_config_api_v1_clients_uid_pdp_config_put
|
|
844
|
+
|
|
845
|
+
> <PDPConfigResponse> update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request, opts)
|
|
846
|
+
|
|
847
|
+
Configure client PDP
|
|
848
|
+
|
|
849
|
+
Configure or update the PDP (PA/PDP) configuration for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Required fields**: - `flowServiceUrl`: PDP Flow Service URL - `tokenUrl`: PDP OAuth token URL - `oauthClientId`: OAuth Client ID - `clientSecret`: OAuth Client Secret (sent but NEVER returned) **Optional fields**: - `isActive`: Enable/disable the config (default: true) - `modeSandbox`: Sandbox mode (default: false) - `encryptionMode`: Encryption mode (default: \"fernet\") - \"fernet\": Server-side encryption only - \"double\": Client AES-256-GCM + Server Fernet (requires X-Encryption-Key header) **Double Encryption Mode**: When `encryptionMode` is set to \"double\", you MUST also provide the `X-Encryption-Key` header containing a base64-encoded AES-256 key (32 bytes). This key is used to encrypt the `clientSecret` on the client side before the server encrypts it again with Fernet. The server cannot decrypt the secret without the client key. **Security**: The `clientSecret` is stored encrypted on Django side and is never returned in API responses.
|
|
850
|
+
|
|
851
|
+
### Examples
|
|
852
|
+
|
|
853
|
+
```ruby
|
|
854
|
+
require 'time'
|
|
855
|
+
require 'factpulse'
|
|
856
|
+
# setup authorization
|
|
857
|
+
FactPulse.configure do |config|
|
|
858
|
+
# Configure API key authorization: APIKeyHeader
|
|
859
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
860
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
861
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
862
|
+
|
|
863
|
+
# Configure Bearer authorization: HTTPBearer
|
|
864
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
865
|
+
end
|
|
866
|
+
|
|
867
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
868
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
869
|
+
pdp_config_update_request = FactPulse::PDPConfigUpdateRequest.new({flow_service_url: 'flow_service_url_example', token_url: 'token_url_example', oauth_client_id: 'oauth_client_id_example', client_secret: 'client_secret_example'}) # PDPConfigUpdateRequest |
|
|
870
|
+
opts = {
|
|
871
|
+
x_encryption_key: 'x_encryption_key_example' # String | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode='double'.
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
begin
|
|
875
|
+
# Configure client PDP
|
|
876
|
+
result = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request, opts)
|
|
877
|
+
p result
|
|
878
|
+
rescue FactPulse::ApiError => e
|
|
879
|
+
puts "Error when calling ClientManagementApi->update_pdp_config_api_v1_clients_uid_pdp_config_put: #{e}"
|
|
880
|
+
end
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
#### Using the update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info variant
|
|
884
|
+
|
|
885
|
+
This returns an Array which contains the response data, status code and headers.
|
|
886
|
+
|
|
887
|
+
> <Array(<PDPConfigResponse>, Integer, Hash)> update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request, opts)
|
|
888
|
+
|
|
889
|
+
```ruby
|
|
890
|
+
begin
|
|
891
|
+
# Configure client PDP
|
|
892
|
+
data, status_code, headers = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request, opts)
|
|
893
|
+
p status_code # => 2xx
|
|
894
|
+
p headers # => { ... }
|
|
895
|
+
p data # => <PDPConfigResponse>
|
|
896
|
+
rescue FactPulse::ApiError => e
|
|
897
|
+
puts "Error when calling ClientManagementApi->update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info: #{e}"
|
|
898
|
+
end
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
### Parameters
|
|
902
|
+
|
|
903
|
+
| Name | Type | Description | Notes |
|
|
904
|
+
| ---- | ---- | ----------- | ----- |
|
|
905
|
+
| **uid** | **String** | | |
|
|
906
|
+
| **pdp_config_update_request** | [**PDPConfigUpdateRequest**](PDPConfigUpdateRequest.md) | | |
|
|
907
|
+
| **x_encryption_key** | **String** | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode='double'. | [optional] |
|
|
908
|
+
|
|
909
|
+
### Return type
|
|
910
|
+
|
|
911
|
+
[**PDPConfigResponse**](PDPConfigResponse.md)
|
|
912
|
+
|
|
913
|
+
### Authorization
|
|
914
|
+
|
|
915
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
916
|
+
|
|
917
|
+
### HTTP request headers
|
|
918
|
+
|
|
919
|
+
- **Content-Type**: application/json
|
|
920
|
+
- **Accept**: application/json
|
|
921
|
+
|