factpulse 0.1.0

data/docs/AFNORLegalUnitPayloadIncluded.md

@@ -0,0 +1,24 @@
+# FactPulse::AFNORLegalUnitPayloadIncluded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **siren** | **String** | SIREN number | [optional] |
+| **business_name** | **String** | Business name | [optional] |
+| **entity_type** | [**AFNOREntityType**](AFNOREntityType.md) |  | [optional] |
+| **administrative_status** | [**AFNORLegalUnitAdministrativeStatus**](AFNORLegalUnitAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORLegalUnitPayloadIncluded.new(
+  siren: 702042755,
+  business_name: Boulangerie Pascale,
+  entity_type: null,
+  administrative_status: null
+)
+```
+

data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORLegalUnitPayloadIncludedNoSiren
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **business_name** | **String** | Business name | [optional] |
+| **entity_type** | [**AFNOREntityType**](AFNOREntityType.md) |  | [optional] |
+| **administrative_status** | [**AFNORLegalUnitAdministrativeStatus**](AFNORLegalUnitAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORLegalUnitPayloadIncludedNoSiren.new(
+  business_name: Boulangerie Pascale,
+  entity_type: null,
+  administrative_status: null
+)
+```
+

data/docs/AFNORPDPPAApi.md

@@ -0,0 +1,150 @@
+# FactPulse::AFNORPDPPAApi
+
+All URIs are relative to *https://factpulse.fr*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get**](AFNORPDPPAApi.md#get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get) | **GET** /api/v1/afnor/incoming-flows/{flow_id} | Retrieve and extract an incoming invoice |
+| [**oauth_token_proxy_api_v1_afnor_oauth_token_post**](AFNORPDPPAApi.md#oauth_token_proxy_api_v1_afnor_oauth_token_post) | **POST** /api/v1/afnor/oauth/token | Test PDP OAuth2 credentials |
+
+
+## get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get
+
+> <IncomingInvoice> get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts)
+
+Retrieve and extract an incoming invoice
+
+Downloads an incoming flow from the AFNOR PDP and extracts invoice metadata into a unified JSON format. Supports Factur-X, CII, and UBL formats.
+
+### 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::AFNORPDPPAApi.new
+flow_id = 'flow_id_example' # String | AFNOR flow ID (UUID format)
+opts = {
+  include_document: true, # Boolean | Include base64-encoded document in response
+  x_encryption_key: 'x_encryption_key_example' # String | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode='double'.
+}
+
+begin
+  # Retrieve and extract an incoming invoice
+  result = api_instance.get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get(flow_id, opts)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get: #{e}"
+end
+```
+
+#### Using the get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IncomingInvoice>, Integer, Hash)> get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts)
+
+```ruby
+begin
+  # Retrieve and extract an incoming invoice
+  data, status_code, headers = api_instance.get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info(flow_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IncomingInvoice>
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAApi->get_flux_entrant_api_v1_afnor_incoming_flows_flow_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** | AFNOR flow ID (UUID format) |  |
+| **include_document** | **Boolean** | Include base64-encoded document in response | [optional][default to false] |
+| **x_encryption_key** | **String** | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode&#x3D;&#39;double&#39;. | [optional] |
+
+### Return type
+
+[**IncomingInvoice**](IncomingInvoice.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## oauth_token_proxy_api_v1_afnor_oauth_token_post
+
+> Object oauth_token_proxy_api_v1_afnor_oauth_token_post
+
+Test PDP OAuth2 credentials
+
+OAuth2 proxy to validate PDP credentials. Use this endpoint to verify that OAuth credentials (client_id, client_secret) are valid before saving a PDP configuration. This endpoint is public (no authentication required).
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::AFNORPDPPAApi.new
+
+begin
+  # Test PDP OAuth2 credentials
+  result = api_instance.oauth_token_proxy_api_v1_afnor_oauth_token_post
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAApi->oauth_token_proxy_api_v1_afnor_oauth_token_post: #{e}"
+end
+```
+
+#### Using the oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info
+
+```ruby
+begin
+  # Test PDP OAuth2 credentials
+  data, status_code, headers = api_instance.oauth_token_proxy_api_v1_afnor_oauth_token_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAApi->oauth_token_proxy_api_v1_afnor_oauth_token_post_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
+