osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/abstract/abstract_compression_info/v1_0_0.py

@@ -0,0 +1,32 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_compression_info/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractCompressionInfo(BaseModel):
+    """
+    A schema fragment containing information about the compression applied. This is typically included for types supporting compression in the dataset group-type.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LossyCompressionIndicator: bool | None = None
+    """
+    Boolean that warns that an imperfect compression algorithm has been applied to the bulk binary data.  Details of the compression method need to be discovered from the format properties and file access methods.
+    """
+    CompressionMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CompressionMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Name of a compression algorithm applied to the data as stored.
+    """
+    CompressionLevel: float | None = None
+    """
+    Number indicating degree of fidelity present in bulk data resulting from compression.  Meaning of number depends on algorithm.
+    """

osdu_models/abstract/abstract_compression_info/v1_1_0.py

@@ -0,0 +1,44 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_compression_info/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractCompressionInfo(BaseModel):
+    """
+    A schema fragment containing information about the compression applied. This is typically included for types supporting compression in the dataset group-type.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LossyCompressionIndicator: bool | None = None
+    """
+    Boolean that warns that an imperfect compression algorithm has been applied to the bulk binary data.  Details of the compression method need to be discovered from the format properties and file access methods.
+    """
+    CompressionMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CompressionMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Name of a compression algorithm applied to the data as stored.
+    """
+    CompressionLevel: float | None = None
+    """
+    Number indicating degree of fidelity present in bulk data resulting from compression.  Meaning of number depends on algorithm.
+    """
+    CompressedByteCount: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['13378823127']
+    )
+    """
+    The byte count of the dataset in its compressed state. The value type is string, but it must be convertible to a long integer.
+    """
+    UncompressedByteCount: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['15032385536']
+    )
+    """
+    The byte count of the dataset prior to compression. The value type is string, but it must be convertible to a long integer.
+    """

osdu_models/abstract/abstract_contact/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_contact/v1_0_0.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_contact/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractContact(BaseModel):
+    """
+    An object with properties that describe a specific person or other point-of-contact (like an email distribution list) that is relevant in this context (like a given data set or business project). The contact specified may be either internal or external to the organisation (something denoted via the Organisation object that is referenced). Note that some properties contain personally identifiable information, so it might not be appropriate to populate all properties in all scenarios.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EmailAddress: str | None = Field(
+        None, examples=['support@company.com'], title='Email Address'
+    )
+    """
+    Contact email address. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """
+    PhoneNumber: str | None = Field(
+        None, examples=['1-555-281-5555'], title='Phone Number'
+    )
+    """
+    Contact phone number. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """
+    RoleTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ContactRoleType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Role Type ID')
+    """
+    The identifier of a reference value for the role of the contact within the associated organisation, such as Account owner, Sales Representative, Technical Support, Project Manager, Party Chief, Client Representative, Senior Observer.
+    """
+    Comment: str | None = Field(None, title='Comment')
+    """
+    Additional information about the contact
+    """
+    OrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Organisation ID')
+    """
+    Reference to the company the contact is associated with.
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of the individual contact. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """

osdu_models/abstract/abstract_contact/v1_1_0.py

@@ -0,0 +1,69 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_contact/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractContact(BaseModel):
+    """
+    An object with properties that describe a specific person or other point-of-contact (like an email distribution list) that is relevant in this context (like a given data set or business project). The contact specified may be either internal or external to the organisation (something denoted via the Organisation object that is referenced). Note that some properties contain personally identifiable information, so it might not be appropriate to populate all properties in all scenarios.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EmailAddress: str | None = Field(
+        None, examples=['support@company.com'], title='Email Address'
+    )
+    """
+    Contact email address. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """
+    PhoneNumber: str | None = Field(
+        None, examples=['1-555-281-5555'], title='Phone Number'
+    )
+    """
+    Contact phone number. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """
+    RoleTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ContactRoleType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Role Type ID')
+    """
+    The identifier of a reference value for the role of the contact within the associated organisation, such as Account owner, Sales Representative, Technical Support, Project Manager, Party Chief, Client Representative, Senior Observer.
+    """
+    DataGovernanceRoleTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DataGovernanceRoleType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='DataGovernanceRoleTypeID')
+    """
+    The data governance role assigned to this contact if and only if the context has a data governance role (in context of TechnicalAssurance). The value is kept absent in all other cases.
+    """
+    WorkflowPersonaTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WorkflowPersonaType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='WorkflowPersonaTypeID')
+    """
+    The persona in context of workflows associated with this contact, as used in TechnicalAssurance.
+    """
+    Comment: str | None = Field(None, title='Comment')
+    """
+    Additional information about the contact
+    """
+    OrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Organisation ID')
+    """
+    Reference to the company the contact is associated with.
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of the individual contact. Property may be left empty where it is inappropriate to provide personally identifiable information.
+    """

