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

samsara/tags/raw_client.py

@@ -7,9 +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.list_tags_response import ListTagsResponse
+from ..types.tag import Tag
 from ..types.tag_response import TagResponse
 from ..types.tagged_object_id import TaggedObjectId
 
@@ -27,7 +29,7 @@ class RawTagsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListTagsResponse]:
+    ) -> SyncPager[Tag]:
         """
         Return all of the tags for an organization.
 
@@ -48,7 +50,7 @@ class RawTagsClient:
 
         Returns
         -------
-        HttpResponse[ListTagsResponse]
+        SyncPager[Tag]
             List of tags.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -62,14 +64,27 @@ class RawTagsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListTagsResponse,
                     parse_obj_as(
                         type_=ListTagsResponse,  # 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)
@@ -458,7 +473,7 @@ class AsyncRawTagsClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListTagsResponse]:
+    ) -> AsyncPager[Tag]:
         """
         Return all of the tags for an organization.
 
@@ -479,7 +494,7 @@ class AsyncRawTagsClient:
 
         Returns
         -------
-        AsyncHttpResponse[ListTagsResponse]
+        AsyncPager[Tag]
             List of tags.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -493,14 +508,30 @@ class AsyncRawTagsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListTagsResponse,
                     parse_obj_as(
                         type_=ListTagsResponse,  # 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/trailers/client.py

@@ -3,11 +3,12 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
 from ..types.goa_attribute_tiny_request_body import GoaAttributeTinyRequestBody
+from ..types.trailer_response_object_response_body import TrailerResponseObjectResponseBody
 from ..types.trailers_create_trailer_response_body import TrailersCreateTrailerResponseBody
 from ..types.trailers_get_trailer_response_body import TrailersGetTrailerResponseBody
-from ..types.trailers_list_trailers_response_body import TrailersListTrailersResponseBody
 from ..types.trailers_update_trailer_response_body import TrailersUpdateTrailerResponseBody
 from .raw_client import AsyncRawTrailersClient, RawTrailersClient
 
@@ -38,7 +39,7 @@ class TrailersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrailersListTrailersResponseBody:
+    ) -> SyncPager[TrailerResponseObjectResponseBody]:
         """
         List all trailers.
 
@@ -68,7 +69,7 @@ class TrailersClient:
 
         Returns
         -------
-        TrailersListTrailersResponseBody
+        SyncPager[TrailerResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -78,12 +79,16 @@ class TrailersClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.trailers.list()
+        response = client.trailers.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(
             tag_ids=tag_ids, parent_tag_ids=parent_tag_ids, limit=limit, after=after, request_options=request_options
         )
-        return _response.data
 
     def create(
         self,
@@ -360,7 +365,7 @@ class AsyncTrailersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrailersListTrailersResponseBody:
+    ) -> AsyncPager[TrailerResponseObjectResponseBody]:
         """
         List all trailers.
 
@@ -390,7 +395,7 @@ class AsyncTrailersClient:
 
         Returns
         -------
