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

samsara/driver_trailer_assignments/client.py

@@ -3,13 +3,14 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
+from ..types.get_driver_trailer_assignments_response_body_response_body import (
+    GetDriverTrailerAssignmentsResponseBodyResponseBody,
+)
 from ..types.trailer_assignments_create_driver_trailer_assignment_response_body import (
     TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody,
 )
-from ..types.trailer_assignments_get_driver_trailer_assignments_response_body import (
-    TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody,
-)
 from ..types.trailer_assignments_update_driver_trailer_assignment_response_body import (
     TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody,
 )
@@ -41,7 +42,7 @@ class DriverTrailerAssignmentsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody:
+    ) -> SyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]:
         """
         Get currently active driver-trailer assignments for driver.
 
@@ -68,7 +69,7 @@ class DriverTrailerAssignmentsClient:
 
         Returns
         -------
-        TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody
+        SyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]
             OK response.
 
         Examples
@@ -78,15 +79,19 @@ class DriverTrailerAssignmentsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.driver_trailer_assignments.list()
+        response = client.driver_trailer_assignments.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(
+        return self._raw_client.list(
             driver_ids=driver_ids,
             after=after,
             include_external_ids=include_external_ids,
             request_options=request_options,
         )
-        return _response.data
 
     def create(
         self,
@@ -209,7 +214,7 @@ class AsyncDriverTrailerAssignmentsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody:
+    ) -> AsyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]:
         """
         Get currently active driver-trailer assignments for driver.
 
@@ -236,7 +241,7 @@ class AsyncDriverTrailerAssignmentsClient:
 
         Returns
         -------
-        TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody
+        AsyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]
             OK response.
 
         Examples
@@ -251,18 +256,23 @@ class AsyncDriverTrailerAssignmentsClient:
 
 
         async def main() -> None:
-            await client.driver_trailer_assignments.list()
+            response = await client.driver_trailer_assignments.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(
+        return await self._raw_client.list(
             driver_ids=driver_ids,
             after=after,
             include_external_ids=include_external_ids,
             request_options=request_options,
         )
-        return _response.data
 
     async def create(
         self,

samsara/driver_trailer_assignments/raw_client.py

@@ -6,6 +6,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 +18,9 @@ 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.get_driver_trailer_assignments_response_body_response_body import (
+    GetDriverTrailerAssignmentsResponseBodyResponseBody,
+)
 from ..types.trailer_assignments_create_driver_trailer_assignment_response_body import (
     TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody,
 )
@@ -42,7 +46,7 @@ class RawDriverTrailerAssignmentsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody]:
+    ) -> SyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]:
         """
         Get currently active driver-trailer assignments for driver.
 
@@ -69,7 +73,7 @@ class RawDriverTrailerAssignmentsClient:
 
         Returns
         -------
-        HttpResponse[TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody]
+        SyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -84,14 +88,28 @@ class RawDriverTrailerAssignmentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody,
                     parse_obj_as(
                         type_=TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody,  # 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(
+                        driver_ids=driver_ids,
+                        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),
@@ -531,7 +549,7 @@ class AsyncRawDriverTrailerAssignmentsClient:
         after: typing.Optional[str] = None,
         include_external_ids: typing.Optional[bool] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody]:
+    ) -> AsyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]:
         """
         Get currently active driver-trailer assignments for driver.
 
@@ -558,7 +576,7 @@ class AsyncRawDriverTrailerAssignmentsClient:
 
         Returns
         -------
