samsara-api 0.0.3__tar.gz → 2.0.0__tar.gz

{samsara_api-0.0.3 → samsara_api-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: samsara-api
-Version: 0.0.3
+Version: 2.0.0
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -125,6 +125,23 @@ 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

{samsara_api-0.0.3 → samsara_api-2.0.0}/README.md

@@ -97,6 +97,23 @@ 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

{samsara_api-0.0.3 → samsara_api-2.0.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "samsara-api"
 
 [tool.poetry]
 name = "samsara-api"
-version = "0.0.3"
+version = "2.0.0"
 description = ""
 readme = "README.md"
 authors = []

{samsara_api-0.0.3 → samsara_api-2.0.0}/src/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_api-2.0.0/src/samsara/auth/__init__.py

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

samsara_api-2.0.0/src/samsara/auth/client.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .raw_client import AsyncRawAuthClient, RawAuthClient
+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:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAuthClient
+        """
+        return self._raw_client
+
+
+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:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAuthClient
+        """
+        return self._raw_client

samsara_api-2.0.0/src/samsara/auth/raw_client.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+
+
+class RawAuthClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+
+class AsyncRawAuthClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper

{samsara_api-0.0.3/src/samsara/auth → samsara_api-2.0.0/src/samsara/auth/tokens}/__init__.py

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

samsara_api-2.0.0/src/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_api-2.0.0/src/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_api-2.0.0/src/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_api-0.0.3/src/samsara/auth/types/get_token_response.py → samsara_api-2.0.0/src/samsara/auth/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_api-0.0.3 → samsara_api-2.0.0}/src/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.3",
+            "User-Agent": "samsara-api/2.0.0",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "samsara-api",
-            "X-Fern-SDK-Version": "0.0.3",
+            "X-Fern-SDK-Version": "2.0.0",
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers

samsara_api-2.0.0/src/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)