Remove return types for paginated endpoints

[adamjmcgrath]

Changes

Paginated endpoints, like organizations.all_organization_members return a list when include_totals is None or False and a dict when include_totals is True. Currently the return type of these is list[dict[str, Any]] and so static type checkers will fail when the developer sets include_totals=True.

I've removed the return type for these because:

• The existing return type list[dict[str, Any]] is not particularly useful
• Using a Union type will be a breaking change for those using the endpoint without pagination
• Trying to fix this in a non breaking way would require overloads and the typing-extensions package (as 3.7 doesn't support typing.Literal), which to change the type to return dict[str, Any] as well as list[dict[str, Any]] is not justified.

Type support for this SDK is only very basic at the moment. But we will improve it in the future if/when we can get structured API data (like OpenAPI 3) from the Auth0 Management API.

References

fix #509

Testing

# foo.py

from auth0 import management

auth0 = management.Auth0(domain="", token="")
data = auth0.organizations.all_organization_members(id="foo", include_totals=True)
print(data.get("total"))

$ mypy foo.py
Success: no issues found in 1 source file

Checklist

• I have read the Auth0 general contribution guidelines
• I have read the Auth0 Code of Conduct
• All existing and new tests complete without errors

[kojiromike]

You can use typing.Literal in combination with typing.overload to get dependent types. For example:

from typing import Literal, overload

@overload
def list(..., include_totals: Literal[True], ...) -> dict[str, Any]:
    ...

@overload
def list(..., include_totals: Literal[False], ...) -> list[dict[str, Any]]:
    ...