@quba/sensitive-data-protection

A TypeScript SDK client for the app.quba.ae API.

Usage

First, install the SDK from npm.

npm install @quba/sensitive-data-protection --save

Next, try it out.

import {
  Configuration,
  SensitiveDataProtectionApi,
} from '@quba/sensitive-data-protection';
import type { AnonymizeTextRequest } from '@quba/sensitive-data-protection';

async function example() {
  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
  const api = new SensitiveDataProtectionApi();

  const body = {
    // AnonymizeRequestBody
    AnonymizeRequestBody: ...,
  } satisfies AnonymizeTextRequest;

  try {
    const data = await api.anonymizeText(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://app.quba.ae/api/sdp

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- SensitiveDataProtectionApi | anonymizeText | POST /anonymize | Anonymize Text SensitiveDataProtectionApi | healthCheck | GET /health | Health SensitiveDataProtectionApi | scanText | POST /scan | Scan Text

Models

• AnonymizeRequestBody
• AnonymizeRequestBodyRulesInner
• AnonymizeResponseBody
• AnonymizeResponseBodyResultsInner
• EncryptRule
• Entities
• EntitiesAnyOfInner
• HTTPValidationError
• MaskRule
• ModelEntity
• ModelResult
• RedactRule
• RegexEntity
• RegexResult
• ReplaceRule
• SHA256Rule
• SHA512Rule
• ScanRequestBody
• ScanResponseBody
• ScanResult
• TextRange
• ValidationError
• ValidationErrorLocInner