factpulse 3.0.10 → 3.0.14

data/docs/AFNORFacilityPayloadHistoryUleB2gAdditionalData.md

@@ -0,0 +1,28 @@
+# FactPulse::AFNORFacilityPayloadHistoryUleB2gAdditionalData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pm** | **Boolean** | Indicates whether the public structure acts as project manager for work invoices in addition to receiving simple invoices. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] |
+| **pm_only** | **Boolean** | Indicates whether the public structure only acts as a project manager; if so, it can only receive invoices for work. This attribute is only returned if the directory line is defined for a public structure at the SIREN/SIRET or SIREN/SIRET/Routing code level. | [optional] |
+| **manages_payment_status** | **Boolean** | Indicates whether the public structure manages the payment status of invoices. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] |
+| **manages_legal_commitment_code** | **Boolean** | Indicates whether the public structure requires a legal commitment number. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] |
+| **manages_legal_commitment_or_service_code** | **Boolean** | Indicates whether the public structure requires a service code or a commitment code in its exchanges. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] |
+| **service_code_status** | **Boolean** | Indicates whether the structure requires a service code. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFacilityPayloadHistoryUleB2gAdditionalData.new(
+  pm: true,
+  pm_only: true,
+  manages_payment_status: true,
+  manages_legal_commitment_code: true,
+  manages_legal_commitment_or_service_code: true,
+  service_code_status: true
+)
+```
+

data/docs/AFNORFacilityPayloadIncluded.md

@@ -0,0 +1,32 @@
+# FactPulse::AFNORFacilityPayloadIncluded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **siret** | **String** | SIRET Number | [optional] |
+| **siren** | **String** | SIREN number | [optional] |
+| **name** | **String** | business name | [optional] |
+| **facility_type** | [**AFNORFacilityType**](AFNORFacilityType.md) |  | [optional] |
+| **diffusible** | [**AFNORDiffusionStatus**](AFNORDiffusionStatus.md) |  | [optional] |
+| **administrative_status** | [**AFNORFacilityAdministrativeStatus**](AFNORFacilityAdministrativeStatus.md) |  | [optional] |
+| **address** | [**AFNORAddressRead**](AFNORAddressRead.md) |  | [optional] |
+| **b2g_additional_data** | [**AFNORFacilityPayloadHistoryUleB2gAdditionalData**](AFNORFacilityPayloadHistoryUleB2gAdditionalData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFacilityPayloadIncluded.new(
+  siret: 70204275500240,
+  siren: 702042755,
+  name: Boulangerie Pascale,
+  facility_type: null,
+  diffusible: null,
+  administrative_status: null,
+  address: null,
+  b2g_additional_data: null
+)
+```
+

data/docs/AFNORFacilityType.md

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

data/docs/AFNORFlow.md

@@ -0,0 +1,38 @@
+# FactPulse::AFNORFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submitted_at** | **Time** | The flow submission date and time (the date and time when the flow was created on the system)  | [optional] |
+| **updated_at** | **Time** | The last update date and time of the flow. When the flow is submitted updatedAt is equal to submittedAt. When the flow acknowledgment status is changed updatedAt date and time is updated.  | [optional] |
+| **flow_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **tracking_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **flow_type** | [**AFNORFlowType**](AFNORFlowType.md) |  | [optional] |
+| **processing_rule** | [**AFNORProcessingRule**](AFNORProcessingRule.md) |  | [optional] |
+| **processing_rule_source** | **String** | Says whether the processing rule has been computed or the processing rule was an input parameter | [optional] |
+| **flow_direction** | [**AFNORFlowDirection**](AFNORFlowDirection.md) |  | [optional] |
+| **flow_syntax** | [**AFNORFlowSyntax**](AFNORFlowSyntax.md) |  | [optional] |
+| **flow_profile** | [**AFNORFlowProfile**](AFNORFlowProfile.md) |  | [optional] |
+| **acknowledgement** | [**AFNORAcknowledgement**](AFNORAcknowledgement.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFlow.new(
+  submitted_at: null,
+  updated_at: null,
+  flow_id: null,
+  tracking_id: null,
+  flow_type: null,
+  processing_rule: null,
+  processing_rule_source: null,
+  flow_direction: null,
+  flow_syntax: null,
+  flow_profile: null,
+  acknowledgement: null
+)
+```
+

data/docs/AFNORFlowAckStatus.md

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

data/docs/AFNORFlowDirection.md

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

data/docs/AFNORFlowInfo.md

@@ -0,0 +1,28 @@
+# FactPulse::AFNORFlowInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracking_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **name** | **String** | Name of the file | [optional] |
+| **processing_rule** | [**AFNORProcessingRule**](AFNORProcessingRule.md) |  | [optional] |
+| **flow_syntax** | [**AFNORFlowSyntax**](AFNORFlowSyntax.md) |  |  |
+| **flow_profile** | [**AFNORFlowProfile**](AFNORFlowProfile.md) |  | [optional] |
+| **sha256** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFlowInfo.new(
+  tracking_id: null,
+  name: null,
+  processing_rule: null,
+  flow_syntax: null,
+  flow_profile: null,
+  sha256: null
+)
+```
+

data/docs/AFNORFlowProfile.md

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

data/docs/AFNORFlowSyntax.md

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

data/docs/AFNORFlowType.md

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

data/docs/AFNORFullFlowInfo.md

@@ -0,0 +1,32 @@
+# FactPulse::AFNORFullFlowInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracking_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **name** | **String** | Name of the file | [optional] |
+| **processing_rule** | [**AFNORProcessingRule**](AFNORProcessingRule.md) |  | [optional] |
+| **flow_syntax** | [**AFNORFlowSyntax**](AFNORFlowSyntax.md) |  |  |
+| **flow_profile** | [**AFNORFlowProfile**](AFNORFlowProfile.md) |  | [optional] |
+| **sha256** | **String** |  | [optional] |
+| **flow_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **submitted_at** | **Time** | The flow submission date and time (the date and time when the flow was created on the system) This property should be used by the API consumer as a time reference to avoid clock synchronization issues  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFullFlowInfo.new(
+  tracking_id: null,
+  name: null,
+  processing_rule: null,
+  flow_syntax: null,
+  flow_profile: null,
+  sha256: null,
+  flow_id: null,
+  submitted_at: null
+)
+```
+

data/docs/AFNORLegalUnitAdministrativeStatus.md

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

data/docs/AFNORLegalUnitPayloadHistory.md

@@ -0,0 +1,24 @@
+# FactPulse::AFNORLegalUnitPayloadHistory
+
+## 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::AFNORLegalUnitPayloadHistory.new(
+  siren: 702042755,
+  business_name: Boulangerie Pascale,
+  entity_type: null,
+  administrative_status: null
+)
+```
+

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

@@ -1,6 +1,6 @@
 # FactPulse::AFNORPDPPAApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://factpulse.fr*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -95,9 +95,9 @@ FactPulse.configure do |config|
 end
 
 api_instance = FactPulse::AFNORPDPPAApi.new
-flow_id = 'flow_id_example' # String | 
+flow_id = 'flow_id_example' # String | AFNOR flow ID (UUID format)
 opts = {
-  include_document: true # Boolean | 
+  include_document: true # Boolean | Include base64-encoded document in response
 }
 
 begin
@@ -131,8 +131,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **flow_id** | **String** |  |  |
-| **include_document** | **Boolean** |  | [optional][default to false] |
+| **flow_id** | **String** | AFNOR flow ID (UUID format) |  |
+| **include_document** | **Boolean** | Include base64-encoded document in response | [optional][default to false] |
 
 ### Return type