osdu_models/abstract/abstract_contact_user_profile/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_contact_user_profile/v1_0_0.py

@@ -0,0 +1,27 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_contact_user_profile/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from ..abstract_contact.v1_1_0 import AbstractContact
+
+
+class AbstractContactUserProfile(AbstractContact):
+    """
+    A schema fragment, which can hold explicit contact information (contact by value) and a relationship to a UserProfile (contact by reference). Both ways of capturing contact information can be used simultaneously : the 'by value' may capture the state of the contact at the time of recording, while the 'by reference' relationship to UserProfile captures the current state of the contact.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    UserProfileID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-UserProfile:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--UserProfile:JohnSmith:'],
+        title='User Profile ID',
+    )
+    """
+    The contact information by reference to a UserProfile record.
+    """

osdu_models/abstract/abstract_coordinates/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_coordinates/v1_0_0.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_coordinates/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict
+
+
+class AbstractCoordinates(BaseModel):
+    """
+    A geographic position on the surface of the earth.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    X: float | None = None
+    """
+    x is Easting or Longitude.
+    """
+    Y: float | None = None
+    """
+    y is Northing or Latitude.
+    """

osdu_models/abstract/abstract_dataset/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_dataset/v1_0_0.py

@@ -0,0 +1,78 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_dataset/v1_0_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class AbstractDataset(BaseModel):
+    """
+    Schema fragment holding properties common for all datasets.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=[13245217273], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties: dict[str, Any] = Field(
+        ..., examples=[{}], title='Dataset Properties'
+    )
+    """
+    Placeholder for a specialization.
+    """

osdu_models/abstract/abstract_dataset/v1_0_1.py

@@ -0,0 +1,78 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_dataset/v1_0_1.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class AbstractDataset(BaseModel):
+    """
+    Schema fragment holding properties common for all datasets.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['42949672960'], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties: dict[str, Any] = Field(
+        ..., examples=[{}], title='Dataset Properties'
+    )
+    """
+    Placeholder for a specialization.
+    """

osdu_models/abstract/abstract_decision_quality_element/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_decision_quality_element/v1_0_0.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_decision_quality_element/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_remark import v1_0_0
+
+
+class AbstractDecisionQualityElement(BaseModel):
+    """
+    The context for a decision quality element according to https://www.decisionprofessionals.com, i.e., one of AppropriateFrame, DoableAlternatives, InformationReliability, TradeOffAnalysis, ReasoningCorrectness, CommitmentToAction.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EvidenceAsText: str | None = Field(None, title='Evidence as Text')
+    """
+    A simple text providing the necessary evidence for this aspect of decision quality.
+    """
+    EvidenceDocumentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-Document:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Evidence Document ID')
+    """
+    The related Document holding the evidence for this aspect of decision quality.
+    """
+    EvidenceDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Evidence Data Collection ID')
+    """
+    The related PersistedCollection, which keeps the data context for this aspect of decision quality.
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    The array of remarks.
+    """
+    AssessmentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AssessedDecisionQuality:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Assessment ID')
+    """
+    The assessed decision quality (Sufficient, within acceptable range and residual risk, insufficient)
+    """

osdu_models/abstract/abstract_downtime_context/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_downtime_context/v1_0_0.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_downtime_context/v1_0_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class ContextType(Enum):
+    """
+    The fixed type 'Downtime Event' for this AbstractDowntimeContext
+    """
+
+    Downtime_Event = 'Downtime Event'
+
+
+class AbstractDowntimeContext(BaseModel):
+    """
+    A single, typed downtime event reference, which is 'abstracted' to AbstractProductionValueContext and then aggregated by ValueContexts properties.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DowntimeEventID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-DowntimeEvent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Downtime Event')
+    """
+    Reference to DowntimeEvent.
+    """
+    ContextType_1: ContextType = Field(..., alias='ContextType', title='Context Type')
+    """
+    The fixed type 'Downtime Event' for this AbstractDowntimeContext
+    """

