@ory/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @ory/keto-client-fetch --save

Next, try it out.

import {
  Configuration,
  MetadataApi,
} from '@ory/keto-client-fetch';
import type { GetVersionRequest } from '@ory/keto-client-fetch';

async function example() {
  console.log("🚀 Testing @ory/keto-client-fetch SDK...");
  const api = new MetadataApi();

  try {
    const data = await api.getVersion();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- MetadataApi | getVersion | GET /version | Return Running Software Version. MetadataApi | isAlive | GET /health/alive | Check HTTP Server Status MetadataApi | isReady | GET /health/ready | Check HTTP Server and Database Status PermissionApi | batchCheckPermission | POST /relation-tuples/batch/check | Batch check permissions PermissionApi | checkPermission | GET /relation-tuples/check/openapi | Check a permission PermissionApi | checkPermissionOrError | GET /relation-tuples/check | Check a permission PermissionApi | expandPermissions | GET /relation-tuples/expand | Expand a Relationship into permissions. PermissionApi | postCheckPermission | POST /relation-tuples/check/openapi | Check a permission PermissionApi | postCheckPermissionOrError | POST /relation-tuples/check | Check a permission RelationshipApi | checkOplSyntax | POST /opl/syntax/check | Check the syntax of an OPL file RelationshipApi | createRelationship | PUT /admin/relation-tuples | Create a Relationship RelationshipApi | deleteRelationships | DELETE /admin/relation-tuples | Delete Relationships RelationshipApi | getRelationships | GET /relation-tuples | Query relationships RelationshipApi | listRelationshipNamespaces | GET /namespaces | Query namespaces RelationshipApi | patchRelationships | PATCH /admin/relation-tuples | Patch Multiple Relationships

Models

• BatchCheckPermissionBody
• BatchCheckPermissionResult
• CheckOplSyntaxResult
• CheckPermissionResult
• CheckPermissionResultWithError
• CreateRelationshipBody
• ErrorGeneric
• ExpandedPermissionTree
• GenericError
• GetVersion200Response
• HealthNotReadyStatus
• HealthStatus
• IsAlive200Response
• IsReady503Response
• Namespace
• ParseError
• PostCheckPermissionBody
• PostCheckPermissionOrErrorBody
• RelationQuery
• Relationship
• RelationshipNamespaces
• RelationshipPatch
• Relationships
• SourcePosition
• SubjectSet
• Version

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: v26.2.0
• Package version: v26.2.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Apache 2.0