factpulse 1.0.8

data/docs/AFNORPDPPAFlowServiceApi.md

@@ -0,0 +1,258 @@
+# FactPulse::AFNORPDPPAFlowServiceApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get**](AFNORPDPPAFlowServiceApi.md#download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Télécharger un flux |
+| [**flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get**](AFNORPDPPAFlowServiceApi.md#flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get) | **GET** /api/v1/afnor/flow/v1/healthcheck | Healthcheck Flow Service |
+| [**search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post**](AFNORPDPPAFlowServiceApi.md#search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post) | **POST** /api/v1/afnor/flow/v1/flows/search | Rechercher des flux |
+| [**submit_flow_proxy_api_v1_afnor_flow_v1_flows_post**](AFNORPDPPAFlowServiceApi.md#submit_flow_proxy_api_v1_afnor_flow_v1_flows_post) | **POST** /api/v1/afnor/flow/v1/flows | Soumettre un flux de facturation |
+
+
+## download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get
+
+> Object download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id)
+
+Télécharger un flux
+
+Télécharger le fichier PDF/A-3 d'un flux de facturation (utilise le client_uid du JWT)
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
+flow_id = 'flow_id_example' # String | 
+
+begin
+  # Télécharger un flux
+  result = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get(flow_id)
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get: #{e}"
+end
+```
+
+#### Using the download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id)
+
+```ruby
+begin
+  # Télécharger un flux
+  data, status_code, headers = api_instance.download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info(flow_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->download_flow_proxy_api_v1_afnor_flow_v1_flows_flow_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/pdf
+
+
+## flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get
+
+> Object flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get
+
+Healthcheck Flow Service
+
+Vérifier la disponibilité du Flow Service
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
+
+begin
+  # Healthcheck Flow Service
+  result = api_instance.flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get: #{e}"
+end
+```
+
+#### Using the flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info
+
+```ruby
+begin
+  # Healthcheck Flow Service
+  data, status_code, headers = api_instance.flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->flow_healthcheck_proxy_api_v1_afnor_flow_v1_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
+
+
+## search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
+
+> Object search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
+
+Rechercher des flux
+
+Rechercher des flux de facturation selon des critères (utilise le client_uid du JWT)
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
+
+begin
+  # Rechercher des flux
+  result = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post: #{e}"
+end
+```
+
+#### Using the search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info
+
+```ruby
+begin
+  # Rechercher des flux
+  data, status_code, headers = api_instance.search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->search_flows_proxy_api_v1_afnor_flow_v1_flows_search_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
+
+
+## submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
+
+> Object submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
+
+Soumettre un flux de facturation
+
+Soumet une facture électronique à une Plateforme de Dématérialisation Partenaire (PDP) conformément à la norme AFNOR XP Z12-013
+
+### Examples
+
+```ruby
+require 'time'
+require 'factpulse'
+
+api_instance = FactPulse::AFNORPDPPAFlowServiceApi.new
+
+begin
+  # Soumettre un flux de facturation
+  result = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post
+  p result
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->submit_flow_proxy_api_v1_afnor_flow_v1_flows_post: #{e}"
+end
+```
+
+#### Using the submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info
+
+```ruby
+begin
+  # Soumettre un flux de facturation
+  data, status_code, headers = api_instance.submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue FactPulse::ApiError => e
+  puts "Error when calling AFNORPDPPAFlowServiceApi->submit_flow_proxy_api_v1_afnor_flow_v1_flows_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
+

data/docs/AdresseElectronique.md

@@ -0,0 +1,20 @@
+# FactPulse::AdresseElectronique
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifiant** | **String** |  |  |
+| **scheme_id** | [**SchemeID**](SchemeID.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AdresseElectronique.new(
+  identifiant: null,
+  scheme_id: null
+)
+```
+

data/docs/AdressePostale.md

@@ -0,0 +1,26 @@
+# FactPulse::AdressePostale
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_postal** | **String** |  | [optional] |
+| **ligne_un** | **String** |  | [optional] |
+| **ligne_deux** | **String** |  | [optional] |
+| **nom_ville** | **String** |  | [optional] |
+| **pays_code_iso** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AdressePostale.new(
+  code_postal: null,
+  ligne_un: null,
+  ligne_deux: null,
+  nom_ville: null,
+  pays_code_iso: null
+)
+```
+

data/docs/BodyAjouterFichierApiV1ChorusProTransversesAjouterFichierPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyAjouterFichierApiV1ChorusProTransversesAjouterFichierPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyAjouterFichierApiV1ChorusProTransversesAjouterFichierPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyCompleterFactureApiV1ChorusProFacturesCompleterPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyCompleterFactureApiV1ChorusProFacturesCompleterPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyCompleterFactureApiV1ChorusProFacturesCompleterPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyListerServicesStructureApiV1ChorusProStructuresIdStructureCppServicesGet.md

@@ -0,0 +1,20 @@
+# FactPulse::BodyListerServicesStructureApiV1ChorusProStructuresIdStructureCppServicesGet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyListerServicesStructureApiV1ChorusProStructuresIdStructureCppServicesGet.new(
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyRechercherFacturesDestinataireApiV1ChorusProFacturesRechercherDestinatairePost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyRechercherFacturesDestinataireApiV1ChorusProFacturesRechercherDestinatairePost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyRechercherFacturesDestinataireApiV1ChorusProFacturesRechercherDestinatairePost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyRechercherFacturesFournisseurApiV1ChorusProFacturesRechercherFournisseurPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyRechercherFacturesFournisseurApiV1ChorusProFacturesRechercherFournisseurPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyRechercherFacturesFournisseurApiV1ChorusProFacturesRechercherFournisseurPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyRecyclerFactureApiV1ChorusProFacturesRecyclerPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyRecyclerFactureApiV1ChorusProFacturesRecyclerPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyRecyclerFactureApiV1ChorusProFacturesRecyclerPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyTelechargerGroupeFacturesApiV1ChorusProFacturesTelechargerGroupePost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyTelechargerGroupeFacturesApiV1ChorusProFacturesTelechargerGroupePost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyTelechargerGroupeFacturesApiV1ChorusProFacturesTelechargerGroupePost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyTraiterFactureRecueApiV1ChorusProFacturesTraiterFactureRecuePost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyTraiterFactureRecueApiV1ChorusProFacturesTraiterFactureRecuePost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyTraiterFactureRecueApiV1ChorusProFacturesTraiterFactureRecuePost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyValideurConsulterFactureApiV1ChorusProFacturesValideurConsulterPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyValideurConsulterFactureApiV1ChorusProFacturesValideurConsulterPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyValideurConsulterFactureApiV1ChorusProFacturesValideurConsulterPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyValideurRechercherFacturesApiV1ChorusProFacturesValideurRechercherPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyValideurRechercherFacturesApiV1ChorusProFacturesValideurRechercherPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyValideurRechercherFacturesApiV1ChorusProFacturesValideurRechercherPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/BodyValideurTraiterFactureApiV1ChorusProFacturesValideurTraiterPost.md

@@ -0,0 +1,22 @@
+# FactPulse::BodyValideurTraiterFactureApiV1ChorusProFacturesValideurTraiterPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | **Hash<String, Object>** |  |  |
+| **user_info** | [**Utilisateur**](Utilisateur.md) |  |  |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::BodyValideurTraiterFactureApiV1ChorusProFacturesValideurTraiterPost.new(
+  payload: null,
+  user_info: null,
+  credentials: null
+)
+```
+

data/docs/CadreDeFacturation.md

@@ -0,0 +1,22 @@
+# FactPulse::CadreDeFacturation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_cadre_facturation** | [**CodeCadreFacturation**](CodeCadreFacturation.md) |  |  |
+| **code_service_valideur** | **String** |  | [optional] |
+| **code_structure_valideur** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::CadreDeFacturation.new(
+  code_cadre_facturation: null,
+  code_service_valideur: null,
+  code_structure_valideur: null
+)
+```
+

data/docs/CategorieTVA.md

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

data/docs/CertificateInfoResponse.md

@@ -0,0 +1,40 @@
+# FactPulse::CertificateInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cn** | **String** | Common Name |  |
+| **organisation** | **String** | Organisation |  |
+| **pays** | **String** | Code pays |  |
+| **ville** | **String** | Ville |  |
+| **province** | **String** | Province |  |
+| **email** | **String** |  | [optional] |
+| **sujet** | **String** | Sujet complet (RFC4514) |  |
+| **emetteur** | **String** | Émetteur (auto-signé = même que sujet) |  |
+| **numero_serie** | **Integer** | Numéro de série du certificat |  |
+| **valide_du** | **String** | Date de début de validité (ISO 8601) |  |
+| **valide_au** | **String** | Date de fin de validité (ISO 8601) |  |
+| **algorithme** | **String** | Algorithme de signature |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::CertificateInfoResponse.new(
+  cn: Test Signature Client XYZ,
+  organisation: Client XYZ SARL,
+  pays: FR,
+  ville: Lyon,
+  province: Rhône-Alpes,
+  email: null,
+  sujet: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhône-Alpes,C=FR,
+  emetteur: CN=Test Signature Client XYZ,O=Client XYZ SARL,L=Lyon,ST=Rhône-Alpes,C=FR,
+  numero_serie: 123456789,
+  valide_du: 2025-01-07T12:00:00+00:00,
+  valide_au: 2026-01-07T12:00:00+00:00,
+  algorithme: sha256WithRSAEncryption
+)
+```
+