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

osdu_models/workproductcomponent/samples_analysis/v2_0_0.py

@@ -0,0 +1,137 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/samples_analysis/v2_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_remark import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+from ...abstract.abstract_wpcactivity.v1_2_1 import AbstractWPCActivity
+
+
+class ParentSamplesAnalysesReport(BaseModel):
+    """
+    A pair of properties building a reference to a report combined with a page reference inside the document.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentSamplesAnalysesReportID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysesReport:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Samples Analyses Report ID')
+    """
+    An OSDU Record representing the report from which this analysis was extracted or an OSDU Record from which this analysis was reconstructed.
+    """
+    ParentSamplesAnalysesReportPageNumbers: str | None = Field(
+        None, examples=['12-15,17'], title='Parent Samples Analyses Report Page Numbers'
+    )
+    """
+    If this dataset was extracted from a larger report, this identifies the page number or range (if in document format such as PDF) or sheet names (if in document format such as spreadsheet). For ease of parsing, ranges should be denoted with hyphens with no spaces, and divided with commas). E.g. "12-15,17" or "Sheet1,Sheet2".
+    """
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for SamplesAnalysis 2.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Sample:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-16:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-17:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-21:',
+            ]
+        ],
+        title='Sample IDs',
+    )
+    """
+    Identifies the specific physical sample(s) on which this batch of lab analysis was performed.
+    """
+    ReportSampleIdentifiers: list[str] | None = Field(
+        None, examples=[['KK-16', 'KK-17', 'KK-21']], title='Report Sample Identifiers'
+    )
+    """
+    The names or identifiers of the analyzed samples in this report or document. These names or identifiers are often assigned by the laboratory. This list can be used to assist in locating the appropriate OSDU Sample records or to find the dataset in the parent report.
+    """
+    DateAnalyzed: str | None = Field(None, title='Date Analyzed')
+    """
+    The date the batch of sample analysis was completed.
+    """
+    LaboratoryIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Laboratory IDs')
+    """
+    Identifies the laboratories that conducted the sample analysis contained in this dataset.
+    """
+    LaboratoryNames: list[str] | None = Field(None, title='Laboratory Names')
+    """
+    List of names of laboratories used to conduct the sample analyses contained in this report. This attribute is more freeform than Laboratory IDs and does not have relationships to OSDU Record IDs.
+    """
+    LaboratoryAnalysts: list[str] | None = Field(None, title='Laboratory Analysts')
+    """
+    The names and other information of the analysts responsible for conducting and reporting on the analysis performed.
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    An array containing operational or quality comments pertaining to the sample analysis represented by this work product component.
+    """
+    DatePublished: str | None = Field(None, title='Date Published')
+    """
+    The date that the results of the analysis containing observed measurements or calculations was published.
+    """
+    ParentSamplesAnalysesReports: list[ParentSamplesAnalysesReport] | None = Field(
+        None, title='Parent Samples Analyses Reports'
+    )
+    """
+    Identifies the report from which this analysis was extracted or multiple reports from which this analysis was reconstructed.
+    """
+    SamplesAnalysisCategoryTagIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-SamplesAnalysisCategoryTag:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            ['namespace:reference-data--SamplesAnalysisCategoryTag:ExxonMobil-SCAL:']
+        ],
+        title='Samples Analysis Category Tag IDs',
+    )
+    """
+    List of higher level grouping terms that are often used within organisations to search for analysis types in addition to the formal Family and Method properties, but which are variable across organisations and therefore do not need to be governed strictly by the OSDU Forum. For example: SCAL, Static SCAL, Dynamic SCAL, Source Rock Analysis. We suggest you use a namespace, like the operators name, like “Shell.SCAL”. BP.SCAL, Equinor.SCAL, Chevron.SCAL, Exxon.SCAL.....
+    """
+    SampleAnalysisTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SampleAnalysisType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Sample Analysis Type ID')
+    """
+    The type of scientific lab analysis (such as routine core analysis, compositional analysis, differential liberation, etc.) performed on a physical specimen. Sample Analysis is characterized by an analysis family and sub family, based on criteria such as analysis method or highly relevant parameters.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/saturation_function_set/__init__.py

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

