ory-keto-client 0.5.4.alpha1 → 0.6.0.alpha6

data/docs/PatchDelta.md

@@ -0,0 +1,20 @@
+# OryHydraClient::PatchDelta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+| **relation_tuple** | [**InternalRelationTuple**](InternalRelationTuple.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryHydraClient::PatchDelta.new(
+  action: null,
+  relation_tuple: null
+)
+```
+

data/docs/ReadApi.md

@@ -0,0 +1,297 @@
+# OryHydraClient::ReadApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_check**](ReadApi.md#get_check) | **GET** /check | Check a relation tuple |
+| [**get_expand**](ReadApi.md#get_expand) | **GET** /expand | Expand a Relation Tuple |
+| [**get_relation_tuples**](ReadApi.md#get_relation_tuples) | **GET** /relation-tuples | Query relation tuples |
+| [**post_check**](ReadApi.md#post_check) | **POST** /check | Check a relation tuple |
+
+
+## get_check
+
+> <GetCheckResponse> get_check(namespace, object, relation, opts)
+
+Check a relation tuple
+
+To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::ReadApi.new
+namespace = 'namespace_example' # String | Namespace of the Relation Tuple
+object = 'object_example' # String | Object of the Relation Tuple
+relation = 'relation_example' # String | Relation of the Relation Tuple
+opts = {
+  subject: 'subject_example' # String | Subject of the Relation Tuple  The subject follows the subject string encoding format.
+}
+
+begin
+  # Check a relation tuple
+  result = api_instance.get_check(namespace, object, relation, opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_check: #{e}"
+end
+```
+
+#### Using the get_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> get_check_with_http_info(namespace, object, relation, opts)
+
+```ruby
+begin
+  # Check a relation tuple
+  data, status_code, headers = api_instance.get_check_with_http_info(namespace, object, relation, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple |  |
+| **object** | **String** | Object of the Relation Tuple |  |
+| **relation** | **String** | Relation of the Relation Tuple |  |
+| **subject** | **String** | Subject of the Relation Tuple  The subject follows the subject string encoding format. | [optional] |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_expand
+
+> <ExpandTree> get_expand(namespace, object, relation, opts)
+
+Expand a Relation Tuple
+
+Use this endpoint to expand a relation tuple.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::ReadApi.new
+namespace = 'namespace_example' # String | Namespace of the Relation Tuple
+object = 'object_example' # String | Object of the Relation Tuple
+relation = 'relation_example' # String | Relation of the Relation Tuple
+opts = {
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Expand a Relation Tuple
+  result = api_instance.get_expand(namespace, object, relation, opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_expand: #{e}"
+end
+```
+
+#### Using the get_expand_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExpandTree>, Integer, Hash)> get_expand_with_http_info(namespace, object, relation, opts)
+
+```ruby
+begin
+  # Expand a Relation Tuple
+  data, status_code, headers = api_instance.get_expand_with_http_info(namespace, object, relation, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpandTree>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_expand_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple |  |
+| **object** | **String** | Object of the Relation Tuple |  |
+| **relation** | **String** | Relation of the Relation Tuple |  |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ExpandTree**](ExpandTree.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_relation_tuples
+
+> <GetRelationTuplesResponse> get_relation_tuples(namespace, opts)
+
+Query relation tuples
+
+Get all relation tuples that match the query. Only the namespace field is required.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::ReadApi.new
+namespace = 'namespace_example' # String | 
+opts = {
+  object: 'object_example', # String | 
+  relation: 'relation_example', # String | 
+  subject: 'subject_example', # String | 
+  page_token: 'page_token_example', # String | 
+  page_size: 789 # Integer | 
+}
+
+begin
+  # Query relation tuples
+  result = api_instance.get_relation_tuples(namespace, opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_relation_tuples: #{e}"
+end
+```
+
+#### Using the get_relation_tuples_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRelationTuplesResponse>, Integer, Hash)> get_relation_tuples_with_http_info(namespace, opts)
+
+```ruby
+begin
+  # Query relation tuples
+  data, status_code, headers = api_instance.get_relation_tuples_with_http_info(namespace, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRelationTuplesResponse>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->get_relation_tuples_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** |  |  |
+| **object** | **String** |  | [optional] |
+| **relation** | **String** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **page_token** | **String** |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+
+### Return type
+
+[**GetRelationTuplesResponse**](GetRelationTuplesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_check
+
+> <GetCheckResponse> post_check(opts)
+
+Check a relation tuple
+
+To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::ReadApi.new
+opts = {
+  payload: OryHydraClient::InternalRelationTuple.new({namespace: 'namespace_example', object: 'object_example', relation: 'relation_example', subject: 'subject_example'}) # InternalRelationTuple | 
+}
+
+begin
+  # Check a relation tuple
+  result = api_instance.post_check(opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->post_check: #{e}"
+end
+```
+
+#### Using the post_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_with_http_info(opts)
+
+```ruby
+begin
+  # Check a relation tuple
+  data, status_code, headers = api_instance.post_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ReadApi->post_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**InternalRelationTuple**](InternalRelationTuple.md) |  | [optional] |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Version.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** | Version is the service's version. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-keto-client'
 
-instance = OryHydraClient::Version.new(version: null)
+instance = OryHydraClient::Version.new(
+  version: null
+)
 ```
 
