factpulse 0.1.0 → 1.0.0

data/docs/ValidateCDARRequest.md

@@ -1,32 +0,0 @@
-# FactPulse::ValidateCDARRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **document_id** | **String** |  | [optional] |
-| **sender_siren** | **String** |  | [optional] |
-| **sender_role** | **String** |  | [optional] |
-| **invoice_id** | **String** |  | [optional] |
-| **invoice_issue_date** | **Date** |  | [optional] |
-| **status** | **String** |  | [optional] |
-| **reason_code** | **String** |  | [optional] |
-| **encaisse_amount** | [**Encaisseamount1**](Encaisseamount1.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidateCDARRequest.new(
-  document_id: null,
-  sender_siren: null,
-  sender_role: null,
-  invoice_id: null,
-  invoice_issue_date: null,
-  status: null,
-  reason_code: null,
-  encaisse_amount: null
-)
-```
-

data/docs/ValidateCDARResponse.md

@@ -1,22 +0,0 @@
-# FactPulse::ValidateCDARResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **valid** | **Boolean** | Résultat de validation |  |
-| **errors** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des erreurs | [optional] |
-| **warnings** | [**Array<ValidationErrorResponse>**](ValidationErrorResponse.md) | Liste des avertissements | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidateCDARResponse.new(
-  valid: null,
-  errors: null,
-  warnings: null
-)
-```
-

data/docs/ValidateEReportingRequest.md

@@ -1,18 +0,0 @@
-# FactPulse::ValidateEReportingRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **data** | [**CreateEReportingRequest**](CreateEReportingRequest.md) | E-Reporting data to validate |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidateEReportingRequest.new(
-  data: null
-)
-```
-

data/docs/ValidateEReportingResponse.md

@@ -1,28 +0,0 @@
-# FactPulse::ValidateEReportingResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **valid** | **Boolean** | Whether the data is valid |  |
-| **report_id** | **String** | Report identifier |  |
-| **flow_type** | **String** | Flux type |  |
-| **errors** | [**Array<EReportingValidationError>**](EReportingValidationError.md) | List of validation errors (if any) | [optional] |
-| **warnings** | [**Array<EReportingValidationError>**](EReportingValidationError.md) | List of validation warnings (if any) | [optional] |
-| **message** | **String** | Status message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidateEReportingResponse.new(
-  valid: null,
-  report_id: null,
-  flow_type: null,
-  errors: null,
-  warnings: null,
-  message: null
-)
-```
-

data/docs/ValidationErrorResponse.md

@@ -1,24 +0,0 @@
-# FactPulse::ValidationErrorResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **field** | **String** | Champ concerné |  |
-| **message** | **String** | Message d'erreur |  |
-| **rule** | **String** |  | [optional] |
-| **severity** | **String** | Sévérité (error/warning) | [optional][default to 'error'] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidationErrorResponse.new(
-  field: null,
-  message: null,
-  rule: null,
-  severity: null
-)
-```
-

data/docs/ValidationInfo.md

@@ -1,28 +0,0 @@
-# FactPulse::ValidationInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **profile** | **String** | Profil Factur-X utilise |  |
-| **schematron_rules_passed** | **Integer** | Regles passees |  |
-| **schematron_rules_total** | **Integer** | Total regles |  |
-| **pdfa_compliant** | **Boolean** | PDF/A-3 conforme | [optional][default to true] |
-| **xml_embedded** | **Boolean** | XML embarque dans PDF | [optional][default to true] |
-| **errors** | [**Array<SchematronValidationError>**](SchematronValidationError.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidationInfo.new(
-  profile: null,
-  schematron_rules_passed: null,
-  schematron_rules_total: null,
-  pdfa_compliant: null,
-  xml_embedded: null,
-  errors: null
-)
-```
-

data/docs/ValidationSuccessResponse.md

@@ -1,18 +0,0 @@
-# FactPulse::ValidationSuccessResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Message confirming XML compliance. |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ValidationSuccessResponse.new(
-  message: null
-)
-```
-

data/docs/VatRate.md

@@ -1,15 +0,0 @@
-# FactPulse::VatRate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::VatRate.new()
-```
-

