checkout-intents 0.2.0__tar.gz → 0.3.0__tar.gz

checkout_intents-0.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.0"
+}

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.3.0 (2025-11-18)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/rye-com/checkout-intents-python/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* Add python sdk target to stainless config ([eea256f](https://github.com/rye-com/checkout-intents-python/commit/eea256fef46bb35554488dba5a0818345096a66a))
+
+
+### Bug Fixes
+
+* **docs:** supply valid buyer details ([12d25b1](https://github.com/rye-com/checkout-intents-python/commit/12d25b12808a05aaedcf48fc97384b5da40ca7e4))
+
+
+### Chores
+
+* **internal:** format code ([445dea0](https://github.com/rye-com/checkout-intents-python/commit/445dea070ddcc8574d0304001e79bd25ca2f9de7))
+
 ## 0.2.0 (2025-11-13)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/rye-com/checkout-intents-python/compare/v0.1.0...v0.2.0)

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: checkout-intents
-Version: 0.2.0
+Version: 0.3.0
 Summary: The official Python library for the Checkout Intents API
 Project-URL: Homepage, https://github.com/rye-com/checkout-intents-python
 Project-URL: Repository, https://github.com/rye-com/checkout-intents-python
@@ -59,9 +59,11 @@ pip install checkout-intents
 The full API of this library can be found in [api.md](https://github.com/rye-com/checkout-intents-python/tree/main/api.md).
 
 ```python
+import os
 from checkout_intents import CheckoutIntents
 
 client = CheckoutIntents(
+    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
     # defaults to "staging".
     environment="production",
 )
@@ -74,7 +76,7 @@ checkout_intent = client.checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -106,7 +108,7 @@ intent = client.checkout_intents.create_and_poll(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -185,10 +187,12 @@ except PollTimeoutError as e:
 Simply import `AsyncCheckoutIntents` instead of `CheckoutIntents` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from checkout_intents import AsyncCheckoutIntents
 
 client = AsyncCheckoutIntents(
+    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
     # defaults to "staging".
     environment="production",
 )
@@ -203,7 +207,7 @@ async def main() -> None:
             "email": "john.doe@example.com",
             "first_name": "John",
             "last_name": "Doe",
-            "phone": "5555555555",
+            "phone": "1234567890",
             "postal_code": "10001",
             "province": "NY",
         },
@@ -238,6 +242,7 @@ from checkout_intents import AsyncCheckoutIntents
 
 async def main() -> None:
     async with AsyncCheckoutIntents(
+        api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
         checkout_intent = await client.checkout_intents.create(
@@ -248,7 +253,7 @@ async def main() -> None:
                 "email": "john.doe@example.com",
                 "first_name": "John",
                 "last_name": "Doe",
-                "phone": "5555555555",
+                "phone": "1234567890",
                 "postal_code": "10001",
                 "province": "NY",
             },
@@ -269,6 +274,77 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Checkout Intents API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from checkout_intents import CheckoutIntents
+
+client = CheckoutIntents()
+
+all_checkout_intents = []
+# Automatically fetches more pages as needed.
+for checkout_intent in client.checkout_intents.list(
+    limit=20,
+):
+    # Do something with checkout_intent here
+    all_checkout_intents.append(checkout_intent)
+print(all_checkout_intents)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from checkout_intents import AsyncCheckoutIntents
+
+client = AsyncCheckoutIntents()
+
+
+async def main() -> None:
+    all_checkout_intents = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for checkout_intent in client.checkout_intents.list(
+        limit=20,
+    ):
+        all_checkout_intents.append(checkout_intent)
+    print(all_checkout_intents)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.checkout_intents.list(
+    limit=20,
+)
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.data)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.checkout_intents.list(
+    limit=20,
+)
+
+print(f"next page cursor: {first_page.page_info.end_cursor}")  # => "next page cursor: ..."
+for checkout_intent in first_page.data:
+    print(checkout_intent)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
@@ -286,12 +362,12 @@ checkout_intent = client.checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
     product_url="productUrl",
-    quantity=0,
+    quantity=1,
 )
 print(checkout_intent.buyer)
 ```
@@ -320,7 +396,7 @@ try:
             "email": "john.doe@example.com",
             "first_name": "John",
             "last_name": "Doe",
-            "phone": "5555555555",
+            "phone": "1234567890",
             "postal_code": "10001",
             "province": "NY",
         },
@@ -397,7 +473,7 @@ client.with_options(max_retries=5).checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -434,7 +510,7 @@ client.with_options(timeout=5.0).checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -489,7 +565,7 @@ response = client.checkout_intents.with_raw_response.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -521,7 +597,7 @@ with client.checkout_intents.with_streaming_response.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/README.md

@@ -25,9 +25,11 @@ pip install checkout-intents
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from checkout_intents import CheckoutIntents
 
 client = CheckoutIntents(
+    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
     # defaults to "staging".
     environment="production",
 )
@@ -40,7 +42,7 @@ checkout_intent = client.checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -72,7 +74,7 @@ intent = client.checkout_intents.create_and_poll(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -151,10 +153,12 @@ except PollTimeoutError as e:
 Simply import `AsyncCheckoutIntents` instead of `CheckoutIntents` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from checkout_intents import AsyncCheckoutIntents
 
 client = AsyncCheckoutIntents(
+    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
     # defaults to "staging".
     environment="production",
 )
@@ -169,7 +173,7 @@ async def main() -> None:
             "email": "john.doe@example.com",
             "first_name": "John",
             "last_name": "Doe",
-            "phone": "5555555555",
+            "phone": "1234567890",
             "postal_code": "10001",
             "province": "NY",
         },
@@ -204,6 +208,7 @@ from checkout_intents import AsyncCheckoutIntents
 
 async def main() -> None:
     async with AsyncCheckoutIntents(
+        api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
         checkout_intent = await client.checkout_intents.create(
@@ -214,7 +219,7 @@ async def main() -> None:
                 "email": "john.doe@example.com",
                 "first_name": "John",
                 "last_name": "Doe",
-                "phone": "5555555555",
+                "phone": "1234567890",
                 "postal_code": "10001",
                 "province": "NY",
             },
@@ -235,6 +240,77 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Checkout Intents API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from checkout_intents import CheckoutIntents
+
+client = CheckoutIntents()
+
+all_checkout_intents = []
+# Automatically fetches more pages as needed.
+for checkout_intent in client.checkout_intents.list(
+    limit=20,
+):
+    # Do something with checkout_intent here
+    all_checkout_intents.append(checkout_intent)
+print(all_checkout_intents)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from checkout_intents import AsyncCheckoutIntents
+
+client = AsyncCheckoutIntents()
+
+
+async def main() -> None:
+    all_checkout_intents = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for checkout_intent in client.checkout_intents.list(
+        limit=20,
+    ):
+        all_checkout_intents.append(checkout_intent)
+    print(all_checkout_intents)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.checkout_intents.list(
+    limit=20,
+)
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.data)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.checkout_intents.list(
+    limit=20,
+)
+
+print(f"next page cursor: {first_page.page_info.end_cursor}")  # => "next page cursor: ..."
+for checkout_intent in first_page.data:
+    print(checkout_intent)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
@@ -252,12 +328,12 @@ checkout_intent = client.checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
     product_url="productUrl",
-    quantity=0,
+    quantity=1,
 )
 print(checkout_intent.buyer)
 ```
@@ -286,7 +362,7 @@ try:
             "email": "john.doe@example.com",
             "first_name": "John",
             "last_name": "Doe",
-            "phone": "5555555555",
+            "phone": "1234567890",
             "postal_code": "10001",
             "province": "NY",
         },
@@ -363,7 +439,7 @@ client.with_options(max_retries=5).checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -400,7 +476,7 @@ client.with_options(timeout=5.0).checkout_intents.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -455,7 +531,7 @@ response = client.checkout_intents.with_raw_response.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },
@@ -487,7 +563,7 @@ with client.checkout_intents.with_streaming_response.create(
         "email": "john.doe@example.com",
         "first_name": "John",
         "last_name": "Doe",
-        "phone": "5555555555",
+        "phone": "1234567890",
         "postal_code": "10001",
         "province": "NY",
     },

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/api.md

@@ -18,6 +18,7 @@ Methods:
 
 - <code title="post /api/v1/checkout-intents">client.checkout_intents.<a href="./src/checkout_intents/resources/checkout_intents.py">create</a>(\*\*<a href="src/checkout_intents/types/checkout_intent_create_params.py">params</a>) -> <a href="./src/checkout_intents/types/checkout_intent.py">CheckoutIntent</a></code>
 - <code title="get /api/v1/checkout-intents/{id}">client.checkout_intents.<a href="./src/checkout_intents/resources/checkout_intents.py">retrieve</a>(id) -> <a href="./src/checkout_intents/types/checkout_intent.py">CheckoutIntent</a></code>
+- <code title="get /api/v1/checkout-intents">client.checkout_intents.<a href="./src/checkout_intents/resources/checkout_intents.py">list</a>(\*\*<a href="src/checkout_intents/types/checkout_intent_list_params.py">params</a>) -> <a href="./src/checkout_intents/types/checkout_intent.py">SyncCursorPagination[CheckoutIntent]</a></code>
 - <code title="post /api/v1/checkout-intents/{id}/payment">client.checkout_intents.<a href="./src/checkout_intents/resources/checkout_intents.py">add_payment</a>(id, \*\*<a href="src/checkout_intents/types/checkout_intent_add_payment_params.py">params</a>) -> <a href="./src/checkout_intents/types/checkout_intent.py">CheckoutIntent</a></code>
 - <code title="post /api/v1/checkout-intents/{id}/confirm">client.checkout_intents.<a href="./src/checkout_intents/resources/checkout_intents.py">confirm</a>(id, \*\*<a href="src/checkout_intents/types/checkout_intent_confirm_params.py">params</a>) -> <a href="./src/checkout_intents/types/checkout_intent.py">CheckoutIntent</a></code>
 

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "checkout-intents"
-version = "0.2.0"
+version = "0.3.0"
 description = "The official Python library for the Checkout Intents API"
 dynamic = ["readme"]
 license = "MIT"

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/src/checkout_intents/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "checkout_intents"
-__version__ = "0.2.0"  # x-release-please-version
+__version__ = "0.3.0"  # x-release-please-version

checkout_intents-0.3.0/src/checkout_intents/pagination.py

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Generic, TypeVar, Optional
+from typing_extensions import override
+
+from pydantic import Field as FieldInfo
+
+from ._models import BaseModel
+from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage
+
+__all__ = ["CursorPaginationPageInfo", "SyncCursorPagination", "AsyncCursorPagination"]
+
+_T = TypeVar("_T")
+
+
+class CursorPaginationPageInfo(BaseModel):
+    end_cursor: Optional[str] = FieldInfo(alias="endCursor", default=None)
+
+    has_next_page: Optional[bool] = FieldInfo(alias="hasNextPage", default=None)
+
+    has_previous_page: Optional[bool] = FieldInfo(alias="hasPreviousPage", default=None)
+
+    start_cursor: Optional[str] = FieldInfo(alias="startCursor", default=None)
+
+
+class SyncCursorPagination(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
+    data: List[_T]
+    page_info: Optional[CursorPaginationPageInfo] = FieldInfo(alias="pageInfo", default=None)
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        data = self.data
+        if not data:
+            return []
+        return data
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        if self._options.params.get("before"):
+            start_cursor = None
+            if self.page_info is not None:
+                if self.page_info.start_cursor is not None:
+                    start_cursor = self.page_info.start_cursor
+            if not start_cursor:
+                return None
+
+            return PageInfo(params={"before": start_cursor})
+
+        end_cursor = None
+        if self.page_info is not None:
+            if self.page_info.end_cursor is not None:
+                end_cursor = self.page_info.end_cursor
+        if not end_cursor:
+            return None
+
+        return PageInfo(params={"after": end_cursor})
+
+
+class AsyncCursorPagination(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
+    data: List[_T]
+    page_info: Optional[CursorPaginationPageInfo] = FieldInfo(alias="pageInfo", default=None)
+
+    @override
+    def _get_page_items(self) -> List[_T]:
+        data = self.data
+        if not data:
+            return []
+        return data
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        if self._options.params.get("before"):
+            start_cursor = None
+            if self.page_info is not None:
+                if self.page_info.start_cursor is not None:
+                    start_cursor = self.page_info.start_cursor
+            if not start_cursor:
+                return None
+
+            return PageInfo(params={"before": start_cursor})
+
+        end_cursor = None
+        if self.page_info is not None:
+            if self.page_info.end_cursor is not None:
+                end_cursor = self.page_info.end_cursor
+        if not end_cursor:
+            return None
+
+        return PageInfo(params={"after": end_cursor})

{checkout_intents-0.2.0 → checkout_intents-0.3.0}/src/checkout_intents/resources/brands.py

@@ -53,8 +53,8 @@ class BrandsResource(SyncAPIResource):
         """
         Retrieve brand information by domain name
 
-        Look up a brand by its domain name (e.g. "aloyoga.com"). Returns brand
-        information including the marketplace type if the lookup succeeds.
+        Look up a brand by its domain name (e.g. "aloyoga.com" or "www.amazon.com").
+        Returns brand information including the marketplace type if the lookup succeeds.
 
         Args:
           domain: Represents a valid domain name string.
@@ -112,8 +112,8 @@ class AsyncBrandsResource(AsyncAPIResource):
         """
         Retrieve brand information by domain name
 
-        Look up a brand by its domain name (e.g. "aloyoga.com"). Returns brand
-        information including the marketplace type if the lookup succeeds.
+        Look up a brand by its domain name (e.g. "aloyoga.com" or "www.amazon.com").
+        Returns brand information including the marketplace type if the lookup succeeds.
 
         Args:
           domain: Represents a valid domain name string.