feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 229
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-bd464d151612058d8029150b376949b22d5515af23621465c0ce1c1069b91644.yml
 openapi_spec_hash: e60e1548c523a0ee7c9daa1bd988cbc5
-config_hash: eecc5886c26d07c167f37f30ae505a2c
+config_hash: ca1425272e17fa23d4466d33492334fa

README.md

@@ -34,6 +34,8 @@ client = Increase(
 
 account = client.accounts.create(
     name="New Account!",
+    entity_id="entity_n8y8tnk2p9339ti393yi",
+    program_id="program_i2v2os4mwza1oetokh9i",
 )
 print(account.id)
 ```
@@ -62,6 +64,8 @@ client = AsyncIncrease(
 async def main() -> None:
     account = await client.accounts.create(
         name="New Account!",
+        entity_id="entity_n8y8tnk2p9339ti393yi",
+        program_id="program_i2v2os4mwza1oetokh9i",
     )
     print(account.id)
 
@@ -97,6 +101,8 @@ async def main() -> None:
     ) as client:
         account = await client.accounts.create(
             name="New Account!",
+            entity_id="entity_n8y8tnk2p9339ti393yi",
+            program_id="program_i2v2os4mwza1oetokh9i",
         )
         print(account.id)
 
@@ -113,6 +119,69 @@ 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 Increase 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 increase import Increase
+
+client = Increase()
+
+all_accounts = []
+# Automatically fetches more pages as needed.
+for account in client.accounts.list():
+    # Do something with account here
+    all_accounts.append(account)
+print(all_accounts)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from increase import AsyncIncrease
+
+client = AsyncIncrease()
+
+
+async def main() -> None:
+    all_accounts = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for account in client.accounts.list():
+        all_accounts.append(account)
+    print(all_accounts)
+
+
+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.accounts.list()
+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.accounts.list()
+
+print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
+for account in first_page.data:
+    print(account.id)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
@@ -298,6 +367,8 @@ client = Increase(
 # Or, configure per-request:
 client.with_options(max_retries=5).accounts.create(
     name="New Account!",
+    entity_id="entity_n8y8tnk2p9339ti393yi",
+    program_id="program_i2v2os4mwza1oetokh9i",
 )
 ```
 
@@ -323,6 +394,8 @@ client = Increase(
 # Override per-request:
 client.with_options(timeout=5.0).accounts.create(
     name="New Account!",
+    entity_id="entity_n8y8tnk2p9339ti393yi",
+    program_id="program_i2v2os4mwza1oetokh9i",
 )
 ```
 
@@ -366,6 +439,8 @@ from increase import Increase
 client = Increase()
 response = client.accounts.with_raw_response.create(
     name="New Account!",
+    entity_id="entity_n8y8tnk2p9339ti393yi",
+    program_id="program_i2v2os4mwza1oetokh9i",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -386,6 +461,8 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 ```python
 with client.accounts.with_streaming_response.create(
     name="New Account!",
+    entity_id="entity_n8y8tnk2p9339ti393yi",
+    program_id="program_i2v2os4mwza1oetokh9i",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

api.md

@@ -3,8 +3,6 @@
 from typing import List, Generic, TypeVar, Optional
 from typing_extensions import override
 
-from pydantic import Field as FieldInfo
-
 from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage
 
 __all__ = ["SyncPage", "AsyncPage"]
@@ -13,12 +11,15 @@
 
 
 class SyncPage(BaseSyncPage[_T], BasePage[_T], Generic[_T]):
-    data: Optional[object] = FieldInfo(alias=":data", default=None)
-    next_cursor: Optional[object] = FieldInfo(alias=":next_cursor", default=None)
+    data: List[_T]
+    next_cursor: Optional[str] = None
+    """A pointer to a place in the list."""
 
     @override
     def _get_page_items(self) -> List[_T]:
         data = self.data
+        if not data:
+            return []
         return data
 
     @override
@@ -27,16 +28,19 @@ def next_page_info(self) -> Optional[PageInfo]:
         if not next_cursor:
             return None
 
-        return PageInfo(params={":cursor": next_cursor})
+        return PageInfo(params={"cursor": next_cursor})
 
 
 class AsyncPage(BaseAsyncPage[_T], BasePage[_T], Generic[_T]):
-    data: Optional[object] = FieldInfo(alias=":data", default=None)
-    next_cursor: Optional[object] = FieldInfo(alias=":next_cursor", default=None)
+    data: List[_T]
+    next_cursor: Optional[str] = None
+    """A pointer to a place in the list."""
 
     @override
     def _get_page_items(self) -> List[_T]:
         data = self.data
+        if not data:
+            return []
         return data
 
     @override
@@ -45,4 +49,4 @@ def next_page_info(self) -> Optional[PageInfo]:
         if not next_cursor:
             return None
 
-        return PageInfo(params={":cursor": next_cursor})
+        return PageInfo(params={"cursor": next_cursor})

src/increase/pagination.py

@@ -17,9 +17,9 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from .._base_client import make_request_options
+from ..pagination import SyncPage, AsyncPage
+from .._base_client import AsyncPaginator, make_request_options
 from ..types.account_number import AccountNumber
-from ..types.account_number_list_response import AccountNumberListResponse
 
 __all__ = ["AccountNumbersResource", "AsyncAccountNumbersResource"]
 
@@ -222,7 +222,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AccountNumberListResponse:
+    ) -> SyncPage[AccountNumber]:
         """
         List Account Numbers
 
@@ -247,8 +247,9 @@ def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._get(
+        return self._get_api_list(
             "/account_numbers",
+            page=SyncPage[AccountNumber],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -267,7 +268,7 @@ def list(
                     account_number_list_params.AccountNumberListParams,
                 ),
             ),
-            cast_to=AccountNumberListResponse,
+            model=AccountNumber,
         )
 
 
@@ -453,7 +454,7 @@ async def update(
             cast_to=AccountNumber,
         )
 
-    async def list(
+    def list(
         self,
         *,
         account_id: str | Omit = omit,
@@ -469,7 +470,7 @@ async def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AccountNumberListResponse:
+    ) -> AsyncPaginator[AccountNumber, AsyncPage[AccountNumber]]:
         """
         List Account Numbers
 
@@ -494,14 +495,15 @@ async def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._get(
+        return self._get_api_list(
             "/account_numbers",
+            page=AsyncPage[AccountNumber],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
+                query=maybe_transform(
                     {
                         "account_id": account_id,
                         "ach_debit_status": ach_debit_status,
@@ -514,7 +516,7 @@ async def list(
                     account_number_list_params.AccountNumberListParams,
                 ),
             ),
-            cast_to=AccountNumberListResponse,
+            model=AccountNumber,
         )
 
 

src/increase/resources/account_numbers.py

@@ -6,7 +6,7 @@
 
 from ..types import account_statement_list_params
 from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
-from .._utils import maybe_transform, async_maybe_transform
+from .._utils import maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
 from .._response import (
@@ -15,9 +15,9 @@
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from .._base_client import make_request_options
+from ..pagination import SyncPage, AsyncPage
+from .._base_client import AsyncPaginator, make_request_options
 from ..types.account_statement import AccountStatement
-from ..types.account_statement_list_response import AccountStatementListResponse
 
 __all__ = ["AccountStatementsResource", "AsyncAccountStatementsResource"]
 
@@ -92,7 +92,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AccountStatementListResponse:
+    ) -> SyncPage[AccountStatement]:
         """
         List Account Statements
 
@@ -112,8 +112,9 @@ def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return self._get(
+        return self._get_api_list(
             "/account_statements",
+            page=SyncPage[AccountStatement],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -129,7 +130,7 @@ def list(
                     account_statement_list_params.AccountStatementListParams,
                 ),
             ),
-            cast_to=AccountStatementListResponse,
+            model=AccountStatement,
         )
 
 
@@ -190,7 +191,7 @@ async def retrieve(
             cast_to=AccountStatement,
         )
 
-    async def list(
+    def list(
         self,
         *,
         account_id: str | Omit = omit,
@@ -203,7 +204,7 @@ async def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AccountStatementListResponse:
+    ) -> AsyncPaginator[AccountStatement, AsyncPage[AccountStatement]]:
         """
         List Account Statements
 
@@ -223,14 +224,15 @@ async def list(
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        return await self._get(
+        return self._get_api_list(
             "/account_statements",
+            page=AsyncPage[AccountStatement],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                query=await async_maybe_transform(
+                query=maybe_transform(
                     {
                         "account_id": account_id,
                         "cursor": cursor,
@@ -240,7 +242,7 @@ async def list(
                     account_statement_list_params.AccountStatementListParams,
                 ),
             ),
-            cast_to=AccountStatementListResponse,
+            model=AccountStatement,
         )