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

samsara/types/v_1_message_sender.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class V1MessageSender(UniversalBaseModel):
+    name: str = pydantic.Field()
+    """
+    Name of user that is sending the message.
+    """
+
+    type: str = pydantic.Field()
+    """
+    Type of user that is sending the message. It will be either dispatch or driver.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

samsara/types/v_1_messages.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .v_1_message import V1Message
+
+V1Messages = typing.List[V1Message]

samsara/types/v_1_messages_response.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .v_1_message_response import V1MessageResponse
+
+V1MessagesResponse = typing.List[V1MessageResponse]

samsara/types/webhook_response_response_body_event_types_item.py

@@ -16,6 +16,7 @@ WebhookResponseResponseBodyEventTypesItem = typing.Union[
         "EngineFaultOff",
         "EngineFaultOn",
         "FormSubmitted",
+        "FormUpdated",
         "GatewayUnplugged",
         "GeofenceEntry",
         "GeofenceExit",

samsara/types/webhooks_get_webhook_response_body_event_types_item.py

@@ -16,6 +16,7 @@ WebhooksGetWebhookResponseBodyEventTypesItem = typing.Union[
         "EngineFaultOff",
         "EngineFaultOn",
         "FormSubmitted",
+        "FormUpdated",
         "GatewayUnplugged",
         "GeofenceEntry",
         "GeofenceExit",

samsara/types/webhooks_patch_webhook_response_body_event_types_item.py

@@ -16,6 +16,7 @@ WebhooksPatchWebhookResponseBodyEventTypesItem = typing.Union[
         "EngineFaultOff",
         "EngineFaultOn",
         "FormSubmitted",
+        "FormUpdated",
         "GatewayUnplugged",
         "GeofenceEntry",
         "GeofenceExit",

samsara/types/webhooks_post_webhooks_response_body_event_types_item.py

@@ -16,6 +16,7 @@ WebhooksPostWebhooksResponseBodyEventTypesItem = typing.Union[
         "EngineFaultOff",
         "EngineFaultOn",
         "FormSubmitted",
+        "FormUpdated",
         "GatewayUnplugged",
         "GeofenceEntry",
         "GeofenceExit",

samsara/types/work_order_item_object_request_body.py

@@ -19,7 +19,7 @@ class WorkOrderItemObjectRequestBody(UniversalBaseModel):
 
     type: WorkOrderItemObjectRequestBodyType = pydantic.Field()
     """
-    The type of item.  Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `SCHEDULED_MAINTENANCE`
+    The type of item.  Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `MAINTENANCE_PREDICTION_EVENT`, `SCHEDULED_MAINTENANCE`
     """
 
     if IS_PYDANTIC_V2:

samsara/types/work_order_item_object_request_body_type.py

@@ -3,5 +3,14 @@
 import typing
 
 WorkOrderItemObjectRequestBodyType = typing.Union[
-    typing.Literal["DVIR", "FAULT", "FORM", "ISSUE", "ITEM_TYPE_UNSPECIFIED", "SCHEDULED_MAINTENANCE"], typing.Any
+    typing.Literal[
+        "DVIR",
+        "FAULT",
+        "FORM",
+        "ISSUE",
+        "ITEM_TYPE_UNSPECIFIED",
+        "MAINTENANCE_PREDICTION_EVENT",
+        "SCHEDULED_MAINTENANCE",
+    ],
+    typing.Any,
 ]

samsara/types/work_order_item_object_response_body.py

@@ -19,7 +19,7 @@ class WorkOrderItemObjectResponseBody(UniversalBaseModel):
 
     type: WorkOrderItemObjectResponseBodyType = pydantic.Field()
     """
