fathom-python 0.0.27__tar.gz → 0.0.28__tar.gz

{fathom_python-0.0.27 → fathom_python-0.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fathom-python
-Version: 0.0.27
+Version: 0.0.28
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{fathom_python-0.0.27 → fathom_python-0.0.28}/pyproject.toml

@@ -3,7 +3,7 @@ name = "fathom-python"
 
 [tool.poetry]
 name = "fathom-python"
-version = "0.0.27"
+version = "0.0.28"
 description = ""
 readme = "README.md"
 authors = []

{fathom_python-0.0.27 → fathom_python-0.0.28}/src/fathom/__init__.py

@@ -11,7 +11,6 @@ from .types import (
     CrmMatches,
     FathomUser,
     Invitee,
-    ListMeetingsRequestMeetingType,
     Meeting,
     MeetingListResponse,
     MeetingMeetingType,
@@ -41,7 +40,6 @@ __all__ = [
     "CrmMatches",
     "FathomUser",
     "Invitee",
-    "ListMeetingsRequestMeetingType",
     "Meeting",
     "MeetingListResponse",
     "MeetingMeetingType",

fathom_python-0.0.28/src/fathom/base_client.py

@@ -0,0 +1,142 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .environment import FathomApiEnvironment
+from .meetings.client import AsyncMeetingsClient, MeetingsClient
+from .team_members.client import AsyncTeamMembersClient, TeamMembersClient
+from .teams.client import AsyncTeamsClient, TeamsClient
+from .webhooks.client import AsyncWebhooksClient, WebhooksClient
+
+
+class BaseClient:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : FathomApiEnvironment
+        The environment to use for requests from the client. from .environment import FathomApiEnvironment
+
+        Defaults to FathomApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.Client]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from fathom import FathomApi
+    client = FathomApi(api_key="YOUR_API_KEY", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: FathomApiEnvironment = FathomApiEnvironment.DEFAULT,
+        api_key: str,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.meetings = MeetingsClient(client_wrapper=self._client_wrapper)
+        self.teams = TeamsClient(client_wrapper=self._client_wrapper)
+        self.team_members = TeamMembersClient(client_wrapper=self._client_wrapper)
+        self.webhooks = WebhooksClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncBaseClient:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : FathomApiEnvironment
+        The environment to use for requests from the client. from .environment import FathomApiEnvironment
+
+        Defaults to FathomApiEnvironment.DEFAULT
+
+
+
+    api_key : str
+    timeout : typing.Optional[float]
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    httpx_client : typing.Optional[httpx.AsyncClient]
+        The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+
+    Examples
+    --------
+    from fathom import AsyncFathomApi
+    client = AsyncFathomApi(api_key="YOUR_API_KEY", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: FathomApiEnvironment = FathomApiEnvironment.DEFAULT,
+        api_key: str,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self.meetings = AsyncMeetingsClient(client_wrapper=self._client_wrapper)
+        self.teams = AsyncTeamsClient(client_wrapper=self._client_wrapper)
+        self.team_members = AsyncTeamMembersClient(client_wrapper=self._client_wrapper)
+        self.webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper)
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: FathomApiEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

{fathom_python-0.0.27 → fathom_python-0.0.28}/src/fathom/core/client_wrapper.py

@@ -14,10 +14,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "fathom-python/0.0.27",
+            "User-Agent": "fathom-python/0.0.28",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "fathom-python",
-            "X-Fern-SDK-Version": "0.0.27",
+            "X-Fern-SDK-Version": "0.0.28",
         }
         headers["X-Api-Key"] = self.api_key
         return headers

fathom_python-0.0.28/src/fathom/errors/__init__.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .bad_request_error import BadRequestError
+from .not_found_error import NotFoundError
+from .too_many_requests_error import TooManyRequestsError
+from .unauthorized_error import UnauthorizedError
+
+__all__ = ["BadRequestError", "NotFoundError", "TooManyRequestsError", "UnauthorizedError"]

fathom_python-0.0.28/src/fathom/errors/not_found_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class NotFoundError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=404, headers=headers, body=body)

fathom_python-0.0.28/src/fathom/errors/too_many_requests_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class TooManyRequestsError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=429, headers=headers, body=body)

fathom_python-0.0.28/src/fathom/meetings/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import ListMeetingsRequestMeetingType
+
+__all__ = ["ListMeetingsRequestMeetingType"]

fathom_python-0.0.28/src/fathom/meetings/client.py

