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

samsara/{beta → forms}/raw_client.py

@@ -17,75 +17,61 @@ from ..errors.not_implemented_error import NotImplementedError
 from ..errors.service_unavailable_error import ServiceUnavailableError
 from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unauthorized_error import UnauthorizedError
-from ..types.hos_daily_logs_update_shipping_docs_response_body import HosDailyLogsUpdateShippingDocsResponseBody
+from ..types.form_templates_get_form_templates_response_body import FormTemplatesGetFormTemplatesResponseBody
 
-# this is used as the default value for optional parameters
-OMIT = typing.cast(typing.Any, ...)
 
-
-class RawBetaClient:
+class RawFormsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def update_shipping_docs(
+    def get_form_templates(
         self,
         *,
-        hos_date: str,
-        driver_id: str,
-        shipping_docs: str,
+        ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[HosDailyLogsUpdateShippingDocsResponseBody]:
+    ) -> HttpResponse[FormTemplatesGetFormTemplatesResponseBody]:
         """
-        Update the shippingDocs field of an existing assignment.
+        Returns a list of the organization's form templates for the specified list of IDs. If no IDs are provided, all form templates for the organization will be returned.
 
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
 
         Parameters
         ----------
-        hos_date : str
-            A start date in yyyy-mm-dd format. Required.
-
-        driver_id : str
-            ID of the driver for whom the duty status is being set.
+        ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            A comma-separated list containing up to 100 template IDs to filter on.
 
-        shipping_docs : str
-            ShippingDocs associated with the driver for the day.
+        after : typing.Optional[str]
+             If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        HttpResponse[HosDailyLogsUpdateShippingDocsResponseBody]
+        HttpResponse[FormTemplatesGetFormTemplatesResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
-            "hos/daily-logs/log-meta-data",
-            method="PATCH",
+            "form-templates",
+            method="GET",
             params={
-                "hosDate": hos_date,
-                "driverID": driver_id,
-            },
-            json={
-                "shippingDocs": shipping_docs,
-            },
-            headers={
-                "content-type": "application/json",
+                "ids": ids,
+                "after": after,
             },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    HosDailyLogsUpdateShippingDocsResponseBody,
+                    FormTemplatesGetFormTemplatesResponseBody,
                     parse_obj_as(
-                        type_=HosDailyLogsUpdateShippingDocsResponseBody,  # type: ignore
+                        type_=FormTemplatesGetFormTemplatesResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -195,69 +181,58 @@ class RawBetaClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
 
-class AsyncRawBetaClient:
+class AsyncRawFormsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def update_shipping_docs(
+    async def get_form_templates(
         self,
         *,
-        hos_date: str,
-        driver_id: str,
-        shipping_docs: str,
+        ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[HosDailyLogsUpdateShippingDocsResponseBody]:
+    ) -> AsyncHttpResponse[FormTemplatesGetFormTemplatesResponseBody]:
         """
-        Update the shippingDocs field of an existing assignment.
+        Returns a list of the organization's form templates for the specified list of IDs. If no IDs are provided, all form templates for the organization will be returned.
 
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
 
         Parameters
         ----------
-        hos_date : str
-            A start date in yyyy-mm-dd format. Required.
+        ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            A comma-separated list containing up to 100 template IDs to filter on.
 
-        driver_id : str
-            ID of the driver for whom the duty status is being set.
-
-        shipping_docs : str
-            ShippingDocs associated with the driver for the day.
+        after : typing.Optional[str]
+             If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AsyncHttpResponse[HosDailyLogsUpdateShippingDocsResponseBody]
+        AsyncHttpResponse[FormTemplatesGetFormTemplatesResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "hos/daily-logs/log-meta-data",
-            method="PATCH",
+            "form-templates",
+            method="GET",
             params={
-                "hosDate": hos_date,
-                "driverID": driver_id,
-            },
-            json={
-                "shippingDocs": shipping_docs,
-            },
-            headers={
-                "content-type": "application/json",
+                "ids": ids,
+                "after": after,
             },
             request_options=request_options,
-            omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    HosDailyLogsUpdateShippingDocsResponseBody,
+                    FormTemplatesGetFormTemplatesResponseBody,
                     parse_obj_as(
-                        type_=HosDailyLogsUpdateShippingDocsResponseBody,  # type: ignore
+                        type_=FormTemplatesGetFormTemplatesResponseBody,  # type: ignore
                         object_=_response.json(),
                     ),
                 )

samsara/function.py

@@ -0,0 +1,99 @@
+import json
+import os
+from typing import Dict, Any, Optional, Protocol
+
+
+class SSMClientProtocol(Protocol):
+    """Protocol defining the SSM client interface we need."""
+
+    def get_parameter(self, Name: str, WithDecryption: bool) -> Dict[str, Any]:
+        """Get parameter from SSM."""
+        ...
+
+
+class Secrets:
+    """
+    Handles loading secrets from either local environment or AWS Parameter Store.
+    """
+
+    def __init__(self, client: Optional[SSMClientProtocol]) -> None:
+        """
+        Initialize the Secrets handler.
+
+        Args:
+            client: SSM client for accessing AWS Parameter Store, or None for local development
+        """
+        self.__client = client
+
+    def load(self) -> Dict[str, Any]:
+        """
+        Load secrets from the appropriate source based on environment.
+
+        When running locally, secrets are loaded from the
+        'SamsaraFunctionLocalSecretsJson' environment variable.
+
+        Returns:
+            Dict containing the parsed secrets
+        """
+        if self.__client is None:
+            return json.loads(os.environ.get("SamsaraFunctionLocalSecretsJson", "{}"))
+
+        res = self.__client.get_parameter(
+            Name=os.environ["SamsaraFunctionSecretsPath"], WithDecryption=True
+        )
+
+        value = res["Parameter"]["Value"]
+        if value == "null":
+            return {}
+
+        return json.loads(value)
+
+
+class Function:
+    """
+    Handles environment detection and secrets management.
+    """
+
+    def __init__(
+        self, is_local: bool = os.environ.get("AWS_EXECUTION_ENV", "") == ""
+    ) -> None:
+        """
+        Initialize the function with appropriate configuration based on environment.
+
+        Args:
+            is_local: Flag indicating if running in local development environment
+
+        Note:
+            The is_local parameter doesn't need to be set explicitly as it defaults to
+            checking if AWS_EXECUTION_ENV is empty. This environment variable is automatically
+            set by AWS Lambda when running in the cloud, but will be empty during local
+            development, making the detection automatic in most cases.
+        """
+        if is_local:
+            self.__secrets = Secrets(None)
+        else:
+            # boto3 is always available in the execution enviroment and not required in development.
+            import boto3  # type: ignore
+
+            sts = boto3.client("sts")
+            res = sts.assume_role(
+                RoleArn=os.environ["SamsaraFunctionExecRoleArn"],
+                RoleSessionName=os.environ["SamsaraFunctionName"],
+            )
+
+            credentials = {
+                "aws_access_key_id": res["Credentials"]["AccessKeyId"],
+                "aws_secret_access_key": res["Credentials"]["SecretAccessKey"],
+                "aws_session_token": res["Credentials"]["SessionToken"],
+            }
+
+            self.__secrets = Secrets(boto3.client("ssm", **credentials))
+
+    def secrets(self) -> Secrets:
+        """
+        Get the secrets handler.
+
+        Returns:
+            The configured Secrets instance
+        """
+        return self.__secrets

samsara/gateways/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.gateways_get_gateways_response_body import GatewaysGetGatewaysResponseBody
+from ..types.gateway_response_object_response_body import GatewayResponseObjectResponseBody
 from ..types.gateways_post_gateway_response_body import GatewaysPostGatewayResponseBody
 from .raw_client import AsyncRawGatewaysClient, RawGatewaysClient
 
@@ -33,7 +34,7 @@ class GatewaysClient:
         models: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> GatewaysGetGatewaysResponseBody:
+    ) -> SyncPager[GatewayResponseObjectResponseBody]:
         """
         List all gateways
 
@@ -57,7 +58,7 @@ class GatewaysClient:
 
         Returns
         -------
-        GatewaysGetGatewaysResponseBody
+        SyncPager[GatewayResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -67,10 +68,14 @@ class GatewaysClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.gateways.list()
+        response = client.gateways.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(models=models, after=after, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(models=models, after=after, request_options=request_options)
 
     def create(
         self, *, serial: str, request_options: typing.Optional[RequestOptions] = None
@@ -171,7 +176,7 @@ class AsyncGatewaysClient:
         models: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> GatewaysGetGatewaysResponseBody:
+    ) -> AsyncPager[GatewayResponseObjectResponseBody]:
         """
         List all gateways
 
