samsara-api 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

samsara/coaching/sessions/raw_client.py

@@ -7,7 +7,7 @@ from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.datetime_utils import serialize_datetime
-from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.pagination import AsyncPager, BaseHttpResponse, SyncPager
 from ...core.pydantic_utilities import parse_obj_as
 from ...core.request_options import RequestOptions
 from ...errors.bad_gateway_error import BadGatewayError
@@ -22,6 +22,7 @@ from ...errors.unauthorized_error import UnauthorizedError
 from ...types.coaching_sessions_get_coaching_sessions_response_body import (
     CoachingSessionsGetCoachingSessionsResponseBody,
 )
+from ...types.coaching_sessions_response_response_body import CoachingSessionsResponseResponseBody
 
 
 class RawSessionsClient:
@@ -40,7 +41,7 @@ class RawSessionsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[CoachingSessionsGetCoachingSessionsResponseBody]:
+    ) -> SyncPager[CoachingSessionsResponseResponseBody]:
         """
         This endpoint will return coaching sessions for your organization based on the time parameters passed in. Results are paginated by sessions. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.
 
@@ -82,7 +83,7 @@ class RawSessionsClient:
 
         Returns
         -------
-        HttpResponse[CoachingSessionsGetCoachingSessionsResponseBody]
+        SyncPager[CoachingSessionsResponseResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -102,14 +103,33 @@ class RawSessionsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     CoachingSessionsGetCoachingSessionsResponseBody,
                     parse_obj_as(
                         type_=CoachingSessionsGetCoachingSessionsResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return HttpResponse(response=_response, data=_data)
+                _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.stream(
+                        start_time=start_time,
+                        driver_ids=driver_ids,
+                        coach_ids=coach_ids,
+                        session_statuses=session_statuses,
+                        include_coachable_events=include_coachable_events,
+                        end_time=end_time,
+                        after=_parsed_next,
+                        include_external_ids=include_external_ids,
+                        request_options=request_options,
+                    )
+                return SyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),
@@ -231,7 +251,7 @@ class AsyncRawSessionsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[CoachingSessionsGetCoachingSessionsResponseBody]:
+    ) -> AsyncPager[CoachingSessionsResponseResponseBody]:
         """
         This endpoint will return coaching sessions for your organization based on the time parameters passed in. Results are paginated by sessions. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.
 
@@ -273,7 +293,7 @@ class AsyncRawSessionsClient:
 
         Returns
         -------
-        AsyncHttpResponse[CoachingSessionsGetCoachingSessionsResponseBody]
+        AsyncPager[CoachingSessionsResponseResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -293,14 +313,36 @@ class AsyncRawSessionsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     CoachingSessionsGetCoachingSessionsResponseBody,
                     parse_obj_as(
                         type_=CoachingSessionsGetCoachingSessionsResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return AsyncHttpResponse(response=_response, data=_data)
+                _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.stream(
+                            start_time=start_time,
+                            driver_ids=driver_ids,
+                            coach_ids=coach_ids,
+                            session_statuses=session_statuses,
+                            include_coachable_events=include_coachable_events,
+                            end_time=end_time,
+                            after=_parsed_next,
+                            include_external_ids=include_external_ids,
+                            request_options=request_options,
+                        )
+
+                return AsyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),

samsara/contacts/client.py

@@ -3,9 +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 .raw_client import AsyncRawContactsClient, RawContactsClient
 
 # this is used as the default value for optional parameters
@@ -33,7 +34,7 @@ class ContactsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListContactsResponse:
+    ) -> SyncPager[Contact]:
         """
         Returns a list of all contacts in an organization.
 
@@ -54,7 +55,7 @@ class ContactsClient:
 
         Returns
         -------
-        ListContactsResponse
+        SyncPager[Contact]
             List of all contacts
 
         Examples
@@ -64,10 +65,14 @@ class ContactsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.contacts.list()
+        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
         """
-        _response = self._raw_client.list(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(limit=limit, after=after, request_options=request_options)
 
     def create(
         self,
@@ -273,7 +278,7 @@ class AsyncContactsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListContactsResponse:
+    ) -> AsyncPager[Contact]:
         """
         Returns a list of all contacts in an organization.
 
@@ -294,7 +299,7 @@ class AsyncContactsClient:
 
         Returns
         -------
-        ListContactsResponse
+        AsyncPager[Contact]
             List of all contacts
 
         Examples
@@ -309,13 +314,18 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.list()
+            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
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(limit=limit, after=after, request_options=request_options)
 
     async def create(
         self,

samsara/contacts/raw_client.py

@@ -7,8 +7,10 @@ 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
 
@@ -26,7 +28,7 @@ class RawContactsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListContactsResponse]:
+    ) -> SyncPager[Contact]:
         """
         Returns a list of all contacts in an organization.
 
@@ -47,7 +49,7 @@ class RawContactsClient:
 
         Returns
         -------
-        HttpResponse[ListContactsResponse]
+        SyncPager[Contact]
             List of all contacts
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -61,14 +63,27 @@ class RawContactsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListContactsResponse,
                     parse_obj_as(
                         type_=ListContactsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return HttpResponse(response=_response, data=_data)
+                _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)
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
@@ -311,7 +326,7 @@ class AsyncRawContactsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListContactsResponse]:
+    ) -> AsyncPager[Contact]:
         """
         Returns a list of all contacts in an organization.
 
@@ -332,7 +347,7 @@ class AsyncRawContactsClient:
 
         Returns
         -------
-        AsyncHttpResponse[ListContactsResponse]
+        AsyncPager[Contact]
             List of all contacts
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -346,14 +361,30 @@ class AsyncRawContactsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListContactsResponse,
                     parse_obj_as(
                         type_=ListContactsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return AsyncHttpResponse(response=_response, data=_data)
+                _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)
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)

samsara/core/client_wrapper.py

@@ -20,10 +20,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "samsara-api/0.0.1",
+            "User-Agent": "samsara-api/0.0.2",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "samsara-api",
-            "X-Fern-SDK-Version": "0.0.1",
+            "X-Fern-SDK-Version": "0.0.2",
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers

samsara/defect_types/client.py

@@ -3,8 +3,9 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
-from ..types.dvir_defect_type_get_defect_types_response_body import DvirDefectTypeGetDefectTypesResponseBody
+from ..types.defect_types_response_data_response_body import DefectTypesResponseDataResponseBody
 from .raw_client import AsyncRawDefectTypesClient, RawDefectTypesClient
 
 
@@ -30,7 +31,7 @@ class DefectTypesClient:
         limit: typing.Optional[int] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> DvirDefectTypeGetDefectTypesResponseBody:
+    ) -> SyncPager[DefectTypesResponseDataResponseBody]:
         """
         Get DVIR defect types.
 
