@quba/sensitive-data-protection 0.0.3 → 0.0.5

package/docs/AnonymizeResponseBody.md

@@ -0,0 +1,36 @@
+
+# AnonymizeResponseBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+`map` | { [key: string]: Array<MapValueInner>; }
+
+## Example
+
+```typescript
+import type { AnonymizeResponseBody } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": null,
+  "map": null,
+} satisfies AnonymizeResponseBody
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AnonymizeResponseBody
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EncryptRule.md

@@ -0,0 +1,38 @@
+
+# EncryptRule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+`key` | string
+
+## Example
+
+```typescript
+import type { EncryptRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "key": null,
+} satisfies EncryptRule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EncryptRule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Entities.md

@@ -0,0 +1,32 @@
+
+# Entities
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { Entities } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies Entities
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Entities
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EntitiesAnyOfInner.md

@@ -0,0 +1,36 @@
+
+# EntitiesAnyOfInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { EntitiesAnyOfInner } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "value": null,
+} satisfies EntitiesAnyOfInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EntitiesAnyOfInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MapValueInner.md

@@ -0,0 +1,44 @@
+
+# MapValueInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`start` | number
+`end` | number
+`value` | string
+`text` | string
+`score` | number
+
+## Example
+
+```typescript
+import type { MapValueInner } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "start": null,
+  "end": null,
+  "value": null,
+  "text": null,
+  "score": null,
+} satisfies MapValueInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MapValueInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/MaskRule.md

@@ -0,0 +1,42 @@
+
+# MaskRule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+`masking_char` | string
+`chars_to_mask` | number
+`from_end` | boolean
+
+## Example
+
+```typescript
+import type { MaskRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "masking_char": null,
+  "chars_to_mask": null,
+  "from_end": null,
+} satisfies MaskRule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as MaskRule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ModelEntity.md

@@ -0,0 +1,36 @@
+
+# ModelEntity
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { ModelEntity } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "value": null,
+} satisfies ModelEntity
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelEntity
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ModelSpan.md

@@ -0,0 +1,45 @@
+
+# ModelSpan
+
+A detected model span.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`start` | number
+`end` | number
+`value` | string
+`text` | string
+`score` | number
+
+## Example
+
+```typescript
+import type { ModelSpan } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "start": null,
+  "end": null,
+  "value": null,
+  "text": null,
+  "score": null,
+} satisfies ModelSpan
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelSpan
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RedactRule.md

@@ -0,0 +1,36 @@
+
+# RedactRule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+
+## Example
+
+```typescript
+import type { RedactRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+} satisfies RedactRule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RedactRule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RegexEntity.md

@@ -0,0 +1,36 @@
+
+# RegexEntity
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { RegexEntity } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "value": null,
+} satisfies RegexEntity
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RegexEntity
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RegexSpan.md

@@ -0,0 +1,43 @@
+
+# RegexSpan
+
+A detected regex span.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`start` | number
+`end` | number
+`value` | string
+`text` | string
+
+## Example
+
+```typescript
+import type { RegexSpan } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "start": null,
+  "end": null,
+  "value": null,
+  "text": null,
+} satisfies RegexSpan
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RegexSpan
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReplaceRule.md

@@ -0,0 +1,38 @@
+
+# ReplaceRule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+`replacement` | string
+
+## Example
+
+```typescript
+import type { ReplaceRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "replacement": null,
+} satisfies ReplaceRule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReplaceRule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SHA256Rule.md

@@ -0,0 +1,36 @@
+
+# SHA256Rule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+
+## Example
+
+```typescript
+import type { SHA256Rule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+} satisfies SHA256Rule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SHA256Rule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SHA512Rule.md

@@ -0,0 +1,36 @@
+
+# SHA512Rule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Entities](Entities.md)
+
+## Example
+
+```typescript
+import type { SHA512Rule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+} satisfies SHA512Rule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SHA512Rule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SensitiveDataProtectionApi.md

@@ -4,11 +4,80 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**anonymizeText**](SensitiveDataProtectionApi.md#anonymizetext) | **POST** /anonymize | Anonymize Text |
 | [**healthCheck**](SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health |
 | [**scanText**](SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text |
 
 
 
+## anonymizeText
+
+> AnonymizeResponseBody anonymizeText(AnonymizeRequestBody)
+
+Anonymize Text
+
+Anonymize the provided text.
+
+### Example
+
+```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);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **AnonymizeRequestBody** | [AnonymizeRequestBody](AnonymizeRequestBody.md) |  | |
+
+### Return type
+
+[**AnonymizeResponseBody**](AnonymizeResponseBody.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## healthCheck
 
 > string healthCheck()

package/package.json

@@ -1,10 +1,11 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@quba/sensitive-data-protection",
   "description": "SDK for Sensitive Data Protection Service",
   "license": "MIT",
   "type": "module",
   "homepage": "https://quba.ae",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "keywords": [
     "sensitive data protection",
     "sdp",