@quba/sensitive-data-protection 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/dist/index.cjs +647 -0
- package/dist/index.d.cts +633 -1
- package/dist/index.d.mts +633 -1
- package/dist/index.mjs +561 -1
- package/docs/AnonymizeRequestBody.md +36 -0
- package/docs/AnonymizeRequestBodyTransformationsInner.md +46 -0
- package/docs/AnonymizeResponseBody.md +36 -0
- package/docs/EncryptTransformation.md +38 -0
- package/docs/EntitySpanResult.md +45 -0
- package/docs/EntityTarget.md +36 -0
- package/docs/MapValueInner.md +46 -0
- package/docs/MaskTransformation.md +42 -0
- package/docs/RedactTransformation.md +36 -0
- package/docs/RegexSpanResult.md +43 -0
- package/docs/RegexTarget.md +36 -0
- package/docs/ReplaceTransformation.md +38 -0
- package/docs/SHA256Transformation.md +36 -0
- package/docs/SHA512Transformation.md +36 -0
- package/docs/SensitiveDataProtectionApi.md +69 -0
- package/docs/Targets.md +32 -0
- package/docs/TargetsAnyOfInner.md +38 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @quba/sensitive-data-protection
|
|
1
|
+
# @quba/sensitive-data-protection
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the app.quba.ae API.
|
|
4
4
|
|
|
@@ -18,14 +18,19 @@ import {
|
|
|
18
18
|
Configuration,
|
|
19
19
|
SensitiveDataProtectionApi,
|
|
20
20
|
} from '@quba/sensitive-data-protection';
|
|
21
|
-
import type {
|
|
21
|
+
import type { AnonymizeTextRequest } from '@quba/sensitive-data-protection';
|
|
22
22
|
|
|
23
23
|
async function example() {
|
|
24
24
|
console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
|
|
25
25
|
const api = new SensitiveDataProtectionApi();
|
|
26
26
|
|
|
27
|
+
const body = {
|
|
28
|
+
// AnonymizeRequestBody
|
|
29
|
+
AnonymizeRequestBody: ...,
|
|
30
|
+
} satisfies AnonymizeTextRequest;
|
|
31
|
+
|
|
27
32
|
try {
|
|
28
|
-
const data = await api.
|
|
33
|
+
const data = await api.anonymizeText(body);
|
|
29
34
|
console.log(data);
|
|
30
35
|
} catch (error) {
|
|
31
36
|
console.error(error);
|
|
@@ -45,16 +50,33 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
|
|
|
45
50
|
|
|
46
51
|
| Class | Method | HTTP request | Description
|
|
47
52
|
| ----- | ------ | ------------ | -------------
|
|
53
|
+
*SensitiveDataProtectionApi* | [**anonymizeText**](docs/SensitiveDataProtectionApi.md#anonymizetext) | **POST** /anonymize | Anonymize Text
|
|
48
54
|
*SensitiveDataProtectionApi* | [**healthCheck**](docs/SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health
|
|
49
55
|
*SensitiveDataProtectionApi* | [**scanText**](docs/SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text
|
|
50
56
|
|
|
51
57
|
|
|
52
58
|
### Models
|
|
53
59
|
|
|
60
|
+
- [AnonymizeRequestBody](docs/AnonymizeRequestBody.md)
|
|
61
|
+
- [AnonymizeRequestBodyTransformationsInner](docs/AnonymizeRequestBodyTransformationsInner.md)
|
|
62
|
+
- [AnonymizeResponseBody](docs/AnonymizeResponseBody.md)
|
|
63
|
+
- [EncryptTransformation](docs/EncryptTransformation.md)
|
|
64
|
+
- [EntitySpanResult](docs/EntitySpanResult.md)
|
|
65
|
+
- [EntityTarget](docs/EntityTarget.md)
|
|
54
66
|
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
67
|
+
- [MapValueInner](docs/MapValueInner.md)
|
|
68
|
+
- [MaskTransformation](docs/MaskTransformation.md)
|
|
69
|
+
- [RedactTransformation](docs/RedactTransformation.md)
|
|
70
|
+
- [RegexSpanResult](docs/RegexSpanResult.md)
|
|
71
|
+
- [RegexTarget](docs/RegexTarget.md)
|
|
72
|
+
- [ReplaceTransformation](docs/ReplaceTransformation.md)
|
|
73
|
+
- [SHA256Transformation](docs/SHA256Transformation.md)
|
|
74
|
+
- [SHA512Transformation](docs/SHA512Transformation.md)
|
|
55
75
|
- [ScanRequestBody](docs/ScanRequestBody.md)
|
|
56
76
|
- [ScanResponseBody](docs/ScanResponseBody.md)
|
|
57
77
|
- [ScanResult](docs/ScanResult.md)
|
|
78
|
+
- [Targets](docs/Targets.md)
|
|
79
|
+
- [TargetsAnyOfInner](docs/TargetsAnyOfInner.md)
|
|
58
80
|
- [ValidationError](docs/ValidationError.md)
|
|
59
81
|
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
60
82
|
|