-        AsyncHttpResponse[TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody]
+        AsyncPager[GetDriverTrailerAssignmentsResponseBodyResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -573,14 +591,31 @@ class AsyncRawDriverTrailerAssignmentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody,
                     parse_obj_as(
                         type_=TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody,  # 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(
+                            driver_ids=driver_ids,
+                            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/drivers/__init__.py

@@ -8,7 +8,7 @@ from .types import (
     UpdateDriverRequestDriverActivationStatus,
     UpdateDriverRequestLocale,
 )
-from . import qr_codes, tachograph_activity, tachograph_files, vehicle_assignments
+from . import qr_codes, vehicle_assignments
 from .vehicle_assignments import VehicleAssignmentsListRequestDriverActivationStatus
 
 __all__ = [
@@ -18,7 +18,5 @@ __all__ = [
     "UpdateDriverRequestLocale",
     "VehicleAssignmentsListRequestDriverActivationStatus",
     "qr_codes",
-    "tachograph_activity",
-    "tachograph_files",
     "vehicle_assignments",
 ]

samsara/drivers/client.py

@@ -3,8 +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.create_driver_request_attributes import CreateDriverRequestAttributes
+from ..types.driver import Driver
 from ..types.driver_carrier_settings import DriverCarrierSettings
 from ..types.driver_has_driving_features_hidden import DriverHasDrivingFeaturesHidden
 from ..types.driver_hos_setting import DriverHosSetting
@@ -12,13 +14,10 @@ from ..types.driver_remote_signout_post_driver_remote_signout_response_body impo
     DriverRemoteSignoutPostDriverRemoteSignoutResponseBody,
 )
 from ..types.driver_response import DriverResponse
-from ..types.list_drivers_response import ListDriversResponse
 from ..types.update_driver_request_hos_setting import UpdateDriverRequestHosSetting
 from ..types.us_driver_ruleset_override import UsDriverRulesetOverride
 from .qr_codes.client import AsyncQrCodesClient, QrCodesClient
 from .raw_client import AsyncRawDriversClient, RawDriversClient
-from .tachograph_activity.client import AsyncTachographActivityClient, TachographActivityClient
-from .tachograph_files.client import AsyncTachographFilesClient, TachographFilesClient
 from .types.create_driver_request_locale import CreateDriverRequestLocale
 from .types.drivers_list_request_driver_activation_status import DriversListRequestDriverActivationStatus
 from .types.update_driver_request_driver_activation_status import UpdateDriverRequestDriverActivationStatus
@@ -34,10 +33,6 @@ class DriversClient:
         self._raw_client = RawDriversClient(client_wrapper=client_wrapper)
         self.qr_codes = QrCodesClient(client_wrapper=client_wrapper)
 
-        self.tachograph_activity = TachographActivityClient(client_wrapper=client_wrapper)
-
-        self.tachograph_files = TachographFilesClient(client_wrapper=client_wrapper)
-
         self.vehicle_assignments = VehicleAssignmentsClient(client_wrapper=client_wrapper)
 
     @property
@@ -63,7 +58,7 @@ class DriversClient:
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListDriversResponse:
+    ) -> SyncPager[Driver]:
         """
         Get all drivers in organization.
 
@@ -102,7 +97,7 @@ class DriversClient:
 
         Returns
         -------
-        ListDriversResponse
+        SyncPager[Driver]
             List of all driver objects.
 
         Examples
@@ -112,9 +107,14 @@ class DriversClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.drivers.list()
+        response = client.drivers.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(
+        return self._raw_client.list(
             driver_activation_status=driver_activation_status,
             limit=limit,
             after=after,
@@ -125,7 +125,6 @@ class DriversClient:
             created_after_time=created_after_time,
             request_options=request_options,
         )
-        return _response.data
 
     def create(
         self,
@@ -585,10 +584,6 @@ class AsyncDriversClient:
         self._raw_client = AsyncRawDriversClient(client_wrapper=client_wrapper)
         self.qr_codes = AsyncQrCodesClient(client_wrapper=client_wrapper)
 
-        self.tachograph_activity = AsyncTachographActivityClient(client_wrapper=client_wrapper)
-
-        self.tachograph_files = AsyncTachographFilesClient(client_wrapper=client_wrapper)
-
         self.vehicle_assignments = AsyncVehicleAssignmentsClient(client_wrapper=client_wrapper)
 
     @property
@@ -614,7 +609,7 @@ class AsyncDriversClient:
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListDriversResponse:
+    ) -> AsyncPager[Driver]:
         """
         Get all drivers in organization.
 
@@ -653,7 +648,7 @@ class AsyncDriversClient:
 
         Returns
         -------
-        ListDriversResponse
+        AsyncPager[Driver]
             List of all driver objects.
 
         Examples
@@ -668,12 +663,18 @@ class AsyncDriversClient:
 
 
         async def main() -> None:
-            await client.drivers.list()
+            response = await client.drivers.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(
+        return await self._raw_client.list(
             driver_activation_status=driver_activation_status,
             limit=limit,
             after=after,
@@ -684,7 +685,6 @@ class AsyncDriversClient:
             created_after_time=created_after_time,
             request_options=request_options,
         )
-        return _response.data
 
     async def create(
         self,

samsara/drivers/raw_client.py

@@ -7,6 +7,7 @@ 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 ..core.serialization import convert_and_respect_annotation_metadata
@@ -20,6 +21,7 @@ from ..errors.service_unavailable_error import ServiceUnavailableError
 from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unauthorized_error import UnauthorizedError
 from ..types.create_driver_request_attributes import CreateDriverRequestAttributes
+from ..types.driver import Driver
 from ..types.driver_carrier_settings import DriverCarrierSettings
 from ..types.driver_has_driving_features_hidden import DriverHasDrivingFeaturesHidden
 from ..types.driver_hos_setting import DriverHosSetting
@@ -55,7 +57,7 @@ class RawDriversClient:
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListDriversResponse]:
+    ) -> SyncPager[Driver]:
         """
         Get all drivers in organization.
 
@@ -94,7 +96,7 @@ class RawDriversClient:
 
         Returns
         -------
-        HttpResponse[ListDriversResponse]
+        SyncPager[Driver]
             List of all driver objects.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -114,14 +116,33 @@ class RawDriversClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListDriversResponse,
                     parse_obj_as(
                         type_=ListDriversResponse,  # 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(
+                        driver_activation_status=driver_activation_status,
+                        limit=limit,
+                        after=_parsed_next,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        attribute_value_ids=attribute_value_ids,
+                        updated_after_time=updated_after_time,
+                        created_after_time=created_after_time,
+                        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)
@@ -747,7 +768,7 @@ class AsyncRawDriversClient:
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListDriversResponse]:
+    ) -> AsyncPager[Driver]:
         """
         Get all drivers in organization.
 
@@ -786,7 +807,7 @@ class AsyncRawDriversClient:
 
         Returns
         -------
-        AsyncHttpResponse[ListDriversResponse]
+        AsyncPager[Driver]
             List of all driver objects.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -806,14 +827,36 @@ class AsyncRawDriversClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListDriversResponse,
                     parse_obj_as(
                         type_=ListDriversResponse,  # 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(
+                            driver_activation_status=driver_activation_status,
+                            limit=limit,
+                            after=_parsed_next,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            attribute_value_ids=attribute_value_ids,
+                            updated_after_time=updated_after_time,
+                            created_after_time=created_after_time,
+                            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)