factpulse 0.1.0 → 1.0.0

data/docs/GenerateAggregatedReportResponse.md

@@ -1,30 +0,0 @@
-# FactPulse::GenerateAggregatedReportResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **report_id** | **String** | Report identifier |  |
-| **transmission_type** | **String** | Transmission type (IN or RE) |  |
-| **flow_type** | **String** | AFNOR FlowType determined from content |  |
-| **xml** | **String** | Generated XML content |  |
-| **xml_size** | **Integer** | XML size in bytes |  |
-| **content_summary** | **Hash<String, Object>** | Summary of content (counts by flux type) |  |
-| **message** | **String** | Status message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GenerateAggregatedReportResponse.new(
-  report_id: null,
-  transmission_type: null,
-  flow_type: null,
-  xml: null,
-  xml_size: null,
-  content_summary: null,
-  message: null
-)
-```
-

data/docs/GenerateCDARResponse.md

@@ -1,26 +0,0 @@
-# FactPulse::GenerateCDARResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **document_id** | **String** |  |  |
-| **xml** | **String** | XML CDAR généré |  |
-| **xml_size** | **Integer** | Taille du XML en octets |  |
-| **sha256** | **String** | Hash SHA256 du XML |  |
-| **message** | **String** | Message de succès |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GenerateCDARResponse.new(
-  document_id: null,
-  xml: null,
-  xml_size: null,
-  sha256: null,
-  message: null
-)
-```
-

data/docs/GenerateEReportingResponse.md

@@ -1,26 +0,0 @@
-# FactPulse::GenerateEReportingResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **report_id** | **String** | Report identifier |  |
-| **flow_type** | **String** | Flux type |  |
-| **xml** | **String** | Generated XML content |  |
-| **xml_size** | **Integer** | XML size in bytes |  |
-| **message** | **String** | Status message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GenerateEReportingResponse.new(
-  report_id: null,
-  flow_type: null,
-  xml: null,
-  xml_size: null,
-  message: null
-)
-```
-

data/docs/GetChorusProIdRequest.md

@@ -1,22 +0,0 @@
-# FactPulse::GetChorusProIdRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
-| **siret** | **String** | Structure SIRET (14 digits) |  |
-| **identifier_type** | **String** | Identifier type (SIRET, SIREN, UE_HORS_FRANCE, etc.) | [optional][default to 'SIRET'] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GetChorusProIdRequest.new(
-  credentials: null,
-  siret: null,
-  identifier_type: null
-)
-```
-

data/docs/GetChorusProIdResponse.md

@@ -1,24 +0,0 @@
-# FactPulse::GetChorusProIdResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **structure_id** | **Integer** | Chorus Pro ID (0 if not found) |  |
-| **structure_identifier** | **String** | Searched SIRET/SIREN |  |
-| **structure_name** | **String** |  | [optional] |
-| **message** | **String** | Return message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GetChorusProIdResponse.new(
-  structure_id: null,
-  structure_identifier: null,
-  structure_name: null,
-  message: null
-)
-```
-

data/docs/GetInvoiceResponse.md

@@ -1,34 +0,0 @@
-# FactPulse::GetInvoiceResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **return_code** | **Integer** | Return code (0 = success) |  |
-| **message** | **String** | Response message |  |
-| **chorus_invoice_id** | **Integer** |  | [optional] |
-| **invoice_number** | **String** |  | [optional] |
-| **invoice_date** | **String** |  | [optional] |
-| **total_gross_amount** | **String** |  | [optional] |
-| **current_status** | [**InvoiceStatus**](InvoiceStatus.md) |  | [optional] |
-| **recipient_structure_id** | **Integer** |  | [optional] |
-| **recipient_structure_name** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GetInvoiceResponse.new(
-  return_code: null,
-  message: null,
-  chorus_invoice_id: null,
-  invoice_number: null,
-  invoice_date: null,
-  total_gross_amount: null,
-  current_status: null,
-  recipient_structure_id: null,
-  recipient_structure_name: null
-)
-```
-

data/docs/GetStructureRequest.md

