brevo-python 4.0.1__py3-none-any.whl

brevo/senders/client.py

@@ -0,0 +1,808 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawSendersClient, RawSendersClient
+from .types.create_sender_request_ips_item import CreateSenderRequestIpsItem
+from .types.create_sender_response import CreateSenderResponse
+from .types.get_ips_from_sender_response import GetIpsFromSenderResponse
+from .types.get_ips_response import GetIpsResponse
+from .types.get_senders_response import GetSendersResponse
+from .types.update_sender_request_ips_item import UpdateSenderRequestIpsItem
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SendersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSendersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSendersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSendersClient
+        """
+        return self._raw_client
+
+    def get_senders(
+        self,
+        *,
+        ip: typing.Optional[str] = None,
+        domain: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetSendersResponse:
+        """
+        Retrieves a list of all email senders from your Brevo account with optional filtering.
+
+        **Use this to:**
+        - Get all available senders for email campaign setup
+        - Find sender details including ID, name, and email address
+        - Filter senders by IP address for dedicated IP users
+        - Filter senders by domain for domain-specific configurations
+        - Monitor sender configuration and status
+
+        **Key information returned:**
+        - Sender details (ID, name, email address)
+        - Sender status and verification information
+        - Associated IP addresses and domains (for dedicated IP accounts)
+        - Sender configuration settings
+
+        **Important considerations:**
+        - Standard accounts show empty IP arrays, dedicated IP accounts show IP assignments
+        - Filtering by IP only available for accounts with dedicated IPs
+        - Domain filtering helps organize senders by business units or brands
+        - Sender status indicates if sender is active and ready for campaign use
+        - Email verification required before sender can be used in campaigns
+
+        Parameters
+        ----------
+        ip : typing.Optional[str]
+            Filter your senders for a specific ip. **Available for dedicated IP usage only**
+
+        domain : typing.Optional[str]
+            Filter your senders for a specific domain
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSendersResponse
+            List of senders retrieved successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.get_senders()
+        """
+        _response = self._raw_client.get_senders(ip=ip, domain=domain, request_options=request_options)
+        return _response.data
+
+    def create_sender(
+        self,
+        *,
+        email: str,
+        name: str,
+        ips: typing.Optional[typing.Sequence[CreateSenderRequestIpsItem]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSenderResponse:
+        """
+        Creates a new email sender in your Brevo account.
+
+        **Use this to:**
+        - Add new senders for email campaigns
+        - Configure sender identity (name and email)
+        - Associate dedicated IPs with the sender (for dedicated IP accounts)
+        - Set up domain-based sender configurations
+
+        **Key information returned:**
+        - Created sender ID
+        - DKIM and SPF configuration status
+        - Success confirmation
+
+        **Important considerations:**
+        - Verification email sent to specified sender address
+        - DKIM and SPF configuration affects deliverability
+        - Dedicated IP accounts require IP association during creation
+        - IP weights must sum to 100 when specified
+        - Sender must be verified before use in campaigns
+
+        Parameters
+        ----------
+        email : str
+            From email to use for the sender. A verification email will be
+            sent to this address.
+
+        name : str
+            From Name to use for the sender
+
+        ips : typing.Optional[typing.Sequence[CreateSenderRequestIpsItem]]
+            **Mandatory in case of dedicated IP**. IPs to associate to the
+            sender. Not required for standard accounts.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSenderResponse
+            Sender created successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.create_sender(
+            email="support@example.com",
+            name="Support Team",
+        )
+        """
+        _response = self._raw_client.create_sender(email=email, name=name, ips=ips, request_options=request_options)
+        return _response.data
+
+    def get_ips(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetIpsResponse:
+        """
+        Retrieves all dedicated IPs associated with your Brevo account.
+
+        Use this to:
+        - List all your dedicated IPs
+        - Check the status of your dedicated IPs (active/inactive)
+        - Find IP addresses and associated domains for configuration purposes
+        - Monitor your IP reputation and deliverability
+        - Verify available IPs for sender configuration
+
+        Key information returned:
+        - IP ID and address
+        - Associated domain
+        - Active status
+        - IP configuration details
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetIpsResponse
+            List of dedicated IPs retrieved successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.get_ips()
+        """
+        _response = self._raw_client.get_ips(request_options=request_options)
+        return _response.data
+
+    def update_sender(
+        self,
+        sender_id: int,
+        *,
+        email: typing.Optional[str] = OMIT,
+        ips: typing.Optional[typing.Sequence[UpdateSenderRequestIpsItem]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Updates an existing email sender's configuration.
+
+        Use this to:
+        - Modify sender display name or email address
+        - Update dedicated IP associations
+        - Change sender configuration settings
+        - Correct sender information
+
+        Key information returned:
+        - Success confirmation
+        - Updated sender details
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        email : typing.Optional[str]
+            From Email to update the sender
+
+        ips : typing.Optional[typing.Sequence[UpdateSenderRequestIpsItem]]
+            **Only in case of dedicated IP**. IPs to associate to the
+            sender. If passed, will replace all the existing IPs. Not required for standard accounts.
+
+        name : typing.Optional[str]
+            From Name to update the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.update_sender(
+            sender_id=1000000,
+            name="New Support Team",
+        )
+        """
+        _response = self._raw_client.update_sender(
+            sender_id, email=email, ips=ips, name=name, request_options=request_options
+        )
+        return _response.data
+
+    def delete_sender(self, sender_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Deletes an email sender from your Brevo account.
+
+        Use this to:
+        - Remove senders that are no longer needed
+        - Clean up sender configurations
+        - Remove duplicate or test senders
+
+        Key information returned:
+        - Success confirmation message
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.delete_sender(
+            sender_id=1000000,
+        )
+        """
+        _response = self._raw_client.delete_sender(sender_id, request_options=request_options)
+        return _response.data
+
+    def get_ips_from_sender(
+        self, sender_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetIpsFromSenderResponse:
+        """
+        Retrieves the dedicated IPs associated with a specific sender.
+
+        Use this to:
+        - Check IP configuration for a sender
+        - Verify dedicated IP associations
+        - Get IP details for troubleshooting
+        - Monitor sender IP configuration
+
+        Key information returned:
+        - List of associated dedicated IPs
+        - IP addresses and domain configurations
+        - IP status and settings
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetIpsFromSenderResponse
+            List of dedicated IPs retrieved successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.get_ips_from_sender(
+            sender_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_ips_from_sender(sender_id, request_options=request_options)
+        return _response.data
+
+    def validate_sender_by_otp(
+        self, sender_id: int, *, otp: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Validates a sender using the OTP (One-Time Password) received via email.
+
+        Use this to:
+        - Complete sender verification process
+        - Activate a newly created sender
+        - Verify ownership of the sender email address
+        - Enable the sender for use in email campaigns
+
+        Key information returned:
+        - Success confirmation of sender verification
+        - Sender activation status
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        otp : int
+            6 digit OTP received on email
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.senders.validate_sender_by_otp(
+            sender_id=1000000,
+            otp=123456,
+        )
+        """
+        _response = self._raw_client.validate_sender_by_otp(sender_id, otp=otp, request_options=request_options)
+        return _response.data
+
+
+class AsyncSendersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSendersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSendersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSendersClient
+        """
+        return self._raw_client
+
+    async def get_senders(
+        self,
+        *,
+        ip: typing.Optional[str] = None,
+        domain: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetSendersResponse:
+        """
+        Retrieves a list of all email senders from your Brevo account with optional filtering.
+
+        **Use this to:**
+        - Get all available senders for email campaign setup
+        - Find sender details including ID, name, and email address
+        - Filter senders by IP address for dedicated IP users
+        - Filter senders by domain for domain-specific configurations
+        - Monitor sender configuration and status
+
+        **Key information returned:**
+        - Sender details (ID, name, email address)
+        - Sender status and verification information
+        - Associated IP addresses and domains (for dedicated IP accounts)
+        - Sender configuration settings
+
+        **Important considerations:**
+        - Standard accounts show empty IP arrays, dedicated IP accounts show IP assignments
+        - Filtering by IP only available for accounts with dedicated IPs
+        - Domain filtering helps organize senders by business units or brands
+        - Sender status indicates if sender is active and ready for campaign use
+        - Email verification required before sender can be used in campaigns
+
+        Parameters
+        ----------
+        ip : typing.Optional[str]
+            Filter your senders for a specific ip. **Available for dedicated IP usage only**
+
+        domain : typing.Optional[str]
+            Filter your senders for a specific domain
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSendersResponse
+            List of senders retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.get_senders()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_senders(ip=ip, domain=domain, request_options=request_options)
+        return _response.data
+
+    async def create_sender(
+        self,
+        *,
+        email: str,
+        name: str,
+        ips: typing.Optional[typing.Sequence[CreateSenderRequestIpsItem]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateSenderResponse:
+        """
+        Creates a new email sender in your Brevo account.
+
+        **Use this to:**
+        - Add new senders for email campaigns
+        - Configure sender identity (name and email)
+        - Associate dedicated IPs with the sender (for dedicated IP accounts)
+        - Set up domain-based sender configurations
+
+        **Key information returned:**
+        - Created sender ID
+        - DKIM and SPF configuration status
+        - Success confirmation
+
+        **Important considerations:**
+        - Verification email sent to specified sender address
+        - DKIM and SPF configuration affects deliverability
+        - Dedicated IP accounts require IP association during creation
+        - IP weights must sum to 100 when specified
+        - Sender must be verified before use in campaigns
+
+        Parameters
+        ----------
+        email : str
+            From email to use for the sender. A verification email will be
+            sent to this address.
+
+        name : str
+            From Name to use for the sender
+
+        ips : typing.Optional[typing.Sequence[CreateSenderRequestIpsItem]]
+            **Mandatory in case of dedicated IP**. IPs to associate to the
+            sender. Not required for standard accounts.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateSenderResponse
+            Sender created successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.create_sender(
+                email="support@example.com",
+                name="Support Team",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_sender(
+            email=email, name=name, ips=ips, request_options=request_options
+        )
+        return _response.data
+
+    async def get_ips(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetIpsResponse:
+        """
+        Retrieves all dedicated IPs associated with your Brevo account.
+
+        Use this to:
+        - List all your dedicated IPs
+        - Check the status of your dedicated IPs (active/inactive)
+        - Find IP addresses and associated domains for configuration purposes
+        - Monitor your IP reputation and deliverability
+        - Verify available IPs for sender configuration
+
+        Key information returned:
+        - IP ID and address
+        - Associated domain
+        - Active status
+        - IP configuration details
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetIpsResponse
+            List of dedicated IPs retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.get_ips()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_ips(request_options=request_options)
+        return _response.data
+
+    async def update_sender(
+        self,
+        sender_id: int,
+        *,
+        email: typing.Optional[str] = OMIT,
+        ips: typing.Optional[typing.Sequence[UpdateSenderRequestIpsItem]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Updates an existing email sender's configuration.
+
+        Use this to:
+        - Modify sender display name or email address
+        - Update dedicated IP associations
+        - Change sender configuration settings
+        - Correct sender information
+
+        Key information returned:
+        - Success confirmation
+        - Updated sender details
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        email : typing.Optional[str]
+            From Email to update the sender
+
+        ips : typing.Optional[typing.Sequence[UpdateSenderRequestIpsItem]]
+            **Only in case of dedicated IP**. IPs to associate to the
+            sender. If passed, will replace all the existing IPs. Not required for standard accounts.
+
+        name : typing.Optional[str]
+            From Name to update the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.update_sender(
+                sender_id=1000000,
+                name="New Support Team",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_sender(
+            sender_id, email=email, ips=ips, name=name, request_options=request_options
+        )
+        return _response.data
+
+    async def delete_sender(self, sender_id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Deletes an email sender from your Brevo account.
+
+        Use this to:
+        - Remove senders that are no longer needed
+        - Clean up sender configurations
+        - Remove duplicate or test senders
+
+        Key information returned:
+        - Success confirmation message
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.delete_sender(
+                sender_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_sender(sender_id, request_options=request_options)
+        return _response.data
+
+    async def get_ips_from_sender(
+        self, sender_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetIpsFromSenderResponse:
+        """
+        Retrieves the dedicated IPs associated with a specific sender.
+
+        Use this to:
+        - Check IP configuration for a sender
+        - Verify dedicated IP associations
+        - Get IP details for troubleshooting
+        - Monitor sender IP configuration
+
+        Key information returned:
+        - List of associated dedicated IPs
+        - IP addresses and domain configurations
+        - IP status and settings
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetIpsFromSenderResponse
+            List of dedicated IPs retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.get_ips_from_sender(
+                sender_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_ips_from_sender(sender_id, request_options=request_options)
+        return _response.data
+
+    async def validate_sender_by_otp(
+        self, sender_id: int, *, otp: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Validates a sender using the OTP (One-Time Password) received via email.
+
+        Use this to:
+        - Complete sender verification process
+        - Activate a newly created sender
+        - Verify ownership of the sender email address
+        - Enable the sender for use in email campaigns
+
+        Key information returned:
+        - Success confirmation of sender verification
+        - Sender activation status
+
+        Parameters
+        ----------
+        sender_id : int
+            Id of the sender
+
+        otp : int
+            6 digit OTP received on email
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.senders.validate_sender_by_otp(
+                sender_id=1000000,
+                otp=123456,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.validate_sender_by_otp(sender_id, otp=otp, request_options=request_options)
+        return _response.data