osdu_models/abstract/abstract_facet/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_facet/v1_0_0.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facet/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractFacet(BaseModel):
+    """
+    A tuple FacetType, FacetRole, both calling specific references
+
+    FacetType: Enumeration of the type of additional context about the nature of a property type (it may include conditions, direction, qualifiers, or statistics).
+
+    FacetRole: Additional context about the nature of a property type. The purpose of such attribute is to minimize the need to create specialized property types by mutualizing some well known qualifiers such as "maximum", "minimum" which apply to a lot of different property types.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacetTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FacetType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Facet Type ID')
+    """
+    FacetType: An 'enumeration' of the type of additional context about the nature of a property type (it may include conditions, direction, qualifiers, or statistics).
+    """
+    FacetRoleID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FacetRole:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Facet Role ID')
+    """
+    Additional context about the nature of a property type. The purpose of such attribute is to minimize the need to create specialized property types by mutualizing some well known qualifiers such as "maximum", "minimum" which apply to a lot of different property types.
+    """

osdu_models/abstract/abstract_facility/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_facility/v1_0_0.py

@@ -0,0 +1,87 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_facility_operator import v1_0_0
+from ..abstract_alias_names import v1_0_0 as v1_0_0_1
+from ..abstract_facility_state import v1_0_0 as v1_0_0_2
+from ..abstract_facility_event import v1_0_0 as v1_0_0_3
+from ..abstract_facility_specification import v1_0_0 as v1_0_0_4
+
+
+class AbstractFacility(BaseModel):
+    """
+    The schema fragment included by facilities. A facility is a grouping of equipment that is located within a specific geographic boundary or site and that is used in the context of energy-related activities such as exploration, extraction, generation, storage, processing, disposal, supply, or transfer. Clarifications: (1) A facility may be surface or subsurface located. (2) Usually facility equipment is commonly owned or operated. (3) Industry definitions may vary and differ from this one. This schema fragment is included by Well, Wellbore, Rig, as well as Tank Batteries, Compression Stations, Storage Facilities, Wind Farms, Wind Turbines, Mining Facilities, etc., once these types are included in to the OSDU.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityID: str | None = Field(None, title='External Facility Identifier')
+    """
+    Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property should identify that source system.
+    """
+    FacilityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The definition of a kind of capability to perform a business function or a service.
+    """
+    FacilityOperators: list[v1_0_0.AbstractFacilityOperator] | None = None
+    """
+    The history of operator organizations of the facility.
+    """
+    InitialOperatorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Initial Operator ID')
+    """
+    A initial operator organization ID; the organization ID may also be found in the FacilityOperatorOrganisationID of the FacilityOperator array providing the actual dates.
+    """
+    CurrentOperatorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Current Operator ID')
+    """
+    The current operator organization ID; the organization ID may also be found in the FacilityOperatorOrganisationID of the FacilityOperator array providing the actual dates.
+    """
+    DataSourceOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The main source of the header information.
+    """
+    OperatingEnvironmentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OperatingEnvironment:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the Facility's general location as being onshore vs. offshore.
+    """
+    FacilityName: str | None = None
+    """
+    Name of the Facility.
+    """
+    FacilityNameAliases: list[v1_0_0_1.AbstractAliasNames] | None = None
+    """
+    DEPRECATED: please use data.NameAliases. Alternative names, including historical, by which this facility is/has been known.
+    """
+    FacilityStates: list[v1_0_0_2.AbstractFacilityState] | None = None
+    """
+    The history of life cycle states the facility has been through.
+    """
+    FacilityEvents: list[v1_0_0_3.AbstractFacilityEvent] | None = None
+    """
+    A list of key facility events.
+    """
+    FacilitySpecifications: list[v1_0_0_4.AbstractFacilitySpecification] | None = None
+    """
+    facilitySpecification maintains the specification like slot name, wellbore drilling permit number, rig name etc.
+    """