brevo-python 4.0.1__py3-none-any.whl

brevo/domains/types/__init__.py

@@ -0,0 +1,83 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .authenticate_domain_response import AuthenticateDomainResponse
+    from .create_domain_response import CreateDomainResponse
+    from .create_domain_response_dns_records import CreateDomainResponseDnsRecords
+    from .create_domain_response_dns_records_brevo_code import CreateDomainResponseDnsRecordsBrevoCode
+    from .create_domain_response_dns_records_dkim_record import CreateDomainResponseDnsRecordsDkimRecord
+    from .create_domain_response_dns_records_dmarc_record import CreateDomainResponseDnsRecordsDmarcRecord
+    from .get_domain_configuration_response import GetDomainConfigurationResponse
+    from .get_domain_configuration_response_dns_records import GetDomainConfigurationResponseDnsRecords
+    from .get_domain_configuration_response_dns_records_brevo_code import (
+        GetDomainConfigurationResponseDnsRecordsBrevoCode,
+    )
+    from .get_domain_configuration_response_dns_records_dkim_record import (
+        GetDomainConfigurationResponseDnsRecordsDkimRecord,
+    )
+    from .get_domain_configuration_response_dns_records_dmarc_record import (
+        GetDomainConfigurationResponseDnsRecordsDmarcRecord,
+    )
+    from .get_domains_response import GetDomainsResponse
+    from .get_domains_response_domains_item import GetDomainsResponseDomainsItem
+    from .get_domains_response_domains_item_creator import GetDomainsResponseDomainsItemCreator
+_dynamic_imports: typing.Dict[str, str] = {
+    "AuthenticateDomainResponse": ".authenticate_domain_response",
+    "CreateDomainResponse": ".create_domain_response",
+    "CreateDomainResponseDnsRecords": ".create_domain_response_dns_records",
+    "CreateDomainResponseDnsRecordsBrevoCode": ".create_domain_response_dns_records_brevo_code",
+    "CreateDomainResponseDnsRecordsDkimRecord": ".create_domain_response_dns_records_dkim_record",
+    "CreateDomainResponseDnsRecordsDmarcRecord": ".create_domain_response_dns_records_dmarc_record",
+    "GetDomainConfigurationResponse": ".get_domain_configuration_response",
+    "GetDomainConfigurationResponseDnsRecords": ".get_domain_configuration_response_dns_records",
+    "GetDomainConfigurationResponseDnsRecordsBrevoCode": ".get_domain_configuration_response_dns_records_brevo_code",
+    "GetDomainConfigurationResponseDnsRecordsDkimRecord": ".get_domain_configuration_response_dns_records_dkim_record",
+    "GetDomainConfigurationResponseDnsRecordsDmarcRecord": ".get_domain_configuration_response_dns_records_dmarc_record",
+    "GetDomainsResponse": ".get_domains_response",
+    "GetDomainsResponseDomainsItem": ".get_domains_response_domains_item",
+    "GetDomainsResponseDomainsItemCreator": ".get_domains_response_domains_item_creator",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AuthenticateDomainResponse",
+    "CreateDomainResponse",
+    "CreateDomainResponseDnsRecords",
+    "CreateDomainResponseDnsRecordsBrevoCode",
+    "CreateDomainResponseDnsRecordsDkimRecord",
+    "CreateDomainResponseDnsRecordsDmarcRecord",
+    "GetDomainConfigurationResponse",
+    "GetDomainConfigurationResponseDnsRecords",
+    "GetDomainConfigurationResponseDnsRecordsBrevoCode",
+    "GetDomainConfigurationResponseDnsRecordsDkimRecord",
+    "GetDomainConfigurationResponseDnsRecordsDmarcRecord",
+    "GetDomainsResponse",
+    "GetDomainsResponseDomainsItem",
+    "GetDomainsResponseDomainsItemCreator",
+]

