factpulse 0.1.0

data/docs/AFNORCredentials.md

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

data/docs/AFNORDestination.md

@@ -0,0 +1,26 @@
+# FactPulse::AFNORDestination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'afnor'] |
+| **credentials** | [**AFNORCredentials**](AFNORCredentials.md) |  | [optional] |
+| **flow_syntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (AFNOR XP Z12-013) | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **processing_rule** | [**ProcessingRule**](ProcessingRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDestination.new(
+  type: null,
+  credentials: null,
+  flow_syntax: null,
+  tracking_id: null,
+  processing_rule: null
+)
+```
+

data/docs/AFNORDiffusionStatus.md

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

data/docs/AFNORDirectoryLineField.md

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

data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md

@@ -0,0 +1,32 @@
+# FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addressing_identifier** | **String** | Addressing identifier of the directory line. | [optional] |
+| **siren** | **String** | SIREN number | [optional] |
+| **siret** | **String** | SIRET Number | [optional] |
+| **addressing_suffix** | **String** | suffix of the directory line which defines an address mesh not attached to a facility | [optional] |
+| **routing_code** | [**AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md) |  | [optional] |
+| **platform** | [**AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md) |  | [optional] |
+| **legal_unit** | [**AFNORLegalUnitPayloadIncludedNoSiren**](AFNORLegalUnitPayloadIncludedNoSiren.md) |  | [optional] |
+| **facility** | [**AFNORFacilityPayloadIncluded**](AFNORFacilityPayloadIncluded.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.new(
+  addressing_identifier: dcsc456sdcsdcs556,
+  siren: 702042755,
+  siret: 70204275500240,
+  addressing_suffix: dcsc456sdcsdcs556,
+  routing_code: null,
+  platform: null,
+  legal_unit: null,
+  facility: null
+)
+```
+

data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform_type** | [**AFNORRecipientPlatformType**](AFNORRecipientPlatformType.md) |  | [optional] |
+| **platform_status** | [**AFNORPlatformStatus**](AFNORPlatformStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.new(
+  platform_type: null,
+  platform_status: null
+)
+```
+

data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md

@@ -0,0 +1,28 @@
+# FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **routing_identifier** | **String** | Routing identifier od a routing code. | [optional] |
+| **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] |
+| **manages_legal_commitment** | **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] |
+| **administrative_status** | [**AFNORRoutingCodeAdministrativeStatus**](AFNORRoutingCodeAdministrativeStatus.md) |  | [optional] |
+| **address** | [**AFNORAddressRead**](AFNORAddressRead.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.new(
+  routing_identifier: dcsc456sdcsdcs556,
+  routing_identifier_type: 0224,
+  routing_code_name: Libellé Code routage,
+  manages_legal_commitment: true,
+  administrative_status: null,
+  address: null
+)
+```
+

data/docs/AFNORDirectoryLinePost201Response.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORDirectoryLinePost201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_instance** | **Integer** | Platform instance identifier in the directory | [optional] |
+| **addressing_identifier** | **String** | Addressing identifier of the directory line. | [optional] |
+| **date_from** | **Date** | Effective start date of the directory line.. | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDirectoryLinePost201Response.new(
+  id_instance: 120,
+  addressing_identifier: dcsc456sdcsdcs556,
+  date_from: 2023-01-01
+)
+```
+

data/docs/AFNORDirectoryLineSearchPost200Response.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORDirectoryLineSearchPost200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search** | [**AFNORSearchDirectoryLine**](AFNORSearchDirectoryLine.md) |  | [optional] |
+| **total_number_of_results** | **Integer** | The total number of results | [optional] |
+| **results** | [**Array<AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode>**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORDirectoryLineSearchPost200Response.new(
+  search: null,
+  total_number_of_results: 1500,
+  results: null
+)
+```
+

data/docs/AFNOREntityType.md

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

data/docs/AFNORError.md

@@ -0,0 +1,26 @@
+# FactPulse::AFNORError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'about:blank'] |
+| **message** | **String** |  | [optional] |
+| **status** | **Integer** | The HTTP status code generated by the origin server for this occurrence of the problem.  | [optional] |
+| **details** | **String** |  | [optional] |
+| **instance** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORError.new(
+  type: /path/reference-url,
+  message: Error message,
+  status: null,
+  details: Error detailed description,
+  instance: /chemin/url-de-reference#instance-du-contexte
+)
+```
+

data/docs/AFNORFacilityAdministrativeStatus.md

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

data/docs/AFNORFacilityNature.md

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

data/docs/AFNORFacilityPayloadHistory.md

@@ -0,0 +1,34 @@
+# FactPulse::AFNORFacilityPayloadHistory
+
+## 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] |
+| **legal_unit** | [**AFNORLegalUnitPayloadIncludedNoSiren**](AFNORLegalUnitPayloadIncludedNoSiren.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORFacilityPayloadHistory.new(
+  siret: 70204275500240,
+  siren: 702042755,
+  name: Boulangerie Pascale,
+  facility_type: null,
+  diffusible: null,
+  administrative_status: null,
+  address: null,
+  b2g_additional_data: null,
+  legal_unit: null
+)
+```
+

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/AFNORHealthCheckResponse.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORHealthCheckResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow_service_ok** | **Boolean** | Flow Service API status |  |
+| **directory_service_ok** | **Boolean** | Directory Service API status |  |
+| **message** | **String** | Descriptive status message |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORHealthCheckResponse.new(
+  flow_service_ok: null,
+  directory_service_ok: null,
+  message: 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
+)
+```
+