-        TrailersListTrailersResponseBody
+        AsyncPager[TrailerResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -405,15 +410,20 @@ class AsyncTrailersClient:
 
 
         async def main() -> None:
-            await client.trailers.list()
+            response = await client.trailers.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(
             tag_ids=tag_ids, parent_tag_ids=parent_tag_ids, limit=limit, after=after, request_options=request_options
         )
-        return _response.data
 
     async def create(
         self,

samsara/trailers/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.goa_attribute_tiny_request_body import GoaAttributeTinyRequestBody
+from ..types.trailer_response_object_response_body import TrailerResponseObjectResponseBody
 from ..types.trailers_create_trailer_response_body import TrailersCreateTrailerResponseBody
 from ..types.trailers_get_trailer_response_body import TrailersGetTrailerResponseBody
 from ..types.trailers_list_trailers_response_body import TrailersListTrailersResponseBody
@@ -41,7 +43,7 @@ class RawTrailersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[TrailersListTrailersResponseBody]:
+    ) -> SyncPager[TrailerResponseObjectResponseBody]:
         """
         List all trailers.
 
@@ -71,7 +73,7 @@ class RawTrailersClient:
 
         Returns
         -------
-        HttpResponse[TrailersListTrailersResponseBody]
+        SyncPager[TrailerResponseObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -87,14 +89,29 @@ class RawTrailersClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrailersListTrailersResponseBody,
                     parse_obj_as(
                         type_=TrailersListTrailersResponseBody,  # 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(
+                        tag_ids=tag_ids,
+                        parent_tag_ids=parent_tag_ids,
+                        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)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),
@@ -887,7 +904,7 @@ class AsyncRawTrailersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[TrailersListTrailersResponseBody]:
+    ) -> AsyncPager[TrailerResponseObjectResponseBody]:
         """
         List all trailers.
 
@@ -917,7 +934,7 @@ class AsyncRawTrailersClient:
 
         Returns
         -------
-        AsyncHttpResponse[TrailersListTrailersResponseBody]
+        AsyncPager[TrailerResponseObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -933,14 +950,32 @@ class AsyncRawTrailersClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrailersListTrailersResponseBody,
                     parse_obj_as(
                         type_=TrailersListTrailersResponseBody,  # 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(
+                            tag_ids=tag_ids,
+                            parent_tag_ids=parent_tag_ids,
+                            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)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),

samsara/training_courses/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.training_courses_get_training_courses_response_body import TrainingCoursesGetTrainingCoursesResponseBody
+from ..types.training_course_response_object_response_body import TrainingCourseResponseObjectResponseBody
 from .raw_client import AsyncRawTrainingCoursesClient, RawTrainingCoursesClient
 
 
@@ -31,7 +32,7 @@ class TrainingCoursesClient:
         category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         status: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrainingCoursesGetTrainingCoursesResponseBody:
+    ) -> SyncPager[TrainingCourseResponseObjectResponseBody]:
         """
         Returns all training courses data. Results are paginated.
          Courses in the ‘draft’ status are excluded from the data returned by this endpoint.
@@ -62,7 +63,7 @@ class TrainingCoursesClient:
 
         Returns
         -------
-        TrainingCoursesGetTrainingCoursesResponseBody
+        SyncPager[TrainingCourseResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -72,16 +73,20 @@ class TrainingCoursesClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.training_courses.list()
+        response = client.training_courses.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(
             after=after,
             course_ids=course_ids,
             category_ids=category_ids,
             status=status,
             request_options=request_options,
         )
-        return _response.data
 
 
 class AsyncTrainingCoursesClient:
@@ -107,7 +112,7 @@ class AsyncTrainingCoursesClient:
         category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         status: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TrainingCoursesGetTrainingCoursesResponseBody:
+    ) -> AsyncPager[TrainingCourseResponseObjectResponseBody]:
         """
         Returns all training courses data. Results are paginated.
          Courses in the ‘draft’ status are excluded from the data returned by this endpoint.
@@ -138,7 +143,7 @@ class AsyncTrainingCoursesClient:
 
         Returns
         -------