@@ -1,22 +0,0 @@
-# FactPulse::GetStructureRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
-| **structure_id** | **Integer** | Chorus Pro structure ID |  |
-| **language_code** | **String** | Language code (fr, en) | [optional][default to 'fr'] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GetStructureRequest.new(
-  credentials: null,
-  structure_id: null,
-  language_code: null
-)
-```
-

data/docs/GetStructureResponse.md

@@ -1,34 +0,0 @@
-# FactPulse::GetStructureResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **return_code** | **Integer** | Return code (0 = success) |  |
-| **message** | **String** | Response message |  |
-| **structure_id** | **Integer** |  | [optional] |
-| **structure_identifier** | **String** |  | [optional] |
-| **structure_label** | **String** |  | [optional] |
-| **company_name** | **String** |  | [optional] |
-| **vat_number** | **String** |  | [optional] |
-| **structure_email** | **String** |  | [optional] |
-| **parameters** | [**StructureParameters**](StructureParameters.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::GetStructureResponse.new(
-  return_code: null,
-  message: null,
-  structure_id: null,
-  structure_identifier: null,
-  structure_label: null,
-  company_name: null,
-  vat_number: null,
-  structure_email: null,
-  parameters: null
-)
-```
-

data/docs/GlobalAllowanceAmount.md

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

data/docs/GrossUnitPrice.md

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

data/docs/HealthApi.md

