@quba/sensitive-data-protection 0.0.8 → 0.0.11

package/README.md

@@ -1,6 +1,6 @@
-# @quba/sensitive-data-protection
+# @quba/sensitive-data-protection@0.1.0
 
-A TypeScript SDK client for the app.quba.ae API.
+A TypeScript SDK client for the www.quba.co API.
 
 ## Usage
 
@@ -16,21 +16,25 @@ Next, try it out.
 ```ts
 import {
   Configuration,
-  SensitiveDataProtectionApi,
+  PoliciesApi,
 } from '@quba/sensitive-data-protection';
-import type { AnonymizeTextRequest } from '@quba/sensitive-data-protection';
+import type { CreatePolicyOperationRequest } 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 PoliciesApi(config);
 
   const body = {
-    // AnonymizeRequestBody
-    AnonymizeRequestBody: ...,
-  } satisfies AnonymizeTextRequest;
+    // CreatePolicyRequest
+    CreatePolicyRequest: ...,
+  } satisfies CreatePolicyOperationRequest;
 
   try {
-    const data = await api.anonymizeText(body);
+    const data = await api.createPolicy(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -46,10 +50,15 @@ example().catch(console.error);
 
 ### API Endpoints
 
-All URIs are relative to *https://app.quba.ae/api/sdp*
+All URIs are relative to *https://www.quba.co/api/sdp*
 
 | Class | Method | HTTP request | Description
 | ----- | ------ | ------------ | -------------
+*PoliciesApi* | [**createPolicy**](docs/PoliciesApi.md#createpolicyoperation) | **POST** /policies | Create a policy
+*PoliciesApi* | [**deletePolicy**](docs/PoliciesApi.md#deletepolicy) | **DELETE** /policies/{id} | Delete a policy
+*PoliciesApi* | [**getPolicy**](docs/PoliciesApi.md#getpolicy) | **GET** /policies/{id} | Read a policy
+*PoliciesApi* | [**listPolicies**](docs/PoliciesApi.md#listpolicies) | **GET** /policies | List policies
+*PoliciesApi* | [**updatePolicy**](docs/PoliciesApi.md#updatepolicyoperation) | **PUT** /policies/{id} | Update a policy
 *SensitiveDataProtectionApi* | [**anonymizeText**](docs/SensitiveDataProtectionApi.md#anonymizetext) | **POST** /anonymize | Anonymize Text
 *SensitiveDataProtectionApi* | [**healthCheck**](docs/SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health
 *SensitiveDataProtectionApi* | [**scanText**](docs/SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text
@@ -61,13 +70,19 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
 - [AnonymizeRequestBodyRulesInner](docs/AnonymizeRequestBodyRulesInner.md)
 - [AnonymizeResponseBody](docs/AnonymizeResponseBody.md)
 - [AnonymizeResponseBodyResultsInner](docs/AnonymizeResponseBodyResultsInner.md)
+- [CreatePolicyRequest](docs/CreatePolicyRequest.md)
+- [DetectRule](docs/DetectRule.md)
+- [DetectRuleEntitiesInner](docs/DetectRuleEntitiesInner.md)
 - [EncryptRule](docs/EncryptRule.md)
-- [Entities](docs/Entities.md)
-- [EntitiesAnyOfInner](docs/EntitiesAnyOfInner.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
+- [ListPolicies200Response](docs/ListPolicies200Response.md)
 - [MaskRule](docs/MaskRule.md)
 - [ModelEntity](docs/ModelEntity.md)
 - [ModelResult](docs/ModelResult.md)
+- [Policy](docs/Policy.md)
+- [PolicyDocument](docs/PolicyDocument.md)
+- [PolicyDocumentRulesInner](docs/PolicyDocumentRulesInner.md)
+- [PolicySummary](docs/PolicySummary.md)
 - [RedactRule](docs/RedactRule.md)
 - [RegexEntity](docs/RegexEntity.md)
 - [RegexResult](docs/RegexResult.md)
@@ -78,5 +93,68 @@ All URIs are relative to *https://app.quba.ae/api/sdp*
 - [ScanResponseBody](docs/ScanResponseBody.md)
 - [ScanResult](docs/ScanResult.md)
 - [TextRange](docs/TextRange.md)
+- [UpdatePolicyRequest](docs/UpdatePolicyRequest.md)
+- [Usage](docs/Usage.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="ApiKeyAuth"></a>
+#### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: `x-api-key`
+- **Location**: HTTP header
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `0.1.0`
+- Package version: `0.1.0`
+- Generator version: `7.18.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[]()