ocpplab 0.3.0__tar.gz → 0.3.2__tar.gz

{ocpplab-0.3.0 → ocpplab-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ocpplab
-Version: 0.3.0
+Version: 0.3.2
 Summary: 
 Keywords: ev,ocpp,sdk,api,charging
 Requires-Python: >=3.10,<4.0
@@ -27,7 +27,7 @@ Requires-Dist: httpx-aiohttp (==0.1.8) ; extra == "aiohttp"
 Requires-Dist: pydantic (>=1.9.2)
 Requires-Dist: pydantic-core (>=2.18.2,<2.44.0)
 Requires-Dist: typing_extensions (>=4.0.0)
-Project-URL: Documentation, https://github.com/ev-cloudx/ocpplab-python-sdk
+Project-URL: Documentation, https://docs.ocpplab.io
 Project-URL: Homepage, https://github.com/ev-cloudx/ocpplab-python-sdk
 Project-URL: Repository, https://github.com/ev-cloudx/ocpplab-python-sdk
 Description-Content-Type: text/markdown
@@ -44,8 +44,10 @@ The Ocpplab Python library provides convenient access to the Ocpplab APIs from P
 - [Installation](#installation)
 - [Reference](#reference)
 - [Usage](#usage)
+- [Environments](#environments)
 - [Async Client](#async-client)
 - [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
 - [Advanced](#advanced)
   - [Access Raw Response Data](#access-raw-response-data)
   - [Retries](#retries)
@@ -68,29 +70,44 @@ A full reference for this library is available [here](https://github.com/ev-clou
 Instantiate and use the client with the following:
 
 ```python
-from ocpplab import OcpplabSDK, OcpiPartnerInput, OcpiBusinessDetails
+from ocpplab import OcpplabSDK, BookingTermsInput, BookingCalendar
+import datetime
 
 client = OcpplabSDK(
     token="<token>",
-    base_url="https://yourhost.com/path/to/api",
 )
 
-client.ocpi.cpo.create(
-    partner=OcpiPartnerInput(
-        country_code="NL",
-        party_id="ABC",
-        name="ABC Charging",
-        role="CPO",
-        ocpi_versions=[
-            "2.2.1"
-        ],
-        business_details=OcpiBusinessDetails(
-            name="ABC Charging B.V.",
-            website="https://abc-charging.example.com",
-            logo_url="https://abc-charging.example.com/logo.png",
-        ),
+client.booking.locations.create(
+    idempotency_key="7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
+    booking_location_id="BLOC-AMS-01",
+    location_id="LOC-AMS-01",
+    tariff_ids=[
+        "TARIFF-AC-STD"
+    ],
+    booking_terms=BookingTermsInput(
+        early_start=10,
     ),
-    ocpi_version="2.2.1",
+    calendars=[
+        BookingCalendar(
+            begin_from=datetime.datetime.fromisoformat("2026-10-01T00:00:00+00:00"),
+        )
+    ],
+    role="CPO",
+    country_code="NL",
+    party_id="OCP",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from ocpplab import OcpplabSDK
+from ocpplab.environment import OcpplabSDKEnvironment
+
+client = OcpplabSDK(
+    environment=OcpplabSDKEnvironment.PRODUCTION,
 )
 ```
 
@@ -100,32 +117,34 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 
 ```python
 import asyncio
+import datetime
 
 from ocpplab import AsyncOcpplabSDK
 
 client = AsyncOcpplabSDK(
     token="<token>",
-    base_url="https://yourhost.com/path/to/api",
 )
 
 
 async def main() -> None:
-    await client.ocpi.cpo.create(
-        partner=OcpiPartnerInput(
-            country_code="NL",
-            party_id="ABC",
-            name="ABC Charging",
-            role="CPO",
-            ocpi_versions=[
-                "2.2.1"
-            ],
-            business_details=OcpiBusinessDetails(
-                name="ABC Charging B.V.",
-                website="https://abc-charging.example.com",
-                logo_url="https://abc-charging.example.com/logo.png",
-            ),
+    await client.booking.locations.create(
+        idempotency_key="7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
+        booking_location_id="BLOC-AMS-01",
+        location_id="LOC-AMS-01",
+        tariff_ids=[
+            "TARIFF-AC-STD"
+        ],
+        booking_terms=BookingTermsInput(
+            early_start=10,
         ),
-        ocpi_version="2.2.1",
+        calendars=[
+            BookingCalendar(
+                begin_from=datetime.datetime.fromisoformat("2026-10-01T00:00:00+00:00"),
+            )
+        ],
+        role="CPO",
+        country_code="NL",
+        party_id="OCP",
     )
 
 
@@ -141,12 +160,38 @@ will be thrown.
 from ocpplab.core.api_error import ApiError
 
 try:
-    client.ocpi.cpo.create(...)
+    client.booking.locations.create(...)
 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 ocpplab import OcpplabSDK
+
+client = OcpplabSDK(
+    token="<token>",
+)
+
+client.booking.locations.list(
+    location_id="LOC-AMS-01",
+    limit=50,
+)
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.booking.locations.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
 ## Advanced
 
 ### Access Raw Response Data
@@ -158,7 +203,7 @@ The `.with_raw_response` property returns a "raw" client that can be used to acc
 from ocpplab import OcpplabSDK
 
 client = OcpplabSDK(...)
-response = client.ocpi.cpo.with_raw_response.create(...)
+response = client.booking.locations.with_raw_response.create(...)
 print(response.headers)  # access the response headers
 print(response.status_code)  # access the response status code
 print(response.data)  # access the underlying object
@@ -179,7 +224,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.ocpi.cpo.create(..., request_options={
+client.booking.locations.create(..., request_options={
     "max_retries": 1
 })
 ```
@@ -194,7 +239,7 @@ from ocpplab import OcpplabSDK
 client = OcpplabSDK(..., timeout=20.0)
 
 # Override timeout for a specific method
-client.ocpi.cpo.create(..., request_options={
+client.booking.locations.create(..., request_options={
     "timeout_in_seconds": 1
 })
 ```

{ocpplab-0.3.0 → ocpplab-0.3.2}/README.md

@@ -10,8 +10,10 @@ The Ocpplab Python library provides convenient access to the Ocpplab APIs from P
 - [Installation](#installation)
 - [Reference](#reference)
 - [Usage](#usage)
+- [Environments](#environments)
 - [Async Client](#async-client)
 - [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
 - [Advanced](#advanced)
   - [Access Raw Response Data](#access-raw-response-data)
   - [Retries](#retries)
@@ -34,29 +36,44 @@ A full reference for this library is available [here](https://github.com/ev-clou
 Instantiate and use the client with the following:
 
 ```python
-from ocpplab import OcpplabSDK, OcpiPartnerInput, OcpiBusinessDetails
+from ocpplab import OcpplabSDK, BookingTermsInput, BookingCalendar
+import datetime
 
 client = OcpplabSDK(
     token="<token>",
-    base_url="https://yourhost.com/path/to/api",
 )
 
-client.ocpi.cpo.create(
-    partner=OcpiPartnerInput(
-        country_code="NL",
-        party_id="ABC",
-        name="ABC Charging",
-        role="CPO",
-        ocpi_versions=[
-            "2.2.1"
-        ],
-        business_details=OcpiBusinessDetails(
-            name="ABC Charging B.V.",
-            website="https://abc-charging.example.com",
-            logo_url="https://abc-charging.example.com/logo.png",
-        ),
+client.booking.locations.create(
+    idempotency_key="7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
+    booking_location_id="BLOC-AMS-01",
+    location_id="LOC-AMS-01",
+    tariff_ids=[
+        "TARIFF-AC-STD"
+    ],
+    booking_terms=BookingTermsInput(
+        early_start=10,
     ),
-    ocpi_version="2.2.1",
+    calendars=[
+        BookingCalendar(
+            begin_from=datetime.datetime.fromisoformat("2026-10-01T00:00:00+00:00"),
+        )
+    ],
+    role="CPO",
+    country_code="NL",
+    party_id="OCP",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from ocpplab import OcpplabSDK
+from ocpplab.environment import OcpplabSDKEnvironment
+
+client = OcpplabSDK(
+    environment=OcpplabSDKEnvironment.PRODUCTION,
 )
 ```
 
@@ -66,32 +83,34 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 
 ```python
 import asyncio
+import datetime
 
 from ocpplab import AsyncOcpplabSDK
 
 client = AsyncOcpplabSDK(
     token="<token>",
-    base_url="https://yourhost.com/path/to/api",
 )
 
 
 async def main() -> None:
-    await client.ocpi.cpo.create(
-        partner=OcpiPartnerInput(
-            country_code="NL",
-            party_id="ABC",
-            name="ABC Charging",
-            role="CPO",
-            ocpi_versions=[
-                "2.2.1"
-            ],
-            business_details=OcpiBusinessDetails(
-                name="ABC Charging B.V.",
-                website="https://abc-charging.example.com",
-                logo_url="https://abc-charging.example.com/logo.png",
-            ),
+    await client.booking.locations.create(
+        idempotency_key="7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
+        booking_location_id="BLOC-AMS-01",
+        location_id="LOC-AMS-01",
+        tariff_ids=[
+            "TARIFF-AC-STD"
+        ],
+        booking_terms=BookingTermsInput(
+            early_start=10,
         ),
-        ocpi_version="2.2.1",
+        calendars=[
+            BookingCalendar(
+                begin_from=datetime.datetime.fromisoformat("2026-10-01T00:00:00+00:00"),
+            )
+        ],
+        role="CPO",
+        country_code="NL",
+        party_id="OCP",
     )
 
 
@@ -107,12 +126,38 @@ will be thrown.
 from ocpplab.core.api_error import ApiError
 
 try:
-    client.ocpi.cpo.create(...)
+    client.booking.locations.create(...)
 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 ocpplab import OcpplabSDK
+
+client = OcpplabSDK(
+    token="<token>",
+)
+
+client.booking.locations.list(
+    location_id="LOC-AMS-01",
+    limit=50,
+)
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.booking.locations.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
 ## Advanced
 
 ### Access Raw Response Data
@@ -124,7 +169,7 @@ The `.with_raw_response` property returns a "raw" client that can be used to acc
 from ocpplab import OcpplabSDK
 
 client = OcpplabSDK(...)
-response = client.ocpi.cpo.with_raw_response.create(...)
+response = client.booking.locations.with_raw_response.create(...)
 print(response.headers)  # access the response headers
 print(response.status_code)  # access the response status code
 print(response.data)  # access the underlying object
@@ -145,7 +190,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.ocpi.cpo.create(..., request_options={
+client.booking.locations.create(..., request_options={
     "max_retries": 1
 })
 ```
@@ -160,7 +205,7 @@ from ocpplab import OcpplabSDK
 client = OcpplabSDK(..., timeout=20.0)
 
 # Override timeout for a specific method
-client.ocpi.cpo.create(..., request_options={
+client.booking.locations.create(..., request_options={
     "timeout_in_seconds": 1
 })
 ```

{ocpplab-0.3.0 → ocpplab-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "ocpplab"
-version = "0.3.0"
+version = "0.3.2"
 description = ""
 readme = "README.md"
 authors = []
@@ -39,7 +39,7 @@ packages = [
 ]
 
 [tool.poetry.urls]
-Documentation = 'https://github.com/ev-cloudx/ocpplab-python-sdk'
+Documentation = 'https://docs.ocpplab.io'
 Homepage = 'https://github.com/ev-cloudx/ocpplab-python-sdk'
 Repository = 'https://github.com/ev-cloudx/ocpplab-python-sdk'