@quba/[email protected]

A TypeScript SDK client for the www.quba.co API.

Usage

First, install the SDK from npm.

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

Next, try it out.

import {
  Configuration,
  PoliciesApi,
} 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 config = new Configuration({ 
    // To configure API key authorization: ApiKeyAuth
    apiKey: "YOUR API KEY",
  });
  const api = new PoliciesApi(config);

  const body = {
    // CreatePolicyRequest
    CreatePolicyRequest: ...,
  } satisfies CreatePolicyOperationRequest;

  try {
    const data = await api.createPolicy(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://www.quba.co/api/sdp

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- PoliciesApi | createPolicy | POST /policies | Create a policy PoliciesApi | deletePolicy | DELETE /policies/{id} | Delete a policy PoliciesApi | getPolicy | GET /policies/{id} | Read a policy PoliciesApi | listPolicies | GET /policies | List policies PoliciesApi | updatePolicy | PUT /policies/{id} | Update a policy SensitiveDataProtectionApi | anonymizeText | POST /anonymize | Anonymize Text SensitiveDataProtectionApi | healthCheck | GET /health | Health SensitiveDataProtectionApi | scanText | POST /scan | Scan Text

Models

• AnonymizeRequestBody
• AnonymizeRequestBodyRulesInner
• AnonymizeResponseBody
• AnonymizeResponseBodyResultsInner
• CreatePolicyRequest
• DetectRule
• DetectRuleEntitiesInner
• EncryptRule
• HTTPValidationError
• ListPolicies200Response
• MaskRule
• ModelEntity
• ModelError
• ModelResult
• Policy
• PolicyDocument
• PolicyDocumentRulesInner
• PolicySummary
• RedactRule
• RegexEntity
• RegexResult
• ReplaceRule
• SHA256Rule
• SHA512Rule
• ScanRequestBody
• ScanResponseBody
• ScanResult
• TextRange
• UpdatePolicyRequest
• Usage
• ValidationError
• ValidationErrorLocInner

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator 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:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License