samsara-api 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

samsara/__init__.py

@@ -2347,7 +2347,6 @@ from .attributes import (
     UpdateAttributeRequestAttributeValueQuantity,
     UpdateAttributeRequestEntityType,
 )
-from .auth import GetTokenResponse
 from .client import AsyncSamsara, Samsara
 from .documents import DocumentsPostDocumentRequestBodyState
 from .driver_vehicle_assignments import (
@@ -3351,7 +3350,6 @@ __all__ = [
     "GetDriverTrailerAssignmentsResponseBodyResponseBody",
     "GetMediaRetrievalObjectResponseBody",
     "GetResponseWorkflowConfigurationObjectResponseBody",
-    "GetTokenResponse",
     "GetWorkflowIncidentResponseObjectResponseBody",
     "GoaAddressTinyResponseResponseBody",
     "GoaAttributeTinyRequestBody",

samsara/auth/__init__.py

@@ -2,6 +2,7 @@
 
 # isort: skip_file
 
-from .types import GetTokenResponse
+from . import tokens
+from .tokens import CreateTokensResponse
 
-__all__ = ["GetTokenResponse"]
+__all__ = ["CreateTokensResponse", "tokens"]

samsara/auth/client.py

@@ -1,19 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.request_options import RequestOptions
 from .raw_client import AsyncRawAuthClient, RawAuthClient
-from .types.get_token_response import GetTokenResponse
-
-# this is used as the default value for optional parameters
-OMIT = typing.cast(typing.Any, ...)
+from .tokens.client import AsyncTokensClient, TokensClient
 
 
 class AuthClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._raw_client = RawAuthClient(client_wrapper=client_wrapper)
+        self.tokens = TokensClient(client_wrapper=client_wrapper)
 
     @property
     def with_raw_response(self) -> RawAuthClient:
@@ -26,49 +21,11 @@ class AuthClient:
         """
         return self._raw_client
 
-    def get_token(
-        self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetTokenResponse:
-        """
-        Obtain an OAuth2 access token using client credentials
-
-        Parameters
-        ----------
-        client_id : str
-            The client ID of the application
-
-        client_secret : str
-            The client secret of the application
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        GetTokenResponse
-            Successful response
-
-        Examples
-        --------
-        from samsara import Samsara
-
-        client = Samsara(
-            token="YOUR_TOKEN",
-        )
-        client.auth.get_token(
-            client_id="client_id",
-            client_secret="client_secret",
-        )
-        """
-        _response = self._raw_client.get_token(
-            client_id=client_id, client_secret=client_secret, request_options=request_options
-        )
-        return _response.data
-
 
 class AsyncAuthClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._raw_client = AsyncRawAuthClient(client_wrapper=client_wrapper)
+        self.tokens = AsyncTokensClient(client_wrapper=client_wrapper)
 
     @property
     def with_raw_response(self) -> AsyncRawAuthClient:
@@ -80,50 +37,3 @@ class AsyncAuthClient:
         AsyncRawAuthClient
         """
         return self._raw_client
-
-    async def get_token(
-        self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetTokenResponse:
-        """
-        Obtain an OAuth2 access token using client credentials
-
-        Parameters
-        ----------
-        client_id : str
-            The client ID of the application
-
-        client_secret : str
-            The client secret of the application
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        GetTokenResponse
-            Successful response
-
-        Examples
-        --------
-        import asyncio
-
-        from samsara import AsyncSamsara
-
-        client = AsyncSamsara(
-            token="YOUR_TOKEN",
-        )
-
-
-        async def main() -> None:
-            await client.auth.get_token(
-                client_id="client_id",
-                client_secret="client_secret",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.get_token(
-            client_id=client_id, client_secret=client_secret, request_options=request_options
-        )
-        return _response.data

samsara/auth/raw_client.py

@@ -1,128 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-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.pydantic_utilities import parse_obj_as
-from ..core.request_options import RequestOptions
-from .types.get_token_response import GetTokenResponse
-
-# this is used as the default value for optional parameters
-OMIT = typing.cast(typing.Any, ...)
 
 
 class RawAuthClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def get_token(
-        self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[GetTokenResponse]:
-        """
-        Obtain an OAuth2 access token using client credentials
-
-        Parameters
-        ----------
-        client_id : str
-            The client ID of the application
-
-        client_secret : str
-            The client secret of the application
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HttpResponse[GetTokenResponse]
-            Successful response
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "oauth/token",
-            method="POST",
-            json={
-                "client_id": client_id,
-                "client_secret": client_secret,
-                "audience": "https://api.samsara.com",
-                "grant_type": "authorization_code",
-            },
-            headers={
-                "content-type": "application/json",
-            },
-            request_options=request_options,
-            omit=OMIT,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    GetTokenResponse,
-                    parse_obj_as(
-                        type_=GetTokenResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return HttpResponse(response=_response, data=_data)
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
-
 
 class AsyncRawAuthClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
-
-    async def get_token(
-        self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[GetTokenResponse]:
-        """
-        Obtain an OAuth2 access token using client credentials
-
-        Parameters
-        ----------
-        client_id : str
-            The client ID of the application
-
-        client_secret : str
-            The client secret of the application
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AsyncHttpResponse[GetTokenResponse]
-            Successful response
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "oauth/token",
-            method="POST",
-            json={
-                "client_id": client_id,
-                "client_secret": client_secret,
-                "audience": "https://api.samsara.com",
-                "grant_type": "authorization_code",
-            },
-            headers={
-                "content-type": "application/json",
-            },
-            request_options=request_options,
-            omit=OMIT,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    GetTokenResponse,
-                    parse_obj_as(
-                        type_=GetTokenResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return AsyncHttpResponse(response=_response, data=_data)
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

samsara/auth/{types → tokens}/__init__.py

@@ -2,6 +2,6 @@
 
 # isort: skip_file
 
-from .get_token_response import GetTokenResponse
+from .types import CreateTokensResponse
 
-__all__ = ["GetTokenResponse"]
+__all__ = ["CreateTokensResponse"]

samsara/auth/tokens/client.py

@@ -0,0 +1,185 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawTokensClient, RawTokensClient
+from .types.create_tokens_response import CreateTokensResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class TokensClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawTokensClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawTokensClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawTokensClient
+        """
+        return self._raw_client
+
+    def create(
+        self, *, code: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateTokensResponse:
+        """
+        Exchange an authorization code for access and refresh tokens.
+
+        Parameters
+        ----------
+        code : typing.Optional[str]
+            The client secret of the application
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateTokensResponse
+            Successful response
+
+        Examples
+        --------
+        from samsara import Samsara
+
+        client = Samsara(
+            token="YOUR_TOKEN",
+        )
+        client.auth.tokens.create()
+        """
+        _response = self._raw_client.create(code=code, request_options=request_options)
+        return _response.data
+
+    def revoke(self, *, token: str, request_options: typing.Optional[RequestOptions] = None) -> CreateTokensResponse:
+        """
+        Invalidates access tokens and refresh tokens for that organization
+
+        Parameters
+        ----------
+        token : str
+            The token to revoke
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateTokensResponse
+            Successful response
+
+        Examples
+        --------
+        from samsara import Samsara
+
+        client = Samsara(
+            token="YOUR_TOKEN",
+        )
+        client.auth.tokens.revoke(
+            token="token",
+        )
+        """
+        _response = self._raw_client.revoke(token=token, request_options=request_options)
+        return _response.data
+
+
+class AsyncTokensClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawTokensClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawTokensClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawTokensClient
+        """
+        return self._raw_client
+
+    async def create(
+        self, *, code: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateTokensResponse:
+        """
+        Exchange an authorization code for access and refresh tokens.
+
+        Parameters
+        ----------
+        code : typing.Optional[str]
+            The client secret of the application
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateTokensResponse
+            Successful response
+
+        Examples
+        --------
+        import asyncio
+
+        from samsara import AsyncSamsara
+
+        client = AsyncSamsara(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.auth.tokens.create()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(code=code, request_options=request_options)
+        return _response.data
+
+    async def revoke(
+        self, *, token: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateTokensResponse:
+        """
+        Invalidates access tokens and refresh tokens for that organization
+
+        Parameters
+        ----------
+        token : str
+            The token to revoke
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateTokensResponse
+            Successful response
+
+        Examples
+        --------
+        import asyncio
+
+        from samsara import AsyncSamsara
+
+        client = AsyncSamsara(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.auth.tokens.revoke(
+                token="token",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.revoke(token=token, request_options=request_options)
+        return _response.data

samsara/auth/tokens/raw_client.py

@@ -0,0 +1,210 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+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.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+from .types.create_tokens_response import CreateTokensResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawTokensClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self, *, code: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[CreateTokensResponse]:
+        """
+        Exchange an authorization code for access and refresh tokens.
+
+        Parameters
+        ----------
+        code : typing.Optional[str]
+            The client secret of the application
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreateTokensResponse]
+            Successful response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "oauth2/token",
+            method="POST",
+            json={
+                "code": code,
+                "grant_type": "authorization_code",
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateTokensResponse,
+                    parse_obj_as(
+                        type_=CreateTokensResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def revoke(
+        self, *, token: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[CreateTokensResponse]:
+        """
+        Invalidates access tokens and refresh tokens for that organization
+
+        Parameters
+        ----------
+        token : str
+            The token to revoke
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreateTokensResponse]
+            Successful response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "oauth2/revoke",
+            method="POST",
+            json={
+                "token": token,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateTokensResponse,
+                    parse_obj_as(
+                        type_=CreateTokensResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawTokensClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self, *, code: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[CreateTokensResponse]:
+        """
+        Exchange an authorization code for access and refresh tokens.
+
+        Parameters
+        ----------
+        code : typing.Optional[str]
+            The client secret of the application
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreateTokensResponse]
+            Successful response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "oauth2/token",
+            method="POST",
+            json={
+                "code": code,
+                "grant_type": "authorization_code",
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateTokensResponse,
+                    parse_obj_as(
+                        type_=CreateTokensResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def revoke(
+        self, *, token: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[CreateTokensResponse]:
+        """
+        Invalidates access tokens and refresh tokens for that organization
+
+        Parameters
+        ----------
+        token : str
+            The token to revoke
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreateTokensResponse]
+            Successful response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "oauth2/revoke",
+            method="POST",
+            json={
+                "token": token,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateTokensResponse,
+                    parse_obj_as(
+                        type_=CreateTokensResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

samsara/auth/tokens/types/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .create_tokens_response import CreateTokensResponse
+
+__all__ = ["CreateTokensResponse"]

samsara/auth/{types/get_token_response.py → tokens/types/create_tokens_response.py}

@@ -3,13 +3,15 @@
 import typing
 
 import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class GetTokenResponse(UniversalBaseModel):
+class CreateTokensResponse(UniversalBaseModel):
     access_token: str
     token_type: str
     expires_in: int
+    refresh_token: str
+    scope: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

samsara/client.py

@@ -160,8 +160,8 @@ class Samsara:
         self.users = UsersClient(client_wrapper=self._client_wrapper)
         self.v_1_messages = V1MessagesClient(client_wrapper=self._client_wrapper)
         self.webhooks = WebhooksClient(client_wrapper=self._client_wrapper)
-        self.auth = AuthClient(client_wrapper=self._client_wrapper)
         self.alerts = AlertsClient(client_wrapper=self._client_wrapper)
+        self.auth = AuthClient(client_wrapper=self._client_wrapper)
         self.cameras = CamerasClient(client_wrapper=self._client_wrapper)
         self.coaching = CoachingClient(client_wrapper=self._client_wrapper)
         self.ifta = IftaClient(client_wrapper=self._client_wrapper)
@@ -273,8 +273,8 @@ class AsyncSamsara:
         self.users = AsyncUsersClient(client_wrapper=self._client_wrapper)
         self.v_1_messages = AsyncV1MessagesClient(client_wrapper=self._client_wrapper)
         self.webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper)
-        self.auth = AsyncAuthClient(client_wrapper=self._client_wrapper)
         self.alerts = AsyncAlertsClient(client_wrapper=self._client_wrapper)
+        self.auth = AsyncAuthClient(client_wrapper=self._client_wrapper)
         self.cameras = AsyncCamerasClient(client_wrapper=self._client_wrapper)
         self.coaching = AsyncCoachingClient(client_wrapper=self._client_wrapper)
         self.ifta = AsyncIftaClient(client_wrapper=self._client_wrapper)

samsara/core/client_wrapper.py

@@ -20,10 +20,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "samsara-api/0.0.2",
+            "User-Agent": "samsara-api/0.0.4",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "samsara-api",
-            "X-Fern-SDK-Version": "0.0.2",
+            "X-Fern-SDK-Version": "0.0.4",
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers

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/utils/webhooks_helper.py

@@ -0,0 +1,52 @@
+import base64
+import hashlib
+import hmac
+
+
+def verify_signature(
+    *,
+    request_body: str,
+    signature_header: str,
+    signature_key: str,
+    notification_url: str,
+) -> bool:
+    """
+    Verifies and validates an event notification. See the `documentation`_ for more details.
+
+    Args:
+        request_body:       The JSON body of the request.
+        signature_header:   The value for the `x-samsara-hmacsha256-signature` header.
+        signature_key:      The signature key from the Samsara Developer portal for the webhook subscription.
+        notification_url:   The notification endpoint URL as defined in the Samsara Developer portal for the webhook
+                            subscription.
+
+    Returns:
+        bool: True if the signature is valid, indicating that the event can be trusted as it came from Samsara.
+            False if the signature validation fails, indicating that the event did not come from Samsara, so it may
+            be malicious and should be discarded.
+
+    Raises:
+        ValueError: if `signature_key` or `notification_url` are empty.
+    """
+    if not request_body:
+        return False
+    if not signature_key:
+        raise ValueError("signature_key is empty")
+    if not notification_url:
+        raise ValueError("notification_url is empty")
+
+    # Perform UTF-8 encoding to bytes
+    payload = notification_url + request_body
+    payload_bytes = payload.encode("utf-8")
+    signature_header_bytes = signature_header.encode("utf-8")
+    signature_key_bytes = signature_key.encode("utf-8")
+
+    # Compute the hash value
+    hashing_obj = hmac.new(
+        key=signature_key_bytes, msg=payload_bytes, digestmod=hashlib.sha256
+    )
+    hash_bytes = hashing_obj.digest()
+
+    # Compare the computed hash vs the value in the signature header
+    hash_base64 = base64.b64encode(hash_bytes)
+    return hmac.compare_digest(hash_base64, signature_header_bytes)

samsara_api-0.0.4.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.1
+Name: samsara-api
+Version: 0.0.4
+Summary: 
+License: MIT
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Samsara Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fsamsarahq%2Fsamsara-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/samsara-api)](https://pypi.python.org/pypi/samsara-api)
+
+The Samsara Python library provides convenient access to the Samsara API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://developers.samsara.com/reference/overview).
+
+## Installation
+
+```sh
+pip install samsara-api
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/samsarahq/samsara-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from samsara import Samsara
+
+client = Samsara(
+    token="YOUR_TOKEN",
+)
+response = client.vehicles.stats.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from samsara import AsyncSamsara
+
+client = AsyncSamsara(
+    token="YOUR_TOKEN",
+)
+
+
+async def main() -> None:
+    response = await client.vehicles.stats.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())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from samsara.core.api_error import ApiError
+
+try:
+    client.vehicles.stats.list(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from samsara import Samsara
+
+client = Samsara(
+    token="YOUR_TOKEN",
+)
+response = client.addresses.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Webhook Signature Verification
+
+The SDK provides utility methods that allow you to verify webhook signatures and ensure
+that all webhook events originate from Samsara. The `verify_signature` method will verify
+the signature.
+
+```python
+from samsara.utils.webhooks_helper import verify_signature
+
+is_valid = verify_signature(
+    request_body=request_body,
+    signature_header=request.headers['x-samsara-hmacsha256-signature'],
+    signature_key="YOUR_SIGNATURE_KEY",
+    notification_url="https://example.com/webhook", # The URL where event notifications are sent.
+)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from samsara import Samsara
+
+client = Samsara(
+    ...,
+)
+response = client.vehicles.stats.with_raw_response.list(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+pager = client.addresses.list(...)
+print(pager.response.headers)  # access the response headers for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response.headers)  # access the response headers for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.vehicles.stats.list(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from samsara import Samsara
+
+client = Samsara(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.vehicles.stats.list(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from samsara import Samsara
+
+client = Samsara(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

{samsara_api-0.0.2.dist-info → samsara_api-0.0.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-samsara/__init__.py,sha256=HRhnyJ-x92KjlApCf6lfvtKrk4M3InEH9viRqJvQxvw,243440
+samsara/__init__.py,sha256=92NvaQpSlOyKeuVpidF-8CqSBNqs-mUz8-ISlOKTWA4,243381
 samsara/addresses/__init__.py,sha256=VwNk87ydCDVCvXs50iVyOtmRChWMryj-qaD37dmXEHE,271
 samsara/addresses/client.py,sha256=NmZDd3Q5xZsNDD-NlBZ6dIxIxHNQUVs9DDZ-3b38qQQ,31432
 samsara/addresses/raw_client.py,sha256=dF0VKXWrRMpZ_FYBwT5Z58StWm1nE7VCQVE4NouRvF0,39437
@@ -41,11 +41,14 @@ samsara/attributes/types/create_attribute_request_entity_type.py,sha256=YVWNyZIS
 samsara/attributes/types/update_attribute_request_attribute_type.py,sha256=nmtbsmoh3lh6NkGW6UVDbrwLSf_Kyp0FmJJyzC60yfY,179
 samsara/attributes/types/update_attribute_request_attribute_value_quantity.py,sha256=UIX4mHT8iNREa_H6CuXcpgIH42KKKQRpnUgxpoYy_P4,187
 samsara/attributes/types/update_attribute_request_entity_type.py,sha256=O3P4cbLmICVFdTzcEUWq4HSpheSpWE-TZfz4HElX9bM,175
-samsara/auth/__init__.py,sha256=18OnM9Fc3eM8ONstdOBjtrf6crsICGrbrJrXs7s6nYw,153
-samsara/auth/client.py,sha256=mVAxQrlLNrX4BVQ-hLm5nK_7P8t6HfMspkberB5uroY,3517
-samsara/auth/raw_client.py,sha256=MFyDhlQ7UFDnSI1e42i04ldoJtvheRStKKossYkU0gc,4574
-samsara/auth/types/__init__.py,sha256=5Tq3eLsH_mAnAdBhkIT7OOx8uJWr1nxusbXq2XdQwlo,166
-samsara/auth/types/get_token_response.py,sha256=P3VDAqNPv_l8HoUWuveV3SHKqhcADcdbxn1xtLnK5Mo,572
+samsara/auth/__init__.py,sha256=9yWTBw0ONdi-3tmC4kjbCpApiVniv2aK5csdVnHOI20,193
+samsara/auth/client.py,sha256=iGRrTmTAyBspdf_-HcGqn0Pb0s1HQwco4PoSphDFwEU,1236
+samsara/auth/raw_client.py,sha256=Xjah5juxJ0L8FfHyZBKMoOVHWxzvqTv4qtQixxA3jDc,405
+samsara/auth/tokens/__init__.py,sha256=gbhdUVQ3-j2WiNIQN0-h_5RODBZ4gvJgteMmSdgtscQ,161
+samsara/auth/tokens/client.py,sha256=g6AlGPqOt3gHPDrz2q9Glemm7jEGHFiGFnijUY4a66Q,4959
+samsara/auth/tokens/raw_client.py,sha256=ZEnP5Xi8DkY-SEsiQkNAsB3b06AIoal5_cmRcW_Zuxo,7528
+samsara/auth/tokens/types/__init__.py,sha256=XmB_JdsWYwBG-Tz8M8Qj3rfQJWmQtPXDtsFiqy_VuNs,178
+samsara/auth/tokens/types/create_tokens_response.py,sha256=wcHMN9xNW0DfH4-wXKa1l1mY14BmMxl6UDLJGLwNDsY,615
 samsara/cameras/__init__.py,sha256=6oUbRWZI3I0mSd4P2kGnp-bNVIQoyoR6J4_1OXzluws,361
 samsara/cameras/client.py,sha256=HdYw4W_X5eIuR9zOYL9IyIrIyeYRIicK9RNdsKPnKJg,1259
 samsara/cameras/media/__init__.py,sha256=bXxa72UiJqERML9R4PL4PCNWKFZhTCrly5ZvF7__7rA,634
@@ -65,7 +68,7 @@ samsara/cameras/raw_client.py,sha256=X7YzaI5nwgwczR-A4OwhSK54TQW6VfCzs00pgNTMuUU
 samsara/carrier_proposed_assignments/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
 samsara/carrier_proposed_assignments/client.py,sha256=UDeSIJ17UU_TboofUe-Y8uIY1zBNNtt9Ss7msqIiLac,17860
 samsara/carrier_proposed_assignments/raw_client.py,sha256=NW9vhF3XwbYEK5nQDzhGYzxkEx4a_wIqL4gqU-npmn0,22836
-samsara/client.py,sha256=rsL4dfA2Li863oRh2IJ-zypCEhCJLN8yyOnKW_Os_bU,17115
+samsara/client.py,sha256=852-56uS8ECcrGvhCp-ykxHYJLSuy7VRe0F1iVPk4tw,17115
 samsara/coaching/__init__.py,sha256=LfmwpXue7wsY-q1lfvX-AYcU4JdP1x0zVtofVAh4pAA,186
 samsara/coaching/client.py,sha256=ULolm0GnWQmfOVzY1FE8vBMaLl-m0InJutgkQJ4lfps,1606
 samsara/coaching/driver_coach_assignments/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
@@ -80,7 +83,7 @@ samsara/contacts/client.py,sha256=-DvPNxYQZboAYekVkG22JH8GLN5Pb441W0pD7amZue8,19
 samsara/contacts/raw_client.py,sha256=nMFcdeS_I53QS01zxF2yeY6-t6cbQ7ZeZeqUxKcH7yI,27530
 samsara/core/__init__.py,sha256=4POYbbRlgR7TwGFY5nmHpaa7nFgXOX_pYHcN1Ezh2p8,1643
 samsara/core/api_error.py,sha256=44vPoTyWN59gonCIZMdzw7M1uspygiLnr3GNFOoVL2Q,614
-samsara/core/client_wrapper.py,sha256=tylN7Z47lS0PcCy8T0aZZcteEYdsU7dLfM9oTf7mQ9k,2236
+samsara/core/client_wrapper.py,sha256=9ANX-olJY3Lv-BmJeGdRh408Cu9mhWO74esp7VjH7jI,2236
 samsara/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 samsara/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
 samsara/core/force_multipart.py,sha256=awxh5MtcRYe74ehY8U76jzv6fYM_w_D3Rur7KQQzSDk,429
@@ -2514,10 +2517,10 @@ samsara/types/work_order_attachment_object_response_body.py,sha256=Ce66d8VXVdpVL
 samsara/types/work_order_attachment_object_response_body_processing_status.py,sha256=w82JZVehbfKHNKnX6yGJ4ZioPLQeU-Yl5g5-LDdVe80,220
 samsara/types/work_order_discount_object_request_body.py,sha256=ypiPPoF0rkmdpYsBjq0rF-Q9e7w4uYEGnyXK9fspt5s,1074
 samsara/types/work_order_discount_object_response_body.py,sha256=Z2Xy7CmOcUAduOpIKSVR2l_WqqJIys1zxH_-e8M2-NA,1078
-samsara/types/work_order_item_object_request_body.py,sha256=Y3cTjYnwDnb8URFotb3uKlsIchOOZJ96uTbvcNgtQ-A,933
-samsara/types/work_order_item_object_request_body_type.py,sha256=VscZ6y43wrrUM6babjcrpryDyhTW7Fm0jN770scYuFw,248
-samsara/types/work_order_item_object_response_body.py,sha256=bGvcAkoyQJhCgBLWhx4WAL77CcxT6MPTbrY1fDmq30s,937
-samsara/types/work_order_item_object_response_body_type.py,sha256=hiB3lQvaJJrAiRCy73GRJN_hCFBg8u4j4nKQ45KqR5M,249
+samsara/types/work_order_item_object_request_body.py,sha256=IR7-f72UooE1Sz5NZtihDMmdZFwsrlj0nhKonrWfx_o,965
+samsara/types/work_order_item_object_request_body_type.py,sha256=vguZe7JH6HLX_7I0qaCErNPllbGiPw1COKxVnoBtYEg,348
+samsara/types/work_order_item_object_response_body.py,sha256=1amSCQKCs6IrqLv9UsSJmaQT4LprDgNVGA688RyqVxg,969
+samsara/types/work_order_item_object_response_body_type.py,sha256=aHS_rnbm5qvc3IghV3sGvE6qOV6057U6X8OLJ3YjOhM,349
 samsara/types/work_order_money_object_request_body.py,sha256=Urpvg5aIH9fx6VStIclHqVhUVp8brDi8_YgD2fb1JUE,816
 samsara/types/work_order_money_object_response_body.py,sha256=7u8dbgEpMRr7s4Yxe2RCEx7l676q7DR-rOkMoNsjkC4,817
 samsara/types/work_order_object_response_body.py,sha256=NXgUY522IAzRXhINXnDSc7L8PYh0Q1qRBAWyntbEEvI,5341
@@ -2610,6 +2613,7 @@ samsara/users/raw_client.py,sha256=aeoDOnJ4dMB4O3WocJXATsCiK-zNHodq09tBBYgaD8w,3
 samsara/users/types/__init__.py,sha256=yVRLnN-wUYfYcYWwrgJSM8GIRnVdqk207hLlDqal0GM,293
 samsara/users/types/create_user_request_auth_type.py,sha256=rdNs3jjJv7IY0koJ6vpgdE79OskOYbA6zUrYMijKmMw,168
 samsara/users/types/update_user_request_auth_type.py,sha256=E2r4bzBS0lwPCWrUwC37GfMlt8Hv-YGw_3abv6wNN-Q,168
+samsara/utils/webhooks_helper.py,sha256=oosLIOouDmGa7a6xj4sI_EfUSvtzfqB6uXXaUKaagP8,1911
 samsara/v_1_messages/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
 samsara/v_1_messages/client.py,sha256=rhUwhh0L3IcgD3sglfNtZMyeLM2j1ogrpMe4902yTos,9734
 samsara/v_1_messages/raw_client.py,sha256=3_5CVjrIRu2VREzYtcV7sQBz0K0F_tOwPDNcMSGDBOw,11896
@@ -2654,7 +2658,7 @@ samsara/webhooks/types/__init__.py,sha256=gZew8TwQaEiQWvSAewo9htvyM3UqVSZc1UJ2Aa
 samsara/webhooks/types/webhooks_patch_webhook_request_body_version.py,sha256=WaQrAnZGbaz7eQ6fpnX77L5nb8dLwuUkEQdvx5mCGAw,224
 samsara/webhooks/types/webhooks_post_webhooks_request_body_event_types_item.py,sha256=-whKIc9UjBEIXZUxwkDULLSxR0Dg_-6KxRUjcfyvTuQ,927
 samsara/webhooks/types/webhooks_post_webhooks_request_body_version.py,sha256=1HR1l6_Qc_jS_mf_UkguxgMiiIeAiwaX7jjOTQfG1bw,224
-samsara_api-0.0.2.dist-info/LICENSE,sha256=uX-nl5hOEHp4uvQPCcpde-doNbQhV5uRQNwkB474IoQ,1064
-samsara_api-0.0.2.dist-info/METADATA,sha256=mvat8gIq2ExK6kWTz_VALsf6nmMxPreEb0ovLOIGmdM,1067
-samsara_api-0.0.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-samsara_api-0.0.2.dist-info/RECORD,,
+samsara_api-0.0.4.dist-info/LICENSE,sha256=uX-nl5hOEHp4uvQPCcpde-doNbQhV5uRQNwkB474IoQ,1064
+samsara_api-0.0.4.dist-info/METADATA,sha256=9uB-xryoMS0LeZ1qLICrPttG2gNMHa6AQ_nNQiyyI28,6831
+samsara_api-0.0.4.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+samsara_api-0.0.4.dist-info/RECORD,,

samsara_api-0.0.2.dist-info/METADATA

@@ -1,29 +0,0 @@
-Metadata-Version: 2.1
-Name: samsara-api
-Version: 0.0.2
-Summary: 
-License: MIT
-Requires-Python: >=3.8,<4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: OS Independent
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
-Requires-Dist: httpx (>=0.21.2)
-Requires-Dist: pydantic (>=1.9.2)
-Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
-Requires-Dist: typing_extensions (>=4.0.0)
-Description-Content-Type: text/markdown
-
-