@@ -57,7 +58,7 @@ class DefectTypesClient:
 
         Returns
         -------
-        DvirDefectTypeGetDefectTypesResponseBody
+        SyncPager[DefectTypesResponseDataResponseBody]
             OK response.
 
         Examples
@@ -67,10 +68,14 @@ class DefectTypesClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.defect_types.list()
+        response = client.defect_types.list()
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
         """
-        _response = self._raw_client.list(after=after, limit=limit, ids=ids, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(after=after, limit=limit, ids=ids, request_options=request_options)
 
 
 class AsyncDefectTypesClient:
@@ -95,7 +100,7 @@ class AsyncDefectTypesClient:
         limit: typing.Optional[int] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> DvirDefectTypeGetDefectTypesResponseBody:
+    ) -> AsyncPager[DefectTypesResponseDataResponseBody]:
         """
         Get DVIR defect types.
 
@@ -122,7 +127,7 @@ class AsyncDefectTypesClient:
 
         Returns
         -------
-        DvirDefectTypeGetDefectTypesResponseBody
+        AsyncPager[DefectTypesResponseDataResponseBody]
             OK response.
 
         Examples
@@ -137,10 +142,15 @@ class AsyncDefectTypesClient:
 
 
         async def main() -> None:
-            await client.defect_types.list()
+            response = await client.defect_types.list()
+            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())
         """
-        _response = await self._raw_client.list(after=after, limit=limit, ids=ids, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(after=after, limit=limit, ids=ids, request_options=request_options)

samsara/defect_types/raw_client.py

@@ -5,7 +5,7 @@ from json.decoder import JSONDecodeError
 
 from ..core.api_error import ApiError
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pagination import AsyncPager, BaseHttpResponse, SyncPager
 from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
 from ..errors.bad_gateway_error import BadGatewayError
@@ -17,6 +17,7 @@ from ..errors.not_implemented_error import NotImplementedError
 from ..errors.service_unavailable_error import ServiceUnavailableError
 from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unauthorized_error import UnauthorizedError
+from ..types.defect_types_response_data_response_body import DefectTypesResponseDataResponseBody
 from ..types.dvir_defect_type_get_defect_types_response_body import DvirDefectTypeGetDefectTypesResponseBody
 
 
@@ -31,7 +32,7 @@ class RawDefectTypesClient:
         limit: typing.Optional[int] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[DvirDefectTypeGetDefectTypesResponseBody]:
+    ) -> SyncPager[DefectTypesResponseDataResponseBody]:
         """
         Get DVIR defect types.
 
@@ -58,7 +59,7 @@ class RawDefectTypesClient:
 
         Returns
         -------
-        HttpResponse[DvirDefectTypeGetDefectTypesResponseBody]
+        SyncPager[DefectTypesResponseDataResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -73,14 +74,28 @@ class RawDefectTypesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     DvirDefectTypeGetDefectTypesResponseBody,
                     parse_obj_as(
                         type_=DvirDefectTypeGetDefectTypesResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return HttpResponse(response=_response, data=_data)
+                _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(
+                        after=_parsed_next,
+                        limit=limit,
+                        ids=ids,
+                        request_options=request_options,
+                    )
+                return SyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),
@@ -197,7 +212,7 @@ class AsyncRawDefectTypesClient:
         limit: typing.Optional[int] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[DvirDefectTypeGetDefectTypesResponseBody]:
+    ) -> AsyncPager[DefectTypesResponseDataResponseBody]:
         """
         Get DVIR defect types.
 
@@ -224,7 +239,7 @@ class AsyncRawDefectTypesClient:
 
         Returns
         -------
-        AsyncHttpResponse[DvirDefectTypeGetDefectTypesResponseBody]
+        AsyncPager[DefectTypesResponseDataResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -239,14 +254,31 @@ class AsyncRawDefectTypesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     DvirDefectTypeGetDefectTypesResponseBody,
                     parse_obj_as(
                         type_=DvirDefectTypeGetDefectTypesResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return AsyncHttpResponse(response=_response, data=_data)
+                _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(
+                            after=_parsed_next,
+                            limit=limit,
+                            ids=ids,
+                            request_options=request_options,
+                        )
+
+                return AsyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),