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

samsara/live_shares/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 ..core.serialization import convert_and_respect_annotation_metadata
@@ -21,6 +22,7 @@ from ..errors.unauthorized_error import UnauthorizedError
 from ..types.assets_location_link_config_object import AssetsLocationLinkConfigObject
 from ..types.assets_near_location_link_config_object import AssetsNearLocationLinkConfigObject
 from ..types.assets_on_route_link_config_object import AssetsOnRouteLinkConfigObject
+from ..types.live_sharing_link_full_response_object_response_body import LiveSharingLinkFullResponseObjectResponseBody
 from ..types.live_sharing_links_create_live_sharing_link_response_body import (
     LiveSharingLinksCreateLiveSharingLinkResponseBody,
 )
@@ -51,7 +53,7 @@ class RawLiveSharesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[LiveSharingLinksGetLiveSharingLinksResponseBody]:
+    ) -> SyncPager[LiveSharingLinkFullResponseObjectResponseBody]:
         """
         Returns all non-expired Live Sharing Links.
 
@@ -81,7 +83,7 @@ class RawLiveSharesClient:
 
         Returns
         -------
-        HttpResponse[LiveSharingLinksGetLiveSharingLinksResponseBody]
+        SyncPager[LiveSharingLinkFullResponseObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -97,14 +99,29 @@ class RawLiveSharesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     LiveSharingLinksGetLiveSharingLinksResponseBody,
                     parse_obj_as(
                         type_=LiveSharingLinksGetLiveSharingLinksResponseBody,  # 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(
+                        ids=ids,
+                        type=type,
+                        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),
@@ -722,7 +739,7 @@ class AsyncRawLiveSharesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[LiveSharingLinksGetLiveSharingLinksResponseBody]:
+    ) -> AsyncPager[LiveSharingLinkFullResponseObjectResponseBody]:
         """
         Returns all non-expired Live Sharing Links.
 
@@ -752,7 +769,7 @@ class AsyncRawLiveSharesClient:
 
         Returns
         -------
