# brease-sdk

> ## SDK Installation

Latest version **0.6.0** (published 2023-06-11) · 0 weekly downloads

## Install

```sh
npm install brease-sdk
pnpm add brease-sdk
yarn add brease-sdk
bun add brease-sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2023-06-11 |
| First published | 2023-04-19 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 168.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | dotinc |
| Maintainers | nadilas |

## Links

- npm: https://www.npmjs.com/package/brease-sdk
- Repository: https://github.com/speakeasy-sdks/brease
- Homepage: https://github.com/speakeasy-sdks/brease#readme
- Issues: https://github.com/speakeasy-sdks/brease/issues
- npm.io page: https://npm.io/package/brease-sdk

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^1.1.3
- [jsonpath](https://npm.io/package/jsonpath.md) ^1.1.1
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1

## Recent versions

- 0.6.0 (latest) — 2023-06-11
- 0.5.1 — 2023-06-10
- 0.5.0 — 2023-06-09
- 0.4.1 — 2023-06-07
- 0.4.0 — 2023-06-02
- 0.3.0 — 2023-05-18
- 0.1.3 — 2023-05-13
- 0.1.2 — 2023-05-10
- 0.1.1 — 2023-04-29
- 0.2.0 — 2023-04-28
- 0.1.0 — 2023-04-21
- 1.0.0 — 2023-04-19

## README

# brease-sdk

<!-- Start SDK Installation -->
## SDK Installation

### NPM

```bash
npm add brease-sdk
```

### Yarn

```bash
yarn add brease-sdk
```
<!-- End SDK Installation -->

## SDK Example Usage
<!-- Start SDK Example Usage -->
```typescript
import { SDK } from "brease-sdk";
import { AddRuleResponse } from "brease-sdk/dist/sdk/models/operations";
import { ConditionType } from "brease-sdk/dist/sdk/models/shared";

const sdk = new SDK();

sdk.contextID.addRule({
  addRuleInput: {
    rule: {
      action: "corrupti",
      description: "provident",
      expression: {
        condition: {
          base: {
            ref: {
              dst: "unde",
              src: "nulla",
            },
          },
          parameter: false,
          type: ConditionType.Rgx,
        },
      },
      id: "69a674e0-f467-4cc8-b96e-d151a05dfc2d",
      target: {
        target: "at",
        targetValue: "maiores",
        type: "molestiae",
      },
    },
  },
  contextID: "quod",
}, {
  apiToken: "",
}).then((res: AddRuleResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## Available Resources and Operations


### [contextID](docs/sdks/contextid/README.md)

* [addRule](docs/sdks/contextid/README.md#addrule) - Adds a new rule to the context
* [evaluateRules](docs/sdks/contextid/README.md#evaluaterules) - Evaluate rules within a context on the provided object
* [getAllRules](docs/sdks/contextid/README.md#getallrules) - Returns all rules with the context
* [removeRule](docs/sdks/contextid/README.md#removerule) - Removes a rule from the context
* [replaceRule](docs/sdks/contextid/README.md#replacerule) - Replaces an existing rule within the context
<!-- End SDK Available Operations -->

### Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

---
_Source: https://npm.io/package/brease-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._