feat!: request via python

Ability to do batch check, write and list relations
No longer supports python 3.9

Author: adriantam

.github/workflows/main.yaml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.10", "3.11"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}

.openapi-generator-ignore

@@ -3,6 +3,7 @@ test/*
 !test/__init__.py
 !test/test_open_fga_api.py
 !test/test_credentials.py
+!test/test_openfga_client.py
 .gitlab-ci.yml
 .travis.yml
 tox.ini

.openapi-generator/FILES

@@ -71,6 +71,20 @@ openfga_sdk/__init__.py
 openfga_sdk/api/__init__.py
 openfga_sdk/api/open_fga_api.py
 openfga_sdk/api_client.py
+openfga_sdk/client/__init__.py
+openfga_sdk/client/batch_check_response.py
+openfga_sdk/client/check_request_body.py
+openfga_sdk/client/client_tuple.py
+openfga_sdk/client/client_write_request.py
+openfga_sdk/client/client_write_response.py
+openfga_sdk/client/configuration.py
+openfga_sdk/client/expand_request_body.py
+openfga_sdk/client/list_objects_request_body.py
+openfga_sdk/client/list_relations_request_body.py
+openfga_sdk/client/openfga_client.py
+openfga_sdk/client/read_changes_body.py
+openfga_sdk/client/single_write_response.py
+openfga_sdk/client/write_transaction.py
 openfga_sdk/configuration.py
 openfga_sdk/credentials.py
 openfga_sdk/exceptions.py
@@ -137,3 +151,4 @@ test-requirements.txt
 test/__init__.py
 test/test_credentials.py
 test/test_open_fga_api.py
+test/test_openfga_client.py

README.md

@@ -661,7 +661,7 @@ Class | Method | HTTP request | Description
 *OpenFgaApi* | [**delete_store**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#delete_store) | **DELETE** /stores/{store_id} | Delete a store
 *OpenFgaApi* | [**expand**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#expand) | **POST** /stores/{store_id}/expand | Expand all relationships in userset tree format, and following userset rewrite rules.  Useful to reason about and debug a certain relationship
 *OpenFgaApi* | [**get_store**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#get_store) | **GET** /stores/{store_id} | Get a store
-*OpenFgaApi* | [**list_objects**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | Get all objects of the given type that the user has a relation with
+*OpenFgaApi* | [**list_objects**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | List all objects of the given type that the user has a relation with
 *OpenFgaApi* | [**list_stores**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#list_stores) | **GET** /stores | List all stores
 *OpenFgaApi* | [**read**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules
 *OpenFgaApi* | [**read_assertions**](https://github.com/openfga/python-sdk/blob/main/docs/OpenFgaApi.md#read_assertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID

docs/OpenFgaApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 [**delete_store**](OpenFgaApi.md#delete_store) | **DELETE** /stores/{store_id} | Delete a store
 [**expand**](OpenFgaApi.md#expand) | **POST** /stores/{store_id}/expand | Expand all relationships in userset tree format, and following userset rewrite rules.  Useful to reason about and debug a certain relationship
 [**get_store**](OpenFgaApi.md#get_store) | **GET** /stores/{store_id} | Get a store
-[**list_objects**](OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | Get all objects of the given type that the user has a relation with
+[**list_objects**](OpenFgaApi.md#list_objects) | **POST** /stores/{store_id}/list-objects | List all objects of the given type that the user has a relation with
 [**list_stores**](OpenFgaApi.md#list_stores) | **GET** /stores | List all stores
 [**read**](OpenFgaApi.md#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules
 [**read_assertions**](OpenFgaApi.md#read_assertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID
@@ -417,9 +417,9 @@ No authorization required
 # **list_objects**
 > ListObjectsResponse list_objects(body)
 
-Get all objects of the given type that the user has a relation with
+List all objects of the given type that the user has a relation with
 
-The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). Note: If you have `and` or `but not` in your model while using ListObjects, checkout the [caveats](https://openfga.dev/docs/interacting/relationship-queries#caveats-and-when-not-to-use-it-3). 
+The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To achieve this, both the store tuples and the authorization model are used. An `authorization_model_id` may be specified in the body. If it is, it will be used to decide the underlying implementation used. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. The response will contain the related objects in an array in the \"objects\" field of the response and they will be strings in the object format `<type>:<id>` (e.g. \"document:roadmap\"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first.  Note: If you have `and` or `but not` in your model while using ListObjects, checkout the [caveats](https://openfga.dev/docs/interacting/relationship-queries#caveats-and-when-not-to-use-it-3). 
 
 ### Example
 
@@ -456,7 +456,7 @@ async with openfga_sdk.ApiClient(configuration) as api_client:
     body = openfga_sdk.ListObjectsRequest() # ListObjectsRequest | 
 
     try:
-        # Get all objects of the given type that the user has a relation with
+        # List all objects of the given type that the user has a relation with
         api_response = await api_instance.api_instance.list_objects(body)
         pprint(api_response)
     except ApiException as e:

openfga_sdk/__init__.py

@@ -16,6 +16,9 @@
 
 __version__ = "0.1.1"
 
+from openfga_sdk.client.openfga_client import OpenFgaClient
+from openfga_sdk.client.configuration import ClientConfiguration
+
 # import apis into sdk package
 from openfga_sdk.api.open_fga_api import OpenFgaApi