feat: add support for ListObjects API endpoint

Author: rhamzeh

.openapi-generator/VERSION

@@ -1 +1 @@
-6.0.0
+6.1.0-SNAPSHOT

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v0.0.2
+
+### [0.0.2](https://github.com/openfga/js-sdk/compare/v0.0.1...v0.0.2) (2022-08-15)
+
+Support for [ListObjects API]](https://openfga.dev/api/service#/Relationship%20Queries/ListObjects)
+
+You call the API and receive the list of object ids from a particular type that the user has a certain relation with.
+
+For example, to find the list of documents that Anne can read:
+
+```javascript
+const response = await openFgaApi.listObjects({
+  user: "anne",
+  relation: "can_read",
+  type: "document"
+});
+
+// response.object_ids = ["roadmap"]
+```
+
 ## v0.0.1
 
 ### [0.0.1](https://github.com/openfga/js-sdk/releases/tag/v0.0.1) (2022-06-15)

README.md

@@ -31,29 +31,30 @@ This is an autogenerated JavaScript SDK for OpenFGA. It provides a wrapper aroun
     - [Expand](#expand)
     - [Read Tuples](#read-tuples)
     - [Read Changes (Watch)](#read-changes-watch)
+    - [List Objects](#list-objects)
   - [API Endpoints](#api-endpoints)
   - [Models](#models)
 - [Contributing](#contributing)
   - [Issues](#issues)
   - [Pull Requests](#pull-requests)
 - [License](#license)
 
-## <a id="about">About OpenFGA</a>
+## About
 
 [OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.
 
 OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.
 
 It allows in-memory data storage for quick development, as well as pluggable database modules - with initial support for PostgreSQL.
 
-It offers an [HTTP API](https://openfga.dev/api) and has SDKs for programming languages including [Node.js/JavaScript](https://github.com/openfga/js-sdk), [GoLang](https://github.com/openfga/go-sdk) and [.NET](https://github.com/openfga/dotnet-sdk).
+It offers an [HTTP API](https://openfga.dev/api/service) and has SDKs for programming languages including [Node.js/JavaScript](https://github.com/openfga/js-sdk), [GoLang](https://github.com/openfga/go-sdk) and [.NET](https://github.com/openfga/dotnet-sdk).
 
 More SDKs and integrations such as Rego are planned for the future.
 
 ## Resources
 
 - [OpenFGA Documentation](https://openfga.dev/docs)
-- [OpenFGA API Documentation](https://openfga.dev/api)
+- [OpenFGA API Documentation](https://openfga.dev/api/service)
 - [Twitter](https://twitter.com/openfga)
 - [OpenFGA Discord Community](https://discord.gg/8naAwJfWN6)
 - [Zanzibar Academy](https://zanzibar.academy)
@@ -120,7 +121,7 @@ If your server is configured with [authentication enabled](https://openfga.dev/d
 
 #### List Stores
 
-[API Documentation](https://openfga.dev/api#/Stores/ListStores)
+[API Documentation](https://openfga.dev/api/service#/Stores/ListStores)
 
 ```javascript
 const { stores } = await openFga.listStores();
@@ -130,7 +131,7 @@ const { stores } = await openFga.listStores();
 
 #### Create Store
 
-[API Documentation](https://openfga.dev/api#/Stores/CreateStore)
+[API Documentation](https://openfga.dev/api/service#/Stores/CreateStore)
 
 ```javascript
 const { id: storeId } = await openFga.createStore({
@@ -142,7 +143,7 @@ const { id: storeId } = await openFga.createStore({
 
 #### Get Store
 
-[API Documentation](https://openfga.dev/api#/Stores/GetStore)
+[API Documentation](https://openfga.dev/api/service#/Stores/GetStore)
 
 > Requires a client initialized with a storeId
 
@@ -156,7 +157,7 @@ const store = await openFga.getStore({
 
 #### Delete Store
 
-[API Documentation](https://openfga.dev/api#/Stores/DeleteStore)
+[API Documentation](https://openfga.dev/api/service#/Stores/DeleteStore)
 
 > Requires a client initialized with a storeId
 
@@ -166,7 +167,7 @@ await openFga.deleteStore();
 
 #### Write Authorization Model
 
-[API Documentation](https://openfga.dev/api#/Authorization%20Models/WriteAuthorizationModel)
+[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/WriteAuthorizationModel)
 
 > Requires a client initialized with a storeId
 
@@ -199,7 +200,7 @@ const { authorization_model_id: id } = await openFga.writeAuthorizationModel({
 
 #### Read a Single Authorization Model
 
-[API Documentation](https://openfga.dev/api#/Authorization%20Models/ReadAuthorizationModel)
+[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/ReadAuthorizationModel)
 
 > Requires a client initialized with a storeId
 
@@ -212,7 +213,7 @@ const { authorization_model: authorizationModel } = await openFga.readAuthorizat
 
 #### Read Authorization Model IDs
 
-[API Documentation](https://openfga.dev/api#/Authorization%20Models/ReadAuthorizationModels)
+[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/ReadAuthorizationModels)
 
 ```javascript
 const { authorization_model_ids: authorizationModelIds } = await openFga.readAuthorizationModels();
@@ -222,7 +223,7 @@ const { authorization_model_ids: authorizationModelIds } = await openFga.readAut
 
 #### Check
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Queries/Check)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/Check)
 
 > Requires a client initialized with a storeId
 
@@ -242,7 +243,7 @@ const result = await openFga.check({
 
 #### Write Tuples
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Tuples/Write)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/Write)
 
 > Requires a client initialized with a storeId
 
@@ -257,7 +258,7 @@ await openFga.write({
 
 #### Delete Tuples
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Tuples/Write)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/Write)
 
 > Requires a client initialized with a storeId
 
@@ -272,7 +273,7 @@ await openFga.write({
 
 #### Expand
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Queries/Expand)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/Expand)
 
 > Requires a client initialized with a storeId
 
@@ -289,7 +290,7 @@ const { tree } = await openFga.expand({
 
 #### Read Tuples
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Tuples/Read)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/Read)
 
 > Requires a client initialized with a storeId
 
@@ -337,7 +338,7 @@ const { tuples } = await openFga.read(body);
 
 > Requires a client initialized with a storeId
 
-[API Documentation](https://openfga.dev/api#/Relationship%20Tuples/ReadChanges)
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/ReadChanges)
 
 ```javascript
 const type = 'workspace';
@@ -352,6 +353,35 @@ const response = await openFga.readChanges(type, pageSize, continuationToken);
 // ]
 ```
 
+#### List Objects
+
+> Requires a client initialized with a storeId
+
+[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/ListObjects)
+
+```javascript
+const response = await openFgaApi.listObjects({
+  authorization_model_id: "01GAHCE4YVKPQEKZQHT2R89MQV",
+  user: "anne",
+  relation: "can_read",
+  type: "document",
+  contextual_tuples: {
+    tuple_keys:
+      [{
+        user: "anne",
+        relation: "editor",
+        object: "folder:product"
+      }, {
+        user: "folder:product",
+        relation: "parent",
+        object: "document:roadmap"
+      }]
+  }
+});
+
+// response.object_ids = ["roadmap"]
+```
+
 
 ### API Endpoints
 
@@ -362,6 +392,7 @@ const response = await openFga.readChanges(type, pageSize, continuationToken);
 | [**deleteStore**](#deletestore) | **DELETE** /stores/{store_id} | Delete a store |
 | [**expand**](#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 |
 | [**getStore**](#getstore) | **GET** /stores/{store_id} | Get a store |
+| [**listObjects**](#listobjects) | **POST** /stores/{store_id}/list-objects | ListObjects lists all of the object ids for objects of the provided type that the given user has a specific relation with. |
 | [**listStores**](#liststores) | **GET** /stores | Get all stores |
 | [**read**](#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules |
 | [**readAssertions**](#readassertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID |
@@ -432,6 +463,18 @@ const response = await openFga.readChanges(type, pageSize, continuationToken);
 [**GetStoreResponse**](#GetStoreResponse)
 
 
+#### listObjects
+
+
+| Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **body** | [**ListObjectsRequest**](#ListObjectsRequest) |  | |
+
+##### Return type
+
+[**ListObjectsResponse**](#ListObjectsResponse)
+
+
 #### listStores
 
 
@@ -559,6 +602,8 @@ const response = await openFga.readChanges(type, pageSize, continuationToken);
  - [InternalErrorCode](#InternalErrorCode)
  - [InternalErrorMessageResponse](#InternalErrorMessageResponse)
  - [Leaf](#Leaf)
+ - [ListObjectsRequest](#ListObjectsRequest)
+ - [ListObjectsResponse](#ListObjectsResponse)
  - [ListStoresResponse](#ListStoresResponse)
  - [Node](#Node)
  - [Nodes](#Nodes)
@@ -856,6 +901,26 @@ Name | Type | Description | Notes
 **computed** | [**Computed**](#Computed) |  | [optional] [default to undefined]
 **tupleToUserset** | [**UsersetTreeTupleToUserset**](#UsersetTreeTupleToUserset) |  | [optional] [default to undefined]
 
+#### ListObjectsRequest
+
+##### Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authorization_model_id** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**relation** | **string** |  | [optional] [default to undefined]
+**user** | **string** |  | [optional] [default to undefined]
+**contextual_tuples** | [**ContextualTupleKeys**](#ContextualTupleKeys) |  | [optional] [default to undefined]
+
+#### ListObjectsResponse
+
+##### Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object_ids** | **string** |  | [optional] [default to undefined]
+
 #### ListStoresResponse
 
 ##### Properties