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

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.3",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "samsara-api",
-            "X-Fern-SDK-Version": "0.0.2",
+            "X-Fern-SDK-Version": "0.0.3",
         }
         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_api-0.0.3.dist-info/METADATA

@@ -0,0 +1,221 @@
+Metadata-Version: 2.1
+Name: samsara-api
+Version: 0.0.3
+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
+```
+
+## 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.3.dist-info}/RECORD

@@ -80,7 +80,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=3F4i9kyUag6uWDXyh6x6xWxjNJw-KY8ezQYsS8jLlaU,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 +2514,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
@@ -2654,7 +2654,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.3.dist-info/LICENSE,sha256=uX-nl5hOEHp4uvQPCcpde-doNbQhV5uRQNwkB474IoQ,1064
+samsara_api-0.0.3.dist-info/METADATA,sha256=Q5d72JwKP-TFYAtidklu9hp0ut6jYbJDCQHbm_oH260,6255
+samsara_api-0.0.3.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+samsara_api-0.0.3.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
-
-