Python SDK pagination - Telnyx

Pagination

List methods in the Telnyx API are paginated. This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:

from telnyx import Telnyx

client = Telnyx()

all_access_ip_addresses = []
# Automatically fetches more pages as needed.
for access_ip_address in client.access_ip_address.list(
    page_number=1,
    page_size=50,
):
    # Do something with access_ip_address here
    all_access_ip_addresses.append(access_ip_address)
print(all_access_ip_addresses)

Or, asynchronously:

import asyncio
from telnyx import AsyncTelnyx

client = AsyncTelnyx()


async def main() -> None:
    all_access_ip_addresses = []
    # Iterate through items across all pages, issuing requests as needed.
    async for access_ip_address in client.access_ip_address.list(
        page_number=1,
        page_size=50,
    ):
        all_access_ip_addresses.append(access_ip_address)
    print(all_access_ip_addresses)


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:

first_page = await client.access_ip_address.list(
    page_number=1,
    page_size=50,
)
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:

first_page = await client.access_ip_address.list(
    page_number=1,
    page_size=50,
)

print(f"page number: {first_page.meta.page_number}")  # => "page number: 1"
for access_ip_address in first_page.data:
    print(access_ip_address.id)

# Remove `await` for non-async usage.

⌘I