Description

This introduces support for OpenFGA's POST /stores/{store_id}/streamed-list-objects endpoint.

The pull request introduces:

• Adds a new streamed_list_objects() method to the SDK client, simplifying the handling of the streaming endpoint for developers.
• Adds a new stream() method to the async/sync REST clients, which supports handling of streaming/chunked HTTP network requests.
• Adds a new build_request() method to the async/sync REST clients to handle the request-building steps shared by the request() and stream() methods.
• Adds a new handle_response_exception() method to the async/sync REST clients to handle the HTTP response exception processing shared between the request() and stream() methods.
• Adds a new _accumulate_json_lines() private method to the async/sync REST clients to help collect and reassemble partially delivered packets from streaming/chunked HTTP network requests. This method is used by stream().
• Adds the OpenAPI-generated streamed_list_objects_response and stream_result_of_streamed_list_objects_response models.
• Adds a new /example/streamed-list-objects example app, demonstrating usage through both the asynchronous and synchronous clients.
• Adds a new section to the README to demonstrate usage.
• Adds the pytest-asyncio dependency to simplify working with async method tests.
• Adds the test/rest_test.py and test/sync/rest_test.py test suites to target all methods in the refactored classes. It includes tests for the new streaming APIs.

It changes:

• Updates the async/sync API clients to use the streamlined REST client APIs.
• Updates the async/sync API clients to support a _streaming parameter on appropriate methods, which helps direct the flow of
• Updates the async/sync OAuth2 clients to use the streamlined REST client APIs.
• Updates the request() method of the async/sync REST clients.
• Refactors the async/sync REST clients to improve type-hinting.
• Updates other test suites to accommodate the streamlined REST client APIs.

And removes:

• Removes the GET(), HEAD(), OPTIONS(), POST(), PUT(), PATCH(), and DELETE() helper methods from the async/sync REST clients, to streamline the class and reduce redundant code.

Usage Example:

Using the async client:

# from openfga_sdk import OpenFgaClient
# from openfga_sdk.client.models import ClientListObjectsRequest

# Initialize the fga_client
# fga_client = OpenFgaClient(configuration)

results = []

documents = ClientListObjectsRequest(
    type="document",
    relation="writer",
    user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
)

async for response in fga_client.streamed_list_objects(request):
    results.append(response)

# results = ["document:...", ...]

You can also review the new /example/streamed-list-objects/asynchronous.py (or synchronous.py) app for a more detailed usage demo.

References

This code is generated using the SDK Generator; the pull request, including these changes, can be reviewed at its repository here: openfga/sdk-generator#469

The relevant issue for tracking this feature can be found her: openfga/sdk-generator#76

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected