factpulse 2.0.42 → 3.0.0

data/docs/SearchServicesResponse.md

@@ -0,0 +1,24 @@
+# FactPulse::SearchServicesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_code** | **Integer** |  |  |
+| **message** | **String** |  |  |
+| **services** | [**Array<StructureService>**](StructureService.md) |  | [optional] |
+| **total** | **Integer** | Number of services | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SearchServicesResponse.new(
+  return_code: null,
+  message: null,
+  services: null,
+  total: null
+)
+```
+

data/docs/SearchStructureRequest.md

@@ -0,0 +1,26 @@
+# FactPulse::SearchStructureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] |
+| **structure_identifier** | **String** |  | [optional] |
+| **structure_identifier_type** | **String** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **restrict_private_structures** | **Boolean** | Limit search to private structures only | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SearchStructureRequest.new(
+  credentials: null,
+  structure_identifier: null,
+  structure_identifier_type: null,
+  company_name: null,
+  restrict_private_structures: null
+)
+```
+

data/docs/SearchStructureResponse.md

@@ -0,0 +1,24 @@
+# FactPulse::SearchStructureResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_code** | **Integer** | Return code (0 = success) |  |
+| **message** | **String** | Return message |  |
+| **structures** | [**Array<StructureInfo>**](StructureInfo.md) |  | [optional] |
+| **total** | **Integer** | Total number of results | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SearchStructureResponse.new(
+  return_code: null,
+  message: null,
+  structures: null,
+  total: null
+)
+```
+

data/docs/SignatureInfo.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **signe** | **Boolean** | Le PDF a été signé |  |
+| **signed** | **Boolean** | PDF was signed |  |
 | **cn** | **String** |  | [optional] |
 | **expiration** | **String** |  | [optional] |
 
@@ -14,7 +14,7 @@
 require 'factpulse'
 
 instance = FactPulse::SignatureInfo.new(
-  signe: null,
+  signed: null,
   cn: null,
   expiration: null
 )

data/docs/SignatureInfoAPI.md

@@ -0,0 +1,28 @@
+# FactPulse::SignatureInfoAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** | Signature field name in the PDF |  |
+| **signer** | **String** |  | [optional] |
+| **signing_date** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **is_valid** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SignatureInfoAPI.new(
+  field_name: null,
+  signer: null,
+  signing_date: null,
+  reason: null,
+  location: null,
+  is_valid: null
+)
+```
+

data/docs/SignatureParameters.md

@@ -0,0 +1,34 @@
+# FactPulse::SignatureParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_pem** | **String** |  | [optional] |
+| **cert_pem** | **String** |  | [optional] |
+| **key_passphrase** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **contact** | **String** |  | [optional] |
+| **field_name** | **String** | PDF signature field name | [optional][default to 'FactPulseSignature'] |
+| **use_pades_lt** | **Boolean** | Enable PAdES-B-LT (long-term archival). REQUIRES certificate with OCSP/CRL access | [optional][default to false] |
+| **use_timestamp** | **Boolean** | Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T) | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SignatureParameters.new(
+  key_pem: null,
+  cert_pem: null,
+  key_passphrase: null,
+  reason: null,
+  location: null,
+  contact: null,
+  field_name: null,
+  use_pades_lt: null,
+  use_timestamp: null
+)
+```
+

data/docs/SimplifiedInvoiceData.md

@@ -0,0 +1,34 @@
+# FactPulse::SimplifiedInvoiceData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | Unique invoice number |  |
+| **supplier** | **Hash<String, Object>** | Supplier information (siret, iban, ...) |  |
+| **recipient** | **Hash<String, Object>** | Recipient information (siret, ...) |  |
+| **lines** | **Array<Hash<String, Object>>** | Invoice lines |  |
+| **date** | **String** |  | [optional] |
+| **due_days** | **Integer** | Due date in days (default: 30) | [optional][default to 30] |
+| **comment** | **String** |  | [optional] |
+| **purchase_order_reference** | **String** |  | [optional] |
+| **contract_reference** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SimplifiedInvoiceData.new(
+  number: null,
+  supplier: null,
+  recipient: null,
+  lines: null,
+  date: null,
+  due_days: null,
+  comment: null,
+  purchase_order_reference: null,
+  contract_reference: null
+)
+```
+

data/docs/StructureInfo.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure |  |
-| **identifiant_structure** | **String** | Identifiant (SIRET, SIREN) |  |
-| **designation_structure** | **String** | Nom de la structure |  |
-| **type_identifiant_structure** | **String** | Type d'identifiant |  |
-| **statut** | **String** | Statut (ACTIVE, INACTIVE) |  |
+| **structure_id** | **Integer** | Chorus Pro structure ID |  |
+| **structure_identifier** | **String** | Identifier (SIRET, SIREN) |  |
+| **structure_name** | **String** | Structure name |  |
+| **structure_identifier_type** | **String** | Identifier type |  |
+| **status** | **String** | Status (ACTIVE, INACTIVE) |  |
 
 ## Example
 