data/docs/VerificationSuccessResponse.md

@@ -1,36 +0,0 @@
-# FactPulse::VerificationSuccessResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **is_compliant** | **Boolean** | True if no critical discrepancy |  |
-| **compliance_score** | **Float** | Compliance score (0-100%) |  |
-| **verified_fields_count** | **Integer** | Number of verified fields | [optional][default to 0] |
-| **compliant_fields_count** | **Integer** | Number of compliant fields | [optional][default to 0] |
-| **is_facturx** | **Boolean** | True if PDF contains Factur-X XML | [optional][default to false] |
-| **facturx_profile** | **String** |  | [optional] |
-| **fields** | [**Array<VerifiedFieldSchema>**](VerifiedFieldSchema.md) | List of verified fields with values, statuses and PDF coordinates | [optional] |
-| **mandatory_notes** | [**Array<MandatoryNoteSchema>**](MandatoryNoteSchema.md) | Mandatory notes (PMT, PMD, AAB) with PDF location | [optional] |
-| **page_dimensions** | [**Array<PageDimensionsSchema>**](PageDimensionsSchema.md) | Dimensions of each PDF page (width, height) | [optional] |
-| **warnings** | **Array<String>** | Non-blocking warnings | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::VerificationSuccessResponse.new(
-  is_compliant: null,
-  compliance_score: null,
-  verified_fields_count: null,
-  compliant_fields_count: null,
-  is_facturx: null,
-  facturx_profile: null,
-  fields: null,
-  mandatory_notes: null,
-  page_dimensions: null,
-  warnings: null
-)
-```
-

data/docs/VerifiedFieldSchema.md

@@ -1,34 +0,0 @@
-# FactPulse::VerifiedFieldSchema
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **business_term** | **String** | EN16931 Business Term (e.g., BT-1) |  |
-| **label** | **String** | Field label (e.g., Invoice Number) |  |
-| **pdf_value** | **String** |  | [optional] |
-| **xml_value** | **String** |  | [optional] |
-| **status** | [**FieldStatus**](FieldStatus.md) | Compliance status |  |
-| **message** | **String** |  | [optional] |
-| **confidence** | **Float** | Confidence score (0-1) | [optional][default to 1.0] |
-| **source** | **String** | Extraction source | [optional][default to 'native_pdf'] |
-| **bbox** | [**BoundingBoxSchema**](BoundingBoxSchema.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::VerifiedFieldSchema.new(
-  business_term: null,
-  label: null,
-  pdf_value: null,
-  xml_value: null,
-  status: null,
-  message: null,
-  confidence: null,
-  source: null,
-  bbox: null
-)
-```
-

data/docs/WebhookSecretDeleteResponse.md

@@ -1,20 +0,0 @@
-# FactPulse::WebhookSecretDeleteResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **success** | **Boolean** | Whether the secret was deleted successfully |  |
-| **message** | **String** | Result message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::WebhookSecretDeleteResponse.new(
-  success: null,
-  message: null
-)
-```
-

data/docs/WebhookSecretGenerateResponse.md

@@ -1,24 +0,0 @@
-# FactPulse::WebhookSecretGenerateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **success** | **Boolean** | Whether the secret was generated successfully |  |
-| **webhook_secret** | **String** | The generated webhook secret (save it, it will never be shown again) |  |
-| **message** | **String** | Result message |  |
-| **created_at** | **Time** | When the secret was created |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::WebhookSecretGenerateResponse.new(
-  success: null,
-  webhook_secret: null,
-  message: null,
-  created_at: null
-)
-```
-

data/docs/WebhookSecretStatusResponse.md

