# ory-keto-client

OryKetoClient - the Ruby gem for the Ory Keto API

Documentation for all of Ory Keto's REST APIs. gRPC is documented separately.


This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v0.8.0-alpha.2
- Package version: v0.8.0-alpha.2
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build ory-keto-client.gemspec
```

Then either install the gem locally:

```shell
gem install ./ory-keto-client-v0.8.0-alpha.2.gem
```

(for development, run `gem install --dev ./ory-keto-client-v0.8.0-alpha.2.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'ory-keto-client', '~> v0.8.0-alpha.2'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/ory/sdk, then add the following in the Gemfile:

    gem 'ory-keto-client', :git => 'https://github.com/ory/sdk.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'ory-keto-client'

api_instance = OryKetoClient::MetadataApi.new

begin
  #Return Running Software Version.
  result = api_instance.get_version
  p result
rescue OryKetoClient::ApiError => e
  puts "Exception when calling MetadataApi->get_version: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*OryKetoClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version.
*OryKetoClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status
*OryKetoClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status
*OryKetoClient::ReadApi* | [**get_check**](docs/ReadApi.md#get_check) | **GET** /check | Check a relation tuple
*OryKetoClient::ReadApi* | [**get_expand**](docs/ReadApi.md#get_expand) | **GET** /expand | Expand a Relation Tuple
*OryKetoClient::ReadApi* | [**get_relation_tuples**](docs/ReadApi.md#get_relation_tuples) | **GET** /relation-tuples | Query relation tuples
*OryKetoClient::ReadApi* | [**post_check**](docs/ReadApi.md#post_check) | **POST** /check | Check a relation tuple
*OryKetoClient::WriteApi* | [**create_relation_tuple**](docs/WriteApi.md#create_relation_tuple) | **PUT** /relation-tuples | Create a Relation Tuple
*OryKetoClient::WriteApi* | [**delete_relation_tuples**](docs/WriteApi.md#delete_relation_tuples) | **DELETE** /relation-tuples | Delete Relation Tuples
*OryKetoClient::WriteApi* | [**patch_relation_tuples**](docs/WriteApi.md#patch_relation_tuples) | **PATCH** /relation-tuples | Patch Multiple Relation Tuples


## Documentation for Models

 - [OryKetoClient::ExpandTree](docs/ExpandTree.md)
 - [OryKetoClient::GenericError](docs/GenericError.md)
 - [OryKetoClient::GetCheckResponse](docs/GetCheckResponse.md)
 - [OryKetoClient::GetRelationTuplesResponse](docs/GetRelationTuplesResponse.md)
 - [OryKetoClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
 - [OryKetoClient::HealthStatus](docs/HealthStatus.md)
 - [OryKetoClient::InlineResponse200](docs/InlineResponse200.md)
 - [OryKetoClient::InlineResponse2001](docs/InlineResponse2001.md)
 - [OryKetoClient::InlineResponse503](docs/InlineResponse503.md)
 - [OryKetoClient::InternalRelationTuple](docs/InternalRelationTuple.md)
 - [OryKetoClient::PatchDelta](docs/PatchDelta.md)
 - [OryKetoClient::RelationQuery](docs/RelationQuery.md)
 - [OryKetoClient::SubjectSet](docs/SubjectSet.md)
 - [OryKetoClient::Version](docs/Version.md)


## Documentation for Authorization

 All endpoints do not require authorization.