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

samsara/beta/client.py

@@ -1,161 +0,0 @@
-# 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.hos_daily_logs_update_shipping_docs_response_body import HosDailyLogsUpdateShippingDocsResponseBody
-from .raw_client import AsyncRawBetaClient, RawBetaClient
-
-# this is used as the default value for optional parameters
-OMIT = typing.cast(typing.Any, ...)
-
-
-class BetaClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._raw_client = RawBetaClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> RawBetaClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        RawBetaClient
-        """
-        return self._raw_client
-
-    def update_shipping_docs(
-        self,
-        *,
-        hos_date: str,
-        driver_id: str,
-        shipping_docs: str,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> HosDailyLogsUpdateShippingDocsResponseBody:
-        """
-        Update the shippingDocs field of an existing assignment.
-
-         <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>
-
-
-         **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.
-
-        shipping_docs : str
-            ShippingDocs associated with the driver for the day.
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HosDailyLogsUpdateShippingDocsResponseBody
-            OK response.
-
-        Examples
-        --------
-        from samsara import Samsara
-
-        client = Samsara(
-            token="YOUR_TOKEN",
-        )
-        client.beta.update_shipping_docs(
-            hos_date="hosDate",
-            driver_id="driverID",
-            shipping_docs="ShippingID1, ShippingID2",
-        )
-        """
-        _response = self._raw_client.update_shipping_docs(
-            hos_date=hos_date, driver_id=driver_id, shipping_docs=shipping_docs, request_options=request_options
-        )
-        return _response.data
-
-
-class AsyncBetaClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._raw_client = AsyncRawBetaClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> AsyncRawBetaClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        AsyncRawBetaClient
-        """
-        return self._raw_client
-
-    async def update_shipping_docs(
-        self,
-        *,
-        hos_date: str,
-        driver_id: str,
-        shipping_docs: str,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> HosDailyLogsUpdateShippingDocsResponseBody:
-        """
-        Update the shippingDocs field of an existing assignment.
-
-         <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>
-
-
-         **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.
-
-        shipping_docs : str
-            ShippingDocs associated with the driver for the day.
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HosDailyLogsUpdateShippingDocsResponseBody
-            OK response.
-
-        Examples
-        --------
-        import asyncio
-
-        from samsara import AsyncSamsara
-
-        client = AsyncSamsara(
-            token="YOUR_TOKEN",
-        )
-
-
-        async def main() -> None:
-            await client.beta.update_shipping_docs(
-                hos_date="hosDate",
-                driver_id="driverID",
-                shipping_docs="ShippingID1, ShippingID2",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.update_shipping_docs(
-            hos_date=hos_date, driver_id=driver_id, shipping_docs=shipping_docs, request_options=request_options
-        )
-        return _response.data

samsara/drivers/tachograph_activity/client.py

@@ -1,186 +0,0 @@
-# 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.driver_tachograph_activity_response import DriverTachographActivityResponse
-from .raw_client import AsyncRawTachographActivityClient, RawTachographActivityClient
-
-
-class TachographActivityClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._raw_client = RawTachographActivityClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> RawTachographActivityClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        RawTachographActivityClient
-        """
-        return self._raw_client
-
-    def history(
-        self,
-        *,
-        start_time: str,
-        end_time: str,
-        after: typing.Optional[str] = None,
-        driver_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> DriverTachographActivityResponse:
-        """
-        Returns all known tachograph activity for all specified drivers in the time range.
-
-         **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 Tachograph (EU)** 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>
-
-        Parameters
-        ----------
-        start_time : str
-            A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        end_time : str
-            An end time in RFC 3339 format. It can't be more than 30 days past startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        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.
-
-        driver_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`
-
-        parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
-
-        tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        DriverTachographActivityResponse
-            List of all driver tachograph activities in a specified time range.
-
-        Examples
-        --------
-        from samsara import Samsara
-
-        client = Samsara(
-            token="YOUR_TOKEN",
-        )
-        client.drivers.tachograph_activity.history(
-            start_time="startTime",
-            end_time="endTime",
-        )
-        """
-        _response = self._raw_client.history(
-            start_time=start_time,
-            end_time=end_time,
-            after=after,
-            driver_ids=driver_ids,
-            parent_tag_ids=parent_tag_ids,
-            tag_ids=tag_ids,
-            request_options=request_options,
-        )
-        return _response.data
-
-
-class AsyncTachographActivityClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._raw_client = AsyncRawTachographActivityClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> AsyncRawTachographActivityClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        AsyncRawTachographActivityClient
-        """
-        return self._raw_client
-
-    async def history(
-        self,
-        *,
-        start_time: str,
-        end_time: str,
-        after: typing.Optional[str] = None,
-        driver_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> DriverTachographActivityResponse:
-        """
-        Returns all known tachograph activity for all specified drivers in the time range.
-
-         **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 Tachograph (EU)** 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>
-
-        Parameters
-        ----------
-        start_time : str
-            A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        end_time : str
-            An end time in RFC 3339 format. It can't be more than 30 days past startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        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.
-
-        driver_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`
-
-        parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
-
-        tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        DriverTachographActivityResponse
-            List of all driver tachograph activities in a specified time range.
-
-        Examples
-        --------
-        import asyncio
-
-        from samsara import AsyncSamsara
-
-        client = AsyncSamsara(
-            token="YOUR_TOKEN",
-        )
-
-
-        async def main() -> None:
-            await client.drivers.tachograph_activity.history(
-                start_time="startTime",
-                end_time="endTime",
-            )
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.history(
-            start_time=start_time,
-            end_time=end_time,
-            after=after,
-            driver_ids=driver_ids,
-            parent_tag_ids=parent_tag_ids,
-            tag_ids=tag_ids,
-            request_options=request_options,
-        )
-        return _response.data

samsara/drivers/tachograph_activity/raw_client.py

@@ -1,169 +0,0 @@
-# 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.driver_tachograph_activity_response import DriverTachographActivityResponse
-
-
-class RawTachographActivityClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    def history(
-        self,
-        *,
-        start_time: str,
-        end_time: str,
-        after: typing.Optional[str] = None,
-        driver_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[DriverTachographActivityResponse]:
-        """
-        Returns all known tachograph activity for all specified drivers in the time range.
-
-         **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 Tachograph (EU)** 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>
-
-        Parameters
-        ----------
-        start_time : str
-            A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        end_time : str
-            An end time in RFC 3339 format. It can't be more than 30 days past startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        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.
-
-        driver_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`
-
-        parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
-
-        tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HttpResponse[DriverTachographActivityResponse]
-            List of all driver tachograph activities in a specified time range.
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "fleet/drivers/tachograph-activity/history",
-            method="GET",
-            params={
-                "after": after,
-                "startTime": start_time,
-                "endTime": end_time,
-                "driverIds": driver_ids,
-                "parentTagIds": parent_tag_ids,
-                "tagIds": tag_ids,
-            },
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    DriverTachographActivityResponse,
-                    parse_obj_as(
-                        type_=DriverTachographActivityResponse,  # 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 AsyncRawTachographActivityClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    async def history(
-        self,
-        *,
-        start_time: str,
-        end_time: str,
-        after: typing.Optional[str] = None,
-        driver_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        parent_tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        tag_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[DriverTachographActivityResponse]:
-        """
-        Returns all known tachograph activity for all specified drivers in the time range.
-
-         **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 Tachograph (EU)** 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>
-
-        Parameters
-        ----------
-        start_time : str
-            A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        end_time : str
-            An end time in RFC 3339 format. It can't be more than 30 days past startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
-
-        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.
-
-        driver_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`
-
-        parent_tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
-
-        tag_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AsyncHttpResponse[DriverTachographActivityResponse]
-            List of all driver tachograph activities in a specified time range.
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "fleet/drivers/tachograph-activity/history",
-            method="GET",
-            params={
-                "after": after,
-                "startTime": start_time,
-                "endTime": end_time,
-                "driverIds": driver_ids,
-                "parentTagIds": parent_tag_ids,
-                "tagIds": tag_ids,
-            },
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    DriverTachographActivityResponse,
-                    parse_obj_as(
-                        type_=DriverTachographActivityResponse,  # 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/hours_of_service/__init__.py

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