factpulse 1.0.8

data/docs/ChorusProCredentials.md

@@ -0,0 +1,26 @@
+# FactPulse::ChorusProCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **piste_client_id** | **String** | Client ID PISTE (portail API gouvernement) |  |
+| **piste_client_secret** | **String** | Client Secret PISTE |  |
+| **chorus_pro_login** | **String** | Login Chorus Pro |  |
+| **chorus_pro_password** | **String** | Mot de passe Chorus Pro |  |
+| **sandbox** | **Boolean** | Utiliser l'environnement sandbox (true) ou production (false) | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ChorusProCredentials.new(
+  piste_client_id: null,
+  piste_client_secret: null,
+  chorus_pro_login: null,
+  chorus_pro_password: null,
+  sandbox: null
+)
+```
+

data/docs/CodeCadreFacturation.md

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

data/docs/CodeRaisonReduction.md

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

data/docs/ConsulterFactureRequest.md

@@ -0,0 +1,20 @@
+# FactPulse::ConsulterFactureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+| **identifiant_facture_cpp** | **Integer** | ID Chorus Pro de la facture |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ConsulterFactureRequest.new(
+  credentials: null,
+  identifiant_facture_cpp: null
+)
+```
+

data/docs/ConsulterFactureResponse.md

@@ -0,0 +1,34 @@
+# FactPulse::ConsulterFactureResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_retour** | **Integer** |  |  |
+| **libelle** | **String** |  |  |
+| **identifiant_facture_cpp** | **Integer** |  | [optional] |
+| **numero_facture** | **String** |  | [optional] |
+| **date_facture** | **String** |  | [optional] |
+| **montant_ttc_total** | **String** |  | [optional] |
+| **statut_courant** | [**StatutFacture**](StatutFacture.md) |  | [optional] |
+| **id_structure_cpp_destinataire** | **Integer** |  | [optional] |
+| **designation_structure_destinataire** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ConsulterFactureResponse.new(
+  code_retour: null,
+  libelle: null,
+  identifiant_facture_cpp: null,
+  numero_facture: null,
+  date_facture: null,
+  montant_ttc_total: null,
+  statut_courant: null,
+  id_structure_cpp_destinataire: null,
+  designation_structure_destinataire: null
+)
+```
+

data/docs/ConsulterStructureRequest.md

@@ -0,0 +1,22 @@
+# FactPulse::ConsulterStructureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) |  | [optional] |
+| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure |  |
+| **code_langue** | **String** | Code langue (fr, en) | [optional][default to 'fr'] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ConsulterStructureRequest.new(
+  credentials: null,
+  id_structure_cpp: null,
+  code_langue: null
+)
+```
+

data/docs/ConsulterStructureResponse.md

