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

osdu_models/masterdata/connected_source_registry_entry/v1_4_0.py

@@ -0,0 +1,316 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/connected_source_registry_entry/v1_4_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, 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
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_2_0 import AbstractProjectActivity
+
+
+class SecurityScheme(BaseModel):
+    """
+    Metadata used to retrieve or generate credentials needed for authorization.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['TGS account'], title='Security scheme name')
+    """
+    Unique name given to a security scheme
+    """
+    TypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SecuritySchemeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--SecuritySchemeType:OAuth2:'],
+        title='Scheme Type Identifier',
+    )
+    """
+    Type of security schema
+    """
+    FlowTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OAuth2FlowType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--OAuth2FlowType:client_credentials:'],
+        title='OAuth2 Flow Type Identifier',
+    )
+    """
+    OAuth2 flow, or grant type
+    """
+    CallbackUrl: str | None = Field(
+        None, examples=['https://my.osdu.com/auth/signin-oidc'], title='Callback Url'
+    )
+    """
+    Url the identity provider will send the token to in OAuth2 authorization code flows
+    """
+    AuthorizationUrl: str | None = Field(
+        None,
+        examples=['https://login.microsoftonline.com/.../oauth2/v2.0/authorize'],
+        title='Authorization Url',
+    )
+    """
+    Authorization endpoint of the identity provider used in OAuth2 flows
+    """
+    TokenUrl: str | None = Field(
+        None,
+        examples=['https://login.microsoftonline.com/.../oauth2/v2.0/token'],
+        title='Token Url',
+    )
+    """
+    Token endpoint of the identity provider used in OAuth2 flows
+    """
+    ScopesKeyName: str | None = Field(
+        None, examples=['tgs_account_scopes'], title='Secret key for Scopes'
+    )
+    """
+    Key for obtaining the space-delimited scopes list for use in OAuth2 flows from the secret repository
+    """
+    ClientID: str | None = Field(None, title='Client ID')
+    """
+    DEPRECATED: Superseded  by ClientIDKeyName. Client ID
+    """
+    ClientSecretKeyName: str | None = Field(
+        None, examples=['tgs_account_client_secret'], title='Client Secret'
+    )
+    """
+    Key for obtaining the client secret for use in OAuth2 flows from the secret repository
+    """
+    Audience: str | None = Field(
+        None, examples=['tgs_account_audience'], title='Audience'
+    )
+    """
+    Audience used in OAuth2 flows
+    """
+    RefreshTokenKeyName: str | None = Field(
+        None,
+        examples=['tgs_account_refresh_token'],
+        title='Secret key for Refresh token',
+    )
+    """
+    Key for obtaining a refresh token from the secret repository
+    """
+    AccessTokenKeyName: str | None = Field(
+        None, examples=['tgs_account_access_token'], title='Secret key for Access token'
+    )
+    """
+    Key for obtaining an access token from the secret repository
+    """
+    APIKeyKeyName: str | None = Field(
+        None, examples=['tgs_account_apikey'], title='Secret key for API key'
+    )
+    """
+    Key for obtaining an API key from the secret repository
+    """
+    UsernameKeyName: str | None = Field(
+        None, examples=['tgs_account_username'], title='Secret key for Username'
+    )
+    """
+    Key for obtaining Username from the secret repository
+    """
+    PasswordKeyName: str | None = Field(
+        None, examples=['tgs_account_password'], title='Secret key for Password'
+    )
+    """
+    Key for obtaining Password from the secret repository
+    """
+    SecretRepoUrl: str | None = Field(
+        None,
+        examples=['https://myvault.vault.azure.net/secrets/'],
+        title='Secret repository Url',
+    )
+    """
+    Url of the secret repository containing secrets for this security scheme
+    """
+    ClientIDKeyName: str | None = Field(
+        None, examples=['tgs_client_id'], title='Secret Key for Client ID'
+    )
+    """
+    Key for obtaining the client id for use in the OAuth2 flows from the secret repository
+    """
+
+
+class SmtpScheme(BaseModel):
+    """
+    Metadata used to mail the EDS's Report.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['TGS account'], title='SMTP Server scheme name')
+    """
+    Unique name given to a SMTP scheme.
+    """
+    SmtpUserKeyName: str | None = Field(
+        None, examples=['tgs_account_smtp_username'], title='SMTP User'
+    )
+    """
+    Key for the SMTP user.
+    """
+    SmtpPasswordKeyName: str | None = Field(
+        None, examples=['tgs_account_smtp_password'], title='SMTP Password'
+    )
+    """
+    Key for the SMTP password.
+    """
+    SmtpSenderMail: str | None = Field(
+        None, examples=['abc@gmail.com'], title='SMTP Sender Mail'
+    )
+    """
+    Sender's mail address.
+    """
+    SmtpTimeOut: int | None = Field(None, examples=[30], title='SMTP Timeout')
+    """
+    Timeout time for the SMTP server.
+    """
+    SmtpRetryLimit: int | None = Field(None, examples=[5], title='SMTP Timeout')
+    """
+    Limit to retry for the connection.
+    """
+    SmtpHostKeyName: str | None = Field(
+        None, examples=['smtp.gmail.com'], title='SMTP Host'
+    )
+    """
+    Key for the SMTP host.
+    """
+    SmtpStartTLS: bool | None = Field(None, examples=[True], title='SMTP StartTLS')
+    """
+    Type of protocol for connection.
+    """
+    SmtpSSL: bool | None = Field(None, examples=[True], title='SMTP SSL')
+    """
+    Type of protocol for connection.
+    """
+    SmtpPort: int | None = Field(None, examples=[587], title='SMTP Port')
+    """
+    SMTP Port for the connection,its different for SSL/StartTLS.
+    """
+    SmtpReceiverMail: list[str] | None = Field(
+        None, examples=[['abc@gmail.com', 'def@gmail.com']], title='SMTP Receiver Mail'
+    )
+    """
+    List of receiver's mail addresses.
+    """
+    ReportStartDate: str | None = Field(
+        None, examples=['2022-07-22T00:00:00.000000'], title='SMTP Start Date'
+    )
+    """
+    Start date from which report is required.
+    """
+    ReportEndDate: str | None = Field(
+        None, examples=['2022-07-22T00:00:00.000000'], title='SMTP End Date'
+    )
+    """
+    End date till report is required.
+    """
+    EmailTriggerFrequency: str | None = Field(
+        None, examples=['2 4 1 * wed'], title='Email Trigger Frequency'
+    )
+    """
+    Email Trigger Frequency for the EDS report, cron job format
+    """
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for ConnectedSourceRegistryEntry 1.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['TGS'], title='Name')
+    """
+    Descriptive label given to the data source. This could be the name of an organisation and/or the name of a specific database or system.
+    """
+    Description: str | None = Field(
+        None,
+        examples=[
+            'Connectivity information for TGS supplier endpoints serving well logs.'
+        ],
+        title='Description',
+    )
+    """
+    Additional information/description about the data source
+    """
+    FullOSDUImplementationIndicator: bool | None = Field(
+        None, examples=[True], title='OSDU Implementation Type'
+    )
+    """
+    Flag that determines whether the external source has a full OSDU implementation (true) or a wrapper facade over proprietary APIs (false)
+    """
+    AgreementIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Agreement:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = Field(None, title='Agreement IDs')
+    """
+    References to applicable agreements governing the use of the data source
+    """
+    SecuritySchemes: list[SecurityScheme] = Field(..., title='List of security schemes')
+    """
+    List of security schemes available for use in authorizing against OSDU-compliant APIs of a connected data source.
+    """
+    SmtpSchemes: list[SmtpScheme] | None = Field(
+        None, title='List of SMTP Server Schemes'
+    )
+    """
+    List of SMTP server schemes available for use in mailing the detailed EDS's report.
+    """
+    AirflowStableAPIUrl: str | None = Field(
+        None,
+        examples=['https://osdu-gcz.com/api/airflow/api/v1'],
+        title='AirflowStableAPIUrl',
+    )
+    """
+    Connectivity information for Airflow endpoints to get more information of Manifest Ingestion.
+    """
+    SourceOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Source Organisation ID')
+    """
+    Identifier of the organisation that the registered source belongs to.
+    """
+    ReferenceValueMappings: dict[str, Any] | None = Field(
+        None, examples=[{}], title='Reference Value Mappings'
+    )
+    """
+    DEPRECATED: Please use reference-data--ExternalReferenceValueMapping reference catalog items instead. Temporary property awaiting a external reference-value mapping framework. A generic dictionary of string reference-data as keys mapping to reference-value as string value. Only predefined reference-data and its values are permitted.
+    """
+    DatasetURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/dataset/v2/'],
+        title='Dataset URL',
+    )
+    """
+    A placeholder to keep the data provider Dataset URL.
+    """
+    SearchURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/search/v3/'],
+        title='Search URL',
+    )
+    """
+    A placeholder to store the data provider Search service URL.
+    """
+    StorageURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/storage/v2/'],
+        title='Storage URL',
+    )
+    """
+    A placeholder to keep the data provider Storage service URL.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/connected_source_registry_entry/v1_5_0.py

@@ -0,0 +1,386 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/connected_source_registry_entry/v1_5_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 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 SecurityScheme(BaseModel):
+    """
+    Metadata used to retrieve or generate credentials needed for authorization.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['TGS account'], title='Security scheme name')
+    """
+    Unique name given to a security scheme
+    """
+    TypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-SecuritySchemeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--SecuritySchemeType:OAuth2:'],
+        title='Scheme Type Identifier',
+    )
+    """
+    Type of security schema
+    """
+    FlowTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OAuth2FlowType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--OAuth2FlowType:client_credentials:'],
+        title='OAuth2 Flow Type Identifier',
+    )
+    """
+    OAuth2 flow, or grant type
+    """
+    CallbackUrl: str | None = Field(
+        None, examples=['https://my.osdu.com/auth/signin-oidc'], title='Callback Url'
+    )
+    """
+    Url the identity provider will send the token to in OAuth2 authorization code flows
+    """
+    AuthorizationUrl: str | None = Field(
+        None,
+        examples=['https://login.microsoftonline.com/.../oauth2/v2.0/authorize'],
+        title='Authorization Url',
+    )
+    """
+    Authorization endpoint of the identity provider used in OAuth2 flows
+    """
+    TokenUrl: str | None = Field(
+        None,
+        examples=['https://login.microsoftonline.com/.../oauth2/v2.0/token'],
+        title='Token Url',
+    )
+    """
+    Token endpoint of the identity provider used in OAuth2 flows
+    """
+    ScopesKeyName: str | None = Field(
+        None, examples=['tgs_account_scopes'], title='Secret key for Scopes'
+    )
+    """
+    Key for obtaining the space-delimited scopes list for use in OAuth2 flows from the secret repository
+    """
+    ClientID: str | None = Field(None, title='Client ID')
+    """
+    DEPRECATED: Superseded  by ClientIDKeyName. Client ID
+    """
+    ClientSecretKeyName: str | None = Field(
+        None, examples=['tgs_account_client_secret'], title='Client Secret'
+    )
+    """
+    Key for obtaining the client secret for use in OAuth2 flows from the secret repository
+    """
+    Audience: str | None = Field(
+        None, examples=['tgs_account_audience'], title='Audience'
+    )
+    """
+    Audience used in OAuth2 flows
+    """
+    RefreshTokenKeyName: str | None = Field(
+        None,
+        examples=['tgs_account_refresh_token'],
+        title='Secret key for Refresh token',
+    )
+    """
+    Key for obtaining a refresh token from the secret repository
+    """
+    AccessTokenKeyName: str | None = Field(
+        None, examples=['tgs_account_access_token'], title='Secret key for Access token'
+    )
+    """
+    Key for obtaining an access token from the secret repository
+    """
+    APIKeyKeyName: str | None = Field(
+        None, examples=['tgs_account_apikey'], title='Secret key for API key'
+    )
+    """
+    Key for obtaining an API key from the secret repository
+    """
+    UsernameKeyName: str | None = Field(
+        None, examples=['tgs_account_username'], title='Secret key for Username'
+    )
+    """
+    Key for obtaining Username from the secret repository
+    """
+    PasswordKeyName: str | None = Field(
+        None, examples=['tgs_account_password'], title='Secret key for Password'
+    )
+    """
+    Key for obtaining Password from the secret repository
+    """
+    SecretRepoUrl: str | None = Field(
+        None,
+        examples=['https://myvault.vault.azure.net/secrets/'],
+        title='Secret repository Url',
+    )
+    """
+    Url of the secret repository containing secrets for this security scheme
+    """
+    ClientIDKeyName: str | None = Field(
+        None, examples=['tgs_client_id'], title='Secret Key for Client ID'
+    )
+    """
+    Key for obtaining the client id for use in the OAuth2 flows from the secret repository
+    """
+
+
+class SmtpScheme(BaseModel):
+    """
+    Metadata used to mail the EDS's Report.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['SMTP Account'], title='SMTP Server Scheme Name')
+    """
+    Unique name given to a SMTP scheme.
+    """
+    SmtpUserKeyName: str | None = Field(
+        None, examples=['smtp_account_username'], title='SMTP User'
+    )
+    """
+    Secret key for the SMTP user.
+    """
+    SmtpPasswordKeyName: str | None = Field(
+        None, examples=['smtp_account_password'], title='SMTP Password'
+    )
+    """
+    Secret key for the SMTP password.
+    """
+    SmtpSenderMail: str | None = Field(
+        None, examples=['abc@gmail.com'], title='SMTP Sender Mail'
+    )
+    """
+    Sender's email address.
+    """
+    SmtpTimeOut: int | None = Field(None, examples=[30], title='SMTP Timeout')
+    """
+    The timeout logic is not being used in EDS code.
+    """
+    SmtpRetryLimit: int | None = Field(None, examples=[5], title='SMTP Timeout')
+    """
+    The retry logic is not being used in EDS code.
+    """
+    SmtpHostKeyName: str | None = Field(None, examples=['smtp_host'], title='SMTP Host')
+    """
+    Secret key for the SMTP host.
+    """
+    SmtpStartTLS: bool | None = Field(None, examples=[True], title='SMTP StartTLS')
+    """
+    Type of protocol connection (Explicit TLS).
+    """
+    SmtpSSL: bool | None = Field(None, examples=[True], title='SMTP SSL')
+    """
+    Type of protocol for connection (Implicit SSL/TLS).
+    """
+    SmtpPort: int | None = Field(None, examples=[587], title='SMTP Port')
+    """
+    SMTP port number for the connection. It differs for SSL and StartTLS.
+    """
+    SmtpReceiverMail: list[str] | None = Field(
+        None, examples=[['abc@gmail.com', 'def@gmail.com']], title='SMTP Receiver Mail'
+    )
+    """
+    List of receivers' email addresses.
+    """
+    EmailTriggerFrequency: str | None = Field(
+        None, examples=['0 9 * * *'], title='Email Trigger Frequency'
+    )
+    """
+    Email trigger frequency for the EDS report, in a cron syntax expression.
+    """
+    ReportEndDate: str | None = Field(
+        None, examples=['2022-07-22T00:00:00.000000'], title='SMTP End Date'
+    )
+    """
+    This property is not being used in EDS code.
+    """
+    ReportStartDate: str | None = Field(
+        None, examples=['2022-07-22T00:00:00.000000'], title='SMTP Start Date'
+    )
+    """
+    Start date from which the report is required.
+    """
+    ReportPeriod: int | None = Field(None, examples=[30], title='SMTP Report Period')
+    """
+    Number of days after the report start date that defines the reporting period.
+    """
+
+
+class EmailApiScheme(BaseModel):
+    """
+    List of Email API schemes available for use in mailing the detailed EDS's report.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['Email API'], title='Email API Scheme Name')
+    """
+    Unique name given to an Email API scheme.
+    """
+    Url: str = Field(
+        ...,
+        examples=['https://graph.microsoft.com/v1.0/me/sendMail'],
+        title='Endpoint URL',
+    )
+    """
+    Email API endpoint to send the POST request to.
+    """
+    SecuritySchemeName: str = Field(
+        ..., examples=['Email API Auth'], title='Security Scheme Name'
+    )
+    """
+    Reference name for the security scheme in the ConnectedSourceRegistryEntry document this Email API belongs to.
+    """
+    SenderEmail: str = Field(..., examples=['abc@gmail.com'], title='Sender Email')
+    """
+    Sender's email address.
+    """
+    RecipientEmails: list[str] = Field(
+        ..., examples=[['def@outlook.com', 'ghi@outlook.com']], title='Recipient Emails'
+    )
+    """
+    List of recipients' email addresses.
+    """
+    PayloadTemplateID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-PayloadTemplate:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--PayloadTemplate:EmailApiPayload:'],
+        title='Payload Template Identifier',
+    )
+    """
+    ID reference of the Payload Template to be used for the Email API's request body.
+    """
+    EmailTriggerFrequency: str | None = Field(
+        None, examples=['0 9 * * *'], title='Email Trigger Frequency'
+    )
+    """
+    Email trigger frequency for the EDS report, in a cron syntax expression.
+    """
+    ReportStartDate: str | None = Field(None, title='Report Start Date')
+    """
+    Start date from which the report is required, in the format of YYYY-MM-DD.
+    """
+    ReportPeriod: int | None = Field(None, examples=[30], title='Report Period')
+    """
+    Number of days after the report start date that defines the reporting period.
+    """
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for ConnectedSourceRegistryEntry 1.5.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., examples=['TGS'], title='Name')
+    """
+    Descriptive label given to the data source. This could be the name of an organisation and/or the name of a specific database or system.
+    """
+    Description: str | None = Field(
+        None,
+        examples=[
+            'Connectivity information for TGS supplier endpoints serving well logs.'
+        ],
+        title='Description',
+    )
+    """
+    Additional information/description about the data source
+    """
+    FullOSDUImplementationIndicator: bool | None = Field(
+        None, examples=[True], title='OSDU Implementation Type'
+    )
+    """
+    Flag that determines whether the external source has a full OSDU implementation (true) or a wrapper facade over proprietary APIs (false)
+    """
+    AgreementIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Agreement:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = Field(None, title='Agreement IDs')
+    """
+    References to applicable agreements governing the use of the data source
+    """
+    SecuritySchemes: list[SecurityScheme] = Field(..., title='List of security schemes')
+    """
+    List of security schemes available for use in authorizing against OSDU-compliant APIs of a connected data source.
+    """
+    SmtpSchemes: list[SmtpScheme] | None = Field(
+        None, title='List of SMTP Server Schemes'
+    )
+    """
+    List of SMTP server schemes available for use in mailing the detailed EDS's report.
+    """
+    AirflowStableAPIUrl: str | None = Field(
+        None,
+        examples=['https://osdu-gcz.com/api/airflow/api/v1'],
+        title='AirflowStableAPIUrl',
+    )
+    """
+    Connectivity information for Airflow endpoints to get more information of Manifest Ingestion.
+    """
+    SourceOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Source Organisation ID')
+    """
+    Identifier of the organisation that the registered source belongs to.
+    """
+    ReferenceValueMappings: dict[str, Any] | None = Field(
+        None, examples=[{}], title='Reference Value Mappings'
+    )
+    """
+    DEPRECATED: Please use reference-data--ExternalReferenceValueMapping reference catalog items instead. Temporary property awaiting a external reference-value mapping framework. A generic dictionary of string reference-data as keys mapping to reference-value as string value. Only predefined reference-data and its values are permitted.
+    """
+    DatasetURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/dataset/v2/'],
+        title='Dataset URL',
+    )
+    """
+    A placeholder to keep the data provider Dataset URL.
+    """
+    SearchURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/search/v3/'],
+        title='Search URL',
+    )
+    """
+    A placeholder to store the data provider Search service URL.
+    """
+    StorageURL: str | None = Field(
+        None,
+        examples=['https://ww.api.enterprise.com/api/storage/v2/'],
+        title='Storage URL',
+    )
+    """
+    A placeholder to keep the data provider Storage service URL.
+    """
+    EmailApiSchemes: list[EmailApiScheme] | None = Field(
+        None, title='Email Api Schemes'
+    )
+    """
+    List of Email API schemes available for use in mailing the detailed EDS's report.
+    """
+    ExtensionProperties: dict[str, Any] | None = None