brevo-python 4.0.1__py3-none-any.whl

brevo/tasks/client.py

@@ -0,0 +1,814 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.task import Task
+from ..types.task_reminder import TaskReminder
+from .raw_client import AsyncRawTasksClient, RawTasksClient
+from .types.get_crm_tasks_request_filter_date import GetCrmTasksRequestFilterDate
+from .types.get_crm_tasks_request_filter_status import GetCrmTasksRequestFilterStatus
+from .types.get_crm_tasks_request_sort import GetCrmTasksRequestSort
+from .types.get_crm_tasks_response import GetCrmTasksResponse
+from .types.get_crm_tasktypes_response import GetCrmTasktypesResponse
+from .types.post_crm_tasks_response import PostCrmTasksResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class TasksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawTasksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawTasksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawTasksClient
+        """
+        return self._raw_client
+
+    def get_all_tasks(
+        self,
+        *,
+        filter_type: typing.Optional[str] = None,
+        filter_status: typing.Optional[GetCrmTasksRequestFilterStatus] = None,
+        filter_date: typing.Optional[GetCrmTasksRequestFilterDate] = None,
+        filter_assign_to: typing.Optional[str] = None,
+        filter_contacts: typing.Optional[str] = None,
+        filter_deals: typing.Optional[str] = None,
+        filter_companies: typing.Optional[str] = None,
+        date_from: typing.Optional[int] = None,
+        date_to: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCrmTasksRequestSort] = None,
+        sort_by: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCrmTasksResponse:
+        """
+        Parameters
+        ----------
+        filter_type : typing.Optional[str]
+            Filter by task type (ID)
+
+        filter_status : typing.Optional[GetCrmTasksRequestFilterStatus]
+            Filter by task status
+
+        filter_date : typing.Optional[GetCrmTasksRequestFilterDate]
+            Filter by date
+
+        filter_assign_to : typing.Optional[str]
+            Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.
+
+        filter_contacts : typing.Optional[str]
+            Filter by contact ids
+
+        filter_deals : typing.Optional[str]
+            Filter by deals ids
+
+        filter_companies : typing.Optional[str]
+            Filter by companies ids
+
+        date_from : typing.Optional[int]
+            dateFrom to date range filter type (timestamp in milliseconds)
+
+        date_to : typing.Optional[int]
+            dateTo to date range filter type (timestamp in milliseconds)
+
+        offset : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCrmTasksRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        sort_by : typing.Optional[str]
+            The field used to sort field names.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCrmTasksResponse
+            Returns task list with filters
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.get_all_tasks(
+            sort_by="name",
+        )
+        """
+        _response = self._raw_client.get_all_tasks(
+            filter_type=filter_type,
+            filter_status=filter_status,
+            filter_date=filter_date,
+            filter_assign_to=filter_assign_to,
+            filter_contacts=filter_contacts,
+            filter_deals=filter_deals,
+            filter_companies=filter_companies,
+            date_from=date_from,
+            date_to=date_to,
+            offset=offset,
+            limit=limit,
+            sort=sort,
+            sort_by=sort_by,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_a_task(
+        self,
+        *,
+        date: dt.datetime,
+        name: str,
+        task_type_id: str,
+        assign_to_id: typing.Optional[str] = OMIT,
+        companies_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        done: typing.Optional[bool] = OMIT,
+        duration: typing.Optional[int] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        reminder: typing.Optional[TaskReminder] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCrmTasksResponse:
+        """
+        Parameters
+        ----------
+        date : dt.datetime
+            Task due date and time
+
+        name : str
+            Name of task
+
+        task_type_id : str
+            Id for type of task e.g Call / Email / Meeting etc.
+
+        assign_to_id : typing.Optional[str]
+            To assign a task to a user you can use either the account email or ID.
+
+        companies_ids : typing.Optional[typing.Sequence[str]]
+            Companies ids for companies a task is linked to
+
+        contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts linked to this task
+
+        deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals a task is linked to
+
+        done : typing.Optional[bool]
+            Task marked as done
+
+        duration : typing.Optional[int]
+            Duration of task in milliseconds [1 minute = 60000 ms]
+
+        notes : typing.Optional[str]
+            Notes added to a task
+
+        reminder : typing.Optional[TaskReminder]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCrmTasksResponse
+            Created new task
+
+        Examples
+        --------
+        import datetime
+
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.create_a_task(
+            date=datetime.datetime.fromisoformat(
+                "2021-11-01 17:44:54+00:00",
+            ),
+            name="Task: Connect with client_dev",
+            task_type_id="61a5cd07ca1347c82306ad09",
+        )
+        """
+        _response = self._raw_client.create_a_task(
+            date=date,
+            name=name,
+            task_type_id=task_type_id,
+            assign_to_id=assign_to_id,
+            companies_ids=companies_ids,
+            contacts_ids=contacts_ids,
+            deals_ids=deals_ids,
+            done=done,
+            duration=duration,
+            notes=notes,
+            reminder=reminder,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_a_task(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Task:
+        """
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Task
+            Returns the Task by id
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.get_a_task(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get_a_task(id, request_options=request_options)
+        return _response.data
+
+    def delete_a_task(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.delete_a_task(
+            id="id",
+        )
+        """
+        _response = self._raw_client.delete_a_task(id, request_options=request_options)
+        return _response.data
+
+    def update_a_task(
+        self,
+        id: str,
+        *,
+        assign_to_id: typing.Optional[str] = OMIT,
+        companies_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        date: typing.Optional[dt.datetime] = OMIT,
+        deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        done: typing.Optional[bool] = OMIT,
+        duration: typing.Optional[int] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        reminder: typing.Optional[TaskReminder] = OMIT,
+        task_type_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        assign_to_id : typing.Optional[str]
+            To assign a task to a user you can use either the account email or ID.
+
+        companies_ids : typing.Optional[typing.Sequence[str]]
+            Companies ids for companies a task is linked to
+
+        contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts linked to this task
+
+        date : typing.Optional[dt.datetime]
+            Task date/time
+
+        deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals a task is linked to
+
+        done : typing.Optional[bool]
+            Task marked as done
+
+        duration : typing.Optional[int]
+            Duration of task in milliseconds [1 minute = 60000 ms]
+
+        name : typing.Optional[str]
+            Name of task
+
+        notes : typing.Optional[str]
+            Notes added to a task
+
+        reminder : typing.Optional[TaskReminder]
+
+        task_type_id : typing.Optional[str]
+            Id for type of task e.g Call / Email / Meeting etc.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.update_a_task(
+            id="id",
+        )
+        """
+        _response = self._raw_client.update_a_task(
+            id,
+            assign_to_id=assign_to_id,
+            companies_ids=companies_ids,
+            contacts_ids=contacts_ids,
+            date=date,
+            deals_ids=deals_ids,
+            done=done,
+            duration=duration,
+            name=name,
+            notes=notes,
+            reminder=reminder,
+            task_type_id=task_type_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_all_task_types(self, *, request_options: typing.Optional[RequestOptions] = None) -> GetCrmTasktypesResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCrmTasktypesResponse
+            Returns all the Task types
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.get_all_task_types()
+        """
+        _response = self._raw_client.get_all_task_types(request_options=request_options)
+        return _response.data
+
+
+class AsyncTasksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawTasksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawTasksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawTasksClient
+        """
+        return self._raw_client
+
+    async def get_all_tasks(
+        self,
+        *,
+        filter_type: typing.Optional[str] = None,
+        filter_status: typing.Optional[GetCrmTasksRequestFilterStatus] = None,
+        filter_date: typing.Optional[GetCrmTasksRequestFilterDate] = None,
+        filter_assign_to: typing.Optional[str] = None,
+        filter_contacts: typing.Optional[str] = None,
+        filter_deals: typing.Optional[str] = None,
+        filter_companies: typing.Optional[str] = None,
+        date_from: typing.Optional[int] = None,
+        date_to: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCrmTasksRequestSort] = None,
+        sort_by: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCrmTasksResponse:
+        """
+        Parameters
+        ----------
+        filter_type : typing.Optional[str]
+            Filter by task type (ID)
+
+        filter_status : typing.Optional[GetCrmTasksRequestFilterStatus]
+            Filter by task status
+
+        filter_date : typing.Optional[GetCrmTasksRequestFilterDate]
+            Filter by date
+
+        filter_assign_to : typing.Optional[str]
+            Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.
+
+        filter_contacts : typing.Optional[str]
+            Filter by contact ids
+
+        filter_deals : typing.Optional[str]
+            Filter by deals ids
+
+        filter_companies : typing.Optional[str]
+            Filter by companies ids
+
+        date_from : typing.Optional[int]
+            dateFrom to date range filter type (timestamp in milliseconds)
+
+        date_to : typing.Optional[int]
+            dateTo to date range filter type (timestamp in milliseconds)
+
+        offset : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCrmTasksRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        sort_by : typing.Optional[str]
+            The field used to sort field names.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCrmTasksResponse
+            Returns task list with filters
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tasks.get_all_tasks(
+                sort_by="name",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_all_tasks(
+            filter_type=filter_type,
+            filter_status=filter_status,
+            filter_date=filter_date,
+            filter_assign_to=filter_assign_to,
+            filter_contacts=filter_contacts,
+            filter_deals=filter_deals,
+            filter_companies=filter_companies,
+            date_from=date_from,
+            date_to=date_to,
+            offset=offset,
+            limit=limit,
+            sort=sort,
+            sort_by=sort_by,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_a_task(
+        self,
+        *,
+        date: dt.datetime,
+        name: str,
+        task_type_id: str,
+        assign_to_id: typing.Optional[str] = OMIT,
+        companies_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        done: typing.Optional[bool] = OMIT,
+        duration: typing.Optional[int] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        reminder: typing.Optional[TaskReminder] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCrmTasksResponse:
+        """
+        Parameters
+        ----------
+        date : dt.datetime
+            Task due date and time
+
+        name : str
+            Name of task
+
+        task_type_id : str
+            Id for type of task e.g Call / Email / Meeting etc.
+
+        assign_to_id : typing.Optional[str]
+            To assign a task to a user you can use either the account email or ID.
+
+        companies_ids : typing.Optional[typing.Sequence[str]]
+            Companies ids for companies a task is linked to
+
+        contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts linked to this task
+
+        deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals a task is linked to
+
+        done : typing.Optional[bool]
+            Task marked as done
+
+        duration : typing.Optional[int]
+            Duration of task in milliseconds [1 minute = 60000 ms]
+
+        notes : typing.Optional[str]
+            Notes added to a task
+
+        reminder : typing.Optional[TaskReminder]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCrmTasksResponse
+            Created new task
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tasks.create_a_task(
+                date=datetime.datetime.fromisoformat(
+                    "2021-11-01 17:44:54+00:00",
+                ),
+                name="Task: Connect with client_dev",
+                task_type_id="61a5cd07ca1347c82306ad09",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_a_task(
+            date=date,
+            name=name,
+            task_type_id=task_type_id,
+            assign_to_id=assign_to_id,
+            companies_ids=companies_ids,
+            contacts_ids=contacts_ids,
+            deals_ids=deals_ids,
+            done=done,
+            duration=duration,
+            notes=notes,
+            reminder=reminder,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_a_task(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Task:
+        """
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Task
+            Returns the Task by id
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tasks.get_a_task(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_a_task(id, request_options=request_options)
+        return _response.data
+
+    async def delete_a_task(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        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.tasks.delete_a_task(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_a_task(id, request_options=request_options)
+        return _response.data
+
+    async def update_a_task(
+        self,
+        id: str,
+        *,
+        assign_to_id: typing.Optional[str] = OMIT,
+        companies_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        date: typing.Optional[dt.datetime] = OMIT,
+        deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        done: typing.Optional[bool] = OMIT,
+        duration: typing.Optional[int] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        notes: typing.Optional[str] = OMIT,
+        reminder: typing.Optional[TaskReminder] = OMIT,
+        task_type_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        assign_to_id : typing.Optional[str]
+            To assign a task to a user you can use either the account email or ID.
+
+        companies_ids : typing.Optional[typing.Sequence[str]]
+            Companies ids for companies a task is linked to
+
+        contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts linked to this task
+
+        date : typing.Optional[dt.datetime]
+            Task date/time
+
+        deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals a task is linked to
+
+        done : typing.Optional[bool]
+            Task marked as done
+
+        duration : typing.Optional[int]
+            Duration of task in milliseconds [1 minute = 60000 ms]
+
+        name : typing.Optional[str]
+            Name of task
+
+        notes : typing.Optional[str]
+            Notes added to a task
+
+        reminder : typing.Optional[TaskReminder]
+
+        task_type_id : typing.Optional[str]
+            Id for type of task e.g Call / Email / Meeting etc.
+
+        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.tasks.update_a_task(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_a_task(
+            id,
+            assign_to_id=assign_to_id,
+            companies_ids=companies_ids,
+            contacts_ids=contacts_ids,
+            date=date,
+            deals_ids=deals_ids,
+            done=done,
+            duration=duration,
+            name=name,
+            notes=notes,
+            reminder=reminder,
+            task_type_id=task_type_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_all_task_types(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetCrmTasktypesResponse:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCrmTasktypesResponse
+            Returns all the Task types
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tasks.get_all_task_types()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_all_task_types(request_options=request_options)
+        return _response.data