-    The type of item.  Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `SCHEDULED_MAINTENANCE`
+    The type of item.  Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `MAINTENANCE_PREDICTION_EVENT`, `SCHEDULED_MAINTENANCE`
     """
 
     if IS_PYDANTIC_V2:

samsara/types/work_order_item_object_response_body_type.py

@@ -3,5 +3,14 @@
 import typing
 
 WorkOrderItemObjectResponseBodyType = typing.Union[
-    typing.Literal["DVIR", "FAULT", "FORM", "ISSUE", "ITEM_TYPE_UNSPECIFIED", "SCHEDULED_MAINTENANCE"], typing.Any
+    typing.Literal[
+        "DVIR",
+        "FAULT",
+        "FORM",
+        "ISSUE",
+        "ITEM_TYPE_UNSPECIFIED",
+        "MAINTENANCE_PREDICTION_EVENT",
+        "SCHEDULED_MAINTENANCE",
+    ],
+    typing.Any,
 ]

samsara/types/workflow_geofence_event_response_object_response_body.py

@@ -3,7 +3,10 @@
 import typing
 
 import pydantic
+import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .fuel_volume_response_body import FuelVolumeResponseBody
 from .vehicle_with_gateway_tiny_response_response_body import VehicleWithGatewayTinyResponseResponseBody
 from .workflow_address_event_with_geofence_object_response_body import (
     WorkflowAddressEventWithGeofenceObjectResponseBody,
@@ -12,6 +15,9 @@ from .workflow_address_event_with_geofence_object_response_body import (
 
 class WorkflowGeofenceEventResponseObjectResponseBody(UniversalBaseModel):
     address: typing.Optional[WorkflowAddressEventWithGeofenceObjectResponseBody] = None
+    fuel_volume: typing_extensions.Annotated[
+        typing.Optional[FuelVolumeResponseBody], FieldMetadata(alias="fuelVolume")
+    ] = None
     vehicle: typing.Optional[VehicleWithGatewayTinyResponseResponseBody] = None
 
     if IS_PYDANTIC_V2:

samsara/types/workflow_incident_details_object_response_body.py

@@ -40,6 +40,7 @@ from .out_of_route_response_body import OutOfRouteResponseBody
 from .outside_geofence_data_response_body import OutsideGeofenceDataResponseBody
 from .panic_button_response_body import PanicButtonResponseBody
 from .person_detected_response_body import PersonDetectedResponseBody
+from .reading_trigger_details_response_body import ReadingTriggerDetailsResponseBody
 from .reefer_temperature_response_body import ReeferTemperatureResponseBody
 from .route_stop_details_object_response_body import RouteStopDetailsObjectResponseBody
 from .route_stop_eta_response_body import RouteStopEtaResponseBody
@@ -176,6 +177,7 @@ class WorkflowIncidentDetailsObjectResponseBody(UniversalBaseModel):
     person_detected: typing_extensions.Annotated[
         typing.Optional[PersonDetectedResponseBody], FieldMetadata(alias="personDetected")
     ] = None
+    reading: typing.Optional[ReadingTriggerDetailsResponseBody] = None
     reefer_temperature: typing_extensions.Annotated[
         typing.Optional[ReeferTemperatureResponseBody], FieldMetadata(alias="reeferTemperature")
     ] = None

samsara/types/workflow_trigger_object_request_body.py

@@ -22,6 +22,7 @@ class WorkflowTriggerObjectRequestBody(UniversalBaseModel):
     The id of the trigger type. Reference the following list for the ids:
     
     Ambient Temperature = 1003
+    Asset Reading = 1062
     DVIR Submitted for Asset = 5005
     Driver Recorded = 5027
     Sudden Fuel Level Rise = 5034

samsara/types/workflow_trigger_object_response_body.py

@@ -22,6 +22,7 @@ class WorkflowTriggerObjectResponseBody(UniversalBaseModel):
     The id of the trigger type. Reference the following list for the ids:
     
     Ambient Temperature = 1003
+    Asset Reading = 1062
     DVIR Submitted for Asset = 5005
     Driver Recorded = 5027
     Sudden Fuel Level Rise = 5034

samsara/user_roles/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.list_user_roles_response import ListUserRolesResponse
+from ..types.user_role import UserRole
 from .raw_client import AsyncRawUserRolesClient, RawUserRolesClient
 
 
@@ -29,7 +30,7 @@ class UserRolesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListUserRolesResponse:
+    ) -> SyncPager[UserRole]:
         """
         Returns a list of all user roles in an organization.
 
@@ -50,7 +51,7 @@ class UserRolesClient:
 
         Returns
         -------
-        ListUserRolesResponse
+        SyncPager[UserRole]
             List all user roles.
 
         Examples
@@ -60,10 +61,14 @@ class UserRolesClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.user_roles.list()
+        response = client.user_roles.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(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(limit=limit, after=after, request_options=request_options)
 
 
 class AsyncUserRolesClient:
@@ -87,7 +92,7 @@ class AsyncUserRolesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListUserRolesResponse:
+    ) -> AsyncPager[UserRole]:
         """
         Returns a list of all user roles in an organization.
 
@@ -108,7 +113,7 @@ class AsyncUserRolesClient:
 
         Returns
         -------
-        ListUserRolesResponse
+        AsyncPager[UserRole]
             List all user roles.
 
         Examples
@@ -123,10 +128,15 @@ class AsyncUserRolesClient:
 
 
         async def main() -> None:
-            await client.user_roles.list()
+            response = await client.user_roles.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(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(limit=limit, after=after, request_options=request_options)

samsara/user_roles/raw_client.py

@@ -5,10 +5,11 @@ 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.list_user_roles_response import ListUserRolesResponse
+from ..types.user_role import UserRole
 
 
 class RawUserRolesClient:
@@ -21,7 +22,7 @@ class RawUserRolesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListUserRolesResponse]:
+    ) -> SyncPager[UserRole]:
         """
         Returns a list of all user roles in an organization.
 
