@quba/sensitive-data-protection 0.0.8 → 0.0.11

package/docs/AnonymizeRequestBody.md

@@ -1,6 +1,7 @@
 
 # AnonymizeRequestBody
 
+Request body for the anonymize endpoint.  Carries the text to anonymize and the list of de-identification rules to apply. See ``AnonymizationCommand`` for field-level details.
 
 ## Properties
 
@@ -9,6 +10,7 @@ Name | Type
 `text` | string
 `rules` | [Array<AnonymizeRequestBodyRulesInner>](AnonymizeRequestBodyRulesInner.md)
 `confidence_threshold` | number
+`policy` | string
 
 ## Example
 
@@ -20,6 +22,7 @@ const example = {
   "text": null,
   "rules": null,
   "confidence_threshold": null,
+  "policy": null,
 } satisfies AnonymizeRequestBody
 
 console.log(example)

package/docs/AnonymizeRequestBodyRulesInner.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 `replacement` | string
 `key` | string
 `masking_char` | string

package/docs/AnonymizeResponseBody.md

@@ -1,6 +1,7 @@
 
 # AnonymizeResponseBody
 
+Response from the anonymize endpoint: the anonymized text and a record of every transformation that was applied.
 
 ## Properties
 
@@ -8,6 +9,7 @@ Name | Type
 ------------ | -------------
 `text` | string
 `results` | [Array<AnonymizeResponseBodyResultsInner>](AnonymizeResponseBodyResultsInner.md)
+`usage` | [Usage](Usage.md)
 
 ## Example
 
@@ -18,6 +20,7 @@ import type { AnonymizeResponseBody } from '@quba/sensitive-data-protection'
 const example = {
   "text": null,
   "results": null,
+  "usage": null,
 } satisfies AnonymizeResponseBody
 
 console.log(example)

package/docs/CreatePolicyRequest.md

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

@@ -0,0 +1,37 @@
+
+# DetectRule
+
+Report each matched value without changing it.  The match is recorded in the results like any other rule, but the text is returned untouched — this is how a policy says \"flag this, don\'t rewrite it\", which is what the browser extension needs when it must not edit the user\'s prompt.  Because overlapping spans are resolved first-match-wins, placing a detect rule before a transform also shields those spans from being rewritten.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+
+## Example
+
+```typescript
+import type { DetectRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+} satisfies DetectRule
+
+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 DetectRule
+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/DetectRuleEntitiesInner.md

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

@@ -1,13 +1,14 @@
 
 # EncryptRule
 
+Replace each matched value with a Fernet-encrypted token.  If no key is supplied, a new Fernet key is generated per rule instance.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 `key` | string
 
 ## Example

package/docs/ListPolicies200Response.md

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

@@ -1,13 +1,14 @@
 
 # MaskRule
 
+Mask part of each matched value with a repeated character.  By default the whole value is masked; set ``chars_to_mask`` to mask only a portion, and ``from_end`` to mask the trailing characters instead of leading.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Entities](Entities.md)
+`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean

package/docs/ModelEntity.md

@@ -1,6 +1,7 @@
 
 # ModelEntity
 
+An AI-model entity type to target, e.g. \'PERSON\', \'EMAIL\', \'LOCATION\'.
 
 ## Properties
 

package/docs/PoliciesApi.md

@@ -0,0 +1,360 @@
+# PoliciesApi
+
+All URIs are relative to *https://www.quba.co/api/sdp*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createPolicy**](PoliciesApi.md#createpolicyoperation) | **POST** /policies | Create a policy |
+| [**deletePolicy**](PoliciesApi.md#deletepolicy) | **DELETE** /policies/{id} | Delete a policy |
+| [**getPolicy**](PoliciesApi.md#getpolicy) | **GET** /policies/{id} | Read a policy |
+| [**listPolicies**](PoliciesApi.md#listpolicies) | **GET** /policies | List policies |
+| [**updatePolicy**](PoliciesApi.md#updatepolicyoperation) | **PUT** /policies/{id} | Update a policy |
+
+
+
+## createPolicy
+
+> Policy createPolicy(CreatePolicyRequest)
+
+Create a policy
+
+### Example
+
+```ts
+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);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **CreatePolicyRequest** | [CreatePolicyRequest](CreatePolicyRequest.md) |  | |
+
+### Return type
+
+[**Policy**](Policy.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | The created policy. |  -  |
+| **409** | A policy with that name already exists. |  -  |
+| **422** | The document failed validation. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deletePolicy
+
+> deletePolicy(id)
+
+Delete a policy
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PoliciesApi,
+} from '@quba/sensitive-data-protection';
+import type { DeletePolicyRequest } 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 = {
+    // string
+    id: id_example,
+  } satisfies DeletePolicyRequest;
+
+  try {
+    const data = await api.deletePolicy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Deleted. |  -  |
+| **404** | No such policy in this organization. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPolicy
+
+> Policy getPolicy(id)
+
+Read a policy
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PoliciesApi,
+} from '@quba/sensitive-data-protection';
+import type { GetPolicyRequest } 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 = {
+    // string
+    id: id_example,
+  } satisfies GetPolicyRequest;
+
+  try {
+    const data = await api.getPolicy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Policy**](Policy.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The policy and its latest document. |  -  |
+| **404** | No such policy in this organization. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPolicies
+
+> ListPolicies200Response listPolicies()
+
+List policies
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PoliciesApi,
+} from '@quba/sensitive-data-protection';
+import type { ListPoliciesRequest } 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);
+
+  try {
+    const data = await api.listPolicies();
+    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
+
+[**ListPolicies200Response**](ListPolicies200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The calling organization\'s policies. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updatePolicy
+
+> Policy updatePolicy(id, UpdatePolicyRequest)
+
+Update a policy
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PoliciesApi,
+} from '@quba/sensitive-data-protection';
+import type { UpdatePolicyOperationRequest } 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 = {
+    // string
+    id: id_example,
+    // UpdatePolicyRequest
+    UpdatePolicyRequest: ...,
+  } satisfies UpdatePolicyOperationRequest;
+
+  try {
+    const data = await api.updatePolicy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **UpdatePolicyRequest** | [UpdatePolicyRequest](UpdatePolicyRequest.md) |  | |
+
+### Return type
+
+[**Policy**](Policy.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The updated policy. |  -  |
+| **404** | No such policy in this organization. |  -  |
+| **409** | A policy with that name already exists. |  -  |
+| **422** | The document failed validation. |  -  |
+
+[[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/Policy.md

@@ -0,0 +1,44 @@
+
+# Policy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`versionId` | string
+`document` | [PolicyDocument](PolicyDocument.md)
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { Policy } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "versionId": null,
+  "document": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Policy
+
+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 Policy
+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/PolicyDocument.md

@@ -0,0 +1,41 @@
+
+# PolicyDocument
+
+A reusable set of de-identification rules. Rules are ORDERED: overlapping matches are resolved first-match-wins, so a detect rule placed before a transform shields those spans from being rewritten.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`schema_version` | number
+`name` | string
+`confidence_threshold` | number
+`rules` | [Array<PolicyDocumentRulesInner>](PolicyDocumentRulesInner.md)
+
+## Example
+
+```typescript
+import type { PolicyDocument } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "schema_version": null,
+  "name": null,
+  "confidence_threshold": null,
+  "rules": null,
+} satisfies PolicyDocument
+
+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 PolicyDocument
+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)
+
+