samsara-api 3.0.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

samsara/contacts/client.py

@@ -3,10 +3,10 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
-from ..types.contact import Contact
 from ..types.contact_response import ContactResponse
+from ..types.list_contacts_response import ListContactsResponse
+from ..types.standard_delete_response import StandardDeleteResponse
 from .raw_client import AsyncRawContactsClient, RawContactsClient
 
 # this is used as the default value for optional parameters
@@ -28,13 +28,13 @@ class ContactsClient:
         """
         return self._raw_client
 
-    def list(
+    def list_contacts(
         self,
         *,
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> SyncPager[Contact]:
+    ) -> ListContactsResponse:
         """
         Returns a list of all contacts in an organization.
 
@@ -55,7 +55,7 @@ class ContactsClient:
 
         Returns
         -------
-        SyncPager[Contact]
+        ListContactsResponse
             List of all contacts
 
         Examples
@@ -65,16 +65,15 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        response = client.contacts.list()
-        for item in response:
-            yield item
-        # alternatively, you can paginate page-by-page
-        for page in response.iter_pages():
-            yield page
+        client.contacts.list_contacts(
+            limit=1000000,
+            after="after",
+        )
         """
-        return self._raw_client.list(limit=limit, after=after, request_options=request_options)
+        _response = self._raw_client.list_contacts(limit=limit, after=after, request_options=request_options)
+        return _response.data
 
-    def create(
+    def create_contact(
         self,
         *,
         email: typing.Optional[str] = OMIT,
@@ -119,14 +118,14 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.contacts.create()
+        client.contacts.create_contact()
         """