@@ -1,203 +0,0 @@
-# FactPulse::HealthApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_user_info_api_v1_me_get**](HealthApi.md#get_user_info_api_v1_me_get) | **GET** /api/v1/me | Get current user information |
-| [**healthcheck_healthcheck_get**](HealthApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Docker healthcheck endpoint |
-| [**root_get**](HealthApi.md#root_get) | **GET** / | Check API status |
-
-
-## get_user_info_api_v1_me_get
-
-> Object get_user_info_api_v1_me_get
-
-Get current user information
-
-Returns information about the authenticated user.  This endpoint allows you to: - Verify that authentication works - Get connected account details - Test JWT token validity - Check your consumption quota  **Requires valid authentication.**
-
-### Examples
-
-```ruby
-require 'time'
-require 'factpulse'
-# setup authorization
-FactPulse.configure do |config|
-  # Configure API key authorization: APIKeyHeader
-  config.api_key['X-API-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['X-API-Key'] = 'Bearer'
-
-  # Configure Bearer authorization: HTTPBearer
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = FactPulse::HealthApi.new
-
-begin
-  # Get current user information
-  result = api_instance.get_user_info_api_v1_me_get
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->get_user_info_api_v1_me_get: #{e}"
-end
-```
-
-#### Using the get_user_info_api_v1_me_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> get_user_info_api_v1_me_get_with_http_info
-
-```ruby
-begin
-  # Get current user information
-  data, status_code, headers = api_instance.get_user_info_api_v1_me_get_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->get_user_info_api_v1_me_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## healthcheck_healthcheck_get
-
-> Object healthcheck_healthcheck_get
-
-Docker healthcheck endpoint
-
-Healthcheck endpoint for Docker and load balancers.  Useful for: - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Availability monitoring - Zero downtime deployment  Returns a 200 code if the API is operational.
-
-### Examples
-
-```ruby
-require 'time'
-require 'factpulse'
-
-api_instance = FactPulse::HealthApi.new
-
-begin
-  # Docker healthcheck endpoint
-  result = api_instance.healthcheck_healthcheck_get
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->healthcheck_healthcheck_get: #{e}"
-end
-```
-
-#### Using the healthcheck_healthcheck_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> healthcheck_healthcheck_get_with_http_info
-
-```ruby
-begin
-  # Docker healthcheck endpoint
-  data, status_code, headers = api_instance.healthcheck_healthcheck_get_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->healthcheck_healthcheck_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## root_get
-
-> Object root_get
-
-Check API status
-
-Health check endpoint to verify the API is responding.  Useful for: - Availability monitoring - Integration tests - Load balancers
-
-### Examples
-
-```ruby
-require 'time'
-require 'factpulse'
-
-api_instance = FactPulse::HealthApi.new
-
-begin
-  # Check API status
-  result = api_instance.root_get
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->root_get: #{e}"
-end
-```
-
-#### Using the root_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Object, Integer, Hash)> root_get_with_http_info
-
-```ruby
-begin
-  # Check API status
-  data, status_code, headers = api_instance.root_get_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Object
-rescue FactPulse::ApiError => e
-  puts "Error when calling HealthApi->root_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/IncomingInvoice.md

@@ -1,54 +0,0 @@
-# FactPulse::IncomingInvoice
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **flow_id** | **String** |  | [optional] |
-| **source_format** | [**InvoiceFormat**](InvoiceFormat.md) | Invoice source format |  |
-| **supplier_reference** | **String** | Invoice number issued by the supplier (BT-1) |  |
-| **document_type** | [**InvoiceTypeCodeOutput**](InvoiceTypeCodeOutput.md) | Document type (BT-3) | [optional] |
-| **supplier** | [**IncomingSupplier**](IncomingSupplier.md) | Invoice issuer (SellerTradeParty) |  |
-| **billing_site_name** | **String** | Recipient name / your company (BT-44) |  |
-| **billing_site_siret** | **String** |  | [optional] |
-| **issue_date** | **String** | Invoice date (BT-2) - YYYY-MM-DD |  |
-| **due_date** | **String** |  | [optional] |
-| **currency** | **String** | ISO currency code (BT-5) | [optional][default to 'EUR'] |
-| **net_amount** | **String** | Total net amount (BT-109) |  |
-| **vat_amount** | **String** | Total VAT amount (BT-110) |  |
-| **gross_amount** | **String** | Total gross amount (BT-112) |  |
-| **purchase_order_number** | **String** |  | [optional] |
-| **contract_reference** | **String** |  | [optional] |
-| **invoice_subject** | **String** |  | [optional] |
-| **document_base64** | **String** |  | [optional] |
-| **document_content_type** | **String** |  | [optional] |
-| **document_filename** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::IncomingInvoice.new(
-  flow_id: null,
-  source_format: null,
-  supplier_reference: null,
-  document_type: null,
-  supplier: null,
-  billing_site_name: null,
-  billing_site_siret: null,
-  issue_date: null,
-  due_date: null,
-  currency: null,
-  net_amount: null,
-  vat_amount: null,
-  gross_amount: null,
-  purchase_order_number: null,
-  contract_reference: null,
-  invoice_subject: null,
-  document_base64: null,
-  document_content_type: null,
-  document_filename: null
-)
-```
-

data/docs/IncomingSupplier.md

@@ -1,32 +0,0 @@
-# FactPulse::IncomingSupplier
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Supplier business name (BT-27) |  |
-| **siren** | **String** |  | [optional] |
-| **siret** | **String** |  | [optional] |
-| **vat_number** | **String** |  | [optional] |
-| **postal_address** | [**PostalAddress**](PostalAddress.md) |  | [optional] |
-| **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **phone** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::IncomingSupplier.new(
-  name: null,
-  siren: null,
-  siret: null,
-  vat_number: null,
-  postal_address: null,
-  electronic_address: null,
-  email: null,
-  phone: null
-)
-```
-

data/docs/InvoiceFormat.md

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

data/docs/InvoiceInput.md

@@ -1,50 +0,0 @@
-# FactPulse::InvoiceInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invoice_id** | **String** | Invoice identifier |  |
-| **issue_date** | **Date** | Invoice issue date |  |
-| **type_code** | [**FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode**](FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md) | Invoice type code | [optional] |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **due_date** | **Date** |  | [optional] |
-| **seller_id** | **String** |  | [optional] |
-| **seller_siren** | **String** |  | [optional] |
-| **seller_vat_id** | **String** |  | [optional] |
-| **seller_country** | [**Sellercountry**](Sellercountry.md) |  | [optional] |
-| **buyer_id** | **String** |  | [optional] |
-| **buyer_vat_id** | **String** |  | [optional] |
-| **buyer_country** | [**Buyercountry**](Buyercountry.md) |  |  |
-| **tax_exclusive_amount** | [**Taxexclusiveamount1**](Taxexclusiveamount1.md) |  |  |
-| **tax_amount** | [**Taxamount1**](Taxamount1.md) |  |  |
-| **tax_breakdown** | [**Array<TaxBreakdownInput>**](TaxBreakdownInput.md) | VAT breakdown |  |
-| **referenced_invoice_id** | **String** |  | [optional] |
-| **referenced_invoice_date** | **Date** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::InvoiceInput.new(
-  invoice_id: FAC-2025-001,
-  issue_date: 2025-01-15,
-  type_code: null,
-  currency: null,
-  due_date: null,
-  seller_id: null,
-  seller_siren: null,
-  seller_vat_id: null,
-  seller_country: null,
-  buyer_id: null,
-  buyer_vat_id: null,
-  buyer_country: null,
-  tax_exclusive_amount: null,
-  tax_amount: null,
-  tax_breakdown: null,
-  referenced_invoice_id: null,
-  referenced_invoice_date: null
-)
-```
-