keynetra-client 0.1.1

data/docs/MetaBody.md

@@ -0,0 +1,24 @@
+# KeyNetra::MetaBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **extra** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::MetaBody.new(
+  request_id: null,
+  limit: null,
+  next_cursor: null,
+  extra: null
+)
+```
+

data/docs/PermissionCreate.md

@@ -0,0 +1,18 @@
+# KeyNetra::PermissionCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PermissionCreate.new(
+  action: null
+)
+```
+

data/docs/PermissionOut.md

@@ -0,0 +1,20 @@
+# KeyNetra::PermissionOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **action** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PermissionOut.new(
+  id: null,
+  action: null
+)
+```
+

data/docs/PermissionUpdate.md

@@ -0,0 +1,18 @@
+# KeyNetra::PermissionUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PermissionUpdate.new(
+  action: null
+)
+```
+

data/docs/PlaygroundApi.md

@@ -0,0 +1,80 @@
+# KeyNetra::PlaygroundApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**evaluate_playground_evaluate_post**](PlaygroundApi.md#evaluate_playground_evaluate_post) | **POST** /playground/evaluate | Evaluate |
+
+
+## evaluate_playground_evaluate_post
+
+> <SuccessResponseDictStrAny> evaluate_playground_evaluate_post(playground_evaluate_request)
+
+Evaluate
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+# setup authorization
+KeyNetra.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KeyNetra::PlaygroundApi.new
+playground_evaluate_request = KeyNetra::PlaygroundEvaluateRequest.new({policies: [KeyNetra::PlaygroundPolicy.new({action: 'action_example'})], input: KeyNetra::PlaygroundInput.new}) # PlaygroundEvaluateRequest | 
+
+begin
+  # Evaluate
+  result = api_instance.evaluate_playground_evaluate_post(playground_evaluate_request)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling PlaygroundApi->evaluate_playground_evaluate_post: #{e}"
+end
+```
+
+#### Using the evaluate_playground_evaluate_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseDictStrAny>, Integer, Hash)> evaluate_playground_evaluate_post_with_http_info(playground_evaluate_request)
+
+```ruby
+begin
+  # Evaluate
+  data, status_code, headers = api_instance.evaluate_playground_evaluate_post_with_http_info(playground_evaluate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseDictStrAny>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling PlaygroundApi->evaluate_playground_evaluate_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **playground_evaluate_request** | [**PlaygroundEvaluateRequest**](PlaygroundEvaluateRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponseDictStrAny**](SuccessResponseDictStrAny.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PlaygroundEvaluateRequest.md

@@ -0,0 +1,20 @@
+# KeyNetra::PlaygroundEvaluateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policies** | [**Array<PlaygroundPolicy>**](PlaygroundPolicy.md) |  |  |
+| **input** | [**PlaygroundInput**](PlaygroundInput.md) |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PlaygroundEvaluateRequest.new(
+  policies: null,
+  input: null
+)
+```
+

data/docs/PlaygroundInput.md

@@ -0,0 +1,24 @@
+# KeyNetra::PlaygroundInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **Hash<String, Object>** |  | [optional] |
+| **resource** | **Hash<String, Object>** |  | [optional] |
+| **action** | **String** |  | [optional][default to ''] |
+| **context** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PlaygroundInput.new(
+  user: null,
+  resource: null,
+  action: null,
+  context: null
+)
+```
+

data/docs/PlaygroundPolicy.md

@@ -0,0 +1,26 @@
+# KeyNetra::PlaygroundPolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  |  |
+| **effect** | **String** |  | [optional][default to 'allow'] |
+| **priority** | **Integer** |  | [optional][default to 100] |
+| **policy_id** | **String** |  | [optional] |
+| **conditions** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PlaygroundPolicy.new(
+  action: null,
+  effect: null,
+  priority: null,
+  policy_id: null,
+  conditions: null
+)
+```
+

data/docs/PolicyCreate.md

@@ -0,0 +1,26 @@
+# KeyNetra::PolicyCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  |  |
+| **effect** | **String** |  | [optional][default to 'allow'] |
+| **priority** | **Integer** |  | [optional][default to 100] |
+| **state** | **String** |  | [optional][default to 'active'] |
+| **conditions** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PolicyCreate.new(
+  action: null,
+  effect: null,
+  priority: null,
+  state: null,
+  conditions: null
+)
+```
+

data/docs/PolicyOut.md

@@ -0,0 +1,28 @@
+# KeyNetra::PolicyOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **action** | **String** |  |  |
+| **effect** | **String** |  |  |
+| **priority** | **Integer** |  |  |
+| **state** | **String** |  | [optional][default to 'active'] |
+| **conditions** | **Hash<String, Object>** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PolicyOut.new(
+  id: null,
+  action: null,
+  effect: null,
+  priority: null,
+  state: null,
+  conditions: null
+)
+```
+

data/docs/PolicySimulationInput.md

@@ -0,0 +1,22 @@
+# KeyNetra::PolicySimulationInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_change** | **String** |  | [optional] |
+| **relationship_change** | **Hash<String, Object>** |  | [optional] |
+| **role_change** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PolicySimulationInput.new(
+  policy_change: null,
+  relationship_change: null,
+  role_change: null
+)
+```
+

data/docs/PolicySimulationRequest.md

@@ -0,0 +1,20 @@
+# KeyNetra::PolicySimulationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **simulate** | [**PolicySimulationInput**](PolicySimulationInput.md) |  | [optional] |
+| **request** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PolicySimulationRequest.new(
+  simulate: null,
+  request: null
+)
+```
+

data/docs/PolicySimulationResponse.md

@@ -0,0 +1,20 @@
+# KeyNetra::PolicySimulationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **decision_before** | **Hash<String, Object>** |  |  |
+| **decision_after** | **Hash<String, Object>** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::PolicySimulationResponse.new(
+  decision_before: null,
+  decision_after: null
+)
+```
+

data/docs/RelationshipCreate.md

@@ -0,0 +1,26 @@
+# KeyNetra::RelationshipCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_type** | **String** |  |  |
+| **subject_id** | **String** |  |  |
+| **relation** | **String** |  |  |
+| **object_type** | **String** |  |  |
+| **object_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::RelationshipCreate.new(
+  subject_type: null,
+  subject_id: null,
+  relation: null,
+  object_type: null,
+  object_id: null
+)
+```
+

data/docs/RelationshipOut.md

@@ -0,0 +1,28 @@
+# KeyNetra::RelationshipOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_type** | **String** |  |  |
+| **subject_id** | **String** |  |  |
+| **relation** | **String** |  |  |
+| **object_type** | **String** |  |  |
+| **object_id** | **String** |  |  |
+| **id** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::RelationshipOut.new(
+  subject_type: null,
+  subject_id: null,
+  relation: null,
+  object_type: null,
+  object_id: null,
+  id: null
+)
+```
+

data/docs/RoleCreate.md

@@ -0,0 +1,18 @@
+# KeyNetra::RoleCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::RoleCreate.new(
+  name: null
+)
+```
+

data/docs/RoleOut.md

@@ -0,0 +1,20 @@
+# KeyNetra::RoleOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::RoleOut.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/RoleUpdate.md

@@ -0,0 +1,18 @@
+# KeyNetra::RoleUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::RoleUpdate.new(
+  name: null
+)
+```
+

data/docs/SimulationResponse.md

@@ -0,0 +1,30 @@
+# KeyNetra::SimulationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **decision** | **String** |  |  |
+| **matched_policies** | **Array<String>** |  |  |
+| **reason** | **String** |  | [optional] |
+| **policy_id** | **String** |  | [optional] |
+| **explain_trace** | **Array<Hash<String, Object>>** |  | [optional] |
+| **failed_conditions** | **Array<String>** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SimulationResponse.new(
+  decision: null,
+  matched_policies: null,
+  reason: null,
+  policy_id: null,
+  explain_trace: null,
+  failed_conditions: null,
+  revision: null
+)
+```
+

data/docs/SuccessResponseACLOut.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseACLOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ACLOut**](ACLOut.md) |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseACLOut.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseAccessDecisionResponse.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseAccessDecisionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AccessDecisionResponse**](AccessDecisionResponse.md) |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseAccessDecisionResponse.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseAdminLoginResponse.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseAdminLoginResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AdminLoginResponse**](AdminLoginResponse.md) |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseAdminLoginResponse.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseAuthModelOut.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseAuthModelOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AuthModelOut**](AuthModelOut.md) |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseAuthModelOut.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseBatchAccessResponse.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseBatchAccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**BatchAccessResponse**](BatchAccessResponse.md) |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseBatchAccessResponse.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseDictStrAny.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseDictStrAny
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseDictStrAny.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseDictStrInt.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseDictStrInt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Integer>** |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseDictStrInt.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+

data/docs/SuccessResponseDictStrObject.md

@@ -0,0 +1,22 @@
+# KeyNetra::SuccessResponseDictStrObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, Object>** |  |  |
+| **meta** | [**MetaBody**](MetaBody.md) |  | [optional] |
+| **error** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::SuccessResponseDictStrObject.new(
+  data: null,
+  meta: null,
+  error: null
+)
+```
+