-        AsyncHttpResponse[LiveSharingLinksGetLiveSharingLinksResponseBody]
+        AsyncPager[LiveSharingLinkFullResponseObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -768,14 +785,32 @@ class AsyncRawLiveSharesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     LiveSharingLinksGetLiveSharingLinksResponseBody,
                     parse_obj_as(
                         type_=LiveSharingLinksGetLiveSharingLinksResponseBody,  # 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(
+                            ids=ids,
+                            type=type,
+                            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/maintenance/service_tasks/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.work_orders_get_service_tasks_response_body import WorkOrdersGetServiceTasksResponseBody
+from ...types.service_task_definition_object_response_body import ServiceTaskDefinitionObjectResponseBody
 from .raw_client import AsyncRawServiceTasksClient, RawServiceTasksClient
 
 
@@ -30,7 +31,7 @@ class ServiceTasksClient:
         include_archived: typing.Optional[bool] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersGetServiceTasksResponseBody:
+    ) -> SyncPager[ServiceTaskDefinitionObjectResponseBody]:
         """
         Gets service tasks.
 
@@ -57,7 +58,7 @@ class ServiceTasksClient:
 
         Returns
         -------
-        WorkOrdersGetServiceTasksResponseBody
+        SyncPager[ServiceTaskDefinitionObjectResponseBody]
             OK response.
 
         Examples
@@ -67,12 +68,16 @@ class ServiceTasksClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.maintenance.service_tasks.list()
+        response = client.maintenance.service_tasks.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(
             ids=ids, include_archived=include_archived, after=after, request_options=request_options
         )
-        return _response.data
 
     def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
@@ -166,7 +171,7 @@ class AsyncServiceTasksClient:
         include_archived: typing.Optional[bool] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersGetServiceTasksResponseBody:
+    ) -> AsyncPager[ServiceTaskDefinitionObjectResponseBody]:
         """
         Gets service tasks.
 
@@ -193,7 +198,7 @@ class AsyncServiceTasksClient:
 
         Returns
         -------
-        WorkOrdersGetServiceTasksResponseBody
+        AsyncPager[ServiceTaskDefinitionObjectResponseBody]
             OK response.
 
         Examples
@@ -208,15 +213,20 @@ class AsyncServiceTasksClient:
 
 
         async def main() -> None:
-            await client.maintenance.service_tasks.list()
+            response = await client.maintenance.service_tasks.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(
             ids=ids, include_archived=include_archived, after=after, request_options=request_options
         )
-        return _response.data
 
     async def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """

samsara/maintenance/service_tasks/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,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.service_task_definition_object_response_body import ServiceTaskDefinitionObjectResponseBody
 from ...types.work_orders_get_service_tasks_response_body import WorkOrdersGetServiceTasksResponseBody
 
 
@@ -31,7 +33,7 @@ class RawServiceTasksClient:
         include_archived: typing.Optional[bool] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[WorkOrdersGetServiceTasksResponseBody]:
+    ) -> SyncPager[ServiceTaskDefinitionObjectResponseBody]:
         """
         Gets service tasks.
 
@@ -58,7 +60,7 @@ class RawServiceTasksClient:
 
         Returns
         -------
-        HttpResponse[WorkOrdersGetServiceTasksResponseBody]
+        SyncPager[ServiceTaskDefinitionObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -73,14 +75,28 @@ class RawServiceTasksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     WorkOrdersGetServiceTasksResponseBody,
                     parse_obj_as(
                         type_=WorkOrdersGetServiceTasksResponseBody,  # 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(
+                        ids=ids,
+                        include_archived=include_archived,
+                        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),
@@ -269,7 +285,7 @@ class AsyncRawServiceTasksClient:
         include_archived: typing.Optional[bool] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[WorkOrdersGetServiceTasksResponseBody]:
+    ) -> AsyncPager[ServiceTaskDefinitionObjectResponseBody]:
         """
         Gets service tasks.
 
@@ -296,7 +312,7 @@ class AsyncRawServiceTasksClient:
 
         Returns
         -------
-        AsyncHttpResponse[WorkOrdersGetServiceTasksResponseBody]
+        AsyncPager[ServiceTaskDefinitionObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -311,14 +327,31 @@ class AsyncRawServiceTasksClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     WorkOrdersGetServiceTasksResponseBody,
                     parse_obj_as(
                         type_=WorkOrdersGetServiceTasksResponseBody,  # 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(
+                            ids=ids,
+                            include_archived=include_archived,
+                            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/maintenance/work_orders/client.py

@@ -4,15 +4,15 @@ import datetime as dt
 import typing
 
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.pagination import AsyncPager, SyncPager
 from ...core.request_options import RequestOptions
 from ...types.service_task_instance_input_object_request_body import ServiceTaskInstanceInputObjectRequestBody
 from ...types.work_order_discount_object_request_body import WorkOrderDiscountObjectRequestBody
 from ...types.work_order_item_object_request_body import WorkOrderItemObjectRequestBody
+from ...types.work_order_object_response_body import WorkOrderObjectResponseBody
 from ...types.work_order_tax_object_request_body import WorkOrderTaxObjectRequestBody
-from ...types.work_orders_get_work_orders_response_body import WorkOrdersGetWorkOrdersResponseBody
 from ...types.work_orders_patch_work_orders_response_body import WorkOrdersPatchWorkOrdersResponseBody
 from ...types.work_orders_post_work_orders_response_body import WorkOrdersPostWorkOrdersResponseBody
-from ...types.work_orders_stream_work_orders_response_body import WorkOrdersStreamWorkOrdersResponseBody
 from .raw_client import AsyncRawWorkOrdersClient, RawWorkOrdersClient
 from .types.work_orders_patch_work_orders_request_body_category import WorkOrdersPatchWorkOrdersRequestBodyCategory
 from .types.work_orders_patch_work_orders_request_body_priority import WorkOrdersPatchWorkOrdersRequestBodyPriority
@@ -46,7 +46,7 @@ class WorkOrdersClient:
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersGetWorkOrdersResponseBody:
+    ) -> SyncPager[WorkOrderObjectResponseBody]:
         """
         Gets work orders.
 
@@ -70,7 +70,7 @@ class WorkOrdersClient:
 
         Returns
         -------
-        WorkOrdersGetWorkOrdersResponseBody
+        SyncPager[WorkOrderObjectResponseBody]
             OK response.
 
         Examples
@@ -80,10 +80,14 @@ class WorkOrdersClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.maintenance.work_orders.list()
+        response = client.maintenance.work_orders.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(ids=ids, after=after, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(ids=ids, after=after, request_options=request_options)
 
     def create(
         self,
@@ -355,7 +359,7 @@ class WorkOrdersClient:
         asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         assigned_user_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersStreamWorkOrdersResponseBody:
+    ) -> SyncPager[WorkOrderObjectResponseBody]:
         """
         Stream work orders.
 
@@ -391,7 +395,7 @@ class WorkOrdersClient:
 
         Returns
         -------
-        WorkOrdersStreamWorkOrdersResponseBody
+        SyncPager[WorkOrderObjectResponseBody]
             OK response.
 
         Examples
@@ -401,11 +405,16 @@ class WorkOrdersClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.maintenance.work_orders.stream(
+        response = client.maintenance.work_orders.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,
             after=after,
             end_time=end_time,
@@ -414,7 +423,6 @@ class WorkOrdersClient:
             assigned_user_ids=assigned_user_ids,
             request_options=request_options,
         )
-        return _response.data
 
 
 class AsyncWorkOrdersClient:
@@ -438,7 +446,7 @@ class AsyncWorkOrdersClient:
         ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersGetWorkOrdersResponseBody:
+    ) -> AsyncPager[WorkOrderObjectResponseBody]:
         """
         Gets work orders.
 
@@ -462,7 +470,7 @@ class AsyncWorkOrdersClient:
 
         Returns
         -------
-        WorkOrdersGetWorkOrdersResponseBody
+        AsyncPager[WorkOrderObjectResponseBody]
             OK response.
 
         Examples
@@ -477,13 +485,18 @@ class AsyncWorkOrdersClient:
 
 
         async def main() -> None:
-            await client.maintenance.work_orders.list()
+            response = await client.maintenance.work_orders.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(ids=ids, after=after, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(ids=ids, after=after, request_options=request_options)
 
     async def create(
         self,
@@ -779,7 +792,7 @@ class AsyncWorkOrdersClient:
         asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         assigned_user_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> WorkOrdersStreamWorkOrdersResponseBody:
+    ) -> AsyncPager[WorkOrderObjectResponseBody]:
         """
         Stream work orders.
 
@@ -815,7 +828,7 @@ class AsyncWorkOrdersClient:
 
         Returns
         -------
-        WorkOrdersStreamWorkOrdersResponseBody
+        AsyncPager[WorkOrderObjectResponseBody]
             OK response.
 
         Examples
@@ -830,14 +843,20 @@ class AsyncWorkOrdersClient:
 
 
         async def main() -> None:
-            await client.maintenance.work_orders.stream(
+            response = await client.maintenance.work_orders.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,
             after=after,
             end_time=end_time,
@@ -846,4 +865,3 @@ class AsyncWorkOrdersClient:
             assigned_user_ids=assigned_user_ids,
             request_options=request_options,
         )
-        return _response.data