factpulse 4.3.0 → 4.5.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 +4 -4
- data/CHANGELOG.md +11 -5
- data/Gemfile.lock +15 -13
- data/README.md +7 -1
- data/docs/AFNORContainsOrStartWithOperator.md +15 -0
- data/docs/AFNORContainsOrStrictOrStartWithOperator.md +15 -0
- data/docs/AFNORDirectoryLinePayloadLegalUnitFacilityRoutingCode.md +4 -0
- data/docs/AFNORDirectoryLinePayloadStatusLegalUnitFacilityRoutingCode.md +2 -0
- data/docs/AFNORDirectoryLineSearchPost200Response.md +1 -1
- data/docs/AFNORFacilityPayloadIncluded.md +2 -0
- data/docs/AFNORFlow.md +2 -2
- data/docs/AFNORLegalUnitPayloadIncluded.md +3 -1
- data/docs/AFNORPDPPAFlowServiceApi.md +3 -133
- data/docs/AFNORRoutingCodeSearch.md +2 -2
- data/docs/AFNORRoutingCodeSearchPost200Response.md +1 -1
- data/docs/AFNORSearchDirectoryLine.md +4 -2
- data/docs/AFNORSearchDirectoryLineSortingInner.md +2 -2
- data/docs/AFNORSearchFlowContent.md +3 -1
- data/docs/AFNORSearchFlowParams.md +3 -1
- data/docs/AFNORSearchSiren.md +1 -1
- data/docs/AFNORSearchSirenFiltersBusinessName.md +1 -1
- data/docs/AFNORSearchSirenSortingInner.md +2 -2
- data/docs/AFNORSearchSiret.md +1 -1
- data/docs/AFNORSearchSiretFiltersAddressLines.md +1 -1
- data/docs/AFNORSearchSiretFiltersLocality.md +1 -1
- data/docs/AFNORSearchSiretFiltersName.md +1 -1
- data/docs/AFNORSearchSiretSortingInner.md +2 -2
- data/docs/AFNORSirenSearchPost200Response.md +1 -1
- data/docs/AFNORSiretSearchPost200Response.md +1 -1
- data/docs/AFNORUniqueDirectoryLineStatus.md +15 -0
- data/docs/AFNORWebhook.md +12 -4
- data/docs/AFNORWebhookIdParam.md +5 -1
- data/docs/AFNORWebhookParams.md +8 -4
- data/docs/AllowanceCharge.md +1 -1
- data/docs/{AFNORAlgorithm.md → Amount3.md} +2 -2
- data/docs/{AFNORContainsOperator.md → Amounteur.md} +2 -2
- data/docs/ClientManagementApi.md +383 -0
- data/docs/CreateCDARRequest.md +7 -1
- data/docs/DeliveryParty.md +2 -2
- data/docs/ElectronicAddressInput.md +20 -0
- data/docs/ElectronicAddressOutput.md +20 -0
- data/docs/ElectronicSignatureApi.md +6 -6
- data/docs/EncaisseAmountByRate.md +20 -0
- data/docs/EncaisseeRequest.md +8 -2
- data/docs/FacturXConversionApi.md +2 -2
- data/docs/FacturXPDFXMLVerificationApi.md +4 -4
- data/docs/FacturXValidationApi.md +4 -4
- data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
- data/docs/{ChorusProCredentials.md → FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md} +2 -2
- data/docs/{ValidationErrorResponse.md → FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md} +2 -2
- data/docs/Flux10EReportingApi.md +22 -12
- data/docs/Flux6InvoiceLifecycleCDARApi.md +45 -21
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/IncomingSupplier.md +4 -2
- data/docs/InvoiceGenerationApi.md +16 -10
- data/docs/InvoiceInput.md +4 -0
- data/docs/{AFNORCallbackAuthentication.md → Invoicedata.md} +9 -9
- data/docs/LifecycleEvent.md +2 -0
- data/docs/LifecycleResponse.md +9 -1
- data/docs/ParseApi.md +4 -4
- data/docs/Payee.md +2 -2
- data/docs/PaymentAmountByRate.md +4 -2
- data/docs/PostalAddressInput.md +30 -0
- data/docs/PostalAddressOutput.md +30 -0
- data/docs/ProcessingOptions.md +1 -1
- data/docs/Recipient.md +3 -3
- data/docs/ReportSender.md +2 -0
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/SimplifiedInvoiceData.md +3 -3
- data/docs/SubmitCDARRequest.md +6 -0
- data/docs/SubmitCompleteInvoiceRequest.md +1 -1
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/docs/SuperPDPConnectURLResponse.md +18 -0
- data/docs/SuperPDPDisconnectResponse.md +20 -0
- data/docs/SuperPDPStatusResponse.md +26 -0
- data/docs/SuperPDPVatRegimeResponse.md +20 -0
- data/docs/SuperPDPVatRegimeUpdateRequest.md +20 -0
- data/docs/Supplier.md +5 -3
- data/docs/TaxBreakdownInput.md +7 -1
- data/docs/TaxRepresentative.md +1 -1
- data/docs/Taxamounteur.md +15 -0
- data/docs/ValidateCDARRequest.md +3 -1
- data/docs/ValidationApi.md +3 -3
- data/docs/ValidationError.md +5 -1
- data/factpulse.gemspec +1 -1
- data/lib/factpulse/api/afnorpdppa_api.rb +1 -1
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1 -1
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +7 -133
- data/lib/factpulse/api/async_tasks_api.rb +1 -1
- data/lib/factpulse/api/chorus_pro_api.rb +1 -1
- data/lib/factpulse/api/client_management_api.rb +333 -1
- data/lib/factpulse/api/downloads_api.rb +1 -1
- data/lib/factpulse/api/electronic_signature_api.rb +7 -7
- data/lib/factpulse/api/factur_x_conversion_api.rb +3 -3
- data/lib/factpulse/api/factur_x_validation_api.rb +5 -5
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +5 -5
- data/lib/factpulse/api/flux10_e_reporting_api.rb +14 -5
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +33 -5
- data/lib/factpulse/api/health_api.rb +1 -1
- data/lib/factpulse/api/invoice_generation_api.rb +11 -5
- data/lib/factpulse/api/parse_api.rb +5 -5
- data/lib/factpulse/api/references_api.rb +1 -1
- data/lib/factpulse/api/validation_api.rb +5 -5
- data/lib/factpulse/api_client.rb +1 -1
- data/lib/factpulse/api_error.rb +1 -1
- data/lib/factpulse/api_model_base.rb +1 -1
- data/lib/factpulse/configuration.rb +1 -1
- data/lib/factpulse/helpers/client.rb +42 -5
- data/lib/factpulse/models/acknowledgment_status.rb +1 -1
- data/lib/factpulse/models/action_code_info.rb +1 -1
- data/lib/factpulse/models/action_codes_response.rb +1 -1
- data/lib/factpulse/models/additional_document.rb +1 -1
- data/lib/factpulse/models/afnor_acknowledgement.rb +1 -1
- data/lib/factpulse/models/afnor_acknowledgement_detail.rb +1 -1
- data/lib/factpulse/models/afnor_address_read.rb +1 -1
- data/lib/factpulse/models/{afnor_contains_operator.rb → afnor_contains_or_start_with_operator.rb} +6 -5
- data/lib/factpulse/models/afnor_contains_or_strict_operator.rb +1 -1
- data/lib/factpulse/models/{afnor_algorithm.rb → afnor_contains_or_strict_or_start_with_operator.rb} +8 -11
- data/lib/factpulse/models/afnor_core_flow_info.rb +6 -6
- data/lib/factpulse/models/afnor_credentials.rb +1 -1
- data/lib/factpulse/models/afnor_destination.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_field.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +1 -1
- data/lib/factpulse/models/afnor_directory_line_payload_legal_unit_facility_routing_code.rb +51 -2
- data/lib/factpulse/models/afnor_directory_line_payload_status_legal_unit_facility_routing_code.rb +42 -2
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_directory_line_status.rb +1 -1
- data/lib/factpulse/models/afnor_entity_type.rb +1 -1
- data/lib/factpulse/models/afnor_error.rb +1 -1
- data/lib/factpulse/models/afnor_error_detail.rb +1 -1
- data/lib/factpulse/models/afnor_facility_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_history.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +1 -1
- data/lib/factpulse/models/afnor_facility_payload_included.rb +11 -2
- data/lib/factpulse/models/afnor_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_flow.rb +45 -11
- data/lib/factpulse/models/afnor_flow_ack_status.rb +1 -1
- data/lib/factpulse/models/afnor_flow_direction.rb +1 -1
- data/lib/factpulse/models/afnor_flow_extension.rb +1 -1
- data/lib/factpulse/models/afnor_flow_info.rb +6 -6
- data/lib/factpulse/models/afnor_flow_info_extension.rb +1 -1
- data/lib/factpulse/models/afnor_flow_profile.rb +3 -2
- data/lib/factpulse/models/afnor_flow_syntax.rb +1 -1
- data/lib/factpulse/models/afnor_flow_type.rb +9 -3
- data/lib/factpulse/models/afnor_full_flow_info.rb +11 -11
- data/lib/factpulse/models/afnor_full_flow_info_extension.rb +7 -7
- data/lib/factpulse/models/afnor_health_check_response.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +1 -1
- data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +14 -5
- data/lib/factpulse/models/afnor_processing_rule.rb +3 -2
- data/lib/factpulse/models/afnor_reason_code.rb +1 -1
- data/lib/factpulse/models/afnor_reason_code_enum.rb +1 -1
- data/lib/factpulse/models/afnor_recipient_platform_type.rb +1 -1
- data/lib/factpulse/models/afnor_result.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_field.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line.rb +35 -2
- data/lib/factpulse/models/afnor_search_directory_line_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +1 -1
- data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_search_flow_content.rb +34 -2
- data/lib/factpulse/models/afnor_search_flow_filters.rb +6 -6
- data/lib/factpulse/models/afnor_search_flow_params.rb +13 -3
- data/lib/factpulse/models/afnor_search_siren.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +1 -1
- data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_search_siret.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_name.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +1 -1
- data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +8 -8
- data/lib/factpulse/models/afnor_siren_field.rb +1 -1
- data/lib/factpulse/models/afnor_siren_instructions.rb +1 -1
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_siret_field.rb +1 -1
- data/lib/factpulse/models/afnor_siret_instructions.rb +1 -1
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +4 -2
- data/lib/factpulse/models/afnor_sorting_order.rb +1 -1
- data/lib/factpulse/models/afnor_strict_operator.rb +1 -1
- data/lib/factpulse/models/afnor_strict_or_start_with_operator.rb +1 -1
- data/lib/factpulse/models/afnor_unique_directory_line_status.rb +40 -0
- data/lib/factpulse/models/afnor_webhook.rb +83 -40
- data/lib/factpulse/models/afnor_webhook_id_param.rb +23 -5
- data/lib/factpulse/models/afnor_webhook_params.rb +65 -40
- data/lib/factpulse/models/aggregated_payment_input.rb +1 -1
- data/lib/factpulse/models/aggregated_transaction_input.rb +1 -1
- data/lib/factpulse/models/allowance_charge.rb +2 -2
- data/lib/factpulse/models/allowance_charge_reason_code.rb +1 -1
- data/lib/factpulse/models/allowance_reason_code.rb +1 -1
- data/lib/factpulse/models/allowance_total_amount.rb +1 -1
- data/lib/factpulse/models/amount.rb +2 -2
- data/lib/factpulse/models/amount1.rb +2 -2
- data/lib/factpulse/models/amount2.rb +2 -2
- data/lib/factpulse/models/amount3.rb +104 -0
- data/lib/factpulse/models/amount_due.rb +1 -1
- data/lib/factpulse/models/amounteur.rb +104 -0
- data/lib/factpulse/models/api_error.rb +1 -1
- data/lib/factpulse/models/api_profile.rb +1 -1
- data/lib/factpulse/models/async_task_status.rb +1 -1
- data/lib/factpulse/models/base_amount.rb +1 -1
- data/lib/factpulse/models/bounding_box_schema.rb +1 -1
- data/lib/factpulse/models/buyercountry.rb +1 -1
- data/lib/factpulse/models/celery_status.rb +1 -1
- data/lib/factpulse/models/certificate_info_response.rb +1 -1
- data/lib/factpulse/models/charge_total_amount.rb +1 -1
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/chorus_pro_result.rb +1 -1
- data/lib/factpulse/models/client_activate_response.rb +1 -1
- data/lib/factpulse/models/client_create_request.rb +1 -1
- data/lib/factpulse/models/client_detail.rb +1 -1
- data/lib/factpulse/models/client_list_response.rb +1 -1
- data/lib/factpulse/models/client_summary.rb +1 -1
- data/lib/factpulse/models/client_update_request.rb +1 -1
- data/lib/factpulse/models/contact.rb +1 -1
- data/lib/factpulse/models/conversion_error_result.rb +1 -1
- data/lib/factpulse/models/conversion_extraction_info.rb +1 -1
- data/lib/factpulse/models/conversion_pending_input_result.rb +1 -1
- data/lib/factpulse/models/conversion_success_task_result.rb +1 -1
- data/lib/factpulse/models/conversion_task_status.rb +1 -1
- data/lib/factpulse/models/conversion_task_status_result.rb +1 -1
- data/lib/factpulse/models/conversion_validation_failed_result.rb +1 -1
- data/lib/factpulse/models/convert_resume_request.rb +1 -1
- data/lib/factpulse/models/convert_success_response.rb +1 -1
- data/lib/factpulse/models/convert_validation_failed_response.rb +1 -1
- data/lib/factpulse/models/country_code.rb +1 -1
- data/lib/factpulse/models/create_aggregated_report_request.rb +1 -1
- data/lib/factpulse/models/create_cdar_request.rb +70 -6
- data/lib/factpulse/models/create_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/currency.rb +1 -1
- data/lib/factpulse/models/currency_code.rb +1 -1
- data/lib/factpulse/models/delivery_party.rb +3 -3
- data/lib/factpulse/models/destination.rb +1 -1
- data/lib/factpulse/models/doc_type.rb +1 -1
- data/lib/factpulse/models/document_type_info.rb +1 -1
- data/lib/factpulse/models/e_reporting_flow_type.rb +1 -1
- data/lib/factpulse/models/e_reporting_validation_error.rb +1 -1
- data/lib/factpulse/models/electronic_address.rb +2 -2
- data/lib/factpulse/models/{afnor_callback_signature.rb → electronic_address_input.rb} +29 -44
- data/lib/factpulse/models/{afnor_callback_parameters.rb → electronic_address_output.rb} +51 -46
- data/lib/factpulse/models/{afnor_basic_authentication.rb → encaisse_amount_by_rate.rb} +37 -35
- data/lib/factpulse/models/encaisseamount.rb +2 -2
- data/lib/factpulse/models/encaisseamount1.rb +1 -1
- data/lib/factpulse/models/encaissee_request.rb +54 -23
- data/lib/factpulse/models/enriched_invoice_info.rb +1 -1
- data/lib/factpulse/models/error_level.rb +1 -1
- data/lib/factpulse/models/error_source.rb +1 -1
- data/lib/factpulse/models/extraction_info.rb +1 -1
- data/lib/factpulse/models/factur_x_invoice.rb +1 -1
- data/lib/factpulse/models/factur_xpdf_info.rb +1 -1
- data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +1 -1
- data/lib/factpulse/models/{chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb} +4 -4
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +1 -1
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +1 -1
- data/lib/factpulse/models/{validation_error_response.rb → facture_electronique_rest_api_schemas_validation_validation_error_response.rb} +4 -4
- data/lib/factpulse/models/field_status.rb +1 -1
- data/lib/factpulse/models/file_info.rb +1 -1
- data/lib/factpulse/models/files_info.rb +1 -1
- data/lib/factpulse/models/flow_direction.rb +1 -1
- data/lib/factpulse/models/flow_profile.rb +3 -2
- data/lib/factpulse/models/flow_summary.rb +1 -1
- data/lib/factpulse/models/flow_syntax.rb +1 -1
- data/lib/factpulse/models/flow_type.rb +9 -3
- data/lib/factpulse/models/generate_aggregated_report_response.rb +1 -1
- data/lib/factpulse/models/generate_cdar_response.rb +1 -1
- data/lib/factpulse/models/generate_certificate_request.rb +1 -1
- data/lib/factpulse/models/generate_certificate_response.rb +1 -1
- data/lib/factpulse/models/generate_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/generation_success_result.rb +1 -1
- data/lib/factpulse/models/generation_task_status.rb +1 -1
- data/lib/factpulse/models/generation_task_status_result.rb +1 -1
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +2 -2
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +1 -1
- data/lib/factpulse/models/get_invoice_request.rb +2 -2
- data/lib/factpulse/models/get_invoice_response.rb +1 -1
- data/lib/factpulse/models/get_structure_request.rb +2 -2
- data/lib/factpulse/models/get_structure_response.rb +1 -1
- data/lib/factpulse/models/global_allowance_amount.rb +1 -1
- data/lib/factpulse/models/gross_unit_price.rb +1 -1
- data/lib/factpulse/models/http_validation_error.rb +1 -1
- data/lib/factpulse/models/incoming_invoice.rb +1 -1
- data/lib/factpulse/models/incoming_supplier.rb +14 -4
- data/lib/factpulse/models/invoice_format.rb +1 -1
- data/lib/factpulse/models/invoice_input.rb +22 -2
- data/lib/factpulse/models/invoice_lifecycle.rb +1 -1
- data/lib/factpulse/models/invoice_line.rb +1 -1
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +1 -1
- data/lib/factpulse/models/invoice_note.rb +1 -1
- data/lib/factpulse/models/invoice_payment_input.rb +1 -1
- data/lib/factpulse/models/invoice_references.rb +1 -1
- data/lib/factpulse/models/invoice_status.rb +1 -1
- data/lib/factpulse/models/invoice_totals.rb +1 -1
- data/lib/factpulse/models/invoice_totals_prepayment.rb +1 -1
- data/lib/factpulse/models/invoice_type_code.rb +1 -1
- data/lib/factpulse/models/invoice_type_code_output.rb +1 -1
- data/lib/factpulse/models/{afnor_callback_authentication.rb → invoicedata.rb} +5 -5
- data/lib/factpulse/models/invoicing_framework.rb +1 -1
- data/lib/factpulse/models/invoicing_framework_code.rb +1 -1
- data/lib/factpulse/models/issuer_role_code.rb +1 -1
- data/lib/factpulse/models/key_rotation_request.rb +1 -1
- data/lib/factpulse/models/key_rotation_response.rb +1 -1
- data/lib/factpulse/models/lifecycle_event.rb +12 -2
- data/lib/factpulse/models/lifecycle_response.rb +49 -5
- data/lib/factpulse/models/line_net_amount.rb +1 -1
- data/lib/factpulse/models/line_sub_type.rb +1 -1
- data/lib/factpulse/models/line_total_amount.rb +1 -1
- data/lib/factpulse/models/location_inner.rb +1 -1
- data/lib/factpulse/models/mandatory_note_schema.rb +1 -1
- data/lib/factpulse/models/manual_rate.rb +1 -1
- data/lib/factpulse/models/manual_vat_rate.rb +1 -1
- data/lib/factpulse/models/missing_field.rb +1 -1
- data/lib/factpulse/models/operation_nature.rb +1 -1
- data/lib/factpulse/models/output_format.rb +1 -1
- data/lib/factpulse/models/page_dimensions_schema.rb +1 -1
- data/lib/factpulse/models/parse_factur_x_response.rb +1 -1
- data/lib/factpulse/models/payee.rb +3 -3
- data/lib/factpulse/models/payment_amount_by_rate.rb +15 -5
- data/lib/factpulse/models/payment_card.rb +1 -1
- data/lib/factpulse/models/payment_means.rb +3 -2
- data/lib/factpulse/models/pdf_validation_result_api.rb +1 -1
- data/lib/factpulse/models/pdp_config_response.rb +1 -1
- data/lib/factpulse/models/pdp_config_update_request.rb +1 -1
- data/lib/factpulse/models/pdp_credentials.rb +1 -1
- data/lib/factpulse/models/percentage.rb +1 -1
- data/lib/factpulse/models/postal_address.rb +7 -7
- data/lib/factpulse/models/postal_address_input.rb +209 -0
- data/lib/factpulse/models/postal_address_output.rb +209 -0
- data/lib/factpulse/models/price_allowance_amount.rb +1 -1
- data/lib/factpulse/models/price_basis_quantity.rb +1 -1
- data/lib/factpulse/models/processing_options.rb +2 -2
- data/lib/factpulse/models/processing_rule.rb +3 -2
- data/lib/factpulse/models/product_characteristic.rb +1 -1
- data/lib/factpulse/models/product_classification.rb +1 -1
- data/lib/factpulse/models/quantity.rb +1 -1
- data/lib/factpulse/models/rate.rb +1 -1
- data/lib/factpulse/models/rate1.rb +1 -1
- data/lib/factpulse/models/reason_code_info.rb +1 -1
- data/lib/factpulse/models/reason_codes_response.rb +1 -1
- data/lib/factpulse/models/recipient.rb +4 -4
- data/lib/factpulse/models/recipient_input.rb +1 -1
- data/lib/factpulse/models/refusee_request.rb +1 -1
- data/lib/factpulse/models/report_issuer.rb +1 -1
- data/lib/factpulse/models/report_period.rb +1 -1
- data/lib/factpulse/models/report_sender.rb +12 -2
- data/lib/factpulse/models/rounding_amount.rb +1 -1
- data/lib/factpulse/models/schematron_validation_error.rb +1 -1
- data/lib/factpulse/models/scheme_id.rb +1 -1
- data/lib/factpulse/models/search_flow_request.rb +1 -1
- data/lib/factpulse/models/search_flow_response.rb +1 -1
- data/lib/factpulse/models/search_services_response.rb +1 -1
- data/lib/factpulse/models/search_structure_request.rb +2 -2
- data/lib/factpulse/models/search_structure_response.rb +1 -1
- data/lib/factpulse/models/secret_status.rb +1 -1
- data/lib/factpulse/models/sellercountry.rb +1 -1
- data/lib/factpulse/models/signature_info.rb +1 -1
- data/lib/factpulse/models/signature_info_api.rb +1 -1
- data/lib/factpulse/models/signature_parameters.rb +1 -1
- data/lib/factpulse/models/signature_success_result.rb +1 -1
- data/lib/factpulse/models/signature_task_status.rb +1 -1
- data/lib/factpulse/models/signature_task_status_result.rb +1 -1
- data/lib/factpulse/models/simplified_cdar_response.rb +1 -1
- data/lib/factpulse/models/simplified_invoice_data.rb +5 -5
- data/lib/factpulse/models/status_code_info.rb +1 -1
- data/lib/factpulse/models/status_codes_response.rb +1 -1
- data/lib/factpulse/models/structure_info.rb +1 -1
- data/lib/factpulse/models/structure_parameters.rb +1 -1
- data/lib/factpulse/models/structure_service.rb +1 -1
- data/lib/factpulse/models/submission_mode.rb +1 -1
- data/lib/factpulse/models/submit_aggregated_report_request.rb +1 -1
- data/lib/factpulse/models/submit_cdar_request.rb +66 -2
- data/lib/factpulse/models/submit_cdar_response.rb +1 -1
- data/lib/factpulse/models/submit_cdarxml_request.rb +1 -1
- data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -3
- data/lib/factpulse/models/submit_complete_invoice_response.rb +1 -1
- data/lib/factpulse/models/submit_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/submit_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/submit_flow_request.rb +1 -1
- data/lib/factpulse/models/submit_flow_response.rb +1 -1
- data/lib/factpulse/models/submit_gross_amount.rb +1 -1
- data/lib/factpulse/models/submit_invoice_request.rb +2 -2
- data/lib/factpulse/models/submit_invoice_response.rb +1 -1
- data/lib/factpulse/models/submit_net_amount.rb +1 -1
- data/lib/factpulse/models/submit_vat_amount.rb +1 -1
- data/lib/factpulse/models/{afnor_webhook_patch_payload.rb → super_pdp_connect_url_response.rb} +30 -31
- data/lib/factpulse/models/{afnor_callback_header.rb → super_pdp_disconnect_response.rb} +38 -35
- data/lib/factpulse/models/super_pdp_status_response.rb +208 -0
- data/lib/factpulse/models/super_pdp_vat_regime_response.rb +195 -0
- data/lib/factpulse/models/{afnor_webhook_metadata.rb → super_pdp_vat_regime_update_request.rb} +33 -63
- data/lib/factpulse/models/supplementary_attachment.rb +1 -1
- data/lib/factpulse/models/supplier.rb +15 -5
- data/lib/factpulse/models/task_error_result.rb +1 -1
- data/lib/factpulse/models/task_response.rb +1 -1
- data/lib/factpulse/models/tax_breakdown_input.rb +35 -5
- data/lib/factpulse/models/tax_due_date_type.rb +1 -1
- data/lib/factpulse/models/tax_representative.rb +2 -2
- data/lib/factpulse/models/taxable_amount.rb +1 -1
- data/lib/factpulse/models/taxableamount.rb +1 -1
- data/lib/factpulse/models/taxamount.rb +1 -1
- data/lib/factpulse/models/taxamount1.rb +1 -1
- data/lib/factpulse/models/taxamount2.rb +1 -1
- data/lib/factpulse/models/taxamounteur.rb +104 -0
- data/lib/factpulse/models/taxexclusiveamount.rb +1 -1
- data/lib/factpulse/models/taxexclusiveamount1.rb +1 -1
- data/lib/factpulse/models/total_gross_amount.rb +1 -1
- data/lib/factpulse/models/total_net_amount.rb +1 -1
- data/lib/factpulse/models/total_vat_amount.rb +1 -1
- data/lib/factpulse/models/transaction_category.rb +1 -1
- data/lib/factpulse/models/transmission_type_code.rb +1 -1
- data/lib/factpulse/models/unit_net_price.rb +1 -1
- data/lib/factpulse/models/unit_of_measure.rb +1 -1
- data/lib/factpulse/models/validate_cdar_request.rb +18 -6
- data/lib/factpulse/models/validate_cdar_response.rb +1 -1
- data/lib/factpulse/models/validate_e_reporting_request.rb +1 -1
- data/lib/factpulse/models/validate_e_reporting_response.rb +1 -1
- data/lib/factpulse/models/validation_error.rb +24 -5
- data/lib/factpulse/models/validation_error_detail.rb +1 -1
- data/lib/factpulse/models/validation_info.rb +1 -1
- data/lib/factpulse/models/validation_success_response.rb +1 -1
- data/lib/factpulse/models/validation_success_task_result.rb +1 -1
- data/lib/factpulse/models/validation_task_status.rb +1 -1
- data/lib/factpulse/models/validation_task_status_result.rb +1 -1
- data/lib/factpulse/models/vat_accounting_code.rb +1 -1
- data/lib/factpulse/models/vat_amount.rb +1 -1
- data/lib/factpulse/models/vat_category.rb +1 -1
- data/lib/factpulse/models/vat_line.rb +1 -1
- data/lib/factpulse/models/vat_point_date_code.rb +1 -1
- data/lib/factpulse/models/vat_rate.rb +1 -1
- data/lib/factpulse/models/vatex_code_info.rb +1 -1
- data/lib/factpulse/models/vatex_codes_response.rb +1 -1
- data/lib/factpulse/models/verification_success_response.rb +1 -1
- data/lib/factpulse/models/verification_success_task_result.rb +1 -1
- data/lib/factpulse/models/verification_typed_task_status.rb +1 -1
- data/lib/factpulse/models/verification_typed_task_status_result.rb +1 -1
- data/lib/factpulse/models/verified_field_schema.rb +1 -1
- data/lib/factpulse/models/webhook_secret_delete_response.rb +1 -1
- data/lib/factpulse/models/webhook_secret_generate_response.rb +1 -1
- data/lib/factpulse/models/webhook_secret_status_response.rb +1 -1
- data/lib/factpulse/version.rb +2 -2
- data/lib/factpulse.rb +21 -13
- metadata +42 -26
- data/docs/AFNORBasicAuthentication.md +0 -20
- data/docs/AFNORCallbackHeader.md +0 -20
- data/docs/AFNORCallbackParameters.md +0 -24
- data/docs/AFNORCallbackSignature.md +0 -20
- data/docs/AFNOROAuth2Authentication.md +0 -22
- data/docs/AFNORWebhookMetadata.md +0 -24
- data/docs/AFNORWebhookPatchPayload.md +0 -22
- data/lib/factpulse/models/afnoro_auth2_authentication.rb +0 -216
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# FactPulse::AFNORUniqueDirectoryLineStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'factpulse'
|
|
12
|
+
|
|
13
|
+
instance = FactPulse::AFNORUniqueDirectoryLineStatus.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/AFNORWebhook.md
CHANGED
|
@@ -5,8 +5,12 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **webhook_id** | **String** | | [optional] |
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
8
|
+
| **signing_key** | **String** | | [optional] |
|
|
9
|
+
| **created_at** | **Time** | | [optional] |
|
|
10
|
+
| **callback_url** | **String** | | |
|
|
11
|
+
| **flow_types** | [**Array<AFNORFlowType>**](AFNORFlowType.md) | | [optional] |
|
|
12
|
+
| **flow_direction** | [**AFNORFlowDirection**](AFNORFlowDirection.md) | | [optional] |
|
|
13
|
+
| **ack_status** | [**AFNORFlowAckStatus**](AFNORFlowAckStatus.md) | | [optional] |
|
|
10
14
|
|
|
11
15
|
## Example
|
|
12
16
|
|
|
@@ -15,8 +19,12 @@ require 'factpulse'
|
|
|
15
19
|
|
|
16
20
|
instance = FactPulse::AFNORWebhook.new(
|
|
17
21
|
webhook_id: null,
|
|
18
|
-
|
|
19
|
-
|
|
22
|
+
signing_key: null,
|
|
23
|
+
created_at: null,
|
|
24
|
+
callback_url: null,
|
|
25
|
+
flow_types: null,
|
|
26
|
+
flow_direction: null,
|
|
27
|
+
ack_status: null
|
|
20
28
|
)
|
|
21
29
|
```
|
|
22
30
|
|
data/docs/AFNORWebhookIdParam.md
CHANGED
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **webhook_id** | **String** | | [optional] |
|
|
8
|
+
| **signing_key** | **String** | | [optional] |
|
|
9
|
+
| **created_at** | **Time** | | [optional] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
10
12
|
|
|
@@ -12,7 +14,9 @@
|
|
|
12
14
|
require 'factpulse'
|
|
13
15
|
|
|
14
16
|
instance = FactPulse::AFNORWebhookIdParam.new(
|
|
15
|
-
webhook_id: null
|
|
17
|
+
webhook_id: null,
|
|
18
|
+
signing_key: null,
|
|
19
|
+
created_at: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
18
22
|
|
data/docs/AFNORWebhookParams.md
CHANGED
|
@@ -4,8 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
7
|
+
| **callback_url** | **String** | | |
|
|
8
|
+
| **flow_types** | [**Array<AFNORFlowType>**](AFNORFlowType.md) | | [optional] |
|
|
9
|
+
| **flow_direction** | [**AFNORFlowDirection**](AFNORFlowDirection.md) | | [optional] |
|
|
10
|
+
| **ack_status** | [**AFNORFlowAckStatus**](AFNORFlowAckStatus.md) | | [optional] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -13,8 +15,10 @@
|
|
|
13
15
|
require 'factpulse'
|
|
14
16
|
|
|
15
17
|
instance = FactPulse::AFNORWebhookParams.new(
|
|
16
|
-
|
|
17
|
-
|
|
18
|
+
callback_url: null,
|
|
19
|
+
flow_types: null,
|
|
20
|
+
flow_direction: null,
|
|
21
|
+
ack_status: null
|
|
18
22
|
)
|
|
19
23
|
```
|
|
20
24
|
|
data/docs/AllowanceCharge.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **is_charge** | **Boolean** | True for charge, False for allowance (ChargeIndicator). | |
|
|
8
|
-
| **amount** | [**
|
|
8
|
+
| **amount** | [**Amount**](Amount.md) | | |
|
|
9
9
|
| **base_amount** | [**BaseAmount**](BaseAmount.md) | | [optional] |
|
|
10
10
|
| **percentage** | [**Percentage**](Percentage.md) | | [optional] |
|
|
11
11
|
| **reason** | **String** | | [optional] |
|
data/docs/ClientManagementApi.md
CHANGED
|
@@ -8,14 +8,19 @@ All URIs are relative to *https://factpulse.fr*
|
|
|
8
8
|
| [**create_client_api_v1_clients_post**](ClientManagementApi.md#create_client_api_v1_clients_post) | **POST** /api/v1/clients | Create a client |
|
|
9
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
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
|
+
| [**disconnect_superpdp_api_v1_clients_uid_superpdp_delete**](ClientManagementApi.md#disconnect_superpdp_api_v1_clients_uid_superpdp_delete) | **DELETE** /api/v1/clients/{uid}/superpdp | Disconnect SuperPDP |
|
|
11
12
|
| [**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
13
|
| [**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
14
|
| [**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 |
|
|
15
|
+
| [**get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post**](ClientManagementApi.md#get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post) | **POST** /api/v1/clients/{uid}/superpdp/connect-url | Get SuperPDP connection URL |
|
|
16
|
+
| [**get_superpdp_status_api_v1_clients_uid_superpdp_status_get**](ClientManagementApi.md#get_superpdp_status_api_v1_clients_uid_superpdp_status_get) | **GET** /api/v1/clients/{uid}/superpdp/status | Get SuperPDP connection status |
|
|
17
|
+
| [**get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get**](ClientManagementApi.md#get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get) | **GET** /api/v1/clients/{uid}/superpdp/vat-regime | Get the SuperPDP VAT regime |
|
|
14
18
|
| [**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
19
|
| [**list_clients_api_v1_clients_get**](ClientManagementApi.md#list_clients_api_v1_clients_get) | **GET** /api/v1/clients | List clients |
|
|
16
20
|
| [**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
21
|
| [**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
22
|
| [**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 |
|
|
23
|
+
| [**update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch**](ClientManagementApi.md#update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch) | **PATCH** /api/v1/clients/{uid}/superpdp/vat-regime | Set the SuperPDP VAT regime |
|
|
19
24
|
|
|
20
25
|
|
|
21
26
|
## activate_client_api_v1_clients_uid_activer_post
|
|
@@ -314,6 +319,80 @@ end
|
|
|
314
319
|
- **Accept**: application/json
|
|
315
320
|
|
|
316
321
|
|
|
322
|
+
## disconnect_superpdp_api_v1_clients_uid_superpdp_delete
|
|
323
|
+
|
|
324
|
+
> <SuperPDPDisconnectResponse> disconnect_superpdp_api_v1_clients_uid_superpdp_delete(uid)
|
|
325
|
+
|
|
326
|
+
Disconnect SuperPDP
|
|
327
|
+
|
|
328
|
+
Disconnect SuperPDP for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Revokes the stored refresh token with SuperPDP (RFC 7009) and deletes the stored tokens. The client can reconnect later via the connect-url endpoint.
|
|
329
|
+
|
|
330
|
+
### Examples
|
|
331
|
+
|
|
332
|
+
```ruby
|
|
333
|
+
require 'time'
|
|
334
|
+
require 'factpulse'
|
|
335
|
+
# setup authorization
|
|
336
|
+
FactPulse.configure do |config|
|
|
337
|
+
# Configure API key authorization: APIKeyHeader
|
|
338
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
339
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
340
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
341
|
+
|
|
342
|
+
# Configure Bearer authorization: HTTPBearer
|
|
343
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
344
|
+
end
|
|
345
|
+
|
|
346
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
347
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
|
|
348
|
+
|
|
349
|
+
begin
|
|
350
|
+
# Disconnect SuperPDP
|
|
351
|
+
result = api_instance.disconnect_superpdp_api_v1_clients_uid_superpdp_delete(uid)
|
|
352
|
+
p result
|
|
353
|
+
rescue FactPulse::ApiError => e
|
|
354
|
+
puts "Error when calling ClientManagementApi->disconnect_superpdp_api_v1_clients_uid_superpdp_delete: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
#### Using the disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info variant
|
|
359
|
+
|
|
360
|
+
This returns an Array which contains the response data, status code and headers.
|
|
361
|
+
|
|
362
|
+
> <Array(<SuperPDPDisconnectResponse>, Integer, Hash)> disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info(uid)
|
|
363
|
+
|
|
364
|
+
```ruby
|
|
365
|
+
begin
|
|
366
|
+
# Disconnect SuperPDP
|
|
367
|
+
data, status_code, headers = api_instance.disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info(uid)
|
|
368
|
+
p status_code # => 2xx
|
|
369
|
+
p headers # => { ... }
|
|
370
|
+
p data # => <SuperPDPDisconnectResponse>
|
|
371
|
+
rescue FactPulse::ApiError => e
|
|
372
|
+
puts "Error when calling ClientManagementApi->disconnect_superpdp_api_v1_clients_uid_superpdp_delete_with_http_info: #{e}"
|
|
373
|
+
end
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
| Name | Type | Description | Notes |
|
|
379
|
+
| ---- | ---- | ----------- | ----- |
|
|
380
|
+
| **uid** | **String** | Client unique identifier (UUID) | |
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
[**SuperPDPDisconnectResponse**](SuperPDPDisconnectResponse.md)
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: Not defined
|
|
393
|
+
- **Accept**: application/json
|
|
394
|
+
|
|
395
|
+
|
|
317
396
|
## generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post
|
|
318
397
|
|
|
319
398
|
> <WebhookSecretGenerateResponse> generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post(uid)
|
|
@@ -536,6 +615,234 @@ end
|
|
|
536
615
|
- **Accept**: application/json
|
|
537
616
|
|
|
538
617
|
|
|
618
|
+
## get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post
|
|
619
|
+
|
|
620
|
+
> <SuperPDPConnectURLResponse> get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post(uid, opts)
|
|
621
|
+
|
|
622
|
+
Get SuperPDP connection URL
|
|
623
|
+
|
|
624
|
+
Generate the SuperPDP OAuth2 authorization URL for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) Redirect the end user to the returned `authorizeUrl` so they can connect their own SuperPDP account to FactPulse (OAuth2 Authorization Code). **Query parameters**: - `modeSandbox` (default `true`): connect via the SuperPDP sandbox app (fictitious data) or the production app. - `returnUrl` (optional): absolute http(s) URL of your own portal. Once the SuperPDP authorization flow is over, the end user is redirected there with `superpdp_connected=true|false` (and `superpdp_error=<code>` on failure) appended to the query string. Without it, FactPulse displays its own confirmation page. Returns `400 invalid_return_url` if the URL is not an absolute http(s) URL.
|
|
625
|
+
|
|
626
|
+
### Examples
|
|
627
|
+
|
|
628
|
+
```ruby
|
|
629
|
+
require 'time'
|
|
630
|
+
require 'factpulse'
|
|
631
|
+
# setup authorization
|
|
632
|
+
FactPulse.configure do |config|
|
|
633
|
+
# Configure API key authorization: APIKeyHeader
|
|
634
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
635
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
636
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
637
|
+
|
|
638
|
+
# Configure Bearer authorization: HTTPBearer
|
|
639
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
640
|
+
end
|
|
641
|
+
|
|
642
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
643
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
|
|
644
|
+
opts = {
|
|
645
|
+
mode_sandbox: true, # Boolean | True for the SuperPDP sandbox app (default), False for production
|
|
646
|
+
return_url: 'return_url_example' # String | Absolute http(s) URL to redirect the end user to once the SuperPDP connection is done. Defaults to the FactPulse confirmation page.
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
begin
|
|
650
|
+
# Get SuperPDP connection URL
|
|
651
|
+
result = api_instance.get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post(uid, opts)
|
|
652
|
+
p result
|
|
653
|
+
rescue FactPulse::ApiError => e
|
|
654
|
+
puts "Error when calling ClientManagementApi->get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post: #{e}"
|
|
655
|
+
end
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
#### Using the get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info variant
|
|
659
|
+
|
|
660
|
+
This returns an Array which contains the response data, status code and headers.
|
|
661
|
+
|
|
662
|
+
> <Array(<SuperPDPConnectURLResponse>, Integer, Hash)> get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info(uid, opts)
|
|
663
|
+
|
|
664
|
+
```ruby
|
|
665
|
+
begin
|
|
666
|
+
# Get SuperPDP connection URL
|
|
667
|
+
data, status_code, headers = api_instance.get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info(uid, opts)
|
|
668
|
+
p status_code # => 2xx
|
|
669
|
+
p headers # => { ... }
|
|
670
|
+
p data # => <SuperPDPConnectURLResponse>
|
|
671
|
+
rescue FactPulse::ApiError => e
|
|
672
|
+
puts "Error when calling ClientManagementApi->get_superpdp_connect_url_api_v1_clients_uid_superpdp_connect_url_post_with_http_info: #{e}"
|
|
673
|
+
end
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
| Name | Type | Description | Notes |
|
|
679
|
+
| ---- | ---- | ----------- | ----- |
|
|
680
|
+
| **uid** | **String** | Client unique identifier (UUID) | |
|
|
681
|
+
| **mode_sandbox** | **Boolean** | True for the SuperPDP sandbox app (default), False for production | [optional][default to true] |
|
|
682
|
+
| **return_url** | **String** | Absolute http(s) URL to redirect the end user to once the SuperPDP connection is done. Defaults to the FactPulse confirmation page. | [optional] |
|
|
683
|
+
|
|
684
|
+
### Return type
|
|
685
|
+
|
|
686
|
+
[**SuperPDPConnectURLResponse**](SuperPDPConnectURLResponse.md)
|
|
687
|
+
|
|
688
|
+
### Authorization
|
|
689
|
+
|
|
690
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
691
|
+
|
|
692
|
+
### HTTP request headers
|
|
693
|
+
|
|
694
|
+
- **Content-Type**: Not defined
|
|
695
|
+
- **Accept**: application/json
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
## get_superpdp_status_api_v1_clients_uid_superpdp_status_get
|
|
699
|
+
|
|
700
|
+
> <SuperPDPStatusResponse> get_superpdp_status_api_v1_clients_uid_superpdp_status_get(uid)
|
|
701
|
+
|
|
702
|
+
Get SuperPDP connection status
|
|
703
|
+
|
|
704
|
+
Check whether a client has connected its SuperPDP account. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `connected`: Whether the client has an active SuperPDP connection - `connectedAt`: When the connection was established (if any) - `expiresAt`: When the current access token expires (if any) - `modeSandbox`: True if connected via the sandbox app, False for production, null if not connected - `lastError`: Last token refresh error, if any
|
|
705
|
+
|
|
706
|
+
### Examples
|
|
707
|
+
|
|
708
|
+
```ruby
|
|
709
|
+
require 'time'
|
|
710
|
+
require 'factpulse'
|
|
711
|
+
# setup authorization
|
|
712
|
+
FactPulse.configure do |config|
|
|
713
|
+
# Configure API key authorization: APIKeyHeader
|
|
714
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
715
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
716
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
717
|
+
|
|
718
|
+
# Configure Bearer authorization: HTTPBearer
|
|
719
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
720
|
+
end
|
|
721
|
+
|
|
722
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
723
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
|
|
724
|
+
|
|
725
|
+
begin
|
|
726
|
+
# Get SuperPDP connection status
|
|
727
|
+
result = api_instance.get_superpdp_status_api_v1_clients_uid_superpdp_status_get(uid)
|
|
728
|
+
p result
|
|
729
|
+
rescue FactPulse::ApiError => e
|
|
730
|
+
puts "Error when calling ClientManagementApi->get_superpdp_status_api_v1_clients_uid_superpdp_status_get: #{e}"
|
|
731
|
+
end
|
|
732
|
+
```
|
|
733
|
+
|
|
734
|
+
#### Using the get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info variant
|
|
735
|
+
|
|
736
|
+
This returns an Array which contains the response data, status code and headers.
|
|
737
|
+
|
|
738
|
+
> <Array(<SuperPDPStatusResponse>, Integer, Hash)> get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info(uid)
|
|
739
|
+
|
|
740
|
+
```ruby
|
|
741
|
+
begin
|
|
742
|
+
# Get SuperPDP connection status
|
|
743
|
+
data, status_code, headers = api_instance.get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info(uid)
|
|
744
|
+
p status_code # => 2xx
|
|
745
|
+
p headers # => { ... }
|
|
746
|
+
p data # => <SuperPDPStatusResponse>
|
|
747
|
+
rescue FactPulse::ApiError => e
|
|
748
|
+
puts "Error when calling ClientManagementApi->get_superpdp_status_api_v1_clients_uid_superpdp_status_get_with_http_info: #{e}"
|
|
749
|
+
end
|
|
750
|
+
```
|
|
751
|
+
|
|
752
|
+
### Parameters
|
|
753
|
+
|
|
754
|
+
| Name | Type | Description | Notes |
|
|
755
|
+
| ---- | ---- | ----------- | ----- |
|
|
756
|
+
| **uid** | **String** | Client unique identifier (UUID) | |
|
|
757
|
+
|
|
758
|
+
### Return type
|
|
759
|
+
|
|
760
|
+
[**SuperPDPStatusResponse**](SuperPDPStatusResponse.md)
|
|
761
|
+
|
|
762
|
+
### Authorization
|
|
763
|
+
|
|
764
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
765
|
+
|
|
766
|
+
### HTTP request headers
|
|
767
|
+
|
|
768
|
+
- **Content-Type**: Not defined
|
|
769
|
+
- **Accept**: application/json
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
## get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get
|
|
773
|
+
|
|
774
|
+
> <SuperPDPVatRegimeResponse> get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get(uid)
|
|
775
|
+
|
|
776
|
+
Get the SuperPDP VAT regime
|
|
777
|
+
|
|
778
|
+
Read the VAT regime of the client's company at SuperPDP (`vatRegime` is null when not set). SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
779
|
+
|
|
780
|
+
### Examples
|
|
781
|
+
|
|
782
|
+
```ruby
|
|
783
|
+
require 'time'
|
|
784
|
+
require 'factpulse'
|
|
785
|
+
# setup authorization
|
|
786
|
+
FactPulse.configure do |config|
|
|
787
|
+
# Configure API key authorization: APIKeyHeader
|
|
788
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
789
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
790
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
791
|
+
|
|
792
|
+
# Configure Bearer authorization: HTTPBearer
|
|
793
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
794
|
+
end
|
|
795
|
+
|
|
796
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
797
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
|
|
798
|
+
|
|
799
|
+
begin
|
|
800
|
+
# Get the SuperPDP VAT regime
|
|
801
|
+
result = api_instance.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get(uid)
|
|
802
|
+
p result
|
|
803
|
+
rescue FactPulse::ApiError => e
|
|
804
|
+
puts "Error when calling ClientManagementApi->get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get: #{e}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
#### Using the get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info variant
|
|
809
|
+
|
|
810
|
+
This returns an Array which contains the response data, status code and headers.
|
|
811
|
+
|
|
812
|
+
> <Array(<SuperPDPVatRegimeResponse>, Integer, Hash)> get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid)
|
|
813
|
+
|
|
814
|
+
```ruby
|
|
815
|
+
begin
|
|
816
|
+
# Get the SuperPDP VAT regime
|
|
817
|
+
data, status_code, headers = api_instance.get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info(uid)
|
|
818
|
+
p status_code # => 2xx
|
|
819
|
+
p headers # => { ... }
|
|
820
|
+
p data # => <SuperPDPVatRegimeResponse>
|
|
821
|
+
rescue FactPulse::ApiError => e
|
|
822
|
+
puts "Error when calling ClientManagementApi->get_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_get_with_http_info: #{e}"
|
|
823
|
+
end
|
|
824
|
+
```
|
|
825
|
+
|
|
826
|
+
### Parameters
|
|
827
|
+
|
|
828
|
+
| Name | Type | Description | Notes |
|
|
829
|
+
| ---- | ---- | ----------- | ----- |
|
|
830
|
+
| **uid** | **String** | Client unique identifier (UUID) | |
|
|
831
|
+
|
|
832
|
+
### Return type
|
|
833
|
+
|
|
834
|
+
[**SuperPDPVatRegimeResponse**](SuperPDPVatRegimeResponse.md)
|
|
835
|
+
|
|
836
|
+
### Authorization
|
|
837
|
+
|
|
838
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
839
|
+
|
|
840
|
+
### HTTP request headers
|
|
841
|
+
|
|
842
|
+
- **Content-Type**: Not defined
|
|
843
|
+
- **Accept**: application/json
|
|
844
|
+
|
|
845
|
+
|
|
539
846
|
## get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get
|
|
540
847
|
|
|
541
848
|
> <WebhookSecretStatusResponse> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
|
|
@@ -919,3 +1226,79 @@ end
|
|
|
919
1226
|
- **Content-Type**: application/json
|
|
920
1227
|
- **Accept**: application/json
|
|
921
1228
|
|
|
1229
|
+
|
|
1230
|
+
## update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch
|
|
1231
|
+
|
|
1232
|
+
> <SuperPDPVatRegimeResponse> update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch(uid, super_pdp_vat_regime_update_request)
|
|
1233
|
+
|
|
1234
|
+
Set the SuperPDP VAT regime
|
|
1235
|
+
|
|
1236
|
+
Set the VAT regime of the client's company at SuperPDP. When `hasVatOnDebits` is omitted, its current value is kept. SuperPDP refuses e-reporting (\"The VAT regime needs to be setup at the company level\") until the VAT regime of the company is set: it defines the e-reporting transmission periods, and the Flux 10 file does not carry it. This setting is not part of the AFNOR API; FactPulse sets it with the client's SuperPDP connection. **Scope**: Client level (JWT with client_uid that must match {uid}) **Errors**: - `404 not_connected`: the client has not connected its SuperPDP account - `400 superpdp_error`: SuperPDP refused the request (`superpdp_status`, `message`) - `502`: SuperPDP unreachable, or the SuperPDP connection must be redone
|
|
1237
|
+
|
|
1238
|
+
### Examples
|
|
1239
|
+
|
|
1240
|
+
```ruby
|
|
1241
|
+
require 'time'
|
|
1242
|
+
require 'factpulse'
|
|
1243
|
+
# setup authorization
|
|
1244
|
+
FactPulse.configure do |config|
|
|
1245
|
+
# Configure API key authorization: APIKeyHeader
|
|
1246
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
1247
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1248
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
1249
|
+
|
|
1250
|
+
# Configure Bearer authorization: HTTPBearer
|
|
1251
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1252
|
+
end
|
|
1253
|
+
|
|
1254
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
1255
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Client unique identifier (UUID)
|
|
1256
|
+
super_pdp_vat_regime_update_request = FactPulse::SuperPDPVatRegimeUpdateRequest.new({vat_regime: 'monthly'}) # SuperPDPVatRegimeUpdateRequest |
|
|
1257
|
+
|
|
1258
|
+
begin
|
|
1259
|
+
# Set the SuperPDP VAT regime
|
|
1260
|
+
result = api_instance.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch(uid, super_pdp_vat_regime_update_request)
|
|
1261
|
+
p result
|
|
1262
|
+
rescue FactPulse::ApiError => e
|
|
1263
|
+
puts "Error when calling ClientManagementApi->update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch: #{e}"
|
|
1264
|
+
end
|
|
1265
|
+
```
|
|
1266
|
+
|
|
1267
|
+
#### Using the update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info variant
|
|
1268
|
+
|
|
1269
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1270
|
+
|
|
1271
|
+
> <Array(<SuperPDPVatRegimeResponse>, Integer, Hash)> update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request)
|
|
1272
|
+
|
|
1273
|
+
```ruby
|
|
1274
|
+
begin
|
|
1275
|
+
# Set the SuperPDP VAT regime
|
|
1276
|
+
data, status_code, headers = api_instance.update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info(uid, super_pdp_vat_regime_update_request)
|
|
1277
|
+
p status_code # => 2xx
|
|
1278
|
+
p headers # => { ... }
|
|
1279
|
+
p data # => <SuperPDPVatRegimeResponse>
|
|
1280
|
+
rescue FactPulse::ApiError => e
|
|
1281
|
+
puts "Error when calling ClientManagementApi->update_superpdp_vat_regime_api_v1_clients_uid_superpdp_vat_regime_patch_with_http_info: #{e}"
|
|
1282
|
+
end
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
### Parameters
|
|
1286
|
+
|
|
1287
|
+
| Name | Type | Description | Notes |
|
|
1288
|
+
| ---- | ---- | ----------- | ----- |
|
|
1289
|
+
| **uid** | **String** | Client unique identifier (UUID) | |
|
|
1290
|
+
| **super_pdp_vat_regime_update_request** | [**SuperPDPVatRegimeUpdateRequest**](SuperPDPVatRegimeUpdateRequest.md) | | |
|
|
1291
|
+
|
|
1292
|
+
### Return type
|
|
1293
|
+
|
|
1294
|
+
[**SuperPDPVatRegimeResponse**](SuperPDPVatRegimeResponse.md)
|
|
1295
|
+
|
|
1296
|
+
### Authorization
|
|
1297
|
+
|
|
1298
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
1299
|
+
|
|
1300
|
+
### HTTP request headers
|
|
1301
|
+
|
|
1302
|
+
- **Content-Type**: application/json
|
|
1303
|
+
- **Accept**: application/json
|
|
1304
|
+
|
data/docs/CreateCDARRequest.md
CHANGED
|
@@ -22,6 +22,9 @@
|
|
|
22
22
|
| **reason_text** | **String** | | [optional] |
|
|
23
23
|
| **action_code** | **String** | | [optional] |
|
|
24
24
|
| **encaisse_amount** | [**Encaisseamount**](Encaisseamount.md) | | [optional] |
|
|
25
|
+
| **encaisse_vat_rate** | **Float** | Taux de TVA du montant encaissé en % (MDT-224, requis par BR-FR-CDV-14 pour le statut 212 ; défaut 20) | [optional][default to 20] |
|
|
26
|
+
| **encaisse_amounts_by_rate** | [**Array<EncaisseAmountByRate>**](EncaisseAmountByRate.md) | | [optional] |
|
|
27
|
+
| **comment** | **String** | | [optional] |
|
|
25
28
|
|
|
26
29
|
## Example
|
|
27
30
|
|
|
@@ -46,7 +49,10 @@ instance = FactPulse::CreateCDARRequest.new(
|
|
|
46
49
|
reason_code: null,
|
|
47
50
|
reason_text: null,
|
|
48
51
|
action_code: null,
|
|
49
|
-
encaisse_amount: null
|
|
52
|
+
encaisse_amount: null,
|
|
53
|
+
encaisse_vat_rate: null,
|
|
54
|
+
encaisse_amounts_by_rate: null,
|
|
55
|
+
comment: null
|
|
50
56
|
)
|
|
51
57
|
```
|
|
52
58
|
|
data/docs/DeliveryParty.md
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional] |
|
|
8
|
-
| **global_id** | [**
|
|
8
|
+
| **global_id** | [**ElectronicAddressInput**](ElectronicAddressInput.md) | | [optional] |
|
|
9
9
|
| **name** | **String** | | [optional] |
|
|
10
|
-
| **postal_address** | [**
|
|
10
|
+
| **postal_address** | [**PostalAddressInput**](PostalAddressInput.md) | | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::ElectronicAddressInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **identifier** | **String** | Electronic address identifier (e.g., SIREN, SIRET, routing code) | |
|
|
8
|
+
| **scheme_id** | [**SchemeID**](SchemeID.md) | Identification scheme (EAS code) | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::ElectronicAddressInput.new(
|
|
16
|
+
identifier: null,
|
|
17
|
+
scheme_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::ElectronicAddressOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **identifier** | **String** | Electronic address identifier (e.g., SIREN, SIRET, routing code) | |
|
|
8
|
+
| **scheme_id** | [**SchemeID**](SchemeID.md) | Identification scheme (EAS code) | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::ElectronicAddressOutput.new(
|
|
16
|
+
identifier: null,
|
|
17
|
+
scheme_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -109,7 +109,7 @@ FactPulse.configure do |config|
|
|
|
109
109
|
end
|
|
110
110
|
|
|
111
111
|
api_instance = FactPulse::ElectronicSignatureApi.new
|
|
112
|
-
pdf_file =
|
|
112
|
+
pdf_file = 'pdf_file_example' # String | PDF file to sign (will be processed and returned signed in base64)
|
|
113
113
|
opts = {
|
|
114
114
|
reason: 'reason_example', # String |
|
|
115
115
|
location: 'location_example', # String |
|
|
@@ -150,7 +150,7 @@ end
|
|
|
150
150
|
|
|
151
151
|
| Name | Type | Description | Notes |
|
|
152
152
|
| ---- | ---- | ----------- | ----- |
|
|
153
|
-
| **pdf_file** | **
|
|
153
|
+
| **pdf_file** | **String** | PDF file to sign (will be processed and returned signed in base64) | |
|
|
154
154
|
| **reason** | **String** | | [optional] |
|
|
155
155
|
| **location** | **String** | | [optional] |
|
|
156
156
|
| **contact** | **String** | | [optional] |
|
|
@@ -197,7 +197,7 @@ FactPulse.configure do |config|
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
api_instance = FactPulse::ElectronicSignatureApi.new
|
|
200
|
-
pdf_file =
|
|
200
|
+
pdf_file = 'pdf_file_example' # String | PDF file to sign (processed asynchronously)
|
|
201
201
|
opts = {
|
|
202
202
|
callback_url: 'callback_url_example', # String |
|
|
203
203
|
webhook_mode: 'webhook_mode_example', # String | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL)
|
|
@@ -240,7 +240,7 @@ end
|
|
|
240
240
|
|
|
241
241
|
| Name | Type | Description | Notes |
|
|
242
242
|
| ---- | ---- | ----------- | ----- |
|
|
243
|
-
| **pdf_file** | **
|
|
243
|
+
| **pdf_file** | **String** | PDF file to sign (processed asynchronously) | |
|
|
244
244
|
| **callback_url** | **String** | | [optional] |
|
|
245
245
|
| **webhook_mode** | **String** | Webhook content delivery: 'inline' (base64 in payload) or 'download_url' (temporary URL, 1h TTL) | [optional][default to 'inline'] |
|
|
246
246
|
| **reason** | **String** | | [optional] |
|
|
@@ -289,7 +289,7 @@ FactPulse.configure do |config|
|
|
|
289
289
|
end
|
|
290
290
|
|
|
291
291
|
api_instance = FactPulse::ElectronicSignatureApi.new
|
|
292
|
-
pdf_file =
|
|
292
|
+
pdf_file = 'pdf_file_example' # String | PDF file to validate (will be analyzed to detect and validate signatures)
|
|
293
293
|
|
|
294
294
|
begin
|
|
295
295
|
# Validate electronic signatures of a PDF
|
|
@@ -322,7 +322,7 @@ end
|
|
|
322
322
|
|
|
323
323
|
| Name | Type | Description | Notes |
|
|
324
324
|
| ---- | ---- | ----------- | ----- |
|
|
325
|
-
| **pdf_file** | **
|
|
325
|
+
| **pdf_file** | **String** | PDF file to validate (will be analyzed to detect and validate signatures) | |
|
|
326
326
|
|
|
327
327
|
### Return type
|
|
328
328
|
|