brevo/domains/types/authenticate_domain_response.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class AuthenticateDomainResponse(UncheckedBaseModel):
+    domain_name: str = pydantic.Field()
+    """
+    Domain name that was authenticated
+    """
+
+    message: str = pydantic.Field()
+    """
+    Success message confirming authentication
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/create_domain_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .create_domain_response_dns_records import CreateDomainResponseDnsRecords
+
+
+class CreateDomainResponse(UncheckedBaseModel):
+    id: int = pydantic.Field()
+    """
+    ID of the Domain created
+    """
+
+    domain_name: str = pydantic.Field()
+    """
+    Domain name
+    """
+
+    domain_provider: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detected domain provider
+    """
+
+    message: str = pydantic.Field()
+    """
+    Success message with next steps
+    """
+
+    dns_records: typing.Optional[CreateDomainResponseDnsRecords] = pydantic.Field(default=None)
+    """
+    DNS records required for domain authentication
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/create_domain_response_dns_records.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .create_domain_response_dns_records_brevo_code import CreateDomainResponseDnsRecordsBrevoCode
+from .create_domain_response_dns_records_dkim_record import CreateDomainResponseDnsRecordsDkimRecord
+from .create_domain_response_dns_records_dmarc_record import CreateDomainResponseDnsRecordsDmarcRecord
+
+
+class CreateDomainResponseDnsRecords(UncheckedBaseModel):
+    """
+    DNS records required for domain authentication
+    """
+
+    brevo_code: CreateDomainResponseDnsRecordsBrevoCode = pydantic.Field()
+    """
+    Brevo verification code record
+    """
+
+    dkim_record: CreateDomainResponseDnsRecordsDkimRecord = pydantic.Field()
+    """
+    DKIM authentication record
+    """
+
+    dmarc_record: CreateDomainResponseDnsRecordsDmarcRecord = pydantic.Field()
+    """
+    DMARC policy record
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/create_domain_response_dns_records_brevo_code.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateDomainResponseDnsRecordsBrevoCode(UncheckedBaseModel):
+    """
+    Brevo verification code record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/create_domain_response_dns_records_dkim_record.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateDomainResponseDnsRecordsDkimRecord(UncheckedBaseModel):
+    """
+    DKIM authentication record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/create_domain_response_dns_records_dmarc_record.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateDomainResponseDnsRecordsDmarcRecord(UncheckedBaseModel):
+    """
+    DMARC policy record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domain_configuration_response.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_domain_configuration_response_dns_records import GetDomainConfigurationResponseDnsRecords
+
+
+class GetDomainConfigurationResponse(UncheckedBaseModel):
+    domain: str = pydantic.Field()
+    """
+    Domain name
+    """
+
+    verified: bool = pydantic.Field()
+    """
+    Status of domain verification (true=verified, false=non
+    verified)
+    """
+
+    authenticated: bool = pydantic.Field()
+    """
+    Status of domain authentication (true=authenticated, false=non
+    authenticated)
+    """
+
+    dns_records: GetDomainConfigurationResponseDnsRecords = pydantic.Field()
+    """
+    DNS records configuration and status
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domain_configuration_response_dns_records.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_domain_configuration_response_dns_records_brevo_code import GetDomainConfigurationResponseDnsRecordsBrevoCode
+from .get_domain_configuration_response_dns_records_dkim_record import (
+    GetDomainConfigurationResponseDnsRecordsDkimRecord,
+)
+from .get_domain_configuration_response_dns_records_dmarc_record import (
+    GetDomainConfigurationResponseDnsRecordsDmarcRecord,
+)
+
+
+class GetDomainConfigurationResponseDnsRecords(UncheckedBaseModel):
+    """
+    DNS records configuration and status
+    """
+
+    brevo_code: GetDomainConfigurationResponseDnsRecordsBrevoCode = pydantic.Field()
+    """
+    Brevo verification code record
+    """
+
+    dkim_record: GetDomainConfigurationResponseDnsRecordsDkimRecord = pydantic.Field()
+    """
+    DKIM authentication record
+    """
+
+    dmarc_record: GetDomainConfigurationResponseDnsRecordsDmarcRecord = pydantic.Field()
+    """
+    DMARC policy record
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domain_configuration_response_dns_records_brevo_code.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetDomainConfigurationResponseDnsRecordsBrevoCode(UncheckedBaseModel):
+    """
+    Brevo verification code record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domain_configuration_response_dns_records_dkim_record.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetDomainConfigurationResponseDnsRecordsDkimRecord(UncheckedBaseModel):
+    """
+    DKIM authentication record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domain_configuration_response_dns_records_dmarc_record.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetDomainConfigurationResponseDnsRecordsDmarcRecord(UncheckedBaseModel):
+    """
+    DMARC policy record
+    """
+
+    host_name: str = pydantic.Field()
+    """
+    DNS record hostname
+    """
+
+    type: str = pydantic.Field()
+    """
+    DNS record type
+    """
+
+    value: str = pydantic.Field()
+    """
+    DNS record value
+    """
+
+    status: bool = pydantic.Field()
+    """
+    Whether the record is properly configured
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domains_response.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_domains_response_domains_item import GetDomainsResponseDomainsItem
+
+
+class GetDomainsResponse(UncheckedBaseModel):
+    domains: typing.List[GetDomainsResponseDomainsItem] = pydantic.Field()
+    """
+    List of the domains available in your account
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of domains
+    """
+
+    current_page: int = pydantic.Field()
+    """
+    Current page number
+    """
+
+    total_pages: int = pydantic.Field()
+    """
+    Total number of pages
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domains_response_domains_item.py

@@ -0,0 +1,56 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_domains_response_domains_item_creator import GetDomainsResponseDomainsItemCreator
+
+
+class GetDomainsResponseDomainsItem(UncheckedBaseModel):
+    id: str = pydantic.Field()
+    """
+    Unique identifier of the domain
+    """
+
+    domain_name: str = pydantic.Field()
+    """
+    Domain name
+    """
+
+    authenticated: bool = pydantic.Field()
+    """
+    Status of domain authentication (true=authenticated,
+    false=non authenticated)
+    """
+
+    verified: bool = pydantic.Field()
+    """
+    Status of domain verification (true=verified, false=non
+    verified)
+    """
+
+    ip: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Dedicated IP associated with domain (null if none)
+    """
+
+    provider: str = pydantic.Field()
+    """
+    DNS provider for the domain
+    """
+
+    creator: GetDomainsResponseDomainsItemCreator = pydantic.Field()
+    """
+    Information about who created the domain
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/domains/types/get_domains_response_domains_item_creator.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class GetDomainsResponseDomainsItemCreator(UncheckedBaseModel):
+    """
+    Information about who created the domain
+    """
+
+    id: str = pydantic.Field()
+    """
+    Creator's user ID
+    """
+
+    email: str = pydantic.Field()
+    """
+    Creator's email address
+    """
+
+    creation_date: typing_extensions.Annotated[
+        dt.datetime,
+        FieldMetadata(alias="creationDate"),
+        pydantic.Field(alias="creationDate", description="Domain creation date"),
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow