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

osdu_models/masterdata/well_license/v1_0_0.py

@@ -0,0 +1,256 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/well_license/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_well_license_condition import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_remark import v1_0_0 as v1_0_0_2
+from ...abstract.abstract_well_license_service import v1_0_0 as v1_0_0_3
+from ...abstract.abstract_well_license_status import v1_0_0 as v1_0_0_4
+from ...abstract.abstract_well_license_violation import v1_0_0 as v1_0_0_5
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for WellLicense 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IsActive: bool | None = None
+    """
+    A Y/N flag indicating whether this license is currently either active / valid (Y) or inactive / invalid (N).
+    """
+    ApprovedContractorID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-BusinessAssociate:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The validated contractor for this license, as approved.  The term contractor has variable interpretations globally, in this instance the contractor is generally meant to be the contractor who will conduct initial operations on the well for drilling to final TD.
+    """
+    ApprovedDrillSlot: str | None = None
+    """
+    Number for the approved drill slot on the offshore platform. Platforms have 24 to 32 slots in which to position derricks for drilling. Each slot may require a different license in some jurisdictions, while others approve all operations on a platform at the same time. If this property is absent, the license applies to all slots.
+    """
+    ApprovedPurposeDescription: str | None = None
+    """
+    The approved purpose for the well proposal in narrative form.  This often contains formation or depth information along with aggregated information from the Well Status and Classifications facets Business Intention, Play Type, Role, Product Type and Fluid Direction. The Well License Status subset allows this information to be decomposed into facets for better clarity.
+    """
+    ApprovedRigID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Rig:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    Sometimes specific rigs may be authorized by a license, particularly where environmental or access restrictions set specific requirements.  This attribute identifies the specific rig approved, where needed.
+    """
+    ApprovedRigSubstructureHeight: float | None = None
+    """
+    The height of the foundation on which the derrick and engine sits.
+    """
+    ApprovedRigTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RigType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The type of rig installation the license is approved for, where this is relevant. For example land, barge, submersible, platform, jackup, drillship, semisub, artificial island...
+    """
+    ApprovedSpudDate: str | None = None
+    """
+    The approved spud date, can be the same as shown on the license application or may be changed as a result of the discussions involved in the approval process or changes to the circumstances surrounding the well plan.
+    """
+    ApprovedSurveyorID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-BusinessAssociate:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Surveying is a specialized skill that requires certification before it can be practiced in most regions.  The name of the surveyor or surveying company provides evidence that a properly qualified individual will conduct the survey.
+    """
+    ApprovedTargetObjectiveProductIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    The WellProductType(s) (e.g., fluid) that is/are approved for the well license.  In some regions, WellProductTypes are approved individually or as a group.  Similarly, in some regions, specific WellProductTypes may be excluded from the well license, particularly if the land right obtained does not include those WellProductTypes.
+    """
+    ApprovedWellIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = None
+    """
+    A well license may be assigned to an entire planned well configuration at the time the license is granted. Other licenses may be assigned to specific well components.  Where the component is known, specific relationships are needed.
+    """
+    ApprovedWellCount: int | None = None
+    """
+    The number of wells that are approved under this license.  Not all regulators define wells the same way.  Some regulators may identify the number of wellbores, others the number of well origins. Refer to PPDM "What is a Well" for more information about well components.
+    """
+    ApprovedWellboreIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = None
+    """
+    A well license may be assigned to one or more wellbores at the time the license is granted. Other licenses may be assigned to specific well components as defined in What is a Well.  Where the component is known, specific relationships are needed.
+    """
+    AuthorizedStratigraphicUnit: str | None = None
+    """
+    The formation authorized for use. May not be the same as the projected formation at the final depth of a wellbore.
+    """
+    AuthorizedStratigraphicUnitUseRoleID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-WellRole:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    For the formation specified in the license, the use that this formation may be used for, such as production, injection, disposal, storage etc.
+    """
+    BiddingRoundIdentifier: str | None = None
+    """
+    Bidding round number for drilling rights that resulted in this license.
+    """
+    IsDelayed: bool | None = None
+    """
+    When a license is delayed, set this flag to True.  Details about the application can be found in the application object.
+    """
+    ExpiredDate: str | None = None
+    """
+    The date on which a license has expired.  Note that this may be different than the due date, particularly where extensions are granted or specific conditions as stated in the license are met or not met.
+    """
+    IsExpired: bool | None = None
+    """
+    When the license expires, set the expiry date to the appropriate date, and set this flag to True.
+    """
+    ExpiryDueDate: str | None = None
+    """
+    The date when the license has or is due to expire.  In many cases, the date when the license term will expire is stated in the license.  This date may therefore be a date in the future. There may be conditions under which the license can be extended.  Where this occurs, the extension should usually be captured as a new version of the license.
+    """
+    GrantedByBusinessAssociateID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-BusinessAssociate:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identify the business associate, most often a regulator or authorized agency, has granted the license.  In some cases, other authorities may grant licenses, attribute is not intended to be proscriptive.
+    """
+    LicenseDate: str | None = None
+    """
+    Date the well license was issued.  This date may not be the same as the date entered into the system.
+    """
+    LicenseIssuedDate: str | None = None
+    """
+    The date on which the license has been issued and comes into effect.  Normally, no operations that involve surface or subsurface disturbance may be started before this date.
+    """
+    LicensePrimaryTerm: float | None = None
+    """
+    The primary term of the license as set by the agency granting the license.
+    """
+    LicenseReissueDate: str | None = None
+    """
+    The date the permit or license was reissued. The regulatory approval normally expires after the primary term unless an extension is requested and granted.
+    """
+    LicenseReissueTerm: float | None = None
+    """
+    The secondary term of the license, often 6 - 12 months in duration.  These are granted by the regulatory authority after requests for renewal are submitted by the operator or the address for service.
+    """
+    LicenseType: str | None = None
+    """
+    The type of license granted is often based on codes and rules set out in legislation or regulation.  This license type attribute should indicate the exact type as specified in the license document.
+    """
+    LicenseeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-BusinessAssociate:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The licensee to whom this license has been granted.  Sometimes, the licensees may be an address for service, particularly for confidential operations. This is not necessarily the name of the operator or the owner of the well.
+    """
+    LicenseeContactBusinessAssociateID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-BusinessAssociate:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The business associate who is the contact representing the licensee for this license.
+    """
+    ProjectedMeasuredDepth: float | None = None
+    """
+    Projected measured depth at which the drilling of the primary wellbore is planned to be terminated. When multiple wellbores are planned, this may be the depth of the deepest wellbore, depending on local rules.
+    """
+    ProjectedStratigraphicUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StratigraphicUnitInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The stratigraphic unit that is proposed for final completion and production (or injection). Note that this may not be the formation at the planned final depth of the wellbore. The stratigraphic unit should be part of the ProjectedStratigraphicColumn.
+    """
+    ProjectedTrueVerticalDepth: float | None = None
+    """
+    Projected true vertical depth of the well determined during the permitting of the well.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    The measured elevation from a known reference datum to a permanent geodetic datum.  This measurement is the foundation for calculating and correlating depths from geodetic datums, which in turn allow depth correlation between wellbores.
+    """
+    RegulationSection: str | None = None
+    """
+    The section of  the regulation under which the license was granted. For Example, the type of permit (such as Rule 37 or Rule 38 in the State of Texas) that is given for the well.
+    """
+    RigTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RigType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    A reference table describing the overall structure of the rig with respect to the environment and function. For example land, barge, submersible, platform, jackup, drillship, semisub or artificial island.
+
+    Sometimes specific types of rigs may be authorized by a license, particularly where environmental or access restrictions set specific requirements.
+    """
+    StratigraphicColumnID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StratigraphicColumn:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The name of the set of formation names used for interpretations.  Different name sets may exist on a regional or basin basis, or may be developed by regulatory agencies, data vendors or operating companies.  Clarity about which name set is used is critical to ensuring that the name of the formation is not ambiguous.
+    """
+    OperatingEnvironmentID: str | None = None
+    """
+    The reference to the operating environment of the well/wellbore this license applies to.
+    """
+    LicenseConditions: list[v1_0_0_1.AbstractWellLicenseCondition] | None = None
+    """
+    Details about conditions imposed on a license by an authority, a partner or other stakeholder.
+    """
+    LicenseRemarks: list[v1_0_0_2.AbstractRemark] | None = None
+    """
+    Remarks and narratives associated to the license.
+    """
+    LicenseServices: list[v1_0_0_3.WellLicenseArea] | None = None
+    """
+    Services associated with the license.
+    """
+    LicenseStates: list[v1_0_0_4.WellLicenseArea] | None = None
+    """
+    Details about LicenseStates, past and present.
+    """
+    LicenseViolations: list[v1_0_0_5.AbstractWellLicenseViolation] | None = None
+    """
+    Details about violations of conditions, past and present.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/well_log_acquisition/__init__.py

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

osdu_models/masterdata/well_log_acquisition/v1_0_0.py

@@ -0,0 +1,239 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/well_log_acquisition/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_remark import v1_0_0
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_2_0 import AbstractProjectActivity
+
+
+class LogPass(BaseModel):
+    """
+    A log pass identifies a single acquisition event or job.  A log run my contain one or multiple log passes.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LogPassID: str | None = None
+    PassTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellLogPassType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Pass Type ID')
+    """
+    The type of log pass such as Calibration Pass, Main Pass, Repeated Pass.
+    """
+    LoggingDirectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellLogDirection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Logging Direction ID')
+    """
+    The direction of logging for this log pass.
+    Specifies whether the logging information was collected in an downward or upward direction or stationary.
+    """
+    IndexTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellLogSamplingDomainType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Index Type ID')
+    """
+    The index reference type for this log pass e.g. depth, time, counter, calendar time.
+    IndexTypeID corresponds to WellLog data.SamplingDomainTypeID.
+    """
+    SamplingInterval: float | None = Field(
+        None, examples=[0.0254], title='Sampling Interval'
+    )
+    """
+    For regularly sampled curves this property holds the sampling interval for this Log Pass. 
+    For a non regular sampling interval this property is not set. The IsRegularSamplingInterval flag indicates whether the SamplingInterval is required.
+    """
+    IsRegularSamplingInterval: bool | None = Field(
+        None, title='Is Regular Sample Interval Flag'
+    )
+    """
+    A boolean property indicating the sampling mode of the index or reference curve for this Log Pass. 
+
+    True means all reference curve values are regularly spaced (see SamplingInterval). False means irregular or discrete sample spacing.
+    """
+    FlowingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellLogFlowingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Flowing Condition ID')
+    """
+    The flowing condition of the wellbore during the log acquisition e.g. Static or Dynamic
+    """
+    SamplingStart: float | None = Field(None, title='Sampling Start')
+    """
+    The smallest value/first value of the log index for this log pass.
+    """
+    SamplingStop: float | None = Field(None, title='Sampling Stop')
+    """
+    The largest value/last value of the log index for this log pass.
+    """
+    WellboreFluidTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreFluidType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Wellbore Fluid Type ID')
+    """
+    The type of fluid in the wellbore at time of acquisition of the log pass e.g. oil based mud, water based mud, water.
+    Only populate if it is different to the wellbore fluid identified in the log run.
+    """
+    HoleTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellLogHoleType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Hole Type IDs')
+    """
+    The type of hole logged in this pass e.g. open hole, cased hole, cemented hole.
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    Remarks specific to this log pass.
+    """
+    SampleAcquisitionJobIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SampleAcquisitionJob:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Sample Acquisition Job IDs')
+    """
+    A reference to the Sample Acquisition Job for samples acquired in the same logging pass. This can be one or more Sample Acquisition Jobs.
+    """
+
+
+class LogRun(BaseModel):
+    """
+    A log run identifies a single series of combinable logging tools that are entered into the wellbore below the reference depth (e.g. KB, the).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LogRunID: str | None = None
+    """
+    A unique identifier for a specific log run. This can be a number or alphanumeric.
+    """
+    GenericToolTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellLogToolClass:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Generic Tool Type IDs')
+    """
+    An array of well log generic tool types used in this Log Run.
+    """
+    ToolMnemonicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellLogToolCode:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Tool Mnemonics IDs')
+    """
+    An array of PWLS tool mnemonics used in this Log Run.
+    """
+    SamplingStart: float | None = Field(None, title='Sampling Start')
+    """
+    The smallest value/first value of the log index for this log run.
+    """
+    SamplingStop: float | None = Field(None, title='Sampling Stop')
+    """
+    The largest value/last value of the log index for this log run.
+    """
+    WellboreFluidTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreFluidType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Wellbore Fluid Type ID')
+    """
+    The type of fluid in the wellbore at time of logging 
+    e.g. oil based mud, water based mud, water. This property could be overridden by the LogPass wellbore fluid type.
+    """
+    ConveyanceMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ConveyanceMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Conveyance Method ID')
+    """
+    The conveyance method used to acquire the log data e.g. wireline, LWD, pipe conveyed.
+    """
+    SensorOffsetDocumentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-Document:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sensor Offset Document ID')
+    """
+    A relationship to the document record within the OSDU Platform containing the tool sensor offsets, for example a tool string diagram or report.
+    """
+    ContractorCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='ContractorCompanyID')
+    """
+    The relationship to a service or contractor organisation, typically the producer or logging contractor for this particular and identifiable Log Run. Typically this is the same as the overall well log acquisition.
+    Only populate this property if a particular and identifiable Log Run has a different or specifically identifiable service or contracting company to the Well Log Acquisition project as a whole. 
+    The overall contracting company is captured under the `Project.Contractors[]` array. This `Project.Contractors[]` array can capture all Contractors associated with the overall Well Log Acquisition project activity, but can not be associated to a specific Log Run.
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    Remarks specific to this log run.
+    """
+    LogPasses: list[LogPass] | None = Field(None, title='LogPasses')
+    """
+    The logging passes within this single logging run.
+    """
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for WellLogAcquisition 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Wellbore ID')
+    """
+    The Wellbore where the well log acquisition was recorded.
+    """
+    VerticalMeasurement: v1_0_0_1.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    The vertical measurement reference for this well logging acquisition activity. This object defines the vertical reference datum for the measured depths.
+    """
+    LogRuns: list[LogRun] | None = Field(None, title='Log Runs')
+    """
+    The tools run in the hole for the purpose of acquiring well log measurements. Defined as a single tool string run below the reference datum e.g. KB, RT. A log run may consist of one or many Log Passes.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/well_planning_well/__init__.py

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

osdu_models/masterdata/well_planning_well/v1_0_0.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/well_planning_well/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+
+
+class Data(OsduCommonResources):
+    """
+    `data` payload for WellPlanningWell 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Well ID')
+    """
+    Identifier of the parent well.
+    """
+    TimeZone: str | None = Field(None, title='Time Zone')
+    """
+    The UTC time zone in which  well is located - expressed as ISO 8601.
+    """
+    TypeWell: str | None = Field(None, title='Type Well')
+    """
+    Proposed values : Mining, Petroleum, Scientific, Geothermal, Storage, Surface Coring, Water well
+    """
+    LicenceName: str | None = Field(None, title='Licence Name')
+    """
+    Legal name of the well as described within the Licence
+    """
+    LicenceNumber: str | None = Field(None, title='Licence Number')
+    """
+    License number of the well
+    """
+    IssueDateTime: float | None = Field(None, title='Issue Date-Time')
+    """
+    Date and time license was issued
+    """
+    BlockID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-GeoPoliticalEntity:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Block ID')
+    """
+    Identifier of the Geopolitical Entity that describes the Block associated to the Licence
+    """
+    OperatorPercentInterest: float | None = Field(
+        None, title='Operator Percent Interest'
+    )
+    """
+    Interest for Operator, Commonly in percent
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of Well Planning well. Derived from the record identified by WellID.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/well_planning_well/v1_1_0.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/well_planning_well/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for WellPlanningWell 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Well ID')
+    """
+    Identifier of the parent well.
+    """
+    TimeZone: str | None = Field(None, title='Time Zone')
+    """
+    The UTC time zone in which  well is located - expressed as ISO 8601.
+    """
+    TypeWell: str | None = Field(None, title='Type Well')
+    """
+    Proposed values : Mining, Petroleum, Scientific, Geothermal, Storage, Surface Coring, Water well
+    """
+    LicenceName: str | None = Field(None, title='Licence Name')
+    """
+    Legal name of the well as described within the Licence
+    """
+    LicenceNumber: str | None = Field(None, title='Licence Number')
+    """
+    License number of the well
+    """
+    IssueDateTime: float | None = Field(None, title='Issue Date-Time')
+    """
+    Date and time license was issued
+    """
+    BlockID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-GeoPoliticalEntity:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Block ID')
+    """
+    Identifier of the Geopolitical Entity that describes the Block associated to the Licence
+    """
+    OperatorPercentInterest: float | None = Field(
+        None, title='Operator Percent Interest'
+    )
+    """
+    Interest for Operator, Commonly in percent
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of Well Planning well. Derived from the record identified by WellID.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/well_planning_wellbore/__init__.py

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