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

samsara/equipment/locations/raw_client.py

@@ -5,11 +5,13 @@ 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 ...types.equipment_locations_list_response import EquipmentLocationsListResponse
+from ...types.equipment_locations_list_response_data import EquipmentLocationsListResponseData
 from ...types.equipment_locations_response import EquipmentLocationsResponse
+from ...types.equipment_locations_response_data import EquipmentLocationsResponseData
 
 
 class RawLocationsClient:
@@ -24,7 +26,7 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[EquipmentLocationsResponse]:
+    ) -> SyncPager[EquipmentLocationsResponseData]:
         """
         Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs.
 
@@ -51,7 +53,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[EquipmentLocationsResponse]
+        SyncPager[EquipmentLocationsResponseData]
             The most recent equipment locations and pagination information
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -67,14 +69,29 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsResponse,  # 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,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        equipment_ids=equipment_ids,
+                        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)
@@ -88,9 +105,9 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[EquipmentLocationsListResponse]:
+    ) -> SyncPager[EquipmentLocationsListResponseData]:
         """
-        Follow a continuous feed of all equipment locations from Samsara AG26s.
+        Follow a continuous feed of all equipment locations.
 
         Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`.
 
@@ -121,7 +138,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[EquipmentLocationsListResponse]
+        SyncPager[EquipmentLocationsListResponseData]
             The feed of equipment locations and pagination information
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -137,14 +154,29 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsListResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsListResponse,  # 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.feed(
+                        after=_parsed_next,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        equipment_ids=equipment_ids,
+                        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)
@@ -160,7 +192,7 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[EquipmentLocationsListResponse]:
+    ) -> SyncPager[EquipmentLocationsListResponseData]:
         """
         Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs.
 
@@ -193,7 +225,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[EquipmentLocationsListResponse]
+        SyncPager[EquipmentLocationsListResponseData]
             Historical equipment locations and pagination information
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -211,14 +243,31 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsListResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsListResponse,  # 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.history(
+                        start_time=start_time,
+                        end_time=end_time,
+                        after=_parsed_next,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        equipment_ids=equipment_ids,
+                        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)
@@ -237,7 +286,7 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[EquipmentLocationsResponse]:
+    ) -> AsyncPager[EquipmentLocationsResponseData]:
         """
         Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs.
 
@@ -264,7 +313,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[EquipmentLocationsResponse]
+        AsyncPager[EquipmentLocationsResponseData]
             The most recent equipment locations and pagination information
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -280,14 +329,32 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsResponse,  # 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,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            equipment_ids=equipment_ids,
+                            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)
@@ -301,9 +368,9 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[EquipmentLocationsListResponse]:
+    ) -> AsyncPager[EquipmentLocationsListResponseData]:
         """
-        Follow a continuous feed of all equipment locations from Samsara AG26s.
+        Follow a continuous feed of all equipment locations.
 
         Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`.
 
@@ -334,7 +401,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[EquipmentLocationsListResponse]
+        AsyncPager[EquipmentLocationsListResponseData]
             The feed of equipment locations and pagination information
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -350,14 +417,32 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsListResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsListResponse,  # 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.feed(
+                            after=_parsed_next,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            equipment_ids=equipment_ids,
+                            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)
@@ -373,7 +458,7 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         equipment_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[EquipmentLocationsListResponse]:
+    ) -> AsyncPager[EquipmentLocationsListResponseData]:
         """
         Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs.
 
@@ -406,7 +491,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[EquipmentLocationsListResponse]
+        AsyncPager[EquipmentLocationsListResponseData]
             Historical equipment locations and pagination information
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -424,14 +509,34 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentLocationsListResponse,
                     parse_obj_as(
                         type_=EquipmentLocationsListResponse,  # 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.history(
+                            start_time=start_time,
+                            end_time=end_time,
+                            after=_parsed_next,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            equipment_ids=equipment_ids,
+                            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/equipment/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.equipment_list_response import EquipmentListResponse
+from ..types.equipment_object import EquipmentObject
 from ..types.equipment_response import EquipmentResponse
 
 
@@ -25,13 +27,9 @@ class RawEquipmentClient:
         parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[EquipmentListResponse]:
+    ) -> SyncPager[EquipmentObject]:
         """
-        Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization.
-
-         **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
-
-        To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        Returns a list of all equipment in an organization.
 
         Parameters
         ----------
@@ -52,7 +50,7 @@ class RawEquipmentClient:
 
         Returns
         -------
-        HttpResponse[EquipmentListResponse]
+        SyncPager[EquipmentObject]
             List of all equipment objects, and pagination information
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -68,14 +66,29 @@ class RawEquipmentClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentListResponse,
                     parse_obj_as(
                         type_=EquipmentListResponse,  # 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,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        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)
@@ -137,13 +150,9 @@ class AsyncRawEquipmentClient:
         parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[EquipmentListResponse]:
+    ) -> AsyncPager[EquipmentObject]:
         """
-        Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization.
-
-         **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
-
-        To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        Returns a list of all equipment in an organization.
 
         Parameters
         ----------
@@ -164,7 +173,7 @@ class AsyncRawEquipmentClient:
 
         Returns
         -------
-        AsyncHttpResponse[EquipmentListResponse]
+        AsyncPager[EquipmentObject]
             List of all equipment objects, and pagination information
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -180,14 +189,32 @@ class AsyncRawEquipmentClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     EquipmentListResponse,
                     parse_obj_as(
                         type_=EquipmentListResponse,  # 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,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            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/equipment/stats/__init__.py

@@ -2,6 +2,6 @@
 
 # isort: skip_file
 
-from .types import StatsFeedRequestTypesItem, StatsGetRequestTypesItem, StatsHistoryRequestTypesItem
+from .types import StatsFeedRequestTypesItem, StatsHistoryRequestTypesItem, StatsListRequestTypesItem
 
-__all__ = ["StatsFeedRequestTypesItem", "StatsGetRequestTypesItem", "StatsHistoryRequestTypesItem"]
+__all__ = ["StatsFeedRequestTypesItem", "StatsHistoryRequestTypesItem", "StatsListRequestTypesItem"]