@@ -16,11 +16,11 @@
 require 'factpulse'
 
 instance = FactPulse::StructureInfo.new(
-  id_structure_cpp: null,
-  identifiant_structure: null,
-  designation_structure: null,
-  type_identifiant_structure: null,
-  statut: null
+  structure_id: null,
+  structure_identifier: null,
+  structure_name: null,
+  structure_identifier_type: null,
+  status: null
 )
 ```
 

data/docs/StructureParameters.md

@@ -0,0 +1,22 @@
+# FactPulse::StructureParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_code_required** | **Boolean** | Service code is mandatory | [optional][default to false] |
+| **engagement_number_required** | **Boolean** | Engagement number is mandatory | [optional][default to false] |
+| **engagement_or_service_management** | **Boolean** | EJ or service code management enabled | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::StructureParameters.new(
+  service_code_required: null,
+  engagement_number_required: null,
+  engagement_or_service_management: null
+)
+```
+

data/docs/StructureService.md

@@ -0,0 +1,24 @@
+# FactPulse::StructureService
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **Integer** | Service ID |  |
+| **service_code** | **String** | Service code |  |
+| **service_label** | **String** | Service label |  |
+| **is_active** | **Boolean** | Service active |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::StructureService.new(
+  service_id: null,
+  service_code: null,
+  service_label: null,
+  is_active: null
+)
+```
+

data/docs/SubmissionMode.md

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

data/docs/SubmitCompleteInvoiceRequest.md

@@ -0,0 +1,26 @@
+# FactPulse::SubmitCompleteInvoiceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_data** | [**SimplifiedInvoiceData**](SimplifiedInvoiceData.md) | Invoice data in simplified format (see examples) |  |
+| **source_pdf** | **String** | Base64-encoded source PDF (will be transformed to Factur-X) |  |
+| **destination** | [**Destination**](Destination.md) |  |  |
+| **signature** | [**SignatureParameters**](SignatureParameters.md) |  | [optional] |
+| **options** | [**ProcessingOptions**](ProcessingOptions.md) | Processing options | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitCompleteInvoiceRequest.new(
+  invoice_data: null,
+  source_pdf: null,
+  destination: null,
+  signature: null,
+  options: null
+)
+```
+

data/docs/SubmitCompleteInvoiceResponse.md

@@ -0,0 +1,34 @@
+# FactPulse::SubmitCompleteInvoiceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Invoice was successfully submitted |  |
+| **destination_type** | **String** | Destination type |  |
+| **chorus_result** | [**ChorusProResult**](ChorusProResult.md) |  | [optional] |
+| **afnor_result** | [**AFNORResult**](AFNORResult.md) |  | [optional] |
+| **enriched_invoice** | [**EnrichedInvoiceInfo**](EnrichedInvoiceInfo.md) | Enriched invoice data |  |
+| **facturx_pdf** | [**FacturXPDFInfo**](FacturXPDFInfo.md) | Generated PDF information |  |
+| **signature** | [**SignatureInfo**](SignatureInfo.md) |  | [optional] |
+| **pdf_base64** | **String** | Generated Factur-X PDF (and signed if requested) base64-encoded |  |
+| **message** | **String** | Return message |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitCompleteInvoiceResponse.new(
+  success: null,
+  destination_type: null,
+  chorus_result: null,
+  afnor_result: null,
+  enriched_invoice: null,
+  facturx_pdf: null,
+  signature: null,
+  pdf_base64: null,
+  message: null
+)
+```
+

data/docs/SubmitFlowRequest.md

@@ -0,0 +1,28 @@
+# FactPulse::SubmitFlowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_name** | **String** | Flow name (e.g., 'Invoice 2025-001') |  |
+| **flow_syntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (CII for Factur-X) | [optional] |
+| **flow_profile** | [**FlowProfile**](FlowProfile.md) |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **request_id** | **String** |  | [optional] |
+| **pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitFlowRequest.new(
+  flow_name: Invoice 2025-001,
+  flow_syntax: null,
+  flow_profile: null,
+  tracking_id: null,
+  request_id: null,
+  pdp_credentials: null
+)
+```
+

data/docs/SubmitFlowResponse.md

