npm package: @ory/oathkeeper-client-fetch
Description: OpenAPI client for @ory/oathkeeper-client-fetch
Author: Ory Corp
Latest version: 26.2.0

# @ory/oathkeeper-client-fetch@v26.2.0

A TypeScript SDK client for the localhost API.

## Usage

First, install the SDK from npm.

```bash
npm install @ory/oathkeeper-client-fetch --save
```

Next, try it out.


```ts
import {
  Configuration,
  ApiApi,
} from '@ory/oathkeeper-client-fetch';
import type { DecisionsRequest } from '@ory/oathkeeper-client-fetch';

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

  try {
    const data = await api.decisions();
    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
| ----- | ------ | ------------ | -------------
*ApiApi* | [**decisions**](docs/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
*ApiApi* | [**getRule**](docs/ApiApi.md#getrule) | **GET** /rules/{id} | Retrieve a Rule
*ApiApi* | [**getWellKnownJSONWebKeys**](docs/ApiApi.md#getwellknownjsonwebkeys) | **GET** /.well-known/jwks.json | Lists Cryptographic Keys
*ApiApi* | [**listRules**](docs/ApiApi.md#listrules) | **GET** /rules | List All Rules
*MetadataApi* | [**getVersion**](docs/MetadataApi.md#getversion) | **GET** /version | Return Running Software Version.
*MetadataApi* | [**isAlive**](docs/MetadataApi.md#isalive) | **GET** /health/alive | Check HTTP Server Status
*MetadataApi* | [**isReady**](docs/MetadataApi.md#isready) | **GET** /health/ready | Check HTTP Server and Database Status


### Models

- [GenericError](docs/GenericError.md)
- [GetVersion200Response](docs/GetVersion200Response.md)
- [HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
- [HealthStatus](docs/HealthStatus.md)
- [IsAlive200Response](docs/IsAlive200Response.md)
- [IsReady503Response](docs/IsReady503Response.md)
- [JsonWebKey](docs/JsonWebKey.md)
- [JsonWebKeySet](docs/JsonWebKeySet.md)
- [Rule](docs/Rule.md)
- [RuleHandler](docs/RuleHandler.md)
- [RuleMatch](docs/RuleMatch.md)
- [Upstream](docs/Upstream.md)
- [Version](docs/Version.md)

### Authorization

Endpoints do not require authorization.


## About

This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
and is automatically generated by the
[OpenAPI Generator](https://openapi-generator.tech) 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:

```bash
npm install
npm run build
```

### Publishing

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

```bash
npm publish
```

## License

[Apache 2.0]()