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

samsara/vehicles/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.vehicle_locations_list_response import VehicleLocationsListResponse
+from ...types.vehicle_locations_list_response_data import VehicleLocationsListResponseData
 from ...types.vehicle_locations_response import VehicleLocationsResponse
+from ...types.vehicle_locations_response_data import VehicleLocationsResponseData
 
 
 class RawLocationsClient:
@@ -25,7 +27,7 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[VehicleLocationsResponse]:
+    ) -> SyncPager[VehicleLocationsResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.***
 
@@ -59,7 +61,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[VehicleLocationsResponse]
+        SyncPager[VehicleLocationsResponseData]
             List of the most recent locations for the specified vehicles.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -76,14 +78,30 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsResponse,
                     parse_obj_as(
                         type_=VehicleLocationsResponse,  # 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,
+                        time=time,
+                        parent_tag_ids=parent_tag_ids,
+                        tag_ids=tag_ids,
+                        vehicle_ids=vehicle_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)
@@ -97,7 +115,7 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[VehicleLocationsListResponse]:
+    ) -> SyncPager[VehicleLocationsListResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.***
 
@@ -134,7 +152,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[VehicleLocationsListResponse]
+        SyncPager[VehicleLocationsListResponseData]
             List of locations events for the specified vehicles.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -150,14 +168,29 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsListResponse,
                     parse_obj_as(
                         type_=VehicleLocationsListResponse,  # 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,
+                        vehicle_ids=vehicle_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)
@@ -173,7 +206,7 @@ class RawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[VehicleLocationsListResponse]:
+    ) -> SyncPager[VehicleLocationsListResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.***
 
@@ -210,7 +243,7 @@ class RawLocationsClient:
 
         Returns
         -------
-        HttpResponse[VehicleLocationsListResponse]
+        SyncPager[VehicleLocationsListResponseData]
             List of all locations for the specified vehicles and time range.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -228,14 +261,31 @@ class RawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsListResponse,
                     parse_obj_as(
                         type_=VehicleLocationsListResponse,  # 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,
+                        vehicle_ids=vehicle_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)
@@ -255,7 +305,7 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[VehicleLocationsResponse]:
+    ) -> AsyncPager[VehicleLocationsResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.***
 
@@ -289,7 +339,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[VehicleLocationsResponse]
+        AsyncPager[VehicleLocationsResponseData]
             List of the most recent locations for the specified vehicles.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -306,14 +356,33 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsResponse,
                     parse_obj_as(
                         type_=VehicleLocationsResponse,  # 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,
+                            time=time,
+                            parent_tag_ids=parent_tag_ids,
+                            tag_ids=tag_ids,
+                            vehicle_ids=vehicle_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)
@@ -327,7 +396,7 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[VehicleLocationsListResponse]:
+    ) -> AsyncPager[VehicleLocationsListResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.***
 
@@ -364,7 +433,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[VehicleLocationsListResponse]
+        AsyncPager[VehicleLocationsListResponseData]
             List of locations events for the specified vehicles.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -380,14 +449,32 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsListResponse,
                     parse_obj_as(
                         type_=VehicleLocationsListResponse,  # 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,
+                            vehicle_ids=vehicle_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)
@@ -403,7 +490,7 @@ class AsyncRawLocationsClient:
         tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         vehicle_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[VehicleLocationsListResponse]:
+    ) -> AsyncPager[VehicleLocationsListResponseData]:
         """
         ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.***
 
@@ -440,7 +527,7 @@ class AsyncRawLocationsClient:
 
         Returns
         -------
-        AsyncHttpResponse[VehicleLocationsListResponse]
+        AsyncPager[VehicleLocationsListResponseData]
             List of all locations for the specified vehicles and time range.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -458,14 +545,34 @@ class AsyncRawLocationsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehicleLocationsListResponse,
                     parse_obj_as(
                         type_=VehicleLocationsListResponse,  # 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,
+                            vehicle_ids=vehicle_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/vehicles/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
@@ -24,6 +25,7 @@ from ..types.gross_vehicle_weight import GrossVehicleWeight
 from ..types.user_identifier_serial import UserIdentifierSerial
 from ..types.vehicle_regulation_mode import VehicleRegulationMode
 from ..types.vehicle_response import VehicleResponse
+from ..types.vehicle_response_object_response_body import VehicleResponseObjectResponseBody
 from ..types.vehicle_type import VehicleType
 from ..types.vehicles_list_vehicles_response_body import VehiclesListVehiclesResponseBody
 from .types.update_vehicle_request_aux_input_type_1 import UpdateVehicleRequestAuxInputType1
@@ -59,10 +61,11 @@ class RawVehiclesClient:
         parent_tag_ids: typing.Optional[str] = None,
         tag_ids: typing.Optional[str] = None,
         attribute_value_ids: typing.Optional[str] = None,
+        attributes: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[VehiclesListVehiclesResponseBody]:
+    ) -> SyncPager[VehicleResponseObjectResponseBody]:
         """
         Returns a list of all vehicles.
 
@@ -90,6 +93,9 @@ class RawVehiclesClient:
         attribute_value_ids : typing.Optional[str]
             A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
 
+        attributes : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            A filter on the data to return entities having given attributes using name-value pair, separated by semicolon. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributes=ExampleAttributeName:some_value&attributes=SomeOtherAttr:123`
+
         updated_after_time : typing.Optional[str]
              A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
 
@@ -101,7 +107,7 @@ class RawVehiclesClient:
 
         Returns
         -------
-        HttpResponse[VehiclesListVehiclesResponseBody]
+        SyncPager[VehicleResponseObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -113,6 +119,7 @@ class RawVehiclesClient:
                 "parentTagIds": parent_tag_ids,
                 "tagIds": tag_ids,
                 "attributeValueIds": attribute_value_ids,
+                "attributes": attributes,
                 "updatedAfterTime": updated_after_time,
                 "createdAfterTime": created_after_time,
             },
@@ -120,14 +127,33 @@ class RawVehiclesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehiclesListVehiclesResponseBody,
                     parse_obj_as(
                         type_=VehiclesListVehiclesResponseBody,  # 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,
+                        attribute_value_ids=attribute_value_ids,
+                        attributes=attributes,
+                        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)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),
@@ -483,10 +509,11 @@ class AsyncRawVehiclesClient:
         parent_tag_ids: typing.Optional[str] = None,
         tag_ids: typing.Optional[str] = None,
         attribute_value_ids: typing.Optional[str] = None,
+        attributes: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         updated_after_time: typing.Optional[str] = None,
         created_after_time: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[VehiclesListVehiclesResponseBody]:
+    ) -> AsyncPager[VehicleResponseObjectResponseBody]:
         """
         Returns a list of all vehicles.
 
@@ -514,6 +541,9 @@ class AsyncRawVehiclesClient:
         attribute_value_ids : typing.Optional[str]
             A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
 
+        attributes : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            A filter on the data to return entities having given attributes using name-value pair, separated by semicolon. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributes=ExampleAttributeName:some_value&attributes=SomeOtherAttr:123`
+
         updated_after_time : typing.Optional[str]
              A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
 
@@ -525,7 +555,7 @@ class AsyncRawVehiclesClient:
 
         Returns
         -------
-        AsyncHttpResponse[VehiclesListVehiclesResponseBody]
+        AsyncPager[VehicleResponseObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -537,6 +567,7 @@ class AsyncRawVehiclesClient:
                 "parentTagIds": parent_tag_ids,
                 "tagIds": tag_ids,
                 "attributeValueIds": attribute_value_ids,
+                "attributes": attributes,
                 "updatedAfterTime": updated_after_time,
                 "createdAfterTime": created_after_time,
             },
@@ -544,14 +575,36 @@ class AsyncRawVehiclesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     VehiclesListVehiclesResponseBody,
                     parse_obj_as(
                         type_=VehiclesListVehiclesResponseBody,  # 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,
+                            attribute_value_ids=attribute_value_ids,
+                            attributes=attributes,
+                            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)
+                )
             if _response.status_code == 401:
                 raise UnauthorizedError(
                     headers=dict(_response.headers),