@quba/sensitive-data-protection 0.0.4 → 0.0.5

package/README.md

@@ -58,25 +58,25 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
 ### Models
 
 - [AnonymizeRequestBody](docs/AnonymizeRequestBody.md)
-- [AnonymizeRequestBodyTransformationsInner](docs/AnonymizeRequestBodyTransformationsInner.md)
+- [AnonymizeRequestBodyRulesInner](docs/AnonymizeRequestBodyRulesInner.md)
 - [AnonymizeResponseBody](docs/AnonymizeResponseBody.md)
-- [EncryptTransformation](docs/EncryptTransformation.md)
-- [EntitySpanResult](docs/EntitySpanResult.md)
-- [EntityTarget](docs/EntityTarget.md)
+- [EncryptRule](docs/EncryptRule.md)
+- [Entities](docs/Entities.md)
+- [EntitiesAnyOfInner](docs/EntitiesAnyOfInner.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [MapValueInner](docs/MapValueInner.md)
-- [MaskTransformation](docs/MaskTransformation.md)
-- [RedactTransformation](docs/RedactTransformation.md)
-- [RegexSpanResult](docs/RegexSpanResult.md)
-- [RegexTarget](docs/RegexTarget.md)
-- [ReplaceTransformation](docs/ReplaceTransformation.md)
-- [SHA256Transformation](docs/SHA256Transformation.md)
-- [SHA512Transformation](docs/SHA512Transformation.md)
+- [MaskRule](docs/MaskRule.md)
+- [ModelEntity](docs/ModelEntity.md)
+- [ModelSpan](docs/ModelSpan.md)
+- [RedactRule](docs/RedactRule.md)
+- [RegexEntity](docs/RegexEntity.md)
+- [RegexSpan](docs/RegexSpan.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)
-- [Targets](docs/Targets.md)
-- [TargetsAnyOfInner](docs/TargetsAnyOfInner.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 

package/docs/AnonymizeRequestBody.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `text` | string
-`transformations` | [Array<AnonymizeRequestBodyTransformationsInner>](AnonymizeRequestBodyTransformationsInner.md)
+`rules` | [Array<AnonymizeRequestBodyRulesInner>](AnonymizeRequestBodyRulesInner.md)
 
 ## Example
 
@@ -17,7 +17,7 @@ import type { AnonymizeRequestBody } from '@quba/sensitive-data-protection'
 // TODO: Update the object below with actual values
 const example = {
   "text": null,
-  "transformations": null,
+  "rules": null,
 } satisfies AnonymizeRequestBody
 
 console.log(example)

package/docs/{AnonymizeRequestBodyTransformationsInner.md → AnonymizeRequestBodyRulesInner.md}

@@ -1,13 +1,13 @@
 
-# AnonymizeRequestBodyTransformationsInner
+# AnonymizeRequestBodyRulesInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
+`type` | string
+`entities` | [Entities](Entities.md)
 `replacement` | string
 `key` | string
 `masking_char` | string
@@ -17,18 +17,18 @@ Name | Type
 ## Example
 
 ```typescript
-import type { AnonymizeRequestBodyTransformationsInner } from '@quba/sensitive-data-protection'
+import type { AnonymizeRequestBodyRulesInner } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "targets": null,
+  "type": null,
+  "entities": null,
   "replacement": null,
   "key": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,
-} satisfies AnonymizeRequestBodyTransformationsInner
+} satisfies AnonymizeRequestBodyRulesInner
 
 console.log(example)
 
@@ -37,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AnonymizeRequestBodyTransformationsInner
+const exampleParsed = JSON.parse(exampleJSON) as AnonymizeRequestBodyRulesInner
 console.log(exampleParsed)
 ```
 

package/docs/{EncryptTransformation.md → EncryptRule.md}

@@ -1,26 +1,26 @@
 
-# EncryptTransformation
+# EncryptRule
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
+`type` | string
+`entities` | [Entities](Entities.md)
 `key` | string
 
 ## Example
 
 ```typescript
-import type { EncryptTransformation } from '@quba/sensitive-data-protection'
+import type { EncryptRule } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "targets": null,
+  "type": null,
+  "entities": null,
   "key": null,
-} satisfies EncryptTransformation
+} satisfies EncryptRule
 
 console.log(example)
 
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as EncryptTransformation
+const exampleParsed = JSON.parse(exampleJSON) as EncryptRule
 console.log(exampleParsed)
 ```
 

package/docs/{Targets.md → Entities.md}

@@ -1,5 +1,5 @@
 
-# Targets
+# Entities
 
 
 ## Properties
@@ -10,11 +10,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { Targets } from '@quba/sensitive-data-protection'
+import type { Entities } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies Targets
+} satisfies Entities
 
 console.log(example)
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as Targets
+const exampleParsed = JSON.parse(exampleJSON) as Entities
 console.log(exampleParsed)
 ```
 

package/docs/{RedactTransformation.md → EntitiesAnyOfInner.md}

@@ -1,24 +1,24 @@
 
-# RedactTransformation
+# EntitiesAnyOfInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
+`type` | string
+`value` | string
 
 ## Example
 
 ```typescript
-import type { RedactTransformation } from '@quba/sensitive-data-protection'
+import type { EntitiesAnyOfInner } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "targets": null,
-} satisfies RedactTransformation
+  "type": null,
+  "value": null,
+} satisfies EntitiesAnyOfInner
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RedactTransformation
+const exampleParsed = JSON.parse(exampleJSON) as EntitiesAnyOfInner
 console.log(exampleParsed)
 ```
 

package/docs/MapValueInner.md

@@ -6,13 +6,12 @@
 
 Name | Type
 ------------ | -------------
-`target` | string
+`type` | string
 `start` | number
 `end` | number
-`entity_type` | string
+`value` | string
 `text` | string
 `score` | number
-`pattern` | string
 
 ## Example
 
@@ -21,13 +20,12 @@ import type { MapValueInner } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "target": null,
+  "type": null,
   "start": null,
   "end": null,
-  "entity_type": null,
+  "value": null,
   "text": null,
   "score": null,
-  "pattern": null,
 } satisfies MapValueInner
 
 console.log(example)

package/docs/{MaskTransformation.md → MaskRule.md}

@@ -1,13 +1,13 @@
 
-# MaskTransformation
+# MaskRule
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
+`type` | string
+`entities` | [Entities](Entities.md)
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean
@@ -15,16 +15,16 @@ Name | Type
 ## Example
 
 ```typescript