@@ -1,20 +0,0 @@
-# FactPulse::WebhookSecretStatusResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **has_secret** | **Boolean** | Whether a webhook secret is configured |  |
-| **created_at** | **Time** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::WebhookSecretStatusResponse.new(
-  has_secret: null,
-  created_at: null
-)
-```
-

data/lib/factpulse/api/async_tasks_api.rb

@@ -1,85 +0,0 @@
-=begin
-#FactPulse REST API
-
-# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search)  ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules)  ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification  ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212)  ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments)  ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user  ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro  ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete  ## 🔒 Authentication  All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ```  ### How to obtain a JWT token?  #### 🔑 Method 1: `/api/token/` API (Recommended)  **URL:** `https://factpulse.fr/api/token/`  This method is **recommended** for integration in your applications and CI/CD workflows.  **Prerequisites:** Having set a password on your account  **For users registered via email/password:** - You already have a password, use it directly  **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\"   }' ```  **Optional `client_uid` parameter:**  To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`:  ```bash curl -X POST https://factpulse.fr/api/token/ \\   -H \"Content-Type: application/json\" \\   -d '{     \"username\": \"your_email@example.com\",     \"password\": \"your_password\",     \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\"   }' ```  The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client  **Response:** ```json {   \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\",  // Access token (validity: 30 min)   \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\"  // Refresh token (validity: 7 days) } ```  **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool  #### 🖥️ Method 2: Dashboard Generation (Alternative)  **URL:** https://factpulse.fr/api/dashboard/  This method is suitable for quick tests or occasional use via the graphical interface.  **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password  **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan  **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface  **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation  ### 📚 Full Documentation  For more information on authentication and API usage: https://factpulse.fr/documentation-api/     
-
-The version of the OpenAPI document: 1.0.0
-Contact: contact@factpulse.fr
-Generated by: https://openapi-generator.tech
-Generator version: 7.20.0-SNAPSHOT
-
-=end
-
-require 'cgi'
-
-module FactPulse
-  class AsyncTasksApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get task generation status
-    # Retrieves the progress status of an invoice generation task.  ## Possible states  The `status` field uses the `CeleryStatus` enum with values: - **PENDING, STARTED, SUCCESS, FAILURE, RETRY**  See the `CeleryStatus` schema documentation for details.  ## Business result  When `status=\"SUCCESS\"`, the `result` field contains: - `status`: \"SUCCESS\" or \"ERROR\" (business result) - `content_b64`: Base64 encoded content (if success) - `errorCode`, `errorMessage`, `details`: AFNOR format (if business error)  ## Usage  Poll this endpoint every 2-3 seconds until `status` is `SUCCESS` or `FAILURE`.
-    # @param task_id [String] Celery task ID returned by async endpoints (UUID format)
-    # @param [Hash] opts the optional parameters
-    # @return [AsyncTaskStatus]
-    def get_task_status_api_v1_processing_tasks_task_id_status_get(task_id, opts = {})
-      data, _status_code, _headers = get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info(task_id, opts)
-      data
-    end
-
-    # Get task generation status
-    # Retrieves the progress status of an invoice generation task.  ## Possible states  The `status` field uses the `CeleryStatus` enum with values: - **PENDING, STARTED, SUCCESS, FAILURE, RETRY**  See the `CeleryStatus` schema documentation for details.  ## Business result  When `status=\"SUCCESS\"`, the `result` field contains: - `status`: \"SUCCESS\" or \"ERROR\" (business result) - `content_b64`: Base64 encoded content (if success) - `errorCode`, `errorMessage`, `details`: AFNOR format (if business error)  ## Usage  Poll this endpoint every 2-3 seconds until `status` is `SUCCESS` or `FAILURE`.
-    # @param task_id [String] Celery task ID returned by async endpoints (UUID format)
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(AsyncTaskStatus, Integer, Hash)>] AsyncTaskStatus data, response status code and response headers
-    def get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info(task_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AsyncTasksApi.get_task_status_api_v1_processing_tasks_task_id_status_get ...'
-      end
-      # verify the required parameter 'task_id' is set
-      if @api_client.config.client_side_validation && task_id.nil?
-        fail ArgumentError, "Missing the required parameter 'task_id' when calling AsyncTasksApi.get_task_status_api_v1_processing_tasks_task_id_status_get"
-      end
-      # resource path
-      local_var_path = '/api/v1/processing/tasks/{task_id}/status'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'AsyncTaskStatus'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
-
-      new_options = opts.merge(
-        :operation => :"AsyncTasksApi.get_task_status_api_v1_processing_tasks_task_id_status_get",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AsyncTasksApi#get_task_status_api_v1_processing_tasks_task_id_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end