@@ -195,7 +200,7 @@ class AsyncGatewaysClient:
 
         Returns
         -------
-        GatewaysGetGatewaysResponseBody
+        AsyncPager[GatewayResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -210,13 +215,18 @@ class AsyncGatewaysClient:
 
 
         async def main() -> None:
-            await client.gateways.list()
+            response = await client.gateways.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(models=models, after=after, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(models=models, after=after, request_options=request_options)
 
     async def create(
         self, *, serial: str, request_options: typing.Optional[RequestOptions] = None

samsara/gateways/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 ..errors.bad_gateway_error import BadGatewayError
@@ -18,6 +19,7 @@ from ..errors.not_implemented_error import NotImplementedError
 from ..errors.service_unavailable_error import ServiceUnavailableError
 from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unauthorized_error import UnauthorizedError
+from ..types.gateway_response_object_response_body import GatewayResponseObjectResponseBody
 from ..types.gateways_get_gateways_response_body import GatewaysGetGatewaysResponseBody
 from ..types.gateways_post_gateway_response_body import GatewaysPostGatewayResponseBody
 
@@ -35,7 +37,7 @@ class RawGatewaysClient:
         models: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[GatewaysGetGatewaysResponseBody]:
+    ) -> SyncPager[GatewayResponseObjectResponseBody]:
         """
         List all gateways
 
@@ -59,7 +61,7 @@ class RawGatewaysClient:
 
         Returns
         -------
-        HttpResponse[GatewaysGetGatewaysResponseBody]
+        SyncPager[GatewayResponseObjectResponseBody]
             OK response.
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -73,14 +75,27 @@ class RawGatewaysClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     GatewaysGetGatewaysResponseBody,
                     parse_obj_as(
                         type_=GatewaysGetGatewaysResponseBody,  # 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(
+                        models=models,
+                        after=_parsed_next,
+                        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,7 +498,7 @@ class AsyncRawGatewaysClient:
         models: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         after: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[GatewaysGetGatewaysResponseBody]:
+    ) -> AsyncPager[GatewayResponseObjectResponseBody]:
         """
         List all gateways
 
@@ -507,7 +522,7 @@ class AsyncRawGatewaysClient:
 
         Returns
         -------
-        AsyncHttpResponse[GatewaysGetGatewaysResponseBody]
+        AsyncPager[GatewayResponseObjectResponseBody]
             OK response.
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -521,14 +536,30 @@ class AsyncRawGatewaysClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     GatewaysGetGatewaysResponseBody,
                     parse_obj_as(
                         type_=GatewaysGetGatewaysResponseBody,  # 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(
+                            models=models,
+                            after=_parsed_next,
+                            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),

samsara/hos/__init__.py

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