-import type { MaskTransformation } from '@quba/sensitive-data-protection'
+import type { MaskRule } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "targets": null,
+  "type": null,
+  "entities": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,
-} satisfies MaskTransformation
+} satisfies MaskRule
 
 console.log(example)
 
@@ -33,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MaskTransformation
+const exampleParsed = JSON.parse(exampleJSON) as MaskRule
 console.log(exampleParsed)
 ```
 

package/docs/{RegexTarget.md → ModelEntity.md}

@@ -1,24 +1,24 @@
 
-# RegexTarget
+# ModelEntity
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`pattern` | string
+`type` | string
+`value` | string
 
 ## Example
 
 ```typescript
-import type { RegexTarget } from '@quba/sensitive-data-protection'
+import type { ModelEntity } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "pattern": null,
-} satisfies RegexTarget
+  "type": null,
+  "value": null,
+} satisfies ModelEntity
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RegexTarget
+const exampleParsed = JSON.parse(exampleJSON) as ModelEntity
 console.log(exampleParsed)
 ```
 

package/docs/{EntitySpanResult.md → ModelSpan.md}

@@ -1,33 +1,33 @@
 
-# EntitySpanResult
+# ModelSpan
 
-A detected entity span.
+A detected model span.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`target` | string
+`type` | string
 `start` | number
 `end` | number
-`entity_type` | string
+`value` | string
 `text` | string
 `score` | number
 
 ## Example
 
 ```typescript
-import type { EntitySpanResult } from '@quba/sensitive-data-protection'
+import type { ModelSpan } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "target": null,
+  "type": null,
   "start": null,
   "end": null,
