ory-keto-client 0.9.0.alpha0 → 0.11.0.alpha0

data/docs/PermissionApi.md

@@ -0,0 +1,380 @@
+# OryKetoClient::PermissionApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_permission**](PermissionApi.md#check_permission) | **GET** /relation-tuples/check/openapi | Check a permission |
+| [**check_permission_or_error**](PermissionApi.md#check_permission_or_error) | **GET** /relation-tuples/check | Check a permission |
+| [**expand_permissions**](PermissionApi.md#expand_permissions) | **GET** /relation-tuples/expand | Expand a Relationship into permissions. |
+| [**post_check_permission**](PermissionApi.md#post_check_permission) | **POST** /relation-tuples/check/openapi | Check a permission |
+| [**post_check_permission_or_error**](PermissionApi.md#post_check_permission_or_error) | **POST** /relation-tuples/check | Check a permission |
+
+
+## check_permission
+
+> <CheckPermissionResult> check_permission(opts)
+
+Check a permission
+
+To learn how relationship tuples and the check works, head over to [the documentation](https://www.ory.sh/docs/keto/concepts/api-overview).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryKetoClient::PermissionApi.new
+opts = {
+  namespace: 'namespace_example', # String | Namespace of the Relationship
+  object: 'object_example', # String | Object of the Relationship
+  relation: 'relation_example', # String | Relation of the Relationship
+  subject_id: 'subject_id_example', # String | SubjectID of the Relationship
+  subject_set_namespace: 'subject_set_namespace_example', # String | Namespace of the Subject Set
+  subject_set_object: 'subject_set_object_example', # String | Object of the Subject Set
+  subject_set_relation: 'subject_set_relation_example', # String | Relation of the Subject Set
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Check a permission
+  result = api_instance.check_permission(opts)
+  p result
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->check_permission: #{e}"
+end
+```
+
+#### Using the check_permission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckPermissionResult>, Integer, Hash)> check_permission_with_http_info(opts)
+
+```ruby
+begin
+  # Check a permission
+  data, status_code, headers = api_instance.check_permission_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckPermissionResult>
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->check_permission_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relationship | [optional] |
+| **object** | **String** | Object of the Relationship | [optional] |
+| **relation** | **String** | Relation of the Relationship | [optional] |
+| **subject_id** | **String** | SubjectID of the Relationship | [optional] |
+| **subject_set_namespace** | **String** | Namespace of the Subject Set | [optional] |
+| **subject_set_object** | **String** | Object of the Subject Set | [optional] |
+| **subject_set_relation** | **String** | Relation of the Subject Set | [optional] |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**CheckPermissionResult**](CheckPermissionResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## check_permission_or_error
+
+> <CheckPermissionResult> check_permission_or_error(opts)
+
+Check a permission
+
+To learn how relationship tuples and the check works, head over to [the documentation](https://www.ory.sh/docs/keto/concepts/api-overview).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryKetoClient::PermissionApi.new
+opts = {
+  namespace: 'namespace_example', # String | Namespace of the Relationship
+  object: 'object_example', # String | Object of the Relationship
+  relation: 'relation_example', # String | Relation of the Relationship
+  subject_id: 'subject_id_example', # String | SubjectID of the Relationship
+  subject_set_namespace: 'subject_set_namespace_example', # String | Namespace of the Subject Set
+  subject_set_object: 'subject_set_object_example', # String | Object of the Subject Set
+  subject_set_relation: 'subject_set_relation_example', # String | Relation of the Subject Set
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Check a permission
+  result = api_instance.check_permission_or_error(opts)
+  p result
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->check_permission_or_error: #{e}"
+end
+```
+
+#### Using the check_permission_or_error_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckPermissionResult>, Integer, Hash)> check_permission_or_error_with_http_info(opts)
+
+```ruby
+begin
+  # Check a permission
+  data, status_code, headers = api_instance.check_permission_or_error_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckPermissionResult>
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->check_permission_or_error_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relationship | [optional] |
+| **object** | **String** | Object of the Relationship | [optional] |
+| **relation** | **String** | Relation of the Relationship | [optional] |
+| **subject_id** | **String** | SubjectID of the Relationship | [optional] |
+| **subject_set_namespace** | **String** | Namespace of the Subject Set | [optional] |
+| **subject_set_object** | **String** | Object of the Subject Set | [optional] |
+| **subject_set_relation** | **String** | Relation of the Subject Set | [optional] |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**CheckPermissionResult**](CheckPermissionResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## expand_permissions
+
+> <ExpandedPermissionTree> expand_permissions(namespace, object, relation, opts)
+
+Expand a Relationship into permissions.
+
+Use this endpoint to expand a relationship tuple into permissions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryKetoClient::PermissionApi.new
+namespace = 'namespace_example' # String | Namespace of the Subject Set
+object = 'object_example' # String | Object of the Subject Set
+relation = 'relation_example' # String | Relation of the Subject Set
+opts = {
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Expand a Relationship into permissions.
+  result = api_instance.expand_permissions(namespace, object, relation, opts)
+  p result
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->expand_permissions: #{e}"
+end
+```
+
+#### Using the expand_permissions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExpandedPermissionTree>, Integer, Hash)> expand_permissions_with_http_info(namespace, object, relation, opts)
+
+```ruby
+begin
+  # Expand a Relationship into permissions.
+  data, status_code, headers = api_instance.expand_permissions_with_http_info(namespace, object, relation, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpandedPermissionTree>
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->expand_permissions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Subject Set |  |
+| **object** | **String** | Object of the Subject Set |  |
+| **relation** | **String** | Relation of the Subject Set |  |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ExpandedPermissionTree**](ExpandedPermissionTree.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_check_permission
+
+> <CheckPermissionResult> post_check_permission(opts)
+
+Check a permission
+
+To learn how relationship tuples and the check works, head over to [the documentation](https://www.ory.sh/docs/keto/concepts/api-overview).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryKetoClient::PermissionApi.new
+opts = {
+  max_depth: 789, # Integer | 
+  post_check_permission_body: OryKetoClient::PostCheckPermissionBody.new # PostCheckPermissionBody | 
+}
+
+begin
+  # Check a permission
+  result = api_instance.post_check_permission(opts)
+  p result
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->post_check_permission: #{e}"
+end
+```
+
+#### Using the post_check_permission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckPermissionResult>, Integer, Hash)> post_check_permission_with_http_info(opts)
+
+```ruby
+begin
+  # Check a permission
+  data, status_code, headers = api_instance.post_check_permission_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckPermissionResult>
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->post_check_permission_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_depth** | **Integer** |  | [optional] |
+| **post_check_permission_body** | [**PostCheckPermissionBody**](PostCheckPermissionBody.md) |  | [optional] |
+
+### Return type
+
+[**CheckPermissionResult**](CheckPermissionResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_permission_or_error
+
+> <CheckPermissionResult> post_check_permission_or_error(opts)
+
+Check a permission
+
+To learn how relationship tuples and the check works, head over to [the documentation](https://www.ory.sh/docs/keto/concepts/api-overview).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-keto-client'
+
+api_instance = OryKetoClient::PermissionApi.new
+opts = {
+  max_depth: 789, # Integer | nolint:deadcode,unused
+  post_check_permission_or_error_body: OryKetoClient::PostCheckPermissionOrErrorBody.new # PostCheckPermissionOrErrorBody | 
+}
+
+begin
+  # Check a permission
+  result = api_instance.post_check_permission_or_error(opts)
+  p result
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->post_check_permission_or_error: #{e}"
+end
+```
+
+#### Using the post_check_permission_or_error_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckPermissionResult>, Integer, Hash)> post_check_permission_or_error_with_http_info(opts)
+
+```ruby
+begin
+  # Check a permission
+  data, status_code, headers = api_instance.post_check_permission_or_error_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckPermissionResult>
+rescue OryKetoClient::ApiError => e
+  puts "Error when calling PermissionApi->post_check_permission_or_error_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_depth** | **Integer** | nolint:deadcode,unused | [optional] |
+| **post_check_permission_or_error_body** | [**PostCheckPermissionOrErrorBody**](PostCheckPermissionOrErrorBody.md) |  | [optional] |
+
+### Return type
+
+[**CheckPermissionResult**](CheckPermissionResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PostCheckPermissionBody.md

@@ -0,0 +1,26 @@
+# OryKetoClient::PostCheckPermissionBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace to query | [optional] |
+| **object** | **String** | Object to query | [optional] |
+| **relation** | **String** | Relation to query | [optional] |
+| **subject_id** | **String** | SubjectID to query  Either SubjectSet or SubjectID can be provided. | [optional] |
+| **subject_set** | [**SubjectSet**](SubjectSet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryKetoClient::PostCheckPermissionBody.new(
+  namespace: null,
+  object: null,
+  relation: null,
+  subject_id: null,
+  subject_set: null
+)
+```
+

data/docs/PostCheckPermissionOrErrorBody.md

@@ -0,0 +1,26 @@
+# OryKetoClient::PostCheckPermissionOrErrorBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace to query | [optional] |
+| **object** | **String** | Object to query | [optional] |
+| **relation** | **String** | Relation to query | [optional] |
+| **subject_id** | **String** | SubjectID to query  Either SubjectSet or SubjectID can be provided. | [optional] |
+| **subject_set** | [**SubjectSet**](SubjectSet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-keto-client'
+
+instance = OryKetoClient::PostCheckPermissionOrErrorBody.new(
+  namespace: null,
+  object: null,
+  relation: null,
+  subject_id: null,
+  subject_set: null
+)
+```
+

data/docs/{RelationTuple.md → Relationship.md}

@@ -1,4 +1,4 @@
-# OryKetoClient::RelationTuple
+# OryKetoClient::Relationship
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'ory-keto-client'
 
-instance = OryKetoClient::RelationTuple.new(
+instance = OryKetoClient::Relationship.new(
   namespace: null,
   object: null,
   relation: null,