@quba/sensitive-data-protection 0.0.12 → 0.2.0

package/docs/ErrorInfo.md

@@ -0,0 +1,39 @@
+
+# ErrorInfo
+
+The error itself.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | [ErrorCode](ErrorCode.md)
+`message` | string
+`details` | [Array<FieldError>](FieldError.md)
+
+## Example
+
+```typescript
+import type { ErrorInfo } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "details": null,
+} satisfies ErrorInfo
+
+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 ErrorInfo
+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/FieldError.md

@@ -0,0 +1,51 @@
+
+# FieldError
+
+One refused field.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | [Array<FieldErrorPathInner>](FieldErrorPathInner.md)
+`code` | [FieldErrorCode](FieldErrorCode.md)
+`message` | string
+`limit` | number
+`min` | number
+`max` | number
+`expected` | string
+`allowed` | Array<string>
+`tokens` | number
+
+## Example
+
+```typescript
+import type { FieldError } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "code": null,
+  "message": null,
+  "limit": null,
+  "min": null,
+  "max": null,
+  "expected": null,
+  "allowed": null,
+  "tokens": null,
+} satisfies FieldError
+
+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 FieldError
+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/FieldErrorCode.md

@@ -0,0 +1,33 @@
+
+# FieldErrorCode
+
+Why one field was refused. `missing`; `wrong_type` (see `expected`); `too_short`/`too_long` in characters and `too_large` in UTF-8 bytes (see `limit`); `too_few`/`too_many` items (see `limit`); `out_of_range` (see `min`, `max`); `blank`: only whitespace; `unknown_type` (see `allowed`); `invalid_pattern`: not a regular expression the engine runs; `invalid_key`: not a Fernet key; `labels_over_budget`: the labels leave the model too little room for text (see `tokens`, `limit`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FieldErrorCode } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FieldErrorCode
+
+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 FieldErrorCode
+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/{HTTPValidationError.md → FieldErrorPathInner.md}

@@ -1,22 +1,21 @@
 
-# HTTPValidationError
+# FieldErrorPathInner
 
+One step of a path into the request body: a field name or a list index.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`detail` | [Array<ValidationError>](ValidationError.md)
 
 ## Example
 
 ```typescript
-import type { HTTPValidationError } from '@quba/sensitive-data-protection'
+import type { FieldErrorPathInner } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "detail": null,
-} satisfies HTTPValidationError
+} satisfies FieldErrorPathInner
 
 console.log(example)
 
@@ -25,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as HTTPValidationError
+const exampleParsed = JSON.parse(exampleJSON) as FieldErrorPathInner
 console.log(exampleParsed)
 ```
 

package/docs/FieldSegment.md

@@ -0,0 +1,39 @@
+
+# FieldSegment
+
+An HL7 v2 field of the segment before it: `5` in `PID-5`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+`repetition` | number
+
+## Example
+
+```typescript
+import type { FieldSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+  "repetition": null,
+} satisfies FieldSegment
+
+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 FieldSegment
+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/FileAttributeResult.md

@@ -0,0 +1,47 @@
+
+# FileAttributeResult
+
+A DICOM attribute the confidentiality profile (PS3.15 Annex E) acted on, or content kept unread.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | number
+`rule` | string
+`input` | string
+`output` | string
+`content_type` | string
+`path` | Array<Array<PathSegment>>
+
+## Example
+
+```typescript
+import type { FileAttributeResult } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "rule": null,
+  "input": null,
+  "output": null,
+  "content_type": null,
+  "path": null,
+} satisfies FileAttributeResult
+
+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 FileAttributeResult
+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/FileEmbeddedResult.md

@@ -0,0 +1,43 @@
+
+# FileEmbeddedResult
+
+Embedded content taken out of the file: embedded files, OLE objects, media, a FHIR photo\'s data; and the thumbnail, which is always removed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | number
+`rule` | string
+`content_type` | string
+`path` | Array<Array<PathSegment>>
+
+## Example
+
+```typescript
+import type { FileEmbeddedResult } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "rule": null,
+  "content_type": null,
+  "path": null,
+} satisfies FileEmbeddedResult
+
+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 FileEmbeddedResult
+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/FileModelResult.md

@@ -0,0 +1,49 @@
+
+# FileModelResult
+
+The model found the value. Another copy of a value already replaced is reported as the first one was.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | number
+`rule` | string
+`value` | string
+`score` | number
+`input` | string
+`output` | string
+`path` | Array<Array<PathSegment>>
+
+## Example
+
+```typescript
+import type { FileModelResult } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "rule": null,
+  "value": null,
+  "score": null,
+  "input": null,
+  "output": null,
+  "path": null,
+} satisfies FileModelResult
+
+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 FileModelResult
+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/{AnonymizeResponseBodyResultsInner.md → FileRegexResult.md}

