@quba/sensitive-data-protection 0.0.8 → 0.0.11

package/docs/PolicyDocumentRulesInner.md

@@ -0,0 +1,46 @@
+
+# PolicyDocumentRulesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`replacement` | string
+`masking_char` | string
+`chars_to_mask` | number
+`from_end` | boolean
+`key` | string
+
+## Example
+
+```typescript
+import type { PolicyDocumentRulesInner } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "replacement": null,
+  "masking_char": null,
+  "chars_to_mask": null,
+  "from_end": null,
+  "key": null,
+} satisfies PolicyDocumentRulesInner
+
+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 PolicyDocumentRulesInner
+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/PolicySummary.md

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

@@ -1,13 +1,14 @@
 
 # RedactRule
 
+Remove each matched value entirely (replace with an empty string).
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 
 ## Example
 

package/docs/RegexEntity.md

@@ -1,6 +1,7 @@
 
 # RegexEntity
 
+A regex pattern to target, e.g. a custom ID or date format.
 
 ## Properties
 

package/docs/ReplaceRule.md

@@ -1,13 +1,14 @@
 
 # ReplaceRule
 
+Replace each matched value with a fixed string (default \'****\').
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 `replacement` | string
 
 ## Example

package/docs/SHA256Rule.md

@@ -1,13 +1,14 @@
 
 # SHA256Rule
 
+Replace each matched value with its SHA-256 hex digest.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 
 ## Example
 

package/docs/SHA512Rule.md

@@ -1,13 +1,14 @@
 
 # SHA512Rule
 
+Replace each matched value with its SHA-512 hex digest.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 
 ## Example
 

package/docs/ScanRequestBody.md

@@ -1,6 +1,7 @@
 
 # ScanRequestBody
 
+Request body for the scan endpoint: the text to inspect and which entity types to detect.
 
 ## Properties
 

package/docs/ScanResponseBody.md

@@ -1,12 +1,14 @@
 
 # ScanResponseBody
 
+Response from the scan endpoint: the sensitive-data entities detected in the text.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `results` | [Array<ScanResult>](ScanResult.md)
+`usage` | [Usage](Usage.md)
 
 ## Example
 
@@ -16,6 +18,7 @@ import type { ScanResponseBody } from '@quba/sensitive-data-protection'
 // TODO: Update the object below with actual values
 const example = {
   "results": null,
+  "usage": null,
 } satisfies ScanResponseBody
 
 console.log(example)

package/docs/ScanResult.md

@@ -1,6 +1,7 @@
 
 # ScanResult
 
+A single sensitive-data entity detected in scanned text.
 
 ## Properties
 

package/docs/SensitiveDataProtectionApi.md

@@ -1,6 +1,6 @@
 # SensitiveDataProtectionApi
 
-All URIs are relative to *https://app.quba.ae/api/sdp*
+All URIs are relative to *https://www.quba.co/api/sdp*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
@@ -16,7 +16,7 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
 
 Anonymize Text
 
-Anonymize the provided text.
+Anonymize sensitive data in text.  Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
 
 ### Example
 
@@ -29,7 +29,11 @@ import type { AnonymizeTextRequest } from '@quba/sensitive-data-protection';
 
 async function example() {
   console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
-  const api = new SensitiveDataProtectionApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SensitiveDataProtectionApi(config);
 
   const body = {
     // AnonymizeRequestBody
@@ -61,7 +65,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -73,6 +77,7 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **404** | No such policy in the calling organization. |  -  |
 | **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)
@@ -84,7 +89,7 @@ No authorization required
 
 Health
 
-Return basic health probe result.
+Health check.  Returns a plain-text message confirming the service is running. Use this as a liveness/readiness probe.
 
 ### Example
 
@@ -97,7 +102,11 @@ import type { HealthCheckRequest } from '@quba/sensitive-data-protection';
 
 async function example() {
   console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
-  const api = new SensitiveDataProtectionApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SensitiveDataProtectionApi(config);
 
   try {
     const data = await api.healthCheck();
@@ -121,7 +130,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-No authorization required
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -143,7 +152,7 @@ No authorization required
 
 Scan Text
 
-Scan the provided text for sensitive data.
+Scan text for sensitive data.  Runs the configured detection entities over the request text and returns every match as a character range with its entity type and confidence score. Detections below the confidence threshold are omitted.
 
 ### Example
 
@@ -156,7 +165,11 @@ import type { ScanTextRequest } from '@quba/sensitive-data-protection';
 
 async function example() {
   console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
-  const api = new SensitiveDataProtectionApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SensitiveDataProtectionApi(config);
 
   const body = {
     // ScanRequestBody
@@ -188,7 +201,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 

package/docs/UpdatePolicyRequest.md

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

@@ -0,0 +1,37 @@
+
+# Usage
+
+What one request cost, the unit billing meters against.  Only the text the model scanned is counted. Anonymized output is built from the input by substitution, not generated, so counting it would charge twice for the same text.  Counted with the detection model\'s own tokenizer, excluding special tokens, so the same text always costs the same for a given model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`input_tokens` | number
+`inference_ms` | number
+
+## Example
+
+```typescript
+import type { Usage } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "input_tokens": null,
+  "inference_ms": null,
+} satisfies Usage
+
+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 Usage
+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/ValidationError.md

@@ -9,6 +9,8 @@ Name | Type
 `loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
 `msg` | string
 `type` | string
+`input` | any
+`ctx` | object
 
 ## Example
 
@@ -20,6 +22,8 @@ const example = {
   "loc": null,
   "msg": null,
   "type": null,
+  "input": null,
+  "ctx": null,
 } satisfies ValidationError
 
 console.log(example)

package/package.json

@@ -4,8 +4,8 @@
   "description": "SDK for Sensitive Data Protection Service",
   "license": "MIT",
   "type": "module",
-  "homepage": "https://quba.ae",
-  "version": "0.0.8",
+  "homepage": "https://www.quba.co",
+  "version": "0.0.11",
   "keywords": [
     "sensitive data protection",
     "sdp",
@@ -27,7 +27,8 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsdown"
+    "build": "tsdown",
+    "prepare": "tsdown"
   },
   "packageManager": "pnpm@10.26.2",
   "devDependencies": {