-

data/docs/VersionApi.md

@@ -2,34 +2,51 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_version**](VersionApi.md#get_version) | **GET** /version | Get service version
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_version**](VersionApi.md#get_version) | **GET** /version | Get service version |
 
 
 ## get_version
 
-> Version get_version
+> <Version> get_version
 
 Get service version
 
 This endpoint returns the service version typically notated using semantic versioning.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-keto-client'
 
 api_instance = OryHydraClient::VersionApi.new
 
 begin
-  #Get service version
+  # Get service version
   result = api_instance.get_version
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling VersionApi->get_version: #{e}"
+  puts "Error when calling VersionApi->get_version: #{e}"
+end
+```
+
+#### Using the get_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Version>, Integer, Hash)> get_version_with_http_info
+
+```ruby
+begin
+  # Get service version
+  data, status_code, headers = api_instance.get_version_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Version>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling VersionApi->get_version_with_http_info: #{e}"
 end
 ```
 

data/docs/WriteApi.md

@@ -0,0 +1,212 @@
+# OryHydraClient::WriteApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_relation_tuple**](WriteApi.md#create_relation_tuple) | **PUT** /relation-tuples | Create a Relation Tuple |
+| [**delete_relation_tuple**](WriteApi.md#delete_relation_tuple) | **DELETE** /relation-tuples | Delete a Relation Tuple |
+| [**patch_relation_tuples**](WriteApi.md#patch_relation_tuples) | **PATCH** /relation-tuples | Patch Multiple Relation Tuples |
+
+
+## create_relation_tuple
+
+> <InternalRelationTuple> create_relation_tuple(opts)
+
+Create a Relation Tuple
+
+Use this endpoint to create a relation tuple.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::WriteApi.new
+opts = {
+  payload: OryHydraClient::InternalRelationTuple.new({namespace: 'namespace_example', object: 'object_example', relation: 'relation_example', subject: 'subject_example'}) # InternalRelationTuple | 
+}
+
+begin
+  # Create a Relation Tuple
+  result = api_instance.create_relation_tuple(opts)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->create_relation_tuple: #{e}"
+end
+```
+
+#### Using the create_relation_tuple_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InternalRelationTuple>, Integer, Hash)> create_relation_tuple_with_http_info(opts)
+
+```ruby
+begin
+  # Create a Relation Tuple
+  data, status_code, headers = api_instance.create_relation_tuple_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InternalRelationTuple>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->create_relation_tuple_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**InternalRelationTuple**](InternalRelationTuple.md) |  | [optional] |
+
+### Return type
+
+[**InternalRelationTuple**](InternalRelationTuple.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_relation_tuple
+
+> delete_relation_tuple(namespace, object, relation, opts)
+
+Delete a Relation Tuple
+
+Use this endpoint to delete a relation tuple.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::WriteApi.new
+namespace = 'namespace_example' # String | Namespace of the Relation Tuple
+object = 'object_example' # String | Object of the Relation Tuple
+relation = 'relation_example' # String | Relation of the Relation Tuple
+opts = {
+  subject: 'subject_example' # String | Subject of the Relation Tuple  The subject follows the subject string encoding format.
+}
+
+begin
+  # Delete a Relation Tuple
+  api_instance.delete_relation_tuple(namespace, object, relation, opts)
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->delete_relation_tuple: #{e}"
+end
+```
+
+#### Using the delete_relation_tuple_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_relation_tuple_with_http_info(namespace, object, relation, opts)
+
+```ruby
+begin
+  # Delete a Relation Tuple
+  data, status_code, headers = api_instance.delete_relation_tuple_with_http_info(namespace, object, relation, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->delete_relation_tuple_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple |  |
+| **object** | **String** | Object of the Relation Tuple |  |
+| **relation** | **String** | Relation of the Relation Tuple |  |
+| **subject** | **String** | Subject of the Relation Tuple  The subject follows the subject string encoding format. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_relation_tuples
+
+> patch_relation_tuples(opts)
+
+Patch Multiple Relation Tuples
+
+Use this endpoint to patch one or more relation tuples.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryHydraClient::WriteApi.new
+opts = {
+  payload: [OryHydraClient::PatchDelta.new] # Array<PatchDelta> | 
+}
+
+begin
+  # Patch Multiple Relation Tuples
+  api_instance.patch_relation_tuples(opts)
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->patch_relation_tuples: #{e}"
+end
+```
+
+#### Using the patch_relation_tuples_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> patch_relation_tuples_with_http_info(opts)
+
+```ruby
+begin
+  # Patch Multiple Relation Tuples
+  data, status_code, headers = api_instance.patch_relation_tuples_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling WriteApi->patch_relation_tuples_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**Array&lt;PatchDelta&gt;**](PatchDelta.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+