@@ -0,0 +1,34 @@
+# FactPulse::ConsulterStructureResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code_retour** | **Integer** |  |  |
+| **libelle** | **String** |  |  |
+| **id_structure_cpp** | **Integer** |  | [optional] |
+| **identifiant_structure** | **String** |  | [optional] |
+| **libelle_structure** | **String** |  | [optional] |
+| **raison_sociale_structure** | **String** |  | [optional] |
+| **numero_tva** | **String** |  | [optional] |
+| **email_structure** | **String** |  | [optional] |
+| **parametres** | [**ParametresStructure**](ParametresStructure.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::ConsulterStructureResponse.new(
+  code_retour: null,
+  libelle: null,
+  id_structure_cpp: null,
+  identifiant_structure: null,
+  libelle_structure: null,
+  raison_sociale_structure: null,
+  numero_tva: null,
+  email_structure: null,
+  parametres: null
+)
+```
+

data/docs/CredentialsAFNOR.md

@@ -0,0 +1,22 @@
+# FactPulse::CredentialsAFNOR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** |  | [optional] |
+| **client_secret** | **String** |  | [optional] |
+| **flow_service_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::CredentialsAFNOR.new(
+  client_id: null,
+  client_secret: null,
+  flow_service_url: null
+)
+```
+

data/docs/CredentialsChorusPro.md

@@ -0,0 +1,26 @@
+# FactPulse::CredentialsChorusPro
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **piste_client_id** | **String** |  | [optional] |
+| **piste_client_secret** | **String** |  | [optional] |
+| **chorus_login** | **String** |  | [optional] |
+| **chorus_password** | **String** |  | [optional] |
+| **mode_sandbox** | **Boolean** | [MODE 2] Utiliser le mode sandbox (défaut: True) | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::CredentialsChorusPro.new(
+  piste_client_id: null,
+  piste_client_secret: null,
+  chorus_login: null,
+  chorus_password: null,
+  mode_sandbox: null
+)
+```
+

data/docs/Destinataire.md

@@ -0,0 +1,24 @@
+# FactPulse::Destinataire
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adresse_electronique** | [**AdresseElectronique**](AdresseElectronique.md) |  |  |
+| **code_service_executant** | **String** |  | [optional] |
+| **nom** | **String** |  | [optional] |
+| **adresse_postale** | [**AdressePostale**](AdressePostale.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::Destinataire.new(
+  adresse_electronique: null,
+  code_service_executant: null,
+  nom: null,
+  adresse_postale: null
+)
+```
+

data/docs/Destination.md

@@ -0,0 +1,79 @@
+# FactPulse::Destination
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::Destination.openapi_one_of
+# =>
+# [
+#   :'DestinationAFNOR',
+#   :'DestinationChorusPro'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::Destination.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::Destination.openapi_discriminator_mapping
+# =>
+# {
+#   :'afnor' => :'DestinationAFNOR',
+#   :'chorus_pro' => :'DestinationChorusPro'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'factpulse'
+
+FactPulse::Destination.build(data)
+# => #<DestinationAFNOR:0x00007fdd4aab02a0>
+
+FactPulse::Destination.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `DestinationAFNOR`
+- `DestinationChorusPro`
+- `nil` (if no type matches)
+

data/docs/DestinationAFNOR.md

@@ -0,0 +1,24 @@
+# FactPulse::DestinationAFNOR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'afnor'] |
+| **credentials** | [**CredentialsAFNOR**](CredentialsAFNOR.md) |  | [optional] |
+| **flow_syntax** | **String** | Syntaxe du flux à envoyer | [optional][default to 'Factur-X'] |
+| **tracking_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::DestinationAFNOR.new(
+  type: null,
+  credentials: null,
+  flow_syntax: null,
+  tracking_id: null
+)
+```
+

data/docs/DestinationChorusPro.md

@@ -0,0 +1,20 @@
+# FactPulse::DestinationChorusPro
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'chorus_pro'] |
+| **credentials** | [**CredentialsChorusPro**](CredentialsChorusPro.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::DestinationChorusPro.new(
+  type: null,
+  credentials: null
+)
+```
+

data/docs/DirectionFlux.md

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

data/docs/DonneesFactureSimplifiees.md

@@ -0,0 +1,34 @@
+# FactPulse::DonneesFactureSimplifiees
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numero** | **String** | Numéro de facture unique |  |
+| **emetteur** | **Hash<String, Object>** | Informations sur l'émetteur (siret, iban, ...) |  |
+| **destinataire** | **Hash<String, Object>** | Informations sur le destinataire (siret, ...) |  |
+| **lignes** | **Array<Hash<String, Object>>** | Lignes de la facture |  |
+| **date** | **String** |  | [optional] |
+| **echeance_jours** | **Integer** | Échéance en jours (défaut: 30) | [optional][default to 30] |
+| **commentaire** | **String** |  | [optional] |
+| **numero_bon_commande** | **String** |  | [optional] |
+| **numero_marche** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::DonneesFactureSimplifiees.new(
+  numero: null,
+  emetteur: null,
+  destinataire: null,
+  lignes: null,
+  date: null,
+  echeance_jours: null,
+  commentaire: null,
+  numero_bon_commande: null,
+  numero_marche: null
+)
+```
+

data/docs/FactureEnrichieInfoInput.md

@@ -0,0 +1,32 @@
+# FactPulse::FactureEnrichieInfoInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numero_facture** | **String** |  |  |
+| **id_emetteur** | **Integer** |  | [optional] |
+| **id_destinataire** | **Integer** |  | [optional] |
+| **nom_emetteur** | **String** |  |  |
+| **nom_destinataire** | **String** |  |  |
+| **montant_ht_total** | [**MontantHtTotal**](MontantHtTotal.md) |  |  |
+| **montant_tva** | [**MontantTva**](MontantTva.md) |  |  |
+| **montant_ttc_total** | [**MontantTtcTotal**](MontantTtcTotal.md) |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FactureEnrichieInfoInput.new(
+  numero_facture: null,
+  id_emetteur: null,
+  id_destinataire: null,
+  nom_emetteur: null,
+  nom_destinataire: null,
+  montant_ht_total: null,
+  montant_tva: null,
+  montant_ttc_total: null
+)
+```
+

data/docs/FactureEnrichieInfoOutput.md

@@ -0,0 +1,32 @@
+# FactPulse::FactureEnrichieInfoOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numero_facture** | **String** |  |  |
+| **id_emetteur** | **Integer** |  | [optional] |
+| **id_destinataire** | **Integer** |  | [optional] |
+| **nom_emetteur** | **String** |  |  |
+| **nom_destinataire** | **String** |  |  |
+| **montant_ht_total** | **String** |  |  |
+| **montant_tva** | **String** |  |  |
+| **montant_ttc_total** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FactureEnrichieInfoOutput.new(
+  numero_facture: null,
+  id_emetteur: null,
+  id_destinataire: null,
+  nom_emetteur: null,
+  nom_destinataire: null,
+  montant_ht_total: null,
+  montant_tva: null,
+  montant_ttc_total: null
+)
+```
+

data/docs/FactureFacturX.md

@@ -0,0 +1,44 @@
+# FactPulse::FactureFacturX
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numero_facture** | **String** |  |  |
+| **date_echeance_paiement** | **String** |  |  |
+| **date_facture** | **String** |  | [optional] |
+| **mode_depot** | [**ModeDepot**](ModeDepot.md) |  |  |
+| **destinataire** | [**Destinataire**](Destinataire.md) |  |  |
+| **fournisseur** | [**Fournisseur**](Fournisseur.md) |  |  |
+| **cadre_de_facturation** | [**CadreDeFacturation**](CadreDeFacturation.md) |  |  |
+| **references** | [**References**](References.md) |  |  |
+| **montant_total** | [**MontantTotal**](MontantTotal.md) |  |  |
+| **lignes_de_poste** | [**Array<LigneDePoste>**](LigneDePoste.md) |  | [optional] |
+| **lignes_de_tva** | [**Array<LigneDeTVA>**](LigneDeTVA.md) |  | [optional] |
+| **commentaire** | **String** |  | [optional] |
+| **id_utilisateur_courant** | **Integer** |  | [optional] |
+| **pieces_jointes_complementaires** | [**Array<PieceJointeComplementaire>**](PieceJointeComplementaire.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FactureFacturX.new(
+  numero_facture: null,
+  date_echeance_paiement: null,
+  date_facture: null,
+  mode_depot: null,
+  destinataire: null,
+  fournisseur: null,
+  cadre_de_facturation: null,
+  references: null,
+  montant_total: null,
+  lignes_de_poste: null,
+  lignes_de_tva: null,
+  commentaire: null,
+  id_utilisateur_courant: null,
+  pieces_jointes_complementaires: null
+)
+```
+

data/docs/FluxResume.md

@@ -0,0 +1,32 @@
+# FactPulse::FluxResume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** |  |  |
+| **tracking_id** | **String** |  | [optional] |
+| **nom** | **String** |  |  |
+| **type_flux** | **String** |  | [optional] |
+| **direction_flux** | **String** |  | [optional] |
+| **statut_acquittement** | **String** |  | [optional] |
+| **date_creation** | **String** |  | [optional] |
+| **date_maj** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::FluxResume.new(
+  flow_id: null,
+  tracking_id: null,
+  nom: null,
+  type_flux: null,
+  direction_flux: null,
+  statut_acquittement: null,
+  date_creation: null,
+  date_maj: null
+)
+```
+

data/docs/FormatSortie.md

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

data/docs/Fournisseur.md

@@ -0,0 +1,34 @@
+# FactPulse::Fournisseur
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adresse_electronique** | [**AdresseElectronique**](AdresseElectronique.md) |  |  |
+| **id_fournisseur** | **Integer** |  |  |
+| **code_coordonnees_bancaires_fournisseur** | **Integer** |  | [optional] |
+| **id_service_fournisseur** | **Integer** |  | [optional] |
+| **nom** | **String** |  | [optional] |
+| **siret** | **String** |  | [optional] |
+| **numero_tva_intra** | **String** |  | [optional] |
+| **iban** | **String** |  | [optional] |
+| **adresse_postale** | [**AdressePostale**](AdressePostale.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::Fournisseur.new(
+  adresse_electronique: null,
+  id_fournisseur: null,
+  code_coordonnees_bancaires_fournisseur: null,
+  id_service_fournisseur: null,
+  nom: null,
+  siret: null,
+  numero_tva_intra: null,
+  iban: null,
+  adresse_postale: null
+)
+```
+

data/docs/GenerateCertificateRequest.md

@@ -0,0 +1,38 @@
+# FactPulse::GenerateCertificateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cn** | **String** | Common Name (CN) - Nom du certificat | [optional][default to 'Test Signature FactPulse'] |
+| **organisation** | **String** | Organisation (O) | [optional][default to 'FactPulse Test'] |
+| **pays** | **String** | Code pays ISO 2 lettres (C) | [optional][default to 'FR'] |
+| **ville** | **String** | Ville (L) | [optional][default to 'Paris'] |
+| **province** | **String** | Province/État (ST) | [optional][default to 'Ile-de-France'] |
+| **email** | **String** |  | [optional] |
+| **duree_jours** | **Integer** | Durée de validité en jours | [optional][default to 365] |
+| **taille_cle** | **Integer** | Taille de la clé RSA en bits | [optional][default to 2048] |
+| **passphrase_cle** | **String** |  | [optional] |
+| **generer_p12** | **Boolean** | Générer aussi un fichier PKCS#12 (.p12) | [optional][default to false] |
+| **passphrase_p12** | **String** | Passphrase pour le fichier PKCS#12 | [optional][default to 'changeme'] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::GenerateCertificateRequest.new(
+  cn: Test Signature Client XYZ,
+  organisation: Client XYZ SARL,
+  pays: FR,
+  ville: Paris,
+  province: Ile-de-France,
+  email: null,
+  duree_jours: 365,
+  taille_cle: 2048,
+  passphrase_cle: null,
+  generer_p12: false,
+  passphrase_p12: changeme
+)
+```
+