osdu_models/workproductcomponent/saturation_function_set/v1_0_0.py

@@ -0,0 +1,174 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/saturation_function_set/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_contact import v1_1_0
+from typing import Any
+from ...abstract.abstract_remark import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class BasisOfModelling(BaseModel):
+    """
+    This set of attributes represents the context surrounding the processes selected and used in computing these saturation functions.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CapillaryPressureInputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Capillary Pressure Input Data Collection ID')
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this Saturation Function Set, except for Samples Analysis, which are identified by CapillaryPressureInputSampleAnalysisIDs. Note that an abbreviation for capillary pressure is "Pc".
+    """
+    CapillaryPressureInputSampleAnalysisIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysis:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Capillary Pressure Input Sample Analysis IDs')
+    """
+    Identifies one or more SamplesAnalysis records (namely where SampleAnalysisType = CapillaryPressure.*), used as input for the capillary pressure values in this SaturationFunctionSet data. Note that an abbreviation for capillary pressure is "Pc".
+    """
+    RelativePermeabilityInputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Relative Permeability Input Data Collection ID')
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this Saturation Function Set, except for Samples Analysis, which are identified by RelativePermeabilityInputSampleAnalysisIDs. Note that an abbreviation for relative permeability is "Kr".
+    """
+    RelativePermeabilityInputSampleAnalysisIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysis:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Relative Permeability Input Sample Analysis IDs')
+    """
+    Identifies one or more SamplesAnalysis records (namely where SampleAnalysisType = RelativePermeability.*), used as input for the relative permeability values in this SaturationFunctionSet data. Note that an abbreviation for relative permeability is "Kr".
+    """
+    ModellingApplicationsUsed: list[str] | None = Field(
+        None, title='Modelling Applications Used'
+    )
+    """
+    The software applications used in creating this data. Best practice is to also capture the application version.
+    """
+    IntendedWorkflowUsageIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WorkflowUsageType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Intended Workflow Usage IDs')
+    """
+    Identifies the subsequent business workflows for which this data is intended to be used.
+    """
+
+
+class SaturationFunction(BaseModel):
+    """
+    Identifies each saturation function composing the set. Usually saturation functions are uniquely identified in a set by their "usage type".
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FunctionName: str | None = Field(None, title='Function Name')
+    """
+    Name of the saturation function
+    """
+    FunctionUsageTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SaturationFunctionUsageType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Function Usage Type ID')
+    """
+    Identifies the type of usage for which the function is designed (such as imbibition, drainage, etc)
+    """
+    BasisOfModelling_1: BasisOfModelling | None = Field(
+        None, alias='BasisOfModelling', title='Basis of Modelling'
+    )
+    """
+    This set of attributes represents the context surrounding the processes selected and used in computing these saturation functions.
+    """
+    DatePublished: str | None = Field(None, title='Date Published')
+    """
+    This represents the date the saturation function set was published and made available to the consumers or downstream applications.
+    """
+    ModellingContacts: list[v1_1_0.AbstractContact] | None = Field(
+        None, title='Modelling Contacts'
+    )
+    """
+    Information about the analysts responsible for creating this saturation function set
+    """
+    ModelAreaOfInterestIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment|master-data\-\-Wellbore|master-data\-\-GenericFacility|work-product-component\-\-WellboreIntervalSet):[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Model Area Of Interest IDs')
+    """
+    A list of specific areas or business objects within which this model definition can be applied; E.g. Reservoir, ReservoirSegment, or Wellbore.
+    """
+    HasRelativePermeability: bool = Field(..., title='Has Relative Permeability')
+    """
+    Indicates whether relative permeability data has been populated.
+    """
+    HasCapillaryPressure: bool = Field(..., title='Has Capillary Pressure')
+    """
+    Indicates whether capillary pressure data has been populated.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SaturationFunctionSet 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ThreePhaseRelativePermeabilityModelTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ThreePhaseRelativePermeabilityModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Three Phase Relative Permeability Model Type ID')
+    """
+    Identifies the Relative Permeability Model applied for three-phase fluid models if used.
+    """
+    SaturationFunctions: list[SaturationFunction] | None = Field(
+        None, title='Saturation Functions'
+    )
+    """
+    Array of saturation functions
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    Free text remarks about this data
+    """
+    ParentModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SaturationFunctionSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Model ID')
+    """
+    This is used, as a form of lineage, to explicitly indicate the OSDU record of the SaturationFunctionSet from which this saturation function set was derived. Only to be used in the case that this saturation function set is derived from another.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/sealed_surface_framework/__init__.py

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

osdu_models/workproductcomponent/sealed_surface_framework/v1_0_0.py

@@ -0,0 +1,310 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/sealed_surface_framework/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_technical_assurance import v1_0_0
+from ...abstract.abstract_spatial_location import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_2
+
+
+class Artefact(BaseModel):
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RoleID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ArtefactRole:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of this artefact's role.
+    """
+    ResourceKind: (
+        constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$') | None
+    ) = None
+    """
+    The kind or schema ID of the artefact. Resolvable with the Schema Service.
+    """
+    ResourceID: (
+        constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    The SRN which identifies this OSDU Artefact resource.
+    """
+
+
+class LineageAssertion(BaseModel):
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ID: constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None = None
+    """
+    The object reference identifying the DIRECT, INDIRECT, REFERENCE dependency.
+    """
+    LineageRelationshipType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LineageRelationshipType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Used by LineageAssertion to describe the nature of the line of descent of a work product component from a prior Resource, such as DIRECT, INDIRECT, REFERENCE.  It is not for proximity (number of nodes away), it is not to cover all the relationships in a full ontology or graph, and it is not to describe the type of activity that created the asserting WPC.  LineageAssertion does not encompass a full provenance, process history, or activity model.
+    """
+
+
+class TimeSeries(BaseModel):
+    """
+    Allow to link the geometry of the representation to a particular index of a time series. This is particularly useful for IJK grids used in geomechanical or basin context where the topology and geometry varies against the time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TimeIndex: int = Field(..., examples=[3], title='TimeIndices')
+    """
+    Index of the timestamp of the representation in the associated TimeSeries
+    """
+    TimeSeriesID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TimeSeries:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=[
+            'namespace:work-product-component--TimeSeries:85348741-3433-406B-9189-22B298C3E2D2:'
+        ],
+        title='TimeSeriesID',
+    )
+    """
+    Time series the representation is associated to
+    """
+
+
+class IndexableElementCountItem(BaseModel):
+    """
+    Defines the count of a particular indexable element in a representation
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Count: int = Field(..., examples=[10000], title='Count')
+    """
+    The count of indexable element
+    """
+    IndexableElementID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IndexableElement:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IndexableElementID')
+    """
+    The indexable element which is counted
+    """
+
+
+class Data(BaseModel):
+    """
+    The group of properties shared by all different kinds of representations.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ResourceHomeRegionID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Resource Home Region ID')
+    """
+    The name of the home [cloud environment] region for this OSDU resource object.
+    """
+    ResourceHostRegionIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Resource Host Region ID')
+    """
+    The name of the host [cloud environment] region(s) for this OSDU resource object.
+    """
+    ResourceCurationStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceCurationStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Curation Status')
+    """
+    Describes the current Curation status.
+    """
+    ResourceLifecycleStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceLifecycleStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Lifecycle Status')
+    """
+    Describes the current Resource Lifecycle status.
+    """
+    ResourceSecurityClassification: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceSecurityClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Security Classification')
+    """
+    Classifies the security level of the resource.
+    """
+    Source: str | None = Field(None, title='Data Source')
+    """
+    The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed.
+    """
+    ExistenceKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ExistenceKind:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Existence Kind')
+    """
+    Where does this data resource sit in the cradle-to-grave span of its existence?
+    """
+    TechnicalAssuranceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Technical Assurance ID')
+    """
+    DEPRECATED: Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Datasets: (
+        list[constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = None
+    """
+    The record id, which identifies this OSDU File or dataset resource.
+    """
+    Artefacts: list[Artefact] | None = None
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+    IsExtendedLoad: bool | None = None
+    """
+    A flag that indicates if the work product component is undergoing an extended load.  It reflects the fact that the work product component is in an early stage and may be updated before finalization.
+    """
+    IsDiscoverable: bool | None = None
+    """
+    A flag that indicates if the work product component is searchable, which means covered in the search index.
+    """
+    TechnicalAssurances: list[v1_0_0.AbstractTechnicalAssurance] | None = Field(
+        None, title='Technical Assurances'
+    )
+    """
+    Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Name: str | None = None
+    """
+    Name
+    """
+    Description: str | None = None
+    """
+    Description.  Summary of the work product component.  Not the same as Remark which captures thoughts of creator about the wpc.
+    """
+    CreationDateTime: str | None = None
+    """
+    Date that a resource (work  product component here) is formed outside of OSDU before loading (e.g. publication date).
+    """
+    Tags: list[str] | None = None
+    """
+    Array of key words to identify the work product, especially to help in search.
+    """
+    SpatialPoint: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    A centroid point that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    SpatialArea: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    A polygon boundary that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    GeoContexts: list[v1_0_0_2.AbstractGeoContext] | None = None
+    """
+    List of geographic entities which provide context to the WPC.  This may include multiple types or multiple values of the same type.
+    """
+    SubmitterName: str | None = None
+    """
+    Name of the person that first submitted the work product component to OSDU.
+    """
+    BusinessActivities: list[str] | None = None
+    """
+    Array of business processes/workflows that the work product component has been through (ex. well planning, exploration).
+    """
+    AuthorIDs: list[str] | None = Field(None, title='Author IDs')
+    """
+    Array of Authors' names of the work product component.  Could be a person or company entity.
+    """
+    LineageAssertions: list[LineageAssertion] | None = None
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+    InterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StructuralOrganizationInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ID of the interpretation')
+    """
+    The reference to the StructuralOrganizationInterpretation this framework belongs to.
+    """
+    InterpretationName: str | None = Field(
+        None, examples=['My Interpretation'], title='Name of the interpretation'
+    )
+    """
+    Name of the interpretation the representation refers to
+    """
+    TimeSeries_1: TimeSeries | None = Field(
+        None, alias='TimeSeries', title='Time Series'
+    )
+    """
+    Allow to link the geometry of the representation to a particular index of a time series. This is particularly useful for IJK grids used in geomechanical or basin context where the topology and geometry varies against the time.
+    """
+    RealizationIndex: int | None = Field(None, examples=[10], title='Realization Index')
+    """
+    The index of the realization of this representation
+    """
+    IndexableElementCount: list[IndexableElementCountItem] | None = Field(
+        None, title='Counts of Indexable element'
+    )
+    """
+    Several optional indexable element counts
+    """
+    LocalModelCompoundCrsID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-LocalModelCompoundCrs:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ID of the compound CRS where this representation is given')
+    """
+    Allow to link a local CRS with this representation
+    """
+    GenericRepresentationIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-GenericRepresentation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='IDs of the generic representations')
+    """
+    List of Generic Representations linked to structural model inputs and outputs, for example fault sticks and triangulated surfaces, Horizon data points and triangulated surfaces, geobody boundary triangulated surfaces.
+    """
+    ExtensionProperties: dict[str, Any] | None = None