-        TrainingCoursesGetTrainingCoursesResponseBody
+        AsyncPager[TrainingCourseResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -153,16 +158,21 @@ class AsyncTrainingCoursesClient:
 
 
         async def main() -> None:
-            await client.training_courses.list()
+            response = await client.training_courses.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(
             after=after,
             course_ids=course_ids,
             category_ids=category_ids,
             status=status,
             request_options=request_options,
         )
-        return _response.data

samsara/training_courses/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.training_course_response_object_response_body import TrainingCourseResponseObjectResponseBody
 from ..types.training_courses_get_training_courses_response_body import TrainingCoursesGetTrainingCoursesResponseBody
 
 
@@ -32,7 +33,7 @@ class RawTrainingCoursesClient:
         category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         status: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[TrainingCoursesGetTrainingCoursesResponseBody]:
+    ) -> SyncPager[TrainingCourseResponseObjectResponseBody]:
         """
         Returns all training courses data. Results are paginated.
          Courses in the ‘draft’ status are excluded from the data returned by this endpoint.
@@ -63,7 +64,7 @@ class RawTrainingCoursesClient:
 
         Returns
         -------
-        HttpResponse[TrainingCoursesGetTrainingCoursesResponseBody]
+        SyncPager[TrainingCourseResponseObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -79,14 +80,29 @@ class RawTrainingCoursesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrainingCoursesGetTrainingCoursesResponseBody,
                     parse_obj_as(
                         type_=TrainingCoursesGetTrainingCoursesResponseBody,  # 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,
+                        course_ids=course_ids,
+                        category_ids=category_ids,
+                        status=status,
+                        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),
@@ -204,7 +220,7 @@ class AsyncRawTrainingCoursesClient:
         category_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         status: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[TrainingCoursesGetTrainingCoursesResponseBody]:
+    ) -> AsyncPager[TrainingCourseResponseObjectResponseBody]:
         """
         Returns all training courses data. Results are paginated.
          Courses in the ‘draft’ status are excluded from the data returned by this endpoint.
@@ -235,7 +251,7 @@ class AsyncRawTrainingCoursesClient:
 
         Returns
         -------
-        AsyncHttpResponse[TrainingCoursesGetTrainingCoursesResponseBody]
+        AsyncPager[TrainingCourseResponseObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -251,14 +267,32 @@ class AsyncRawTrainingCoursesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     TrainingCoursesGetTrainingCoursesResponseBody,
                     parse_obj_as(
                         type_=TrainingCoursesGetTrainingCoursesResponseBody,  # 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,
+                            course_ids=course_ids,
+                            category_ids=category_ids,
+                            status=status,
+                            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/trips/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.trips_get_trips_response_body import TripsGetTripsResponseBody
+from ..types.trip_response_body import TripResponseBody
 from .raw_client import AsyncRawTripsClient, RawTripsClient
 from .types.trips_stream_request_completion_status import TripsStreamRequestCompletionStatus
 from .types.trips_stream_request_query_by import TripsStreamRequestQueryBy
@@ -36,7 +37,7 @@ class TripsClient:
         after: typing.Optional[str] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TripsGetTripsResponseBody:
+    ) -> SyncPager[TripResponseBody]:
         """
         This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Reach out to your Samsara Representative to have this API enabled for your organization.
 
@@ -75,7 +76,7 @@ class TripsClient:
 
         Returns
         -------
-        TripsGetTripsResponseBody
+        SyncPager[TripResponseBody]
             OK response.
 
         Examples
@@ -85,11 +86,16 @@ class TripsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.trips.stream(
+        response = client.trips.stream(
             start_time="startTime",
         )
+        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.stream(
+        return self._raw_client.stream(
             start_time=start_time,
             include_asset=include_asset,
             completion_status=completion_status,
@@ -99,7 +105,6 @@ class TripsClient:
             ids=ids,
             request_options=request_options,
         )
-        return _response.data
 
 
 class AsyncTripsClient:
@@ -128,7 +133,7 @@ class AsyncTripsClient:
         after: typing.Optional[str] = None,
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TripsGetTripsResponseBody:
+    ) -> AsyncPager[TripResponseBody]:
         """
         This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Reach out to your Samsara Representative to have this API enabled for your organization.
 
@@ -167,7 +172,7 @@ class AsyncTripsClient:
 
         Returns
         -------
-        TripsGetTripsResponseBody
+        AsyncPager[TripResponseBody]
             OK response.
 
         Examples
@@ -182,14 +187,20 @@ class AsyncTripsClient:
 
 
         async def main() -> None:
-            await client.trips.stream(
+            response = await client.trips.stream(
                 start_time="startTime",
             )
+            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.stream(
+        return await self._raw_client.stream(
             start_time=start_time,
             include_asset=include_asset,
             completion_status=completion_status,
@@ -199,4 +210,3 @@ class AsyncTripsClient:
             ids=ids,
             request_options=request_options,
         )
-        return _response.data