@quba/sensitive-data-protection 0.0.1 → 0.0.2

package/docs/HTTPValidationError.md

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

@@ -0,0 +1,40 @@
+
+# ScanRequestBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+`language` | string
+`entities` | Array<string>
+`confidence_threshold` | number
+
+## Example
+
+```typescript
+import type { ScanRequestBody } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": null,
+  "language": null,
+  "entities": null,
+  "confidence_threshold": null,
+} satisfies ScanRequestBody
+
+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 ScanRequestBody
+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/ScanResponseBody.md

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

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

@@ -0,0 +1,137 @@
+# SensitiveDataProtectionApi
+
+All URIs are relative to *https://app.quba.ae/api/sdp*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**healthCheck**](SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health |
+| [**scanText**](SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text |
+
+
+
+## healthCheck
+
+> string healthCheck()
+
+Health
+
+Return basic health probe result.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SensitiveDataProtectionApi,
+} from '@quba/sensitive-data-protection';
+import type { HealthCheckRequest } from '@quba/sensitive-data-protection';
+
+async function example() {
+  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
+  const api = new SensitiveDataProtectionApi();
+
+  try {
+    const data = await api.healthCheck();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## scanText
+
+> ScanResponseBody scanText(ScanRequestBody)
+
+Scan Text
+
+Scan the provided text for sensitive data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SensitiveDataProtectionApi,
+} from '@quba/sensitive-data-protection';
+import type { ScanTextRequest } from '@quba/sensitive-data-protection';
+
+async function example() {
+  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
+  const api = new SensitiveDataProtectionApi();
+
+  const body = {
+    // ScanRequestBody
+    ScanRequestBody: ...,
+  } satisfies ScanTextRequest;
+
+  try {
+    const data = await api.scanText(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ScanRequestBody** | [ScanRequestBody](ScanRequestBody.md) |  | |
+
+### Return type
+
+[**ScanResponseBody**](ScanResponseBody.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)
+

package/docs/ValidationError.md

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

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

@@ -4,7 +4,7 @@
   "license": "MIT",
   "type": "module",
   "homepage": "https://quba.ae",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "keywords": [
     "sensitive data protection",
     "sdp",
@@ -21,7 +21,7 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "src/docs",
+    "docs",
     "README.md"
   ],
   "exports": {