@@ -0,0 +1,250 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
+from ..core.request_options import RequestOptions
+from ..types.meeting import Meeting
+from .raw_client import AsyncRawMeetingsClient, RawMeetingsClient
+from .types.list_meetings_request_meeting_type import ListMeetingsRequestMeetingType
+
+
+class MeetingsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawMeetingsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawMeetingsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawMeetingsClient
+        """
+        return self._raw_client
+
+    def list_meetings(
+        self,
+        *,
+        calendar_invitees: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        calendar_invitees_domains: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        created_after: typing.Optional[str] = None,
+        created_before: typing.Optional[str] = None,
+        cursor: typing.Optional[str] = None,
+        include_crm_matches: typing.Optional[bool] = None,
+        include_transcript: typing.Optional[bool] = None,
+        meeting_type: typing.Optional[ListMeetingsRequestMeetingType] = None,
+        recorded_by: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        teams: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SyncPager[Meeting]:
+        """
+        Parameters
+        ----------
+        calendar_invitees : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Email address of calendar_invitees to filter by.
+
+            Pass the parameter once per value, e.g.
+            `calendar_invitees[]=cfo@acme.com&calendar_invitees[]=legal@acme.com`.
+
+            Returns meetings where any of the given email addresses appear
+            in the calendar_invitees list.
+
+        calendar_invitees_domains : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Domains of the companies to filter by. Exact match.
+
+            Pass the parameter once per value, e.g.
+            `calendar_invitees_domains[]=acme.com&calendar_invitees_domains[]=client.com`.
+
+            Returns meetings where any of the given company domains appear in the meeting.
+
+        created_after : typing.Optional[str]
+            Filter to meetings with created_at after this timestamp, e.g. `created_after=2025-01-01T00:00:00Z`.
+
+        created_before : typing.Optional[str]
+            Filter to meetings with created_at before this timestamp, e.g. `created_before=2025-01-01T00:00:00Z`.
+
+        cursor : typing.Optional[str]
+            Cursor for pagination.
+
+        include_crm_matches : typing.Optional[bool]
+            Include CRM matches for each meeting. Only returns data from your or your team's linked CRM.
+
+        include_transcript : typing.Optional[bool]
+            Include the transcript for each meeting.
+
+        meeting_type : typing.Optional[ListMeetingsRequestMeetingType]
+            Filter by meeting type.
+
+        recorded_by : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Email addresses of meeting owners.
+
+            Pass the parameter once per value, e.g.
+            `recorded_by[]=ceo@acme.com&recorded_by[]=pm@acme.com`.
+
+            Returns meetings hosted by any of the specified users.
+
+        teams : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Team names to filter by.
+
+            Pass the parameter once per value, e.g.
+            `teams[]=Sales&teams[]=Engineering`.
+
+            Returns meetings that belong to any of the specified teams.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SyncPager[Meeting]
+            Paginated list of meetings.
+
+        Examples
+        --------
+        from fathom import FathomApi
+        client = FathomApi(api_key="YOUR_API_KEY", )
+        response = client.meetings.list_meetings()
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
+        """
+        return self._raw_client.list_meetings(
+            calendar_invitees=calendar_invitees,
+            calendar_invitees_domains=calendar_invitees_domains,
+            created_after=created_after,
+            created_before=created_before,
+            cursor=cursor,
+            include_crm_matches=include_crm_matches,
+            include_transcript=include_transcript,
+            meeting_type=meeting_type,
+            recorded_by=recorded_by,
+            teams=teams,
+            request_options=request_options,
+        )
+
+
+class AsyncMeetingsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawMeetingsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawMeetingsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawMeetingsClient
+        """
+        return self._raw_client
+
+    async def list_meetings(
+        self,
+        *,
+        calendar_invitees: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        calendar_invitees_domains: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        created_after: typing.Optional[str] = None,
+        created_before: typing.Optional[str] = None,
+        cursor: typing.Optional[str] = None,
+        include_crm_matches: typing.Optional[bool] = None,
+        include_transcript: typing.Optional[bool] = None,
+        meeting_type: typing.Optional[ListMeetingsRequestMeetingType] = None,
+        recorded_by: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        teams: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncPager[Meeting]:
+        """
+        Parameters
+        ----------
+        calendar_invitees : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Email address of calendar_invitees to filter by.
+
+            Pass the parameter once per value, e.g.
+            `calendar_invitees[]=cfo@acme.com&calendar_invitees[]=legal@acme.com`.
+
+            Returns meetings where any of the given email addresses appear
+            in the calendar_invitees list.
+
+        calendar_invitees_domains : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Domains of the companies to filter by. Exact match.
+
+            Pass the parameter once per value, e.g.
+            `calendar_invitees_domains[]=acme.com&calendar_invitees_domains[]=client.com`.
+
+            Returns meetings where any of the given company domains appear in the meeting.
+
+        created_after : typing.Optional[str]
+            Filter to meetings with created_at after this timestamp, e.g. `created_after=2025-01-01T00:00:00Z`.
+
+        created_before : typing.Optional[str]
+            Filter to meetings with created_at before this timestamp, e.g. `created_before=2025-01-01T00:00:00Z`.
+
+        cursor : typing.Optional[str]
+            Cursor for pagination.
+
+        include_crm_matches : typing.Optional[bool]
+            Include CRM matches for each meeting. Only returns data from your or your team's linked CRM.
+
+        include_transcript : typing.Optional[bool]
+            Include the transcript for each meeting.
+
+        meeting_type : typing.Optional[ListMeetingsRequestMeetingType]
+            Filter by meeting type.
+
+        recorded_by : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Email addresses of meeting owners.
+
+            Pass the parameter once per value, e.g.
+            `recorded_by[]=ceo@acme.com&recorded_by[]=pm@acme.com`.
+
+            Returns meetings hosted by any of the specified users.
+
+        teams : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            Team names to filter by.
+
+            Pass the parameter once per value, e.g.
+            `teams[]=Sales&teams[]=Engineering`.
+
+            Returns meetings that belong to any of the specified teams.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncPager[Meeting]
+            Paginated list of meetings.
+
+        Examples
+        --------
+        from fathom import AsyncFathomApi
+        import asyncio
+        client = AsyncFathomApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            response = await client.meetings.list_meetings()
+            async for item in response:
+                yield item
+
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
+        asyncio.run(main())
+        """
+        return await self._raw_client.list_meetings(
+            calendar_invitees=calendar_invitees,
+            calendar_invitees_domains=calendar_invitees_domains,
+            created_after=created_after,
+            created_before=created_before,
+            cursor=cursor,
+            include_crm_matches=include_crm_matches,
+            include_transcript=include_transcript,
+            meeting_type=meeting_type,
+            recorded_by=recorded_by,
+            teams=teams,
+            request_options=request_options,
+        )