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

{samsara_api-0.0.1.dist-info → samsara_api-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: samsara-api
-Version: 0.0.1
+Version: 0.0.3
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -33,6 +33,10 @@ Description-Content-Type: text/markdown
 
 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
@@ -41,23 +45,24 @@ pip install samsara-api
 
 ## Reference
 
-A full reference for this library is available [here](./reference.md).
+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 CreateAddressRequestGeofence, Samsara
+from samsara import Samsara
 
 client = Samsara(
     token="YOUR_TOKEN",
 )
-client.addresses.create(
-    formatted_address="350 Rhode Island St, San Francisco, CA",
-    geofence=CreateAddressRequestGeofence(),
-    name="Samsara HQ",
-)
+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
@@ -67,7 +72,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from samsara import AsyncSamsara, CreateAddressRequestGeofence
+from samsara import AsyncSamsara
 
 client = AsyncSamsara(
     token="YOUR_TOKEN",
@@ -75,11 +80,13 @@ client = AsyncSamsara(
 
 
 async def main() -> None:
-    await client.addresses.create(
-        formatted_address="350 Rhode Island St, San Francisco, CA",
-        geofence=CreateAddressRequestGeofence(),
-        name="Samsara HQ",
-    )
+    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())
@@ -94,7 +101,7 @@ will be thrown.
 from samsara.core.api_error import ApiError
 
 try:
-    client.addresses.create(...)
+    client.vehicles.stats.list(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -131,7 +138,7 @@ from samsara import Samsara
 client = Samsara(
     ...,
 )
-response = client.addresses.with_raw_response.create(...)
+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(...)
@@ -159,7 +166,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.addresses.create(..., request_options={
+client.vehicles.stats.list(..., request_options={
     "max_retries": 1
 })
 ```
@@ -179,7 +186,7 @@ client = Samsara(
 
 
 # Override timeout for a specific method
-client.addresses.create(..., request_options={
+client.vehicles.stats.list(..., request_options={
     "timeout_in_seconds": 1
 })
 ```