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

samsara/v_1_messages/client.py

@@ -0,0 +1,258 @@
+# 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 ..types.inline_response_2005 import InlineResponse2005
+from ..types.inline_response_2006 import InlineResponse2006
+from .raw_client import AsyncRawV1MessagesClient, RawV1MessagesClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class V1MessagesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawV1MessagesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawV1MessagesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawV1MessagesClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        end_ms: typing.Optional[int] = None,
+        duration_ms: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InlineResponse2005:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Get all messages.
+
+         <b>Rate limit:</b> 75 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</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.
+
+        To use this endpoint, select **Read Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        end_ms : typing.Optional[int]
+            Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.
+
+        duration_ms : typing.Optional[int]
+            Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InlineResponse2005
+            Returns the fetched messages from most recently sent to least recently sent.
+
+        Examples
+        --------
+        from samsara import Samsara
+
+        client = Samsara(
+            token="YOUR_TOKEN",
+        )
+        client.v_1_messages.list()
+        """
+        _response = self._raw_client.list(end_ms=end_ms, duration_ms=duration_ms, request_options=request_options)
+        return _response.data
+
+    def create(
+        self, *, driver_ids: typing.Sequence[int], text: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> InlineResponse2006:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Send a message to a list of driver ids.
+
+         **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.
+
+        To use this endpoint, select **Write Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        driver_ids : typing.Sequence[int]
+            IDs of the drivers for whom the messages are sent to.
+
+        text : str
+            The text sent in the message. Max 2500 characters allowed.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InlineResponse2006
+            Returns the created messages.
+
+        Examples
+        --------
+        from samsara import Samsara
+
+        client = Samsara(
+            token="YOUR_TOKEN",
+        )
+        client.v_1_messages.create(
+            driver_ids=[111, 222, 333],
+            text="This is a message.",
+        )
+        """
+        _response = self._raw_client.create(driver_ids=driver_ids, text=text, request_options=request_options)
+        return _response.data
+
+
+class AsyncV1MessagesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawV1MessagesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawV1MessagesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawV1MessagesClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        end_ms: typing.Optional[int] = None,
+        duration_ms: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InlineResponse2005:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Get all messages.
+
+         <b>Rate limit:</b> 75 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</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.
+
+        To use this endpoint, select **Read Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        end_ms : typing.Optional[int]
+            Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.
+
+        duration_ms : typing.Optional[int]
+            Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InlineResponse2005
+            Returns the fetched messages from most recently sent to least recently sent.
+
+        Examples
+        --------
+        import asyncio
+
+        from samsara import AsyncSamsara
+
+        client = AsyncSamsara(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.v_1_messages.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(end_ms=end_ms, duration_ms=duration_ms, request_options=request_options)
+        return _response.data
+
+    async def create(
+        self, *, driver_ids: typing.Sequence[int], text: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> InlineResponse2006:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Send a message to a list of driver ids.
+
+         **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.
+
+        To use this endpoint, select **Write Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        driver_ids : typing.Sequence[int]
+            IDs of the drivers for whom the messages are sent to.
+
+        text : str
+            The text sent in the message. Max 2500 characters allowed.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InlineResponse2006
+            Returns the created messages.
+
+        Examples
+        --------
+        import asyncio
+
+        from samsara import AsyncSamsara
+
+        client = AsyncSamsara(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.v_1_messages.create(
+                driver_ids=[111, 222, 333],
+                text="This is a message.",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(driver_ids=driver_ids, text=text, request_options=request_options)
+        return _response.data

samsara/v_1_messages/raw_client.py

@@ -0,0 +1,273 @@
+# 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.inline_response_2005 import InlineResponse2005
+from ..types.inline_response_2006 import InlineResponse2006
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawV1MessagesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        end_ms: typing.Optional[int] = None,
+        duration_ms: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[InlineResponse2005]:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Get all messages.
+
+         <b>Rate limit:</b> 75 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</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.
+
+        To use this endpoint, select **Read Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        end_ms : typing.Optional[int]
+            Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.
+
+        duration_ms : typing.Optional[int]
+            Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[InlineResponse2005]
+            Returns the fetched messages from most recently sent to least recently sent.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/fleet/messages",
+            method="GET",
+            params={
+                "endMs": end_ms,
+                "durationMs": duration_ms,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    InlineResponse2005,
+                    parse_obj_as(
+                        type_=InlineResponse2005,  # 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 create(
+        self, *, driver_ids: typing.Sequence[int], text: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[InlineResponse2006]:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Send a message to a list of driver ids.
+
+         **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.
+
+        To use this endpoint, select **Write Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        driver_ids : typing.Sequence[int]
+            IDs of the drivers for whom the messages are sent to.
+
+        text : str
+            The text sent in the message. Max 2500 characters allowed.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[InlineResponse2006]
+            Returns the created messages.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/fleet/messages",
+            method="POST",
+            json={
+                "driverIds": driver_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    InlineResponse2006,
+                    parse_obj_as(
+                        type_=InlineResponse2006,  # 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 AsyncRawV1MessagesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        end_ms: typing.Optional[int] = None,
+        duration_ms: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[InlineResponse2005]:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Get all messages.
+
+         <b>Rate limit:</b> 75 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</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.
+
+        To use this endpoint, select **Read Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        end_ms : typing.Optional[int]
+            Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.
+
+        duration_ms : typing.Optional[int]
+            Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[InlineResponse2005]
+            Returns the fetched messages from most recently sent to least recently sent.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/fleet/messages",
+            method="GET",
+            params={
+                "endMs": end_ms,
+                "durationMs": duration_ms,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    InlineResponse2005,
+                    parse_obj_as(
+                        type_=InlineResponse2005,  # 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 create(
+        self, *, driver_ids: typing.Sequence[int], text: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[InlineResponse2006]:
+        """
+        <n class="warning">
+        <nh>
+        <i class="fa fa-exclamation-circle"></i>
+        This endpoint is still on our legacy API.
+        </nh>
+        </n>
+
+        Send a message to a list of driver ids.
+
+         **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.
+
+        To use this endpoint, select **Write Messages** under the Driver Workflow 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>
+
+        Parameters
+        ----------
+        driver_ids : typing.Sequence[int]
+            IDs of the drivers for whom the messages are sent to.
+
+        text : str
+            The text sent in the message. Max 2500 characters allowed.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[InlineResponse2006]
+            Returns the created messages.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/fleet/messages",
+            method="POST",
+            json={
+                "driverIds": driver_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    InlineResponse2006,
+                    parse_obj_as(
+                        type_=InlineResponse2006,  # 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/vehicles/__init__.py

@@ -18,7 +18,7 @@ from .types import (
     UpdateVehicleRequestAuxInputType9,
     UpdateVehicleRequestHarshAccelerationSettingType,
 )
-from . import immobilizer, locations, stats, tachograph_files
+from . import immobilizer, locations, stats
 from .stats import (
     StatsFeedRequestDecorationsItem,
     StatsFeedRequestTypesItem,
@@ -50,5 +50,4 @@ __all__ = [
     "immobilizer",
     "locations",
     "stats",
-    "tachograph_files",
 ]