@@ -0,0 +1,30 @@
+# FactPulse::SubmitFlowResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_id** | **String** | Unique flow identifier generated by the PDP |  |
+| **tracking_id** | **String** |  | [optional] |
+| **name** | **String** | Flow name |  |
+| **flow_syntax** | **String** | Flow syntax (CII, UBL, etc.) |  |
+| **flow_profile** | **String** |  | [optional] |
+| **sha256** | **String** | SHA256 hash of the submitted file |  |
+| **message** | **String** | Confirmation message |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitFlowResponse.new(
+  flow_id: null,
+  tracking_id: null,
+  name: null,
+  flow_syntax: null,
+  flow_profile: null,
+  sha256: null,
+  message: null
+)
+```
+

data/docs/SubmitInvoiceRequest.md

@@ -0,0 +1,46 @@
+# FactPulse::SubmitInvoiceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credentials** | [**FactureElectroniqueRestApiSchemasChorusProChorusProCredentials**](FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md) |  | [optional] |
+| **invoice_number** | **String** | Invoice number |  |
+| **invoice_date** | **String** | Invoice date (ISO format: YYYY-MM-DD) |  |
+| **payment_due_date** | **String** |  | [optional] |
+| **structure_id** | **Integer** | Chorus Pro recipient structure ID |  |
+| **service_code** | **String** |  | [optional] |
+| **engagement_number** | **String** |  | [optional] |
+| **total_net_amount** | [**TotalNetAmount**](TotalNetAmount.md) |  |  |
+| **vat_amount** | [**VatAmount**](VatAmount.md) |  |  |
+| **total_gross_amount** | [**TotalGrossAmount**](TotalGrossAmount.md) |  |  |
+| **main_attachment_id** | **Integer** |  | [optional] |
+| **main_attachment_label** | **String** |  | [optional] |
+| **comment** | **String** |  | [optional] |
+| **purchase_order_reference** | **String** |  | [optional] |
+| **contract_reference** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitInvoiceRequest.new(
+  credentials: null,
+  invoice_number: null,
+  invoice_date: null,
+  payment_due_date: null,
+  structure_id: null,
+  service_code: null,
+  engagement_number: null,
+  total_net_amount: null,
+  vat_amount: null,
+  total_gross_amount: null,
+  main_attachment_id: null,
+  main_attachment_label: null,
+  comment: null,
+  purchase_order_reference: null,
+  contract_reference: null
+)
+```
+

data/docs/SubmitInvoiceResponse.md

@@ -0,0 +1,24 @@
+# FactPulse::SubmitInvoiceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_code** | **Integer** | Return code (0 = success) |  |
+| **message** | **String** | Return message |  |
+| **chorus_invoice_id** | **Integer** |  | [optional] |
+| **deposit_flow_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SubmitInvoiceResponse.new(
+  return_code: null,
+  message: null,
+  chorus_invoice_id: null,
+  deposit_flow_number: null
+)
+```
+

data/docs/SupplementaryAttachment.md

@@ -0,0 +1,26 @@
+# FactPulse::SupplementaryAttachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  |  |
+| **id** | **Integer** |  |  |
+| **link_id** | **Integer** |  |  |
+| **invoice_line_number** | **Integer** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::SupplementaryAttachment.new(
+  description: null,
+  id: null,
+  link_id: null,
+  invoice_line_number: null,
+  type: null
+)
+```
+

data/docs/Supplier.md

@@ -0,0 +1,36 @@
+# FactPulse::Supplier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  |  |
+| **supplier_id** | **Integer** |  |  |
+| **supplier_bank_account_code** | **Integer** |  | [optional] |
+| **supplier_service_id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **siren** | **String** |  | [optional] |
+| **siret** | **String** |  | [optional] |
+| **vat_number** | **String** |  | [optional] |
+| **iban** | **String** |  | [optional] |
+| **postal_address** | [**PostalAddress**](PostalAddress.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::Supplier.new(
+  electronic_address: null,
+  supplier_id: null,
+  supplier_bank_account_code: null,
+  supplier_service_id: null,
+  name: null,
+  siren: null,
+  siret: null,
+  vat_number: null,
+  iban: null,
+  postal_address: null
+)
+```
+

data/docs/TaskResponse.md

@@ -0,0 +1,18 @@
+# FactPulse::TaskResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Unique task identifier for polling |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::TaskResponse.new(
+  task_id: null
+)
+```
+

data/docs/TaskStatus.md

@@ -0,0 +1,22 @@
+# FactPulse::TaskStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_id** | **String** | Unique task identifier |  |
+| **status** | [**CeleryStatus**](CeleryStatus.md) | Celery task status (PENDING, STARTED, SUCCESS, FAILURE, RETRY) |  |
+| **result** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::TaskStatus.new(
+  task_id: null,
+  status: null,
+  result: null
+)
+```
+

data/docs/TaxableAmount.md

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

data/docs/TotalGrossAmount.md

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

data/docs/TotalNetAmount.md

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

data/docs/TotalVATAmount.md

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

data/docs/UnitNetPrice.md

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