factpulse 4.0.2 → 4.1.2
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 +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +12 -0
- data/docs/AFNORErrorDetail.md +26 -0
- data/docs/AFNORPDPPAApi.md +9 -2
- data/docs/AsyncTasksApi.md +231 -1
- data/docs/ChorusProApi.md +96 -16
- data/docs/ClientManagementApi.md +371 -25
- data/docs/ConversionErrorResult.md +30 -0
- data/docs/ConversionExtractionInfo.md +20 -0
- data/docs/ConversionPendingInputResult.md +30 -0
- data/docs/ConversionSuccessTaskResult.md +36 -0
- data/docs/ConversionTaskStatus.md +22 -0
- data/docs/ConversionTaskStatusResult.md +85 -0
- data/docs/ConversionValidationFailedResult.md +34 -0
- data/docs/ConvertResumeRequest.md +5 -1
- data/docs/DownloadsApi.md +16 -6
- data/docs/ElectronicSignatureApi.md +24 -4
- data/docs/FacturXConversionApi.md +176 -4
- data/docs/FacturXInvoice.md +1 -1
- data/docs/FacturXPDFXMLVerificationApi.md +93 -3
- data/docs/FacturXValidationApi.md +12 -78
- data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
- data/docs/Flux10EReportingApi.md +36 -6
- data/docs/Flux6InvoiceLifecycleCDARApi.md +100 -3
- data/docs/GenerationSuccessResult.md +24 -0
- data/docs/GenerationTaskStatus.md +22 -0
- data/docs/GenerationTaskStatusResult.md +79 -0
- data/docs/HealthApi.md +6 -125
- data/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md} +39 -24
- data/docs/InvoiceInput.md +1 -1
- data/docs/InvoiceLifecycle.md +24 -0
- data/docs/InvoicingFramework.md +1 -1
- data/docs/KeyRotationRequest.md +20 -0
- data/docs/KeyRotationResponse.md +24 -0
- data/docs/LifecycleEvent.md +38 -0
- data/docs/LifecycleResponse.md +22 -0
- data/docs/PDPConfigResponse.md +2 -0
- data/docs/PDPConfigUpdateRequest.md +3 -1
- data/docs/ParseApi.md +161 -0
- data/docs/ParseFacturXResponse.md +26 -0
- data/docs/ReferencesApi.md +74 -0
- data/docs/SecretStatus.md +5 -1
- data/docs/SignatureSuccessResult.md +34 -0
- data/docs/SignatureTaskStatus.md +22 -0
- data/docs/SignatureTaskStatusResult.md +79 -0
- data/docs/SimplifiedInvoiceData.md +1 -1
- data/docs/SubmitCompleteInvoiceResponse.md +3 -1
- data/docs/Supplier.md +1 -1
- data/docs/TaskErrorResult.md +26 -0
- data/docs/VATEXCodeInfo.md +24 -0
- data/docs/VATEXCodesResponse.md +22 -0
- data/docs/ValidateCDARResponse.md +2 -2
- data/docs/ValidationApi.md +88 -0
- data/docs/ValidationErrorResponse.md +8 -2
- data/docs/ValidationSuccessTaskResult.md +20 -0
- data/docs/ValidationTaskStatus.md +22 -0
- data/docs/ValidationTaskStatusResult.md +79 -0
- data/docs/VerificationSuccessTaskResult.md +20 -0
- data/docs/VerificationTypedTaskStatus.md +22 -0
- data/docs/VerificationTypedTaskStatusResult.md +79 -0
- data/docs/WebhookSecretDeleteResponse.md +20 -0
- data/docs/WebhookSecretGenerateResponse.md +24 -0
- data/docs/WebhookSecretStatusResponse.md +20 -0
- data/factpulse.gemspec +3 -3
- data/lib/factpulse/api/afnorpdppa_api.rb +6 -3
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +2 -2
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +2 -2
- data/lib/factpulse/api/async_tasks_api.rb +192 -3
- data/lib/factpulse/api/chorus_pro_api.rb +18 -18
- data/lib/factpulse/api/client_management_api.rb +290 -24
- data/lib/factpulse/api/downloads_api.rb +8 -8
- data/lib/factpulse/api/electronic_signature_api.rb +6 -6
- data/lib/factpulse/api/factur_x_conversion_api.rb +143 -6
- data/lib/factpulse/api/factur_x_validation_api.rb +4 -79
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +68 -5
- data/lib/factpulse/api/flux10_e_reporting_api.rb +8 -8
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +88 -5
- data/lib/factpulse/api/health_api.rb +3 -117
- data/lib/factpulse/api/{factur_x_generation_api.rb → invoice_generation_api.rb} +26 -26
- data/lib/factpulse/api/parse_api.rb +163 -0
- data/lib/factpulse/api/references_api.rb +82 -0
- data/lib/factpulse/api/validation_api.rb +97 -0
- data/lib/factpulse/api_client.rb +2 -2
- data/lib/factpulse/api_error.rb +2 -2
- data/lib/factpulse/api_model_base.rb +2 -2
- data/lib/factpulse/configuration.rb +9 -2
- data/lib/factpulse/models/acknowledgment_status.rb +2 -2
- data/lib/factpulse/models/action_code_info.rb +2 -2
- data/lib/factpulse/models/action_codes_response.rb +2 -2
- data/lib/factpulse/models/additional_document.rb +2 -2
- data/lib/factpulse/models/afnor_acknowledgement.rb +2 -2
- data/lib/factpulse/models/afnor_acknowledgement_detail.rb +2 -2
- data/lib/factpulse/models/afnor_address_edit.rb +2 -2
- data/lib/factpulse/models/afnor_address_patch.rb +2 -2
- data/lib/factpulse/models/afnor_address_put.rb +2 -2
- data/lib/factpulse/models/afnor_address_read.rb +2 -2
- data/lib/factpulse/models/afnor_algorithm.rb +2 -2
- data/lib/factpulse/models/afnor_contains_operator.rb +2 -2
- data/lib/factpulse/models/afnor_create_directory_line_body.rb +2 -2
- data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +2 -2
- data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +2 -2
- data/lib/factpulse/models/afnor_create_routing_code_body.rb +2 -2
- data/lib/factpulse/models/afnor_credentials.rb +2 -2
- data/lib/factpulse/models/afnor_destination.rb +2 -2
- data/lib/factpulse/models/afnor_diffusion_status.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_field.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_post201_response.rb +2 -2
- data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +2 -2
- data/lib/factpulse/models/afnor_entity_type.rb +2 -2
- data/lib/factpulse/models/afnor_error.rb +2 -2
- data/lib/factpulse/models/afnor_error_detail.rb +237 -0
- data/lib/factpulse/models/afnor_facility_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_facility_nature.rb +2 -2
- data/lib/factpulse/models/afnor_facility_payload_history.rb +2 -2
- data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +2 -2
- data/lib/factpulse/models/afnor_facility_payload_included.rb +2 -2
- data/lib/factpulse/models/afnor_facility_type.rb +2 -2
- data/lib/factpulse/models/afnor_flow.rb +2 -2
- data/lib/factpulse/models/afnor_flow_ack_status.rb +2 -2
- data/lib/factpulse/models/afnor_flow_direction.rb +2 -2
- data/lib/factpulse/models/afnor_flow_info.rb +2 -2
- data/lib/factpulse/models/afnor_flow_profile.rb +2 -2
- data/lib/factpulse/models/afnor_flow_syntax.rb +2 -2
- data/lib/factpulse/models/afnor_flow_type.rb +2 -2
- data/lib/factpulse/models/afnor_full_flow_info.rb +2 -2
- data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
- data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +2 -2
- data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +2 -2
- data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +2 -2
- data/lib/factpulse/models/afnor_platform_status.rb +2 -2
- data/lib/factpulse/models/afnor_processing_rule.rb +2 -2
- data/lib/factpulse/models/afnor_reason_code.rb +2 -2
- data/lib/factpulse/models/afnor_reason_code_enum.rb +2 -2
- data/lib/factpulse/models/afnor_recipient_platform_type.rb +2 -2
- data/lib/factpulse/models/afnor_result.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_field.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_post201_response.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_filters.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +2 -2
- data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +2 -2
- data/lib/factpulse/models/afnor_search_directory_line.rb +2 -2
- data/lib/factpulse/models/afnor_search_directory_line_filters.rb +2 -2
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +2 -2
- data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +2 -2
- data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +2 -2
- data/lib/factpulse/models/afnor_search_flow_content.rb +2 -2
- data/lib/factpulse/models/afnor_search_flow_filters.rb +2 -2
- data/lib/factpulse/models/afnor_search_flow_params.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +2 -2
- data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +2 -2
- 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 +2 -2
- data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +2 -2
- data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +2 -2
- data/lib/factpulse/models/afnor_siren_field.rb +2 -2
- data/lib/factpulse/models/afnor_siren_search_post200_response.rb +2 -2
- data/lib/factpulse/models/afnor_siret_field.rb +2 -2
- data/lib/factpulse/models/afnor_siret_search_post200_response.rb +2 -2
- data/lib/factpulse/models/afnor_sorting_order.rb +2 -2
- data/lib/factpulse/models/afnor_strict_operator.rb +2 -2
- data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +2 -2
- data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +2 -2
- data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +2 -2
- data/lib/factpulse/models/afnor_webhook_callback_content.rb +2 -2
- data/lib/factpulse/models/aggregated_payment_input.rb +2 -2
- data/lib/factpulse/models/aggregated_transaction_input.rb +2 -2
- data/lib/factpulse/models/allowance_charge.rb +2 -2
- data/lib/factpulse/models/allowance_charge_reason_code.rb +2 -2
- data/lib/factpulse/models/allowance_reason_code.rb +2 -2
- data/lib/factpulse/models/allowance_total_amount.rb +2 -2
- 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/amount_due.rb +2 -2
- data/lib/factpulse/models/api_error.rb +2 -2
- data/lib/factpulse/models/api_profile.rb +2 -2
- data/lib/factpulse/models/async_task_status.rb +2 -2
- data/lib/factpulse/models/base_amount.rb +2 -2
- data/lib/factpulse/models/bounding_box_schema.rb +2 -2
- data/lib/factpulse/models/buyercountry.rb +2 -2
- data/lib/factpulse/models/celery_status.rb +2 -2
- data/lib/factpulse/models/certificate_info_response.rb +2 -2
- data/lib/factpulse/models/charge_total_amount.rb +2 -2
- data/lib/factpulse/models/chorus_pro_credentials.rb +2 -2
- data/lib/factpulse/models/chorus_pro_destination.rb +2 -2
- data/lib/factpulse/models/chorus_pro_result.rb +2 -2
- data/lib/factpulse/models/client_activate_response.rb +2 -2
- data/lib/factpulse/models/client_create_request.rb +2 -2
- data/lib/factpulse/models/client_detail.rb +2 -2
- data/lib/factpulse/models/client_list_response.rb +2 -2
- data/lib/factpulse/models/client_summary.rb +2 -2
- data/lib/factpulse/models/client_update_request.rb +2 -2
- data/lib/factpulse/models/contact.rb +2 -2
- data/lib/factpulse/models/conversion_error_result.rb +277 -0
- data/lib/factpulse/models/conversion_extraction_info.rb +176 -0
- data/lib/factpulse/models/conversion_pending_input_result.rb +344 -0
- data/lib/factpulse/models/conversion_success_task_result.rb +355 -0
- data/lib/factpulse/models/conversion_task_status.rb +223 -0
- data/lib/factpulse/models/conversion_task_status_result.rb +59 -0
- data/lib/factpulse/models/conversion_validation_failed_result.rb +348 -0
- data/lib/factpulse/models/convert_resume_request.rb +29 -7
- data/lib/factpulse/models/convert_success_response.rb +2 -2
- data/lib/factpulse/models/convert_validation_failed_response.rb +2 -2
- data/lib/factpulse/models/country_code.rb +2 -2
- data/lib/factpulse/models/create_aggregated_report_request.rb +2 -2
- data/lib/factpulse/models/create_cdar_request.rb +2 -2
- data/lib/factpulse/models/create_e_reporting_request.rb +2 -2
- data/lib/factpulse/models/currency.rb +2 -2
- data/lib/factpulse/models/currency_code.rb +2 -2
- data/lib/factpulse/models/delivery_party.rb +2 -2
- data/lib/factpulse/models/destination.rb +2 -2
- data/lib/factpulse/models/doc_type.rb +2 -2
- data/lib/factpulse/models/document_type_info.rb +2 -2
- data/lib/factpulse/models/e_reporting_flow_type.rb +2 -2
- data/lib/factpulse/models/e_reporting_validation_error.rb +2 -2
- data/lib/factpulse/models/electronic_address.rb +2 -2
- data/lib/factpulse/models/encaisseamount.rb +2 -2
- data/lib/factpulse/models/encaisseamount1.rb +2 -2
- data/lib/factpulse/models/encaissee_request.rb +2 -2
- data/lib/factpulse/models/enriched_invoice_info.rb +2 -2
- data/lib/factpulse/models/error_level.rb +2 -2
- data/lib/factpulse/models/error_source.rb +2 -2
- data/lib/factpulse/models/extraction_info.rb +2 -2
- data/lib/factpulse/models/factur_x_invoice.rb +3 -19
- data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
- data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +2 -2
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
- data/lib/factpulse/models/field_status.rb +2 -2
- data/lib/factpulse/models/file_info.rb +2 -2
- data/lib/factpulse/models/files_info.rb +2 -2
- data/lib/factpulse/models/flow_direction.rb +2 -2
- data/lib/factpulse/models/flow_profile.rb +2 -2
- data/lib/factpulse/models/flow_summary.rb +2 -2
- data/lib/factpulse/models/flow_syntax.rb +2 -2
- data/lib/factpulse/models/flow_type.rb +2 -2
- data/lib/factpulse/models/generate_aggregated_report_response.rb +2 -2
- data/lib/factpulse/models/generate_cdar_response.rb +2 -2
- data/lib/factpulse/models/generate_certificate_request.rb +2 -2
- data/lib/factpulse/models/generate_certificate_response.rb +2 -2
- data/lib/factpulse/models/generate_e_reporting_response.rb +2 -2
- data/lib/factpulse/models/generation_success_result.rb +230 -0
- data/lib/factpulse/models/generation_task_status.rb +223 -0
- data/lib/factpulse/models/generation_task_status_result.rb +55 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +2 -2
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
- data/lib/factpulse/models/get_invoice_request.rb +2 -2
- data/lib/factpulse/models/get_invoice_response.rb +2 -2
- data/lib/factpulse/models/get_structure_request.rb +2 -2
- data/lib/factpulse/models/get_structure_response.rb +2 -2
- data/lib/factpulse/models/global_allowance_amount.rb +2 -2
- data/lib/factpulse/models/gross_unit_price.rb +2 -2
- data/lib/factpulse/models/http_validation_error.rb +2 -2
- data/lib/factpulse/models/incoming_invoice.rb +2 -2
- data/lib/factpulse/models/incoming_supplier.rb +2 -2
- data/lib/factpulse/models/invoice_format.rb +2 -2
- data/lib/factpulse/models/invoice_input.rb +3 -3
- data/lib/factpulse/models/invoice_lifecycle.rb +215 -0
- data/lib/factpulse/models/invoice_line.rb +2 -2
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
- data/lib/factpulse/models/invoice_note.rb +2 -2
- data/lib/factpulse/models/invoice_payment_input.rb +2 -2
- data/lib/factpulse/models/invoice_references.rb +2 -2
- data/lib/factpulse/models/invoice_status.rb +2 -2
- data/lib/factpulse/models/invoice_totals.rb +2 -2
- data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
- data/lib/factpulse/models/invoice_type_code.rb +8 -19
- data/lib/factpulse/models/invoice_type_code_output.rb +2 -2
- data/lib/factpulse/models/invoicing_framework.rb +3 -20
- data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
- data/lib/factpulse/models/issuer_role_code.rb +2 -2
- data/lib/factpulse/models/key_rotation_request.rb +211 -0
- data/lib/factpulse/models/key_rotation_response.rb +232 -0
- data/lib/factpulse/models/lifecycle_event.rb +300 -0
- data/lib/factpulse/models/lifecycle_response.rb +205 -0
- data/lib/factpulse/models/line_net_amount.rb +2 -2
- data/lib/factpulse/models/line_sub_type.rb +2 -2
- data/lib/factpulse/models/line_total_amount.rb +2 -2
- data/lib/factpulse/models/location_inner.rb +2 -2
- data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
- data/lib/factpulse/models/manual_rate.rb +2 -2
- data/lib/factpulse/models/manual_vat_rate.rb +2 -2
- data/lib/factpulse/models/missing_field.rb +2 -2
- data/lib/factpulse/models/operation_nature.rb +2 -2
- data/lib/factpulse/models/output_format.rb +5 -3
- data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
- data/lib/factpulse/models/parse_factur_x_response.rb +249 -0
- data/lib/factpulse/models/payee.rb +2 -2
- data/lib/factpulse/models/payment_amount_by_rate.rb +2 -2
- data/lib/factpulse/models/payment_card.rb +2 -2
- data/lib/factpulse/models/payment_means.rb +2 -2
- data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
- data/lib/factpulse/models/pdp_config_response.rb +13 -3
- data/lib/factpulse/models/pdp_config_update_request.rb +51 -7
- data/lib/factpulse/models/pdp_credentials.rb +2 -2
- data/lib/factpulse/models/percentage.rb +2 -2
- data/lib/factpulse/models/postal_address.rb +2 -2
- data/lib/factpulse/models/price_allowance_amount.rb +2 -2
- data/lib/factpulse/models/price_basis_quantity.rb +2 -2
- data/lib/factpulse/models/processing_options.rb +2 -2
- data/lib/factpulse/models/processing_rule.rb +2 -2
- data/lib/factpulse/models/product_characteristic.rb +2 -2
- data/lib/factpulse/models/product_classification.rb +2 -2
- data/lib/factpulse/models/quantity.rb +2 -2
- data/lib/factpulse/models/rate.rb +2 -2
- data/lib/factpulse/models/rate1.rb +2 -2
- data/lib/factpulse/models/reason_code_info.rb +2 -2
- data/lib/factpulse/models/reason_codes_response.rb +2 -2
- data/lib/factpulse/models/recipient.rb +2 -2
- data/lib/factpulse/models/recipient_input.rb +2 -2
- data/lib/factpulse/models/refusee_request.rb +2 -2
- data/lib/factpulse/models/report_issuer.rb +2 -2
- data/lib/factpulse/models/report_period.rb +2 -2
- data/lib/factpulse/models/report_sender.rb +2 -2
- data/lib/factpulse/models/rounding_amount.rb +2 -2
- data/lib/factpulse/models/schematron_validation_error.rb +2 -2
- data/lib/factpulse/models/scheme_id.rb +2 -2
- data/lib/factpulse/models/search_flow_request.rb +2 -2
- data/lib/factpulse/models/search_flow_response.rb +2 -2
- data/lib/factpulse/models/search_services_response.rb +2 -2
- data/lib/factpulse/models/search_structure_request.rb +2 -2
- data/lib/factpulse/models/search_structure_response.rb +2 -2
- data/lib/factpulse/models/secret_status.rb +26 -6
- data/lib/factpulse/models/sellercountry.rb +2 -2
- data/lib/factpulse/models/signature_info.rb +2 -2
- data/lib/factpulse/models/signature_info_api.rb +2 -2
- data/lib/factpulse/models/signature_parameters.rb +2 -2
- data/lib/factpulse/models/signature_success_result.rb +394 -0
- data/lib/factpulse/models/signature_task_status.rb +223 -0
- data/lib/factpulse/models/signature_task_status_result.rb +55 -0
- data/lib/factpulse/models/simplified_cdar_response.rb +2 -2
- data/lib/factpulse/models/simplified_invoice_data.rb +3 -3
- data/lib/factpulse/models/status_code_info.rb +2 -2
- data/lib/factpulse/models/status_codes_response.rb +2 -2
- data/lib/factpulse/models/structure_info.rb +2 -2
- data/lib/factpulse/models/structure_parameters.rb +2 -2
- data/lib/factpulse/models/structure_service.rb +2 -2
- data/lib/factpulse/models/submission_mode.rb +2 -2
- data/lib/factpulse/models/submit_aggregated_report_request.rb +2 -2
- data/lib/factpulse/models/submit_cdar_request.rb +2 -2
- data/lib/factpulse/models/submit_cdar_response.rb +2 -2
- data/lib/factpulse/models/submit_cdarxml_request.rb +2 -2
- data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
- data/lib/factpulse/models/submit_complete_invoice_response.rb +33 -4
- data/lib/factpulse/models/submit_e_reporting_request.rb +2 -2
- data/lib/factpulse/models/submit_e_reporting_response.rb +2 -2
- data/lib/factpulse/models/submit_flow_request.rb +2 -2
- data/lib/factpulse/models/submit_flow_response.rb +2 -2
- data/lib/factpulse/models/submit_gross_amount.rb +2 -2
- data/lib/factpulse/models/submit_invoice_request.rb +2 -2
- data/lib/factpulse/models/submit_invoice_response.rb +2 -2
- data/lib/factpulse/models/submit_net_amount.rb +2 -2
- data/lib/factpulse/models/submit_vat_amount.rb +2 -2
- data/lib/factpulse/models/supplementary_attachment.rb +2 -2
- data/lib/factpulse/models/supplier.rb +4 -18
- data/lib/factpulse/models/task_error_result.rb +257 -0
- data/lib/factpulse/models/task_response.rb +2 -2
- data/lib/factpulse/models/tax_breakdown_input.rb +2 -2
- data/lib/factpulse/models/tax_due_date_type.rb +2 -2
- data/lib/factpulse/models/tax_representative.rb +2 -2
- data/lib/factpulse/models/taxable_amount.rb +2 -2
- data/lib/factpulse/models/taxableamount.rb +2 -2
- data/lib/factpulse/models/taxamount.rb +2 -2
- data/lib/factpulse/models/taxamount1.rb +2 -2
- data/lib/factpulse/models/taxamount2.rb +2 -2
- data/lib/factpulse/models/taxexclusiveamount.rb +2 -2
- data/lib/factpulse/models/taxexclusiveamount1.rb +2 -2
- data/lib/factpulse/models/total_gross_amount.rb +2 -2
- data/lib/factpulse/models/total_net_amount.rb +2 -2
- data/lib/factpulse/models/total_vat_amount.rb +2 -2
- data/lib/factpulse/models/transaction_category.rb +2 -2
- data/lib/factpulse/models/transmission_type_code.rb +2 -2
- data/lib/factpulse/models/unit_net_price.rb +2 -2
- data/lib/factpulse/models/unit_of_measure.rb +17 -3
- data/lib/factpulse/models/validate_cdar_request.rb +2 -2
- data/lib/factpulse/models/validate_cdar_response.rb +4 -4
- data/lib/factpulse/models/validate_e_reporting_request.rb +2 -2
- data/lib/factpulse/models/validate_e_reporting_response.rb +2 -2
- data/lib/factpulse/models/validation_error.rb +2 -2
- data/lib/factpulse/models/validation_error_detail.rb +2 -2
- data/lib/factpulse/models/validation_error_response.rb +69 -22
- data/lib/factpulse/models/validation_info.rb +2 -2
- data/lib/factpulse/models/validation_success_response.rb +2 -2
- data/lib/factpulse/models/validation_success_task_result.rb +210 -0
- data/lib/factpulse/models/validation_task_status.rb +223 -0
- data/lib/factpulse/models/validation_task_status_result.rb +55 -0
- data/lib/factpulse/models/vat_accounting_code.rb +2 -2
- data/lib/factpulse/models/vat_amount.rb +2 -2
- data/lib/factpulse/models/vat_category.rb +2 -2
- data/lib/factpulse/models/vat_line.rb +2 -2
- data/lib/factpulse/models/vat_point_date_code.rb +2 -2
- data/lib/factpulse/models/vat_rate.rb +2 -2
- data/lib/factpulse/models/vatex_code_info.rb +247 -0
- data/lib/factpulse/models/vatex_codes_response.rb +204 -0
- data/lib/factpulse/models/verification_success_response.rb +2 -2
- data/lib/factpulse/models/verification_success_task_result.rb +210 -0
- data/lib/factpulse/models/verification_typed_task_status.rb +223 -0
- data/lib/factpulse/models/verification_typed_task_status_result.rb +55 -0
- data/lib/factpulse/models/verified_field_schema.rb +2 -2
- 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 +3 -3
- data/lib/factpulse.rb +40 -5
- metadata +133 -63
- data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +0 -24
- data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +0 -15
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +0 -215
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +0 -43
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# FactPulse::ConversionPendingInputResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional][default to 'PENDING_INPUT'] |
|
|
8
|
+
| **conversion_id** | **String** | | |
|
|
9
|
+
| **message** | **String** | | |
|
|
10
|
+
| **missing_fields** | **Array<String>** | | |
|
|
11
|
+
| **extracted_data** | **Hash<String, Object>** | | |
|
|
12
|
+
| **confidence_score** | **Float** | | |
|
|
13
|
+
| **processing_time_ms** | **Integer** | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'factpulse'
|
|
19
|
+
|
|
20
|
+
instance = FactPulse::ConversionPendingInputResult.new(
|
|
21
|
+
status: null,
|
|
22
|
+
conversion_id: null,
|
|
23
|
+
message: null,
|
|
24
|
+
missing_fields: null,
|
|
25
|
+
extracted_data: null,
|
|
26
|
+
confidence_score: null,
|
|
27
|
+
processing_time_ms: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# FactPulse::ConversionSuccessTaskResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional][default to 'SUCCESS'] |
|
|
8
|
+
| **conversion_id** | **String** | | |
|
|
9
|
+
| **document_type_code** | **Integer** | | |
|
|
10
|
+
| **profile** | **String** | | |
|
|
11
|
+
| **extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) | | |
|
|
12
|
+
| **processing_time_ms** | **Integer** | | |
|
|
13
|
+
| **pdf_regenerated** | **Boolean** | | [optional][default to false] |
|
|
14
|
+
| **pdf_regenerated_reason** | **String** | | [optional] |
|
|
15
|
+
| **content_b64** | **String** | | [optional] |
|
|
16
|
+
| **xml_content** | **String** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'factpulse'
|
|
22
|
+
|
|
23
|
+
instance = FactPulse::ConversionSuccessTaskResult.new(
|
|
24
|
+
status: null,
|
|
25
|
+
conversion_id: null,
|
|
26
|
+
document_type_code: null,
|
|
27
|
+
profile: null,
|
|
28
|
+
extraction: null,
|
|
29
|
+
processing_time_ms: null,
|
|
30
|
+
pdf_regenerated: null,
|
|
31
|
+
pdf_regenerated_reason: null,
|
|
32
|
+
content_b64: null,
|
|
33
|
+
xml_content: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::ConversionTaskStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **task_id** | **String** | | |
|
|
8
|
+
| **status** | [**CeleryStatus**](CeleryStatus.md) | | |
|
|
9
|
+
| **result** | [**ConversionTaskStatusResult**](ConversionTaskStatusResult.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::ConversionTaskStatus.new(
|
|
17
|
+
task_id: null,
|
|
18
|
+
status: null,
|
|
19
|
+
result: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# FactPulse::ConversionTaskStatusResult
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
FactPulse::ConversionTaskStatusResult.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'ConversionErrorResult',
|
|
18
|
+
# :'ConversionPendingInputResult',
|
|
19
|
+
# :'ConversionSuccessTaskResult',
|
|
20
|
+
# :'ConversionValidationFailedResult'
|
|
21
|
+
# ]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### `openapi_discriminator_name`
|
|
25
|
+
|
|
26
|
+
Returns the discriminator's property name.
|
|
27
|
+
|
|
28
|
+
#### Example
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'factpulse'
|
|
32
|
+
|
|
33
|
+
FactPulse::ConversionTaskStatusResult.openapi_discriminator_name
|
|
34
|
+
# => :'status'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `openapi_discriminator_name`
|
|
38
|
+
|
|
39
|
+
Returns the discriminator's mapping.
|
|
40
|
+
|
|
41
|
+
#### Example
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
require 'factpulse'
|
|
45
|
+
|
|
46
|
+
FactPulse::ConversionTaskStatusResult.openapi_discriminator_mapping
|
|
47
|
+
# =>
|
|
48
|
+
# {
|
|
49
|
+
# :'ERROR' => :'ConversionErrorResult',
|
|
50
|
+
# :'PENDING_INPUT' => :'ConversionPendingInputResult',
|
|
51
|
+
# :'SUCCESS' => :'ConversionSuccessTaskResult',
|
|
52
|
+
# :'VALIDATION_FAILED' => :'ConversionValidationFailedResult'
|
|
53
|
+
# }
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### build
|
|
57
|
+
|
|
58
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
59
|
+
|
|
60
|
+
#### Example
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
require 'factpulse'
|
|
64
|
+
|
|
65
|
+
FactPulse::ConversionTaskStatusResult.build(data)
|
|
66
|
+
# => #<ConversionErrorResult:0x00007fdd4aab02a0>
|
|
67
|
+
|
|
68
|
+
FactPulse::ConversionTaskStatusResult.build(data_that_doesnt_match)
|
|
69
|
+
# => nil
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
#### Parameters
|
|
73
|
+
|
|
74
|
+
| Name | Type | Description |
|
|
75
|
+
| ---- | ---- | ----------- |
|
|
76
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
77
|
+
|
|
78
|
+
#### Return type
|
|
79
|
+
|
|
80
|
+
- `ConversionErrorResult`
|
|
81
|
+
- `ConversionPendingInputResult`
|
|
82
|
+
- `ConversionSuccessTaskResult`
|
|
83
|
+
- `ConversionValidationFailedResult`
|
|
84
|
+
- `nil` (if no type matches)
|
|
85
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# FactPulse::ConversionValidationFailedResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional][default to 'VALIDATION_FAILED'] |
|
|
8
|
+
| **conversion_id** | **String** | | |
|
|
9
|
+
| **message** | **String** | | |
|
|
10
|
+
| **extracted_data** | **Hash<String, Object>** | | |
|
|
11
|
+
| **extraction** | [**ConversionExtractionInfo**](ConversionExtractionInfo.md) | | [optional] |
|
|
12
|
+
| **validation_errors** | **Array<Hash<String, Object>>** | | [optional] |
|
|
13
|
+
| **profile** | **String** | | |
|
|
14
|
+
| **processing_time_ms** | **Integer** | | |
|
|
15
|
+
| **correction_attempted** | **Boolean** | | [optional][default to false] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'factpulse'
|
|
21
|
+
|
|
22
|
+
instance = FactPulse::ConversionValidationFailedResult.new(
|
|
23
|
+
status: null,
|
|
24
|
+
conversion_id: null,
|
|
25
|
+
message: null,
|
|
26
|
+
extracted_data: null,
|
|
27
|
+
extraction: null,
|
|
28
|
+
validation_errors: null,
|
|
29
|
+
profile: null,
|
|
30
|
+
processing_time_ms: null,
|
|
31
|
+
correction_attempted: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **overrides** | **Hash<String, Object>** | Sous-ensemble de FacturXInvoice a mettre a jour (merge profond) | [optional] |
|
|
8
|
+
| **callback_url** | **String** | | [optional] |
|
|
9
|
+
| **webhook_mode** | **String** | Mode de livraison webhook: 'inline' ou 'download_url' | [optional][default to 'inline'] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
10
12
|
|
|
@@ -12,7 +14,9 @@
|
|
|
12
14
|
require 'factpulse'
|
|
13
15
|
|
|
14
16
|
instance = FactPulse::ConvertResumeRequest.new(
|
|
15
|
-
overrides: null
|
|
17
|
+
overrides: null,
|
|
18
|
+
callback_url: null,
|
|
19
|
+
webhook_mode: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
18
22
|
|
data/docs/DownloadsApi.md
CHANGED
|
@@ -23,12 +23,17 @@ require 'time'
|
|
|
23
23
|
require 'factpulse'
|
|
24
24
|
# setup authorization
|
|
25
25
|
FactPulse.configure do |config|
|
|
26
|
+
# Configure API key authorization: APIKeyHeader
|
|
27
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
30
|
+
|
|
26
31
|
# Configure Bearer authorization: HTTPBearer
|
|
27
32
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
33
|
end
|
|
29
34
|
|
|
30
35
|
api_instance = FactPulse::DownloadsApi.new
|
|
31
|
-
download_id = 'download_id_example' # String |
|
|
36
|
+
download_id = 'download_id_example' # String | Unique identifier of the temporary file to check
|
|
32
37
|
|
|
33
38
|
begin
|
|
34
39
|
# Check if a file exists
|
|
@@ -61,7 +66,7 @@ end
|
|
|
61
66
|
|
|
62
67
|
| Name | Type | Description | Notes |
|
|
63
68
|
| ---- | ---- | ----------- | ----- |
|
|
64
|
-
| **download_id** | **String** |
|
|
69
|
+
| **download_id** | **String** | Unique identifier of the temporary file to check | |
|
|
65
70
|
|
|
66
71
|
### Return type
|
|
67
72
|
|
|
@@ -69,7 +74,7 @@ end
|
|
|
69
74
|
|
|
70
75
|
### Authorization
|
|
71
76
|
|
|
72
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
77
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
73
78
|
|
|
74
79
|
### HTTP request headers
|
|
75
80
|
|
|
@@ -92,12 +97,17 @@ require 'time'
|
|
|
92
97
|
require 'factpulse'
|
|
93
98
|
# setup authorization
|
|
94
99
|
FactPulse.configure do |config|
|
|
100
|
+
# Configure API key authorization: APIKeyHeader
|
|
101
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
104
|
+
|
|
95
105
|
# Configure Bearer authorization: HTTPBearer
|
|
96
106
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
97
107
|
end
|
|
98
108
|
|
|
99
109
|
api_instance = FactPulse::DownloadsApi.new
|
|
100
|
-
download_id = 'download_id_example' # String |
|
|
110
|
+
download_id = 'download_id_example' # String | Unique identifier of the temporary file to download
|
|
101
111
|
opts = {
|
|
102
112
|
delete_after: true # Boolean | If true, delete the file after download (one-time download)
|
|
103
113
|
}
|
|
@@ -133,7 +143,7 @@ end
|
|
|
133
143
|
|
|
134
144
|
| Name | Type | Description | Notes |
|
|
135
145
|
| ---- | ---- | ----------- | ----- |
|
|
136
|
-
| **download_id** | **String** |
|
|
146
|
+
| **download_id** | **String** | Unique identifier of the temporary file to download | |
|
|
137
147
|
| **delete_after** | **Boolean** | If true, delete the file after download (one-time download) | [optional][default to false] |
|
|
138
148
|
|
|
139
149
|
### Return type
|
|
@@ -142,7 +152,7 @@ end
|
|
|
142
152
|
|
|
143
153
|
### Authorization
|
|
144
154
|
|
|
145
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
155
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
146
156
|
|
|
147
157
|
### HTTP request headers
|
|
148
158
|
|
|
@@ -25,6 +25,11 @@ require 'time'
|
|
|
25
25
|
require 'factpulse'
|
|
26
26
|
# setup authorization
|
|
27
27
|
FactPulse.configure do |config|
|
|
28
|
+
# Configure API key authorization: APIKeyHeader
|
|
29
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
31
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
32
|
+
|
|
28
33
|
# Configure Bearer authorization: HTTPBearer
|
|
29
34
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
35
|
end
|
|
@@ -71,7 +76,7 @@ end
|
|
|
71
76
|
|
|
72
77
|
### Authorization
|
|
73
78
|
|
|
74
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
79
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
75
80
|
|
|
76
81
|
### HTTP request headers
|
|
77
82
|
|
|
@@ -94,6 +99,11 @@ require 'time'
|
|
|
94
99
|
require 'factpulse'
|
|
95
100
|
# setup authorization
|
|
96
101
|
FactPulse.configure do |config|
|
|
102
|
+
# Configure API key authorization: APIKeyHeader
|
|
103
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
104
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
105
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
106
|
+
|
|
97
107
|
# Configure Bearer authorization: HTTPBearer
|
|
98
108
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
109
|
end
|
|
@@ -154,7 +164,7 @@ end
|
|
|
154
164
|
|
|
155
165
|
### Authorization
|
|
156
166
|
|
|
157
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
167
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
158
168
|
|
|
159
169
|
### HTTP request headers
|
|
160
170
|
|
|
@@ -177,6 +187,11 @@ require 'time'
|
|
|
177
187
|
require 'factpulse'
|
|
178
188
|
# setup authorization
|
|
179
189
|
FactPulse.configure do |config|
|
|
190
|
+
# Configure API key authorization: APIKeyHeader
|
|
191
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
192
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
193
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
194
|
+
|
|
180
195
|
# Configure Bearer authorization: HTTPBearer
|
|
181
196
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
182
197
|
end
|
|
@@ -241,7 +256,7 @@ end
|
|
|
241
256
|
|
|
242
257
|
### Authorization
|
|
243
258
|
|
|
244
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
259
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
245
260
|
|
|
246
261
|
### HTTP request headers
|
|
247
262
|
|
|
@@ -264,6 +279,11 @@ require 'time'
|
|
|
264
279
|
require 'factpulse'
|
|
265
280
|
# setup authorization
|
|
266
281
|
FactPulse.configure do |config|
|
|
282
|
+
# Configure API key authorization: APIKeyHeader
|
|
283
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
286
|
+
|
|
267
287
|
# Configure Bearer authorization: HTTPBearer
|
|
268
288
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
269
289
|
end
|
|
@@ -310,7 +330,7 @@ end
|
|
|
310
330
|
|
|
311
331
|
### Authorization
|
|
312
332
|
|
|
313
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
333
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
314
334
|
|
|
315
335
|
### HTTP request headers
|
|
316
336
|
|
|
@@ -7,7 +7,9 @@ All URIs are relative to *https://factpulse.fr*
|
|
|
7
7
|
| [**convert_document_async_api_v1_convert_async_post**](FacturXConversionApi.md#convert_document_async_api_v1_convert_async_post) | **POST** /api/v1/convert/async | Convert a document to Factur-X (async mode) |
|
|
8
8
|
| [**download_file_api_v1_convert_conversion_id_download_filename_get**](FacturXConversionApi.md#download_file_api_v1_convert_conversion_id_download_filename_get) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Download a generated file |
|
|
9
9
|
| [**get_conversion_status_api_v1_convert_conversion_id_status_get**](FacturXConversionApi.md#get_conversion_status_api_v1_convert_conversion_id_status_get) | **GET** /api/v1/convert/{conversion_id}/status | Check conversion status |
|
|
10
|
+
| [**get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get**](FacturXConversionApi.md#get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get) | **GET** /api/v1/convert/tasks/{task_id}/conversion-status | Get typed conversion task status |
|
|
10
11
|
| [**resume_conversion_api_v1_convert_conversion_id_resume_post**](FacturXConversionApi.md#resume_conversion_api_v1_convert_conversion_id_resume_post) | **POST** /api/v1/convert/{conversion_id}/resume | Resume a conversion with corrections |
|
|
12
|
+
| [**resume_conversion_async_api_v1_convert_conversion_id_resume_async_post**](FacturXConversionApi.md#resume_conversion_async_api_v1_convert_conversion_id_resume_async_post) | **POST** /api/v1/convert/{conversion_id}/resume/async | Resume a conversion asynchronously |
|
|
11
13
|
|
|
12
14
|
|
|
13
15
|
## convert_document_async_api_v1_convert_async_post
|
|
@@ -25,6 +27,11 @@ require 'time'
|
|
|
25
27
|
require 'factpulse'
|
|
26
28
|
# setup authorization
|
|
27
29
|
FactPulse.configure do |config|
|
|
30
|
+
# Configure API key authorization: APIKeyHeader
|
|
31
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
34
|
+
|
|
28
35
|
# Configure Bearer authorization: HTTPBearer
|
|
29
36
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
37
|
end
|
|
@@ -79,7 +86,7 @@ end
|
|
|
79
86
|
|
|
80
87
|
### Authorization
|
|
81
88
|
|
|
82
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
89
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
83
90
|
|
|
84
91
|
### HTTP request headers
|
|
85
92
|
|
|
@@ -102,6 +109,11 @@ require 'time'
|
|
|
102
109
|
require 'factpulse'
|
|
103
110
|
# setup authorization
|
|
104
111
|
FactPulse.configure do |config|
|
|
112
|
+
# Configure API key authorization: APIKeyHeader
|
|
113
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
116
|
+
|
|
105
117
|
# Configure Bearer authorization: HTTPBearer
|
|
106
118
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
107
119
|
end
|
|
@@ -150,7 +162,7 @@ end
|
|
|
150
162
|
|
|
151
163
|
### Authorization
|
|
152
164
|
|
|
153
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
165
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
154
166
|
|
|
155
167
|
### HTTP request headers
|
|
156
168
|
|
|
@@ -173,6 +185,11 @@ require 'time'
|
|
|
173
185
|
require 'factpulse'
|
|
174
186
|
# setup authorization
|
|
175
187
|
FactPulse.configure do |config|
|
|
188
|
+
# Configure API key authorization: APIKeyHeader
|
|
189
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
191
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
192
|
+
|
|
176
193
|
# Configure Bearer authorization: HTTPBearer
|
|
177
194
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
178
195
|
end
|
|
@@ -219,7 +236,81 @@ end
|
|
|
219
236
|
|
|
220
237
|
### Authorization
|
|
221
238
|
|
|
222
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
239
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: Not defined
|
|
244
|
+
- **Accept**: application/json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get
|
|
248
|
+
|
|
249
|
+
> <ConversionTaskStatus> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
|
|
250
|
+
|
|
251
|
+
Get typed conversion task status
|
|
252
|
+
|
|
253
|
+
Typed status endpoint for document conversion tasks. Returns a strongly-typed `result` discriminated on `result.status`: - **SUCCESS**: `ConversionSuccessTaskResult` - **PENDING_INPUT**: `ConversionPendingInputResult` (missing fields) - **VALIDATION_FAILED**: `ConversionValidationFailedResult` - **ERROR**: `ConversionErrorResult`
|
|
254
|
+
|
|
255
|
+
### Examples
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
require 'time'
|
|
259
|
+
require 'factpulse'
|
|
260
|
+
# setup authorization
|
|
261
|
+
FactPulse.configure do |config|
|
|
262
|
+
# Configure API key authorization: APIKeyHeader
|
|
263
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
264
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
265
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
266
|
+
|
|
267
|
+
# Configure Bearer authorization: HTTPBearer
|
|
268
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
api_instance = FactPulse::FacturXConversionApi.new
|
|
272
|
+
task_id = 'task_id_example' # String | Celery task ID returned by POST /convert
|
|
273
|
+
|
|
274
|
+
begin
|
|
275
|
+
# Get typed conversion task status
|
|
276
|
+
result = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id)
|
|
277
|
+
p result
|
|
278
|
+
rescue FactPulse::ApiError => e
|
|
279
|
+
puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get: #{e}"
|
|
280
|
+
end
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
#### Using the get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info variant
|
|
284
|
+
|
|
285
|
+
This returns an Array which contains the response data, status code and headers.
|
|
286
|
+
|
|
287
|
+
> <Array(<ConversionTaskStatus>, Integer, Hash)> get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
begin
|
|
291
|
+
# Get typed conversion task status
|
|
292
|
+
data, status_code, headers = api_instance.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id)
|
|
293
|
+
p status_code # => 2xx
|
|
294
|
+
p headers # => { ... }
|
|
295
|
+
p data # => <ConversionTaskStatus>
|
|
296
|
+
rescue FactPulse::ApiError => e
|
|
297
|
+
puts "Error when calling FacturXConversionApi->get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
| Name | Type | Description | Notes |
|
|
304
|
+
| ---- | ---- | ----------- | ----- |
|
|
305
|
+
| **task_id** | **String** | Celery task ID returned by POST /convert | |
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
[**ConversionTaskStatus**](ConversionTaskStatus.md)
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
223
314
|
|
|
224
315
|
### HTTP request headers
|
|
225
316
|
|
|
@@ -242,6 +333,11 @@ require 'time'
|
|
|
242
333
|
require 'factpulse'
|
|
243
334
|
# setup authorization
|
|
244
335
|
FactPulse.configure do |config|
|
|
336
|
+
# Configure API key authorization: APIKeyHeader
|
|
337
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
338
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
339
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
340
|
+
|
|
245
341
|
# Configure Bearer authorization: HTTPBearer
|
|
246
342
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
247
343
|
end
|
|
@@ -290,7 +386,83 @@ end
|
|
|
290
386
|
|
|
291
387
|
### Authorization
|
|
292
388
|
|
|
293
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
389
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: application/json
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
## resume_conversion_async_api_v1_convert_conversion_id_resume_async_post
|
|
398
|
+
|
|
399
|
+
> Object resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
|
|
400
|
+
|
|
401
|
+
Resume a conversion asynchronously
|
|
402
|
+
|
|
403
|
+
Resume a conversion after completing missing data or correcting errors (async mode). The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery. ## Workflow 1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion ## Possible responses - **202**: Task accepted, processing - **404**: Conversion not found or expired
|
|
404
|
+
|
|
405
|
+
### Examples
|
|
406
|
+
|
|
407
|
+
```ruby
|
|
408
|
+
require 'time'
|
|
409
|
+
require 'factpulse'
|
|
410
|
+
# setup authorization
|
|
411
|
+
FactPulse.configure do |config|
|
|
412
|
+
# Configure API key authorization: APIKeyHeader
|
|
413
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
414
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
415
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
416
|
+
|
|
417
|
+
# Configure Bearer authorization: HTTPBearer
|
|
418
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
419
|
+
end
|
|
420
|
+
|
|
421
|
+
api_instance = FactPulse::FacturXConversionApi.new
|
|
422
|
+
conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
|
|
423
|
+
convert_resume_request = FactPulse::ConvertResumeRequest.new # ConvertResumeRequest |
|
|
424
|
+
|
|
425
|
+
begin
|
|
426
|
+
# Resume a conversion asynchronously
|
|
427
|
+
result = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
|
|
428
|
+
p result
|
|
429
|
+
rescue FactPulse::ApiError => e
|
|
430
|
+
puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post: #{e}"
|
|
431
|
+
end
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
#### Using the resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info variant
|
|
435
|
+
|
|
436
|
+
This returns an Array which contains the response data, status code and headers.
|
|
437
|
+
|
|
438
|
+
> <Array(Object, Integer, Hash)> resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
|
|
439
|
+
|
|
440
|
+
```ruby
|
|
441
|
+
begin
|
|
442
|
+
# Resume a conversion asynchronously
|
|
443
|
+
data, status_code, headers = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
|
|
444
|
+
p status_code # => 2xx
|
|
445
|
+
p headers # => { ... }
|
|
446
|
+
p data # => Object
|
|
447
|
+
rescue FactPulse::ApiError => e
|
|
448
|
+
puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info: #{e}"
|
|
449
|
+
end
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
| Name | Type | Description | Notes |
|
|
455
|
+
| ---- | ---- | ----------- | ----- |
|
|
456
|
+
| **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) | |
|
|
457
|
+
| **convert_resume_request** | [**ConvertResumeRequest**](ConvertResumeRequest.md) | | |
|
|
458
|
+
|
|
459
|
+
### Return type
|
|
460
|
+
|
|
461
|
+
**Object**
|
|
462
|
+
|
|
463
|
+
### Authorization
|
|
464
|
+
|
|
465
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
294
466
|
|
|
295
467
|
### HTTP request headers
|
|
296
468
|
|
data/docs/FacturXInvoice.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **submission_mode** | [**SubmissionMode**](SubmissionMode.md) | | [optional] |
|
|
11
11
|
| **recipient** | [**Recipient**](Recipient.md) | | |
|
|
12
12
|
| **supplier** | [**Supplier**](Supplier.md) | | |
|
|
13
|
-
| **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) | |
|
|
13
|
+
| **invoicing_framework** | [**InvoicingFramework**](InvoicingFramework.md) | | [optional] |
|
|
14
14
|
| **references** | [**InvoiceReferences**](InvoiceReferences.md) | | |
|
|
15
15
|
| **totals** | [**InvoiceTotals**](InvoiceTotals.md) | | |
|
|
16
16
|
| **invoice_lines** | [**Array<InvoiceLine>**](InvoiceLine.md) | | [optional] |
|