refactor!: rename batch_check to client_batch_check

BREAKING CHANGE: Usage of the existing batch_check should now use client_batch_check instead,
additionally the existing BatchCheckResponse has been renamed to ClientBatchCheckClientResponse.

Author: ewanharris

openfga_sdk/client/client.py

@@ -22,6 +22,7 @@
     ClientCheckRequest,
     construct_check_request,
 )
+from openfga_sdk.client.models.client_batch_check_response import ClientBatchCheckClientResponse
 from openfga_sdk.client.models.expand_request import ClientExpandRequest
 from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
 from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest
@@ -115,7 +116,7 @@ def options_to_transaction_info(options: dict[str, int | str] = None):
     return WriteTransactionOpts()
 
 
-def _check_allowed(response: BatchCheckResponse):
+def _check_allowed(response: ClientBatchCheckClientResponse):
     """
     Helper function to return whether the response is check is allowed
     """
@@ -571,7 +572,7 @@ async def check(self, body: ClientCheckRequest, options: dict[str, str] = None):
         api_response = await self._api.check(body=req_body, **kwargs)
         return api_response
 
-    async def _single_batch_check(
+    async def _single_client_batch_check(
         self,
         body: ClientCheckRequest,
         semaphore: asyncio.Semaphore,
@@ -585,7 +586,7 @@ async def _single_batch_check(
         await semaphore.acquire()
         try:
             api_response = await self.check(body, options)
-            return BatchCheckResponse(
+            return ClientBatchCheckClientResponse(
                 allowed=api_response.allowed,
                 request=body,
                 response=api_response,
@@ -594,13 +595,13 @@ async def _single_batch_check(
         except (AuthenticationError, UnauthorizedException) as err:
             raise err
         except Exception as err:
-            return BatchCheckResponse(
+            return ClientBatchCheckClientResponse(
                 allowed=False, request=body, response=None, error=err
             )
         finally:
             semaphore.release()
 
-    async def batch_check(
+    async def client_batch_check(
         self, body: list[ClientCheckRequest], options: dict[str, str | int] = None
     ):
         """
@@ -630,7 +631,7 @@ async def batch_check(
 
         sem = asyncio.Semaphore(max_parallel_requests)
         batch_check_coros = [
-            self._single_batch_check(request, sem, options) for request in body
+            self._single_client_batch_check(request, sem, options) for request in body
         ]
         batch_check_response = await asyncio.gather(*batch_check_coros)
 
@@ -718,7 +719,7 @@ async def list_relations(
             )
             for i in body.relations
         ]
-        result = await self.batch_check(request_body, options)
+        result = await self.client_batch_check(request_body, options)
         # need to filter with the allowed response
         result_iterator = filter(_check_allowed, result)
         result_list = list(result_iterator)

openfga_sdk/client/models/__init__.py

@@ -13,6 +13,7 @@
 from openfga_sdk.client.models.assertion import ClientAssertion
 from openfga_sdk.client.models.batch_check_response import BatchCheckResponse
 from openfga_sdk.client.models.check_request import ClientCheckRequest
+from openfga_sdk.client.models.client_batch_check_response import ClientBatchCheckClientResponse
 from openfga_sdk.client.models.expand_request import ClientExpandRequest
 from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
 from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest

openfga_sdk/client/models/client_batch_check_response.py

@@ -0,0 +1,66 @@
+"""
+   Python SDK for OpenFGA
+
+   API version: 1.x
+   Website: https://openfga.dev
+   Documentation: https://openfga.dev/docs
+   Support: https://openfga.dev/community
+   License: [Apache-2.0](https://github.com/openfga/python-sdk/blob/main/LICENSE)
+
+   NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
+"""
+
+from openfga_sdk.client.models.check_request import ClientCheckRequest
+from openfga_sdk.models.check_response import CheckResponse
+
+
+class ClientBatchCheckClientResponse:
+    """
+    ClientBatchCheckClientResponse encapsulates the response for a single batch check
+    """
+
+    def __init__(
+        self,
+        allowed: bool,
+        request: ClientCheckRequest,
+        response: CheckResponse,
+        error: Exception = None,
+    ):
+        self._allowed = allowed
+        self._request = request
+        self._response = response
+        self._error = error
+
+    @property
+    def allowed(self):
+        """
+        Return whether request is allowed
+        """
+        return self._allowed
+
+    @property
+    def request(self):
+        """
+        Return original request
+        """
+        return self._request
+
+    @property
+    def response(self):
+        """
+        Return original request
+        """
+        return self._response
+
+    @property
+    def error(self):
+        """
+        Return error associated with batch request (if any)
+        """
+        return self._error
+
+    def __str__(self):
+        """
+        Return the class string
+        """
+        return f"allowed {self._allowed} request {self._request} error {self._error}"

openfga_sdk/sync/client/client.py

@@ -20,6 +20,7 @@
     ClientCheckRequest,
     construct_check_request,
 )
+from openfga_sdk.client.models.client_batch_check_response import ClientBatchCheckClientResponse
 from openfga_sdk.client.models.expand_request import ClientExpandRequest
 from openfga_sdk.client.models.list_objects_request import ClientListObjectsRequest
 from openfga_sdk.client.models.list_relations_request import ClientListRelationsRequest
@@ -115,7 +116,7 @@ def options_to_transaction_info(options: dict[str, int | str] = None):
     return WriteTransactionOpts()
 
 
-def _check_allowed(response: BatchCheckResponse):
+def _check_allowed(response: ClientBatchCheckClientResponse):
     """
     Helper function to return whether the response is check is allowed
     """
@@ -564,7 +565,7 @@ def check(self, body: ClientCheckRequest, options: dict[str, str] = None):
         api_response = self._api.check(body=req_body, **kwargs)
         return api_response
 
-    def _single_batch_check(
+    def _single_client_batch_check(
         self, body: ClientCheckRequest, options: dict[str, str] = None
     ):
         """
@@ -574,7 +575,7 @@ def _single_batch_check(
         """
         try:
             api_response = self.check(body, options)
-            return BatchCheckResponse(
+            return ClientBatchCheckClientResponse(
                 allowed=api_response.allowed,
                 request=body,
                 response=api_response,
@@ -583,11 +584,11 @@ def _single_batch_check(
         except (AuthenticationError, UnauthorizedException) as err:
             raise err
         except Exception as err:
-            return BatchCheckResponse(
+            return ClientBatchCheckClientResponse(
                 allowed=False, request=body, response=None, error=err
             )
 
-    def batch_check(
+    def client_batch_check(
         self, body: list[ClientCheckRequest], options: dict[str, str | int] = None
     ):
         """
@@ -619,7 +620,7 @@ def batch_check(
         batch_check_response = []
 
         def single_batch_check(request):
-            return self._single_batch_check(request, options)
+            return self._single_client_batch_check(request, options)
 
         with ThreadPoolExecutor(max_workers=max_parallel_requests) as executor:
             for response in executor.map(single_batch_check, body):
@@ -709,7 +710,7 @@ def list_relations(
             )
             for i in body.relations
         ]
-        result = self.batch_check(request_body, options)
+        result = self.client_batch_check(request_body, options)
         # need to filter with the allowed response
         result_iterator = filter(_check_allowed, result)
         result_list = list(result_iterator)

test/client/client_test.py

@@ -1936,7 +1936,7 @@ async def test_batch_check_single_request(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         async with OpenFgaClient(configuration) as api_client:
-            api_response = await api_client.batch_check(
+            api_response = await api_client.client_batch_check(
                 body=[body],
                 options={"authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1"},
             )
@@ -1996,7 +1996,7 @@ async def test_batch_check_multiple_request(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         async with OpenFgaClient(configuration) as api_client:
-            api_response = await api_client.batch_check(
+            api_response = await api_client.client_batch_check(
                 body=[body1, body2, body3],
                 options={
                     "authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1",
@@ -2105,7 +2105,7 @@ async def test_batch_check_multiple_request_fail(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         async with OpenFgaClient(configuration) as api_client:
-            api_response = await api_client.batch_check(
+            api_response = await api_client.client_batch_check(
                 body=[body1, body2, body3],
                 options={
                     "authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1",

test/sync/client/client_test.py

@@ -1935,7 +1935,7 @@ def test_batch_check_single_request(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         with OpenFgaClient(configuration) as api_client:
-            api_response = api_client.batch_check(
+            api_response = api_client.client_batch_check(
                 body=[body],
                 options={
                     "authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1",
@@ -1999,7 +1999,7 @@ def test_batch_check_multiple_request(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         with OpenFgaClient(configuration) as api_client:
-            api_response = api_client.batch_check(
+            api_response = api_client.client_batch_check(
                 body=[body1, body2, body3],
                 options={
                     "authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1",
@@ -2108,7 +2108,7 @@ def test_batch_check_multiple_request_fail(self, mock_request):
         configuration = self.configuration
         configuration.store_id = store_id
         with OpenFgaClient(configuration) as api_client:
-            api_response = api_client.batch_check(
+            api_response = api_client.client_batch_check(
                 body=[body1, body2, body3],
                 options={
                     "authorization_model_id": "01GXSA8YR785C4FYS3C0RTG7B1",