@@ -42,7 +43,7 @@ class RawUserRolesClient:
 
         Returns
         -------
-        HttpResponse[ListUserRolesResponse]
+        SyncPager[UserRole]
             List all user roles.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -56,14 +57,27 @@ class RawUserRolesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListUserRolesResponse,
                     parse_obj_as(
                         type_=ListUserRolesResponse,  # 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)
@@ -80,7 +94,7 @@ class AsyncRawUserRolesClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListUserRolesResponse]:
+    ) -> AsyncPager[UserRole]:
         """
         Returns a list of all user roles in an organization.
 
@@ -101,7 +115,7 @@ class AsyncRawUserRolesClient:
 
         Returns
         -------
-        AsyncHttpResponse[ListUserRolesResponse]
+        AsyncPager[UserRole]
             List all user roles.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -115,14 +129,30 @@ class AsyncRawUserRolesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListUserRolesResponse,
                     parse_obj_as(
                         type_=ListUserRolesResponse,  # 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/users/client.py

@@ -3,9 +3,10 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
 from ..types.create_user_request_roles import CreateUserRequestRoles
-from ..types.list_users_response import ListUsersResponse
+from ..types.user import User
 from ..types.user_response import UserResponse
 from .raw_client import AsyncRawUsersClient, RawUsersClient
 from .types.create_user_request_auth_type import CreateUserRequestAuthType
@@ -36,7 +37,7 @@ class UsersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListUsersResponse:
+    ) -> SyncPager[User]:
         """
         Returns a list of all users in an organization. Users that have expired access will not be returned.
 
@@ -57,7 +58,7 @@ class UsersClient:
 
         Returns
         -------
-        ListUsersResponse
+        SyncPager[User]
             List all users.
 
         Examples
@@ -67,10 +68,14 @@ class UsersClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.users.list()
+        response = client.users.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(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(limit=limit, after=after, request_options=request_options)
 
     def create(
         self,
@@ -294,7 +299,7 @@ class AsyncUsersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListUsersResponse:
+    ) -> AsyncPager[User]:
         """
         Returns a list of all users in an organization. Users that have expired access will not be returned.
 
@@ -315,7 +320,7 @@ class AsyncUsersClient:
 
         Returns
         -------
-        ListUsersResponse
+        AsyncPager[User]
             List all users.
 
         Examples
@@ -330,13 +335,18 @@ class AsyncUsersClient:
 
 
         async def main() -> None:
-            await client.users.list()
+            response = await client.users.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(limit=limit, after=after, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(limit=limit, after=after, request_options=request_options)
 
     async def create(
         self,

samsara/users/raw_client.py

@@ -7,11 +7,13 @@ 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
 from ..types.create_user_request_roles import CreateUserRequestRoles
 from ..types.list_users_response import ListUsersResponse
+from ..types.user import User
 from ..types.user_response import UserResponse
 from .types.create_user_request_auth_type import CreateUserRequestAuthType
 from .types.update_user_request_auth_type import UpdateUserRequestAuthType
@@ -30,7 +32,7 @@ class RawUsersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListUsersResponse]:
+    ) -> SyncPager[User]:
         """
         Returns a list of all users in an organization. Users that have expired access will not be returned.
 
@@ -51,7 +53,7 @@ class RawUsersClient:
 
         Returns
         -------
-        HttpResponse[ListUsersResponse]
+        SyncPager[User]
             List all users.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -65,14 +67,27 @@ class RawUsersClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListUsersResponse,
                     parse_obj_as(
                         type_=ListUsersResponse,  # 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)
@@ -324,7 +339,7 @@ class AsyncRawUsersClient:
         limit: typing.Optional[int] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListUsersResponse]:
+    ) -> AsyncPager[User]:
         """
         Returns a list of all users in an organization. Users that have expired access will not be returned.
 
@@ -345,7 +360,7 @@ class AsyncRawUsersClient:
 
         Returns
         -------
-        AsyncHttpResponse[ListUsersResponse]
+        AsyncPager[User]
             List all users.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -359,14 +374,30 @@ class AsyncRawUsersClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListUsersResponse,
                     parse_obj_as(
                         type_=ListUsersResponse,  # 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/v_1_messages/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+