factpulse 0.1.0 → 1.0.0

data/docs/AFNORUpdatePatchRoutingCodeBody.md

@@ -1,24 +0,0 @@
-# FactPulse::AFNORUpdatePatchRoutingCodeBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **routing_identifier_type** | **String** | Routing Identifier type. | [optional] |
-| **routing_code_name** | **String** | Name of the directory line routing code. This attribute is only returned if the directory line is defined at the SIREN / SIRET / Routing code mesh. | [optional] |
-| **administrative_status** | [**AFNORRoutingCodeAdministrativeStatus**](AFNORRoutingCodeAdministrativeStatus.md) |  | [optional] |
-| **address** | [**AFNORAddressPatch**](AFNORAddressPatch.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AFNORUpdatePatchRoutingCodeBody.new(
-  routing_identifier_type: 0224,
-  routing_code_name: Libellé Code routage,
-  administrative_status: null,
-  address: null
-)
-```
-

data/docs/AFNORUpdatePutRoutingCodeBody.md

@@ -1,24 +0,0 @@
-# FactPulse::AFNORUpdatePutRoutingCodeBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **routing_identifier_type** | **String** | Routing Identifier type. |  |
-| **routing_code_name** | **String** | Name of the directory line routing code. This attribute is only returned if the directory line is defined at the SIREN / SIRET / Routing code mesh. |  |
-| **administrative_status** | [**AFNORRoutingCodeAdministrativeStatus**](AFNORRoutingCodeAdministrativeStatus.md) |  |  |
-| **address** | [**AFNORAddressPut**](AFNORAddressPut.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AFNORUpdatePutRoutingCodeBody.new(
-  routing_identifier_type: 0224,
-  routing_code_name: Libellé Code routage,
-  administrative_status: null,
-  address: null
-)
-```
-

data/docs/AFNORWebhookCallbackContent.md

@@ -1,18 +0,0 @@
-# FactPulse::AFNORWebhookCallbackContent
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **flow_info** | [**AFNORFlow**](AFNORFlow.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AFNORWebhookCallbackContent.new(
-  flow_info: null
-)
-```
-

data/docs/AcknowledgmentStatus.md

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

data/docs/ActionCodeInfo.md

@@ -1,22 +0,0 @@
-# FactPulse::ActionCodeInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **code** | **String** | Code |  |
-| **name** | **String** | Nom Python de l'enum |  |
-| **description** | **String** | Description |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ActionCodeInfo.new(
-  code: null,
-  name: null,
-  description: null
-)
-```
-

data/docs/ActionCodesResponse.md

@@ -1,22 +0,0 @@
-# FactPulse::ActionCodesResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **codes** | [**Array<ActionCodeInfo>**](ActionCodeInfo.md) | Liste des codes action |  |
-| **count** | **Integer** | Nombre de codes |  |
-| **source** | **String** | Règle source | [optional][default to 'BR-FR-CDV-CL-10'] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ActionCodesResponse.new(
-  codes: null,
-  count: null,
-  source: null
-)
-```
-

data/docs/AdditionalDocument.md

@@ -1,26 +0,0 @@
-# FactPulse::AdditionalDocument
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Document reference identifier (BT-122). |  |
-| **type_code** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **uri** | **String** |  | [optional] |
-| **reference_type_code** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AdditionalDocument.new(
-  id: null,
-  type_code: null,
-  name: null,
-  uri: null,
-  reference_type_code: null
-)
-```
-

data/docs/AggregatedPaymentInput.md

@@ -1,22 +0,0 @@
-# FactPulse::AggregatedPaymentInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payment_date** | **Date** | Payment date |  |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **amounts_by_rate** | [**Array<PaymentAmountByRate>**](PaymentAmountByRate.md) | Payment amounts by VAT rate |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AggregatedPaymentInput.new(
-  payment_date: 2025-01-15,
-  currency: null,
-  amounts_by_rate: null
-)
-```
-

data/docs/AggregatedTransactionInput.md

@@ -1,32 +0,0 @@
-# FactPulse::AggregatedTransactionInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Transaction date (TT-77) |  |
-| **category_code** | [**TransactionCategory**](TransactionCategory.md) | Transaction category code (TT-81). Use TLB1 for goods, TPS1 for services. |  |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **tax_exclusive_amount** | [**Taxexclusiveamount**](Taxexclusiveamount.md) |  |  |
-| **tax_amount** | [**Taxamount**](Taxamount.md) |  |  |
-| **tax_breakdown** | [**Array<TaxBreakdownInput>**](TaxBreakdownInput.md) | VAT breakdown by rate |  |
-| **transaction_count** | **Integer** |  | [optional] |
-| **tax_due_type** | [**TaxDueDateType**](TaxDueDateType.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AggregatedTransactionInput.new(
-  date: 2025-01-15,
-  category_code: null,
-  currency: null,
-  tax_exclusive_amount: null,
-  tax_amount: null,
-  tax_breakdown: null,
-  transaction_count: null,
-  tax_due_type: null
-)
-```
-

data/docs/AllowanceCharge.md

@@ -1,32 +0,0 @@
-# FactPulse::AllowanceCharge
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **is_charge** | **Boolean** | True for charge, False for allowance (ChargeIndicator). |  |
-| **amount** | [**Amount2**](Amount2.md) |  |  |
-| **base_amount** | [**BaseAmount**](BaseAmount.md) |  | [optional] |
-| **percentage** | [**Percentage**](Percentage.md) |  | [optional] |
-| **reason** | **String** |  | [optional] |
-| **reason_code** | [**AllowanceChargeReasonCode**](AllowanceChargeReasonCode.md) |  | [optional] |
-| **vat_category** | [**VATCategory**](VATCategory.md) |  | [optional] |
-| **vat_rate** | [**VatRate**](VatRate.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::AllowanceCharge.new(
-  is_charge: null,
-  amount: null,
-  base_amount: null,
-  percentage: null,
-  reason: null,
-  reason_code: null,
-  vat_category: null,
-  vat_rate: null
-)
-```
-

data/docs/AllowanceChargeReasonCode.md

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

data/docs/AllowanceReasonCode.md

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

data/docs/AllowanceTotalAmount.md

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

data/docs/AsyncTaskStatus.md

@@ -1,22 +0,0 @@
-# FactPulse::AsyncTaskStatus
-
-## 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::AsyncTaskStatus.new(
-  task_id: null,
-  status: null,
-  result: null
-)
-```
-

data/docs/AsyncTasksApi.md

@@ -1,82 +0,0 @@
-# FactPulse::AsyncTasksApi
-
-All URIs are relative to *https://factpulse.fr*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_task_status_api_v1_processing_tasks_task_id_status_get**](AsyncTasksApi.md#get_task_status_api_v1_processing_tasks_task_id_status_get) | **GET** /api/v1/processing/tasks/{task_id}/status | Get task generation status |
-
-
-## get_task_status_api_v1_processing_tasks_task_id_status_get
-
-> <AsyncTaskStatus> get_task_status_api_v1_processing_tasks_task_id_status_get(task_id)
-
-Get task generation status
-
-Retrieves the progress status of an invoice generation task.  ## Possible states  The `status` field uses the `CeleryStatus` enum with values: - **PENDING, STARTED, SUCCESS, FAILURE, RETRY**  See the `CeleryStatus` schema documentation for details.  ## Business result  When `status=\"SUCCESS\"`, the `result` field contains: - `status`: \"SUCCESS\" or \"ERROR\" (business result) - `content_b64`: Base64 encoded content (if success) - `errorCode`, `errorMessage`, `details`: AFNOR format (if business error)  ## Usage  Poll this endpoint every 2-3 seconds until `status` is `SUCCESS` or `FAILURE`.
-
-### 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::AsyncTasksApi.new
-task_id = 'task_id_example' # String | Celery task ID returned by async endpoints (UUID format)
-
-begin
-  # Get task generation status
-  result = api_instance.get_task_status_api_v1_processing_tasks_task_id_status_get(task_id)
-  p result
-rescue FactPulse::ApiError => e
-  puts "Error when calling AsyncTasksApi->get_task_status_api_v1_processing_tasks_task_id_status_get: #{e}"
-end
-```
-
-#### Using the get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AsyncTaskStatus>, Integer, Hash)> get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info(task_id)
-
-```ruby
-begin
-  # Get task generation status
-  data, status_code, headers = api_instance.get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info(task_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AsyncTaskStatus>
-rescue FactPulse::ApiError => e
-  puts "Error when calling AsyncTasksApi->get_task_status_api_v1_processing_tasks_task_id_status_get_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **task_id** | **String** | Celery task ID returned by async endpoints (UUID format) |  |
-
-### Return type
-
-[**AsyncTaskStatus**](AsyncTaskStatus.md)
-
-### Authorization
-
-[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/BaseAmount.md

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

data/docs/BoundingBoxSchema.md

@@ -1,30 +0,0 @@
-# FactPulse::BoundingBoxSchema
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x0** | **Float** | Left X coordinate |  |
-| **y0** | **Float** | Bottom Y coordinate |  |
-| **x1** | **Float** | Right X coordinate |  |
-| **y1** | **Float** | Top Y coordinate |  |
-| **page** | **Integer** | Page number (0-indexed) | [optional][default to 0] |
-| **width** | **Float** | Area width |  |
-| **height** | **Float** | Area height |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::BoundingBoxSchema.new(
-  x0: null,
-  y0: null,
-  x1: null,
-  y1: null,
-  page: null,
-  width: null,
-  height: null
-)
-```
-

data/docs/Buyercountry.md

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

data/docs/CeleryStatus.md

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

data/docs/ChargeTotalAmount.md

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

data/docs/ChorusProDestination.md

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

data/docs/ChorusProResult.md

@@ -1,22 +0,0 @@
-# FactPulse::ChorusProResult
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chorus_invoice_id** | **Integer** | Chorus Pro invoice ID |  |
-| **deposit_flow_number** | **String** |  | [optional] |
-| **attachment_id** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ChorusProResult.new(
-  chorus_invoice_id: null,
-  deposit_flow_number: null,
-  attachment_id: null
-)
-```
-

data/docs/ClientActivateResponse.md

@@ -1,22 +0,0 @@
-# FactPulse::ClientActivateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **uid** | **String** | Unique client identifier |  |
-| **is_active** | **Boolean** | New status |  |
-| **message** | **String** | Confirmation message |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ClientActivateResponse.new(
-  uid: null,
-  is_active: null,
-  message: null
-)
-```
-

data/docs/ClientCreateRequest.md

@@ -1,22 +0,0 @@
-# FactPulse::ClientCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Client name |  |
-| **description** | **String** |  | [optional] |
-| **siret** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ClientCreateRequest.new(
-  name: null,
-  description: null,
-  siret: null
-)
-```
-

data/docs/ClientDetail.md

@@ -1,38 +0,0 @@
-# FactPulse::ClientDetail
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **uid** | **String** | Unique client identifier |  |
-| **name** | **String** | Client name |  |
-| **siret** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **is_active** | **Boolean** | Whether the client is active |  |
-| **has_config_pdp** | **Boolean** | Whether PDP config exists |  |
-| **pdp_is_active** | **Boolean** |  | [optional] |
-| **pdp_is_mock** | **Boolean** |  | [optional] |
-| **has_config_chorus** | **Boolean** | Whether Chorus Pro config exists |  |
-| **created_at** | **Time** | Creation date |  |
-| **updated_at** | **Time** | Last update date |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ClientDetail.new(
-  uid: null,
-  name: null,
-  siret: null,
-  description: null,
-  is_active: null,
-  has_config_pdp: null,
-  pdp_is_active: null,
-  pdp_is_mock: null,
-  has_config_chorus: null,
-  created_at: null,
-  updated_at: null
-)
-```
-

data/docs/ClientListResponse.md

@@ -1,24 +0,0 @@
-# FactPulse::ClientListResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **results** | [**Array<ClientSummary>**](ClientSummary.md) | List of clients |  |
-| **total** | **Integer** | Total number of clients |  |
-| **page** | **Integer** | Current page |  |
-| **page_size** | **Integer** | Page size |  |
-
-## Example
-
-```ruby
-require 'factpulse'
-
-instance = FactPulse::ClientListResponse.new(
-  results: null,
-  total: null,
-  page: null,
-  page_size: null
-)
-```
-