# @quba/sensitive-data-protection

A TypeScript SDK client for the app.quba.ae API.

## Usage

First, install the SDK from npm.

```bash
npm install @quba/sensitive-data-protection --save
```

Next, try it out.


```ts
import {
  Configuration,
  SensitiveDataProtectionApi,
} from '@quba/sensitive-data-protection';
import type { AnonymizeTextRequest } from '@quba/sensitive-data-protection';

async function example() {
  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
  const api = new SensitiveDataProtectionApi();

  const body = {
    // AnonymizeRequestBody
    AnonymizeRequestBody: ...,
  } satisfies AnonymizeTextRequest;

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

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


## Documentation

### API Endpoints

All URIs are relative to *https://app.quba.ae/api/sdp*

| Class | Method | HTTP request | Description
| ----- | ------ | ------------ | -------------
*SensitiveDataProtectionApi* | [**anonymizeText**](docs/SensitiveDataProtectionApi.md#anonymizetext) | **POST** /anonymize | Anonymize Text
*SensitiveDataProtectionApi* | [**healthCheck**](docs/SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health
*SensitiveDataProtectionApi* | [**scanText**](docs/SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text


### Models

- [AnonymizeRequestBody](docs/AnonymizeRequestBody.md)
- [AnonymizeRequestBodyRulesInner](docs/AnonymizeRequestBodyRulesInner.md)
- [AnonymizeResponseBody](docs/AnonymizeResponseBody.md)
- [AnonymizeResponseBodyResultsInner](docs/AnonymizeResponseBodyResultsInner.md)
- [EncryptRule](docs/EncryptRule.md)
- [Entities](docs/Entities.md)
- [EntitiesAnyOfInner](docs/EntitiesAnyOfInner.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [MaskRule](docs/MaskRule.md)
- [ModelEntity](docs/ModelEntity.md)
- [ModelResult](docs/ModelResult.md)
- [RedactRule](docs/RedactRule.md)
- [RegexEntity](docs/RegexEntity.md)
- [RegexResult](docs/RegexResult.md)
- [ReplaceRule](docs/ReplaceRule.md)
- [SHA256Rule](docs/SHA256Rule.md)
- [SHA512Rule](docs/SHA512Rule.md)
- [ScanRequestBody](docs/ScanRequestBody.md)
- [ScanResponseBody](docs/ScanResponseBody.md)
- [ScanResult](docs/ScanResult.md)
- [TextRange](docs/TextRange.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)