factpulse 3.0.9 → 3.0.13

data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchDirectoryLineFiltersAddressingIdentifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | Addressing identifier of the directory line. | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchDirectoryLineFiltersAddressingIdentifier.new(
+  op: null,
+  value: dcsc456sdcsdcs556
+)
+```
+

data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchDirectoryLineFiltersAddressingSuffix
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) |  | [optional] |
+| **value** | **String** | suffix of the directory line which defines an address mesh not attached to a facility | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchDirectoryLineFiltersAddressingSuffix.new(
+  op: null,
+  value: dcsc456sdcsdcs556
+)
+```
+

data/docs/AFNORSearchDirectoryLineSortingInner.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchDirectoryLineSortingInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**AFNORDirectoryLineField**](AFNORDirectoryLineField.md) |  | [optional] |
+| **sorting_order** | [**AFNORSortingOrder**](AFNORSortingOrder.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchDirectoryLineSortingInner.new(
+  field: null,
+  sorting_order: null
+)
+```
+

data/docs/AFNORSearchFlowContent.md

@@ -0,0 +1,22 @@
+# FactPulse::AFNORSearchFlowContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **filters** | [**AFNORSearchFlowFilters**](AFNORSearchFlowFilters.md) |  | [optional] |
+| **results** | [**Array<AFNORFlow>**](AFNORFlow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchFlowContent.new(
+  limit: null,
+  filters: null,
+  results: null
+)
+```
+

data/docs/AFNORSearchFlowFilters.md

@@ -0,0 +1,30 @@
+# FactPulse::AFNORSearchFlowFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **updated_after** | **Time** |  | [optional] |
+| **updated_before** | **Time** |  | [optional] |
+| **processing_rule** | [**Array<AFNORProcessingRule>**](AFNORProcessingRule.md) |  | [optional] |
+| **flow_type** | [**Array<AFNORFlowType>**](AFNORFlowType.md) |  | [optional] |
+| **flow_direction** | [**Array<AFNORFlowDirection>**](AFNORFlowDirection.md) |  | [optional] |
+| **tracking_id** | **String** | Unique identifier supporting UUID but not only, for flexibility purpose | [optional] |
+| **ack_status** | [**AFNORFlowAckStatus**](AFNORFlowAckStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchFlowFilters.new(
+  updated_after: null,
+  updated_before: null,
+  processing_rule: null,
+  flow_type: null,
+  flow_direction: null,
+  tracking_id: null,
+  ack_status: null
+)
+```
+

data/docs/AFNORSearchFlowParams.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchFlowParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of results that may be returned | [optional][default to 25] |
+| **where** | [**AFNORSearchFlowFilters**](AFNORSearchFlowFilters.md) |  |  |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchFlowParams.new(
+  limit: null,
+  where: null
+)
+```
+

data/docs/AFNORSearchSiren.md

@@ -0,0 +1,26 @@
+# FactPulse::AFNORSearchSiren
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**AFNORSearchSirenFilters**](AFNORSearchSirenFilters.md) |  | [optional] |
+| **sorting** | [**Array<AFNORSearchSirenSortingInner>**](AFNORSearchSirenSortingInner.md) | Sorting criteria on a field and an order (ascending or descending). | [optional] |
+| **fields** | [**Array<AFNORSirenField>**](AFNORSirenField.md) | Allows you to filter the desired fields in the response. | [optional] |
+| **limit** | **Integer** | Maximum number of results | [optional] |
+| **ignore** | **Integer** | Number of results to skip | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiren.new(
+  filters: null,
+  sorting: [{field=siren, order=ascending}, {field=administrativeStatus, order=descending}],
+  fields: [siren, businessName, entityType, administrativeStatus, idInstance],
+  limit: 50,
+  ignore: 20
+)
+```
+

data/docs/AFNORSearchSirenFilters.md

@@ -0,0 +1,24 @@
+# FactPulse::AFNORSearchSirenFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **siren** | [**AFNORSearchSirenFiltersSiren**](AFNORSearchSirenFiltersSiren.md) |  | [optional] |
+| **business_name** | [**AFNORSearchSirenFiltersBusinessName**](AFNORSearchSirenFiltersBusinessName.md) |  | [optional] |
+| **entity_type** | [**AFNORSearchSirenFiltersEntityType**](AFNORSearchSirenFiltersEntityType.md) |  | [optional] |
+| **administrative_status** | [**AFNORSearchSirenFiltersAdministrativeStatus**](AFNORSearchSirenFiltersAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenFilters.new(
+  siren: null,
+  business_name: null,
+  entity_type: null,
+  administrative_status: null
+)
+```
+

data/docs/AFNORSearchSirenFiltersAdministrativeStatus.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSirenFiltersAdministrativeStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) |  | [optional] |
+| **value** | [**AFNORLegalUnitAdministrativeStatus**](AFNORLegalUnitAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenFiltersAdministrativeStatus.new(
+  op: null,
+  value: null
+)
+```
+

data/docs/AFNORSearchSirenFiltersBusinessName.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSirenFiltersBusinessName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | Business name | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenFiltersBusinessName.new(
+  op: null,
+  value: Boulangerie Pascale
+)
+```
+

data/docs/AFNORSearchSirenFiltersEntityType.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSirenFiltersEntityType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) |  | [optional] |
+| **value** | [**AFNOREntityType**](AFNOREntityType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenFiltersEntityType.new(
+  op: null,
+  value: null
+)
+```
+

data/docs/AFNORSearchSirenFiltersSiren.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSirenFiltersSiren
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | SIREN number to search for. | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenFiltersSiren.new(
+  op: null,
+  value: 702042755
+)
+```
+

data/docs/AFNORSearchSirenSortingInner.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSirenSortingInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**AFNORSirenField**](AFNORSirenField.md) |  | [optional] |
+| **sorting_order** | [**AFNORSortingOrder**](AFNORSortingOrder.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSirenSortingInner.new(
+  field: null,
+  sorting_order: null
+)
+```
+

data/docs/AFNORSearchSiret.md

@@ -0,0 +1,28 @@
+# FactPulse::AFNORSearchSiret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**AFNORSearchSiretFilters**](AFNORSearchSiretFilters.md) |  | [optional] |
+| **sorting** | [**Array<AFNORSearchSiretSortingInner>**](AFNORSearchSiretSortingInner.md) | Sorting criteria on a field and an order (ascending or descending). | [optional] |
+| **fields** | [**Array<AFNORSiretField>**](AFNORSiretField.md) | Allows you to filter the desired fields in the response. | [optional] |
+| **include** | **Array<String>** |  | [optional] |
+| **limit** | **Integer** | Maximum number of results | [optional] |
+| **ignore** | **Integer** | Number of results to skip | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiret.new(
+  filters: null,
+  sorting: [{champ=siret, order=ascending}, {champ=name, order=descending}],
+  fields: [siret, siren, name, facilityType, address, diffusible, administrativeStatus, pmStatus, pmOnly, managesPaymentStatus, managesLegalCommitment, managesLegalCommitmentOrService, serviceCodeStatus, idInstance],
+  include: [siren],
+  limit: 50,
+  ignore: 20
+)
+```
+

data/docs/AFNORSearchSiretFilters.md

@@ -0,0 +1,34 @@
+# FactPulse::AFNORSearchSiretFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **siret** | [**AFNORSearchSiretFiltersSiret**](AFNORSearchSiretFiltersSiret.md) |  | [optional] |
+| **siren** | [**AFNORSearchSirenFiltersSiren**](AFNORSearchSirenFiltersSiren.md) |  | [optional] |
+| **facility_type** | [**AFNORSearchSiretFiltersFacilityType**](AFNORSearchSiretFiltersFacilityType.md) |  | [optional] |
+| **name** | [**AFNORSearchSiretFiltersName**](AFNORSearchSiretFiltersName.md) |  | [optional] |
+| **address_lines** | [**AFNORSearchSiretFiltersAddressLines**](AFNORSearchSiretFiltersAddressLines.md) |  | [optional] |
+| **postal_code** | [**AFNORSearchSiretFiltersPostalCode**](AFNORSearchSiretFiltersPostalCode.md) |  | [optional] |
+| **country_subdivision** | [**AFNORSearchSiretFiltersCountrySubdivision**](AFNORSearchSiretFiltersCountrySubdivision.md) |  | [optional] |
+| **locality** | [**AFNORSearchSiretFiltersLocality**](AFNORSearchSiretFiltersLocality.md) |  | [optional] |
+| **administrative_status** | [**AFNORSearchSiretFiltersAdministrativeStatus**](AFNORSearchSiretFiltersAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFilters.new(
+  siret: null,
+  siren: null,
+  facility_type: null,
+  name: null,
+  address_lines: null,
+  postal_code: null,
+  country_subdivision: null,
+  locality: null,
+  administrative_status: null
+)
+```
+

data/docs/AFNORSearchSiretFiltersAddressLines.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersAddressLines
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | address lines of the recipient structure having defined the directory line(s). | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersAddressLines.new(
+  op: null,
+  value: 16 BIS RUE HENRI BARBUSSE - CEDEX 1 - Bâtiment le Callipso
+)
+```
+

data/docs/AFNORSearchSiretFiltersAdministrativeStatus.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersAdministrativeStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORStrictOperator**](AFNORStrictOperator.md) |  | [optional] |
+| **value** | [**AFNORFacilityAdministrativeStatus**](AFNORFacilityAdministrativeStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersAdministrativeStatus.new(
+  op: null,
+  value: null
+)
+```
+

data/docs/AFNORSearchSiretFiltersCountrySubdivision.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersCountrySubdivision
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | Subdivision of the country | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersCountrySubdivision.new(
+  op: null,
+  value: Bretagne
+)
+```
+

data/docs/AFNORSearchSiretFiltersFacilityType.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersFacilityType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | [**AFNORFacilityType**](AFNORFacilityType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersFacilityType.new(
+  op: null,
+  value: null
+)
+```
+

data/docs/AFNORSearchSiretFiltersLocality.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersLocality
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | Municipality of the recipient structure having defined the directory line(s). | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersLocality.new(
+  op: null,
+  value: Grenoble
+)
+```
+

data/docs/AFNORSearchSiretFiltersName.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | business name | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersName.new(
+  op: null,
+  value: Boulangerie Pascale
+)
+```
+

data/docs/AFNORSearchSiretFiltersPostalCode.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersPostalCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | Service postal code | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersPostalCode.new(
+  op: null,
+  value: 38100
+)
+```
+

data/docs/AFNORSearchSiretFiltersSiret.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretFiltersSiret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | [**AFNORContainsOperator**](AFNORContainsOperator.md) |  | [optional] |
+| **value** | **String** | SIRET number to search for. | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretFiltersSiret.new(
+  op: null,
+  value: 70204275500000
+)
+```
+

data/docs/AFNORSearchSiretSortingInner.md

@@ -0,0 +1,20 @@
+# FactPulse::AFNORSearchSiretSortingInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**AFNORSiretField**](AFNORSiretField.md) |  | [optional] |
+| **sorting_order** | [**AFNORSortingOrder**](AFNORSortingOrder.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'factpulse'
+
+instance = FactPulse::AFNORSearchSiretSortingInner.new(
+  field: null,
+  sorting_order: null
+)
+```
+

data/docs/AFNORSirenField.md

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

data/docs/AFNORSirenSearchPost200Response.md

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

data/docs/AFNORSiretField.md

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

data/docs/AFNORSiretSearchPost200Response.md

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

data/docs/AFNORSortingOrder.md

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

data/docs/AFNORStrictOperator.md

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