@@ -1,32 +1,35 @@
 
-# AnonymizeResponseBodyResultsInner
+# FileRegexResult
 
+A regex rule matched.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
+`id` | number
 `rule` | string
 `value` | string
-`input` | [TextRange](TextRange.md)
-`output` | [TextRange](TextRange.md)
-`score` | number
+`input` | string
+`output` | string
+`path` | Array<Array<PathSegment>>
 
 ## Example
 
 ```typescript
-import type { AnonymizeResponseBodyResultsInner } from '@quba/sensitive-data-protection'
+import type { FileRegexResult } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
+  "id": null,
   "rule": null,
   "value": null,
   "input": null,
   "output": null,
-  "score": null,
-} satisfies AnonymizeResponseBodyResultsInner
+  "path": null,
+} satisfies FileRegexResult
 
 console.log(example)
 
@@ -35,7 +38,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AnonymizeResponseBodyResultsInner
+const exampleParsed = JSON.parse(exampleJSON) as FileRegexResult
 console.log(exampleParsed)
 ```
 

package/docs/FileResult.md

@@ -0,0 +1,51 @@
+
+# FileResult
+
+One change made to the file, by what found it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | number
+`rule` | string
+`value` | string
+`score` | number
+`input` | string
+`output` | string
+`path` | Array<Array<PathSegment>>
+`content_type` | string
+
+## Example
+
+```typescript
+import type { FileResult } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "rule": null,
+  "value": null,
+  "score": null,
+  "input": null,
+  "output": null,
+  "path": null,
+  "content_type": null,
+} satisfies FileResult
+
+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 FileResult
+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/FootnoteSegment.md

@@ -0,0 +1,37 @@
+
+# FootnoteSegment
+
+A footnote (`w:footnote`), by its id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | string
+
+## Example
+
+```typescript
+import type { FootnoteSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+} satisfies FootnoteSegment
+
+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 FootnoteSegment
+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/FrameSegment.md

@@ -0,0 +1,37 @@
+
+# FrameSegment
+
+A frame of DICOM pixel data, from 1.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+
+## Example
+
+```typescript
+import type { FrameSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+} satisfies FrameSegment
+
+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 FrameSegment
+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/HMACRule.md

@@ -0,0 +1,43 @@
+
+# HMACRule
+
+Replace each matched value with its HMAC-SHA256 under `key`, in hex.  The same value and key always give the same digest, so records can still be joined; without the key, values can\'t be recovered by hashing guesses (a plain SHA-256 of a phone number can).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
+`key` | string
+`length` | number
+
+## Example
+
+```typescript
+import type { HMACRule } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "entities": null,
+  "action": null,
+  "key": null,
+  "length": null,
+} satisfies HMACRule
+
+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 HMACRule
+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/HeaderFooterSegment.md

@@ -0,0 +1,37 @@
+
+# HeaderFooterSegment
+
+A worksheet\'s page header or footer, by its element: `oddHeader`, `oddFooter`, `evenHeader`…
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { HeaderFooterSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+} satisfies HeaderFooterSegment
+
+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 HeaderFooterSegment
+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/IndexSegment.md

@@ -0,0 +1,37 @@
+
+# IndexSegment
+
+A JSON array\'s index, from 0: a step towards a value, as in a JSON Pointer.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`index` | number
+
+## Example
+
+```typescript
+import type { IndexSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "index": null,
+} satisfies IndexSegment
+
+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 IndexSegment
+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/ItemSegment.md

@@ -0,0 +1,37 @@
+
+# ItemSegment
+
+An item of the DICOM sequence before it, from 1.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`number` | number
+
+## Example
+
+```typescript
+import type { ItemSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "number": null,
+} satisfies ItemSegment
+
+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 ItemSegment
+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)
+
+