-        _response = self._raw_client.create(
+        _response = self._raw_client.create_contact(
             email=email, first_name=first_name, last_name=last_name, phone=phone, request_options=request_options
         )
         return _response.data
 
-    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ContactResponse:
+    def get_contact(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ContactResponse:
         """
         Get a specific contact's information.
 
@@ -154,16 +153,16 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.contacts.get(
+        client.contacts.get_contact(
             id="id",
         )
         """
-        _response = self._raw_client.get(id, request_options=request_options)
+        _response = self._raw_client.get_contact(id, request_options=request_options)
         return _response.data
 
-    def delete(
+    def delete_contact(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.Optional[typing.Any]:
+    ) -> StandardDeleteResponse:
         """
         Delete the given contact.
 
@@ -181,7 +180,7 @@ class ContactsClient:
 
         Returns
         -------
-        typing.Optional[typing.Any]
+        StandardDeleteResponse
             A successful DELETE response is a 204 with no content.
 
         Examples
@@ -191,14 +190,14 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.contacts.delete(
+        client.contacts.delete_contact(
             id="id",
         )
         """
-        _response = self._raw_client.delete(id, request_options=request_options)
+        _response = self._raw_client.delete_contact(id, request_options=request_options)
         return _response.data
 
-    def update(
+    def update_contact(
         self,
         id: str,
         *,
@@ -247,11 +246,11 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.contacts.update(
+        client.contacts.update_contact(
             id="id",
         )
         """
-        _response = self._raw_client.update(
+        _response = self._raw_client.update_contact(
             id, email=email, first_name=first_name, last_name=last_name, phone=phone, request_options=request_options
         )
         return _response.data
@@ -272,13 +271,13 @@ class AsyncContactsClient:
         """
         return self._raw_client
 
-    async def list(
+    async def list_contacts(
         self,
         *,
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncPager[Contact]:
+    ) -> ListContactsResponse:
         """
         Returns a list of all contacts in an organization.
 
@@ -299,7 +298,7 @@ class AsyncContactsClient:
 
         Returns
         -------
-        AsyncPager[Contact]
+        ListContactsResponse
             List of all contacts
 
         Examples
@@ -314,20 +313,18 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            response = await client.contacts.list()
-            async for item in response:
-                yield item
-
-            # alternatively, you can paginate page-by-page
-            async for page in response.iter_pages():
-                yield page
+            await client.contacts.list_contacts(
+                limit=1000000,
+                after="after",
+            )
 
 
         asyncio.run(main())
         """
-        return await self._raw_client.list(limit=limit, after=after, request_options=request_options)
+        _response = await self._raw_client.list_contacts(limit=limit, after=after, request_options=request_options)
+        return _response.data
 
-    async def create(
+    async def create_contact(
         self,
         *,
         email: typing.Optional[str] = OMIT,
@@ -377,17 +374,17 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.create()
+            await client.contacts.create_contact()
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.create(
+        _response = await self._raw_client.create_contact(
             email=email, first_name=first_name, last_name=last_name, phone=phone, request_options=request_options
         )
         return _response.data
 
-    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ContactResponse:
+    async def get_contact(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ContactResponse:
         """
         Get a specific contact's information.
 
@@ -420,19 +417,19 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.get(
+            await client.contacts.get_contact(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get(id, request_options=request_options)
+        _response = await self._raw_client.get_contact(id, request_options=request_options)
         return _response.data
 
-    async def delete(
+    async def delete_contact(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.Optional[typing.Any]:
+    ) -> StandardDeleteResponse:
         """
         Delete the given contact.
 
@@ -450,7 +447,7 @@ class AsyncContactsClient:
 
         Returns
         -------
-        typing.Optional[typing.Any]
+        StandardDeleteResponse
             A successful DELETE response is a 204 with no content.
 
         Examples
@@ -465,17 +462,17 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.delete(
+            await client.contacts.delete_contact(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete(id, request_options=request_options)
+        _response = await self._raw_client.delete_contact(id, request_options=request_options)
         return _response.data
 
-    async def update(
+    async def update_contact(
         self,
         id: str,
         *,
@@ -529,14 +526,14 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.update(
+            await client.contacts.update_contact(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.update(
+        _response = await self._raw_client.update_contact(
             id, email=email, first_name=first_name, last_name=last_name, phone=phone, request_options=request_options
         )
         return _response.data

samsara/contacts/raw_client.py

@@ -7,12 +7,11 @@ from ..core.api_error import ApiError
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.http_response import AsyncHttpResponse, HttpResponse
 from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pagination import AsyncPager, BaseHttpResponse, SyncPager
 from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
-from ..types.contact import Contact
 from ..types.contact_response import ContactResponse
 from ..types.list_contacts_response import ListContactsResponse
+from ..types.standard_delete_response import StandardDeleteResponse
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -22,13 +21,13 @@ class RawContactsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def list(
+    def list_contacts(
         self,
         *,
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> SyncPager[Contact]:
+    ) -> HttpResponse[ListContactsResponse]:
         """
         Returns a list of all contacts in an organization.
 
@@ -49,7 +48,7 @@ class RawContactsClient:
 
         Returns
         -------
-        SyncPager[Contact]
+        HttpResponse[ListContactsResponse]
             List of all contacts
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -63,33 +62,20 @@ class RawContactsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _parsed_response = typing.cast(
+                _data = typing.cast(
                     ListContactsResponse,
                     parse_obj_as(
                         type_=ListContactsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                _items = _parsed_response.data
-                _has_next = False
-                _get_next = None
-                if _parsed_response.pagination is not None:
-                    _parsed_next = _parsed_response.pagination.end_cursor
-                    _has_next = _parsed_next is not None and _parsed_next != ""
-                    _get_next = lambda: self.list(
-                        limit=limit,
-                        after=_parsed_next,
-                        request_options=request_options,
-                    )
-                return SyncPager(
-                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
-                )
+                return HttpResponse(response=_response, data=_data)
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def create(
+    def create_contact(
         self,
         *,
         email: typing.Optional[str] = OMIT,
@@ -157,7 +143,9 @@ class RawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[ContactResponse]:
+    def get_contact(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[ContactResponse]:
         """
         Get a specific contact's information.
 
@@ -198,9 +186,9 @@ class RawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def delete(
+    def delete_contact(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[typing.Optional[typing.Any]]:
+    ) -> HttpResponse[StandardDeleteResponse]:
         """
         Delete the given contact.
 
@@ -218,7 +206,7 @@ class RawContactsClient:
 
         Returns
         -------
-        HttpResponse[typing.Optional[typing.Any]]
+        HttpResponse[StandardDeleteResponse]
             A successful DELETE response is a 204 with no content.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -227,13 +215,11 @@ class RawContactsClient:
             request_options=request_options,
         )
         try:
-            if _response is None or not _response.text.strip():
-                return HttpResponse(response=_response, data=None)
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.Optional[typing.Any],
+                    StandardDeleteResponse,
                     parse_obj_as(
-                        type_=typing.Optional[typing.Any],  # type: ignore
+                        type_=StandardDeleteResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -243,7 +229,7 @@ class RawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def update(
+    def update_contact(
         self,
         id: str,
         *,
@@ -320,13 +306,13 @@ class AsyncRawContactsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def list(
+    async def list_contacts(
         self,
         *,
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncPager[Contact]:
+    ) -> AsyncHttpResponse[ListContactsResponse]:
         """
         Returns a list of all contacts in an organization.
 
@@ -347,7 +333,7 @@ class AsyncRawContactsClient:
 
         Returns
         -------
-        AsyncPager[Contact]
+        AsyncHttpResponse[ListContactsResponse]
             List of all contacts
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -361,36 +347,20 @@ class AsyncRawContactsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _parsed_response = typing.cast(
+                _data = typing.cast(
                     ListContactsResponse,
                     parse_obj_as(
                         type_=ListContactsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                _items = _parsed_response.data
-                _has_next = False
-                _get_next = None
-                if _parsed_response.pagination is not None:
-                    _parsed_next = _parsed_response.pagination.end_cursor
-                    _has_next = _parsed_next is not None and _parsed_next != ""
-
-                    async def _get_next():
-                        return await self.list(
-                            limit=limit,
-                            after=_parsed_next,
-                            request_options=request_options,
-                        )
-
-                return AsyncPager(
-                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
-                )
+                return AsyncHttpResponse(response=_response, data=_data)
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def create(
+    async def create_contact(
         self,
         *,
         email: typing.Optional[str] = OMIT,
@@ -458,7 +428,7 @@ class AsyncRawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def get(
+    async def get_contact(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[ContactResponse]:
         """
@@ -501,9 +471,9 @@ class AsyncRawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def delete(
+    async def delete_contact(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[typing.Optional[typing.Any]]:
+    ) -> AsyncHttpResponse[StandardDeleteResponse]:
         """
         Delete the given contact.
 
@@ -521,7 +491,7 @@ class AsyncRawContactsClient:
 
         Returns
         -------
-        AsyncHttpResponse[typing.Optional[typing.Any]]
+        AsyncHttpResponse[StandardDeleteResponse]
             A successful DELETE response is a 204 with no content.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -530,13 +500,11 @@ class AsyncRawContactsClient:
             request_options=request_options,
         )
         try:
-            if _response is None or not _response.text.strip():
-                return AsyncHttpResponse(response=_response, data=None)
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.Optional[typing.Any],
+                    StandardDeleteResponse,
                     parse_obj_as(
-                        type_=typing.Optional[typing.Any],  # type: ignore
+                        type_=StandardDeleteResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -546,7 +514,7 @@ class AsyncRawContactsClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    async def update(
+    async def update_contact(
         self,
         id: str,
         *,

samsara/core/__init__.py

@@ -2,27 +2,82 @@
 
 # isort: skip_file
 
-from .api_error import ApiError
-from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
-from .datetime_utils import serialize_datetime
-from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
-from .http_client import AsyncHttpClient, HttpClient
-from .http_response import AsyncHttpResponse, HttpResponse
-from .jsonable_encoder import jsonable_encoder
-from .pagination import AsyncPager, SyncPager
-from .pydantic_utilities import (
-    IS_PYDANTIC_V2,
-    UniversalBaseModel,
-    UniversalRootModel,
-    parse_obj_as,
-    universal_field_validator,
-    universal_root_validator,
-    update_forward_refs,
-)
-from .query_encoder import encode_query
-from .remove_none_from_dict import remove_none_from_dict
-from .request_options import RequestOptions
-from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .api_error import ApiError
+    from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+    from .datetime_utils import serialize_datetime
+    from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
+    from .http_client import AsyncHttpClient, HttpClient
+    from .http_response import AsyncHttpResponse, HttpResponse
+    from .jsonable_encoder import jsonable_encoder
+    from .pagination import AsyncPager, SyncPager
+    from .pydantic_utilities import (
+        IS_PYDANTIC_V2,
+        UniversalBaseModel,
+        UniversalRootModel,
+        parse_obj_as,
+        universal_field_validator,
+        universal_root_validator,
+        update_forward_refs,
+    )
+    from .query_encoder import encode_query
+    from .remove_none_from_dict import remove_none_from_dict
+    from .request_options import RequestOptions
+    from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApiError": ".api_error",
+    "AsyncClientWrapper": ".client_wrapper",
+    "AsyncHttpClient": ".http_client",
+    "AsyncHttpResponse": ".http_response",
+    "AsyncPager": ".pagination",
+    "BaseClientWrapper": ".client_wrapper",
+    "FieldMetadata": ".serialization",
+    "File": ".file",
+    "HttpClient": ".http_client",
+    "HttpResponse": ".http_response",
+    "IS_PYDANTIC_V2": ".pydantic_utilities",
+    "RequestOptions": ".request_options",
+    "SyncClientWrapper": ".client_wrapper",
+    "SyncPager": ".pagination",
+    "UniversalBaseModel": ".pydantic_utilities",
+    "UniversalRootModel": ".pydantic_utilities",
+    "convert_and_respect_annotation_metadata": ".serialization",
+    "convert_file_dict_to_httpx_tuples": ".file",
+    "encode_query": ".query_encoder",
+    "jsonable_encoder": ".jsonable_encoder",
+    "parse_obj_as": ".pydantic_utilities",
+    "remove_none_from_dict": ".remove_none_from_dict",
+    "serialize_datetime": ".datetime_utils",
+    "universal_field_validator": ".pydantic_utilities",
+    "universal_root_validator": ".pydantic_utilities",
+    "update_forward_refs": ".pydantic_utilities",
+    "with_content_type": ".file",
+}
+
+
+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__ = [
     "ApiError",