-  "entity_type": null,
+  "value": null,
   "text": null,
   "score": null,
-} satisfies EntitySpanResult
+} satisfies ModelSpan
 
 console.log(example)
 
@@ -36,7 +36,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as EntitySpanResult
+const exampleParsed = JSON.parse(exampleJSON) as ModelSpan
 console.log(exampleParsed)
 ```
 

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/{EntityTarget.md → RegexEntity.md}

@@ -1,24 +1,24 @@
 
-# EntityTarget
+# RegexEntity
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`entity_type` | string
+`type` | string
+`value` | string
 
 ## Example
 
 ```typescript
-import type { EntityTarget } from '@quba/sensitive-data-protection'
+import type { RegexEntity } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "entity_type": null,
-} satisfies EntityTarget
+  "type": null,
+  "value": null,
+} satisfies RegexEntity
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as EntityTarget
+const exampleParsed = JSON.parse(exampleJSON) as RegexEntity
 console.log(exampleParsed)
 ```
 

package/docs/{RegexSpanResult.md → RegexSpan.md}

@@ -1,5 +1,5 @@
 
-# RegexSpanResult
+# RegexSpan
 
 A detected regex span.
 
@@ -7,25 +7,25 @@ A detected regex span.
 
 Name | Type
 ------------ | -------------
-`target` | string
+`type` | string
 `start` | number
 `end` | number
-`pattern` | string
+`value` | string
 `text` | string
 
 ## Example
 
 ```typescript
-import type { RegexSpanResult } from '@quba/sensitive-data-protection'
+import type { RegexSpan } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "target": null,
+  "type": null,
   "start": null,
   "end": null,
-  "pattern": null,
+  "value": null,
   "text": null,
-} satisfies RegexSpanResult
+} satisfies RegexSpan
 
 console.log(example)
 
@@ -34,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RegexSpanResult
+const exampleParsed = JSON.parse(exampleJSON) as RegexSpan
 console.log(exampleParsed)
 ```
 

package/docs/{ReplaceTransformation.md → ReplaceRule.md}

@@ -1,26 +1,26 @@
 
-# ReplaceTransformation
+# ReplaceRule
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
+`type` | string
+`entities` | [Entities](Entities.md)
 `replacement` | string
 
 ## Example
 
 ```typescript
-import type { ReplaceTransformation } from '@quba/sensitive-data-protection'
+import type { ReplaceRule } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "targets": null,
+  "type": null,
+  "entities": null,
   "replacement": null,
-} satisfies ReplaceTransformation
+} satisfies ReplaceRule
 
 console.log(example)
 
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ReplaceTransformation
+const exampleParsed = JSON.parse(exampleJSON) as ReplaceRule
 console.log(exampleParsed)
 ```
 

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/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.4",
+  "version": "0.0.5",
   "keywords": [
     "sensitive data protection",
     "sdp",

package/docs/SHA256Transformation.md

@@ -1,36 +0,0 @@
-
-# SHA256Transformation
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
-
-## Example
-
-```typescript
-import type { SHA256Transformation } from '@quba/sensitive-data-protection'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "targets": null,
-} satisfies SHA256Transformation
-
-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 SHA256Transformation
-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/SHA512Transformation.md

@@ -1,36 +0,0 @@
-
-# SHA512Transformation
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`targets` | [Targets](Targets.md)
-
-## Example
-
-```typescript
-import type { SHA512Transformation } from '@quba/sensitive-data-protection'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "targets": null,
-} satisfies SHA512Transformation
-
-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 SHA512Transformation
-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/TargetsAnyOfInner.md

@@ -1,38 +0,0 @@
-
-# TargetsAnyOfInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`entity_type` | string
-`pattern` | string
-
-## Example
-
-```typescript
-import type { TargetsAnyOfInner } from '@quba/sensitive-data-protection'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "entity_type": null,
-  "pattern": null,
-} satisfies TargetsAnyOfInner
-
-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 TargetsAnyOfInner
-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)
-
-