@quba/sensitive-data-protection 0.0.12 → 0.2.0

package/docs/RangeSegment.md

@@ -0,0 +1,39 @@
+
+# RangeSegment
+
+Cells, in A1 (`A2:A100`): a data validation\'s.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`ref` | string
+`kind` | [RangeKind](RangeKind.md)
+
+## Example
+
+```typescript
+import type { RangeSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "ref": null,
+  "kind": null,
+} satisfies RangeSegment
+
+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 RangeSegment
+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/RedactRule.md

@@ -8,7 +8,8 @@ Remove each matched value entirely (replace with an empty string).
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { RedactRule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
 } satisfies RedactRule
 
 console.log(example)

package/docs/Refusal.md

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

@@ -12,6 +12,7 @@ Name | Type
 `value` | string
 `input` | [TextRange](TextRange.md)
 `output` | [TextRange](TextRange.md)
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -25,6 +26,7 @@ const example = {
   "value": null,
   "input": null,
   "output": null,
+  "action": null,
 } satisfies RegexResult
 
 console.log(example)

package/docs/RegionSegment.md

@@ -0,0 +1,43 @@
+
+# RegionSegment
+
+A box on an image, in its upright pixels, padded as painted: where a value found in it is. A value over several boxes has a path for each.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`x` | number
+`y` | number
+`w` | number
+`h` | number
+
+## Example
+
+```typescript
+import type { RegionSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "x": null,
+  "y": null,
+  "w": null,
+  "h": null,
+} satisfies RegionSegment
+
+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 RegionSegment
+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/ReplaceRule.md

@@ -8,7 +8,8 @@ Replace each matched value with a fixed string (default \'****\').
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 `replacement` | string
 
 ## Example
@@ -20,6 +21,7 @@ import type { ReplaceRule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
   "replacement": null,
 } satisfies ReplaceRule
 

package/docs/{AnonymizeRequestBodyRulesInner.md → RuleBody.md}

@@ -1,34 +1,41 @@
 
-# AnonymizeRequestBodyRulesInner
+# RuleBody
 
+One rule, chosen by its `type`.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 `replacement` | string
 `key` | string
 `masking_char` | string
 `chars_to_mask` | number
 `from_end` | boolean
+`tag` | string
+`length` | number
 
 ## Example
 
 ```typescript
-import type { AnonymizeRequestBodyRulesInner } from '@quba/sensitive-data-protection'
+import type { RuleBody } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
   "replacement": null,
   "key": null,
   "masking_char": null,
   "chars_to_mask": null,
   "from_end": null,
-} satisfies AnonymizeRequestBodyRulesInner
+  "tag": null,
+  "length": null,
+} satisfies RuleBody
 
 console.log(example)
 
@@ -37,7 +44,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AnonymizeRequestBodyRulesInner
+const exampleParsed = JSON.parse(exampleJSON) as RuleBody
 console.log(exampleParsed)
 ```
 

package/docs/SHA256Rule.md

@@ -8,7 +8,8 @@ Replace each matched value with its SHA-256 hex digest.
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { SHA256Rule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
 } satisfies SHA256Rule
 
 console.log(example)

package/docs/SHA512Rule.md

@@ -8,7 +8,8 @@ Replace each matched value with its SHA-512 hex digest.
 Name | Type
 ------------ | -------------
 `type` | string
-`entities` | [Array<DetectRuleEntitiesInner>](DetectRuleEntitiesInner.md)
+`entities` | [Array<EntityBody>](EntityBody.md)
+`action` | [Action](Action.md)
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { SHA512Rule } from '@quba/sensitive-data-protection'
 const example = {
   "type": null,
   "entities": null,
+  "action": null,
 } satisfies SHA512Rule
 
 console.log(example)

package/docs/ScanRequestBody.md

@@ -11,6 +11,7 @@ Name | Type
 `language` | string
 `entities` | Array<string>
 `confidence_threshold` | number
+`models` | Array<string>
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "language": null,
   "entities": null,
   "confidence_threshold": null,
+  "models": null,
 } satisfies ScanRequestBody
 
 console.log(example)

package/docs/ScanResponseBody.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `results` | [Array<ScanResult>](ScanResult.md)
 `usage` | [Usage](Usage.md)
+`models` | Array<string>
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { ScanResponseBody } from '@quba/sensitive-data-protection'
 const example = {
   "results": null,
   "usage": null,
+  "models": null,
 } satisfies ScanResponseBody
 
 console.log(example)

package/docs/SegmentSegment.md

@@ -0,0 +1,39 @@
+
+# SegmentSegment
+
+An HL7 v2 segment (`PID`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`index` | number
+
+## Example
+
+```typescript
+import type { SegmentSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+  "index": null,
+} satisfies SegmentSegment
+
+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 SegmentSegment
+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/SensitiveDataProtectionApi.md

@@ -4,19 +4,112 @@ All URIs are relative to *https://www.quba.co/api/sdp*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**anonymizeFile**](SensitiveDataProtectionApi.md#anonymizefile) | **POST** /anonymize/file | Anonymize File |
 | [**anonymizeText**](SensitiveDataProtectionApi.md#anonymizetext) | **POST** /anonymize | Anonymize Text |
 | [**healthCheck**](SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health |
+| [**listModels**](SensitiveDataProtectionApi.md#listmodels) | **GET** /models | List Models |
 | [**scanText**](SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text |
 
 
 
+## anonymizeFile
+
+> AnonymizeFileResponseBody anonymizeFile(file, rules, confidence_threshold, embedded_rules, table_headers, models, dicom_options)
+
+Anonymize File
+
+Anonymize sensitive data in a file.  Reads the file\'s text (Office parts, cells, lines), applies the rules as `/anonymize` does, and returns the file in its own format with every change made: each value found, with where it is (`path`), and each part removed. With `Accept: application/x-ndjson`, answers with one JSON event per line: `start`, a `batch` per step of reading, then `done` (the same body) or `error`. An Office file\'s images and kept embedded files are read as files of their own beside its text: each has `task` events (queued, started, then done, stopped or failed), and its own `start` and `batch` events carry its `task` path.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SensitiveDataProtectionApi,
+} from '@quba/sensitive-data-protection';
+import type { AnonymizeFileRequest } 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 SensitiveDataProtectionApi(config);
+
+  const body = {
+    // Blob | The file: docx, xlsx, pptx, csv, tsv, txt, md, log, json, jsonl, xml, html, hl7 (HL7 v2), png, jpg, webp, bmp, tiff (one page) or dcm (DICOM Part 10). Office files, images, DICOM, XML, HTML, HL7 v2 and FHIR JSON are told by their bytes; other text by its part\\\'s `Content-Type` when specific, else its name\\\'s extension.
+    file: BINARY_DATA_HERE,
+    // string | The de-identification rules, a JSON array as for `/anonymize`. Omit for the default rules. (optional)
+    rules: rules_example,
+    // number | Minimum score for model detections. Does not affect regex matches. (optional)
+    confidence_threshold: 8.14,
+    // string | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. (optional)
+    embedded_rules: embedded_rules_example,
+    // string | CSV, TSV and xlsx only: where a table\\\'s headers are, in the data\\\'s order (field 1, column A), so each value is read with its header. (optional)
+    table_headers: table_headers_example,
+    // string | Ids from `GET /models`, comma-separated (or the field repeated), each type\\\'s in order of preference: the first `ready` text model runs, and, for a file with images (an image, a DICOM file\\\'s pixels, an Office file\\\'s images), the first `ready` image reader. A type named none of runs on the first ready of all, largest first, waiting at startup until one is. None named of a type is ready: a 503, with `Retry-After` while one still loads. An unknown id: a 422. Omit for the defaults. (optional)
+    models: models_example,
+    // string | DICOM only: the options of the Basic Application Level Confidentiality Profile (PS3.15 Annex E) to apply, comma-separated, of: `clean_descriptors`, `retain_longitudinal_full_dates`, `retain_patient_characteristics`, `retain_device_identity`, `retain_institution_identity`, `retain_uids`. Empty for none. `clean_descriptors` scans descriptions and comments with the rules instead of removing them. (optional)
+    dicom_options: dicom_options_example,
+  } satisfies AnonymizeFileRequest;
+
+  try {
+    const data = await api.anonymizeFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` | The file: docx, xlsx, pptx, csv, tsv, txt, md, log, json, jsonl, xml, html, hl7 (HL7 v2), png, jpg, webp, bmp, tiff (one page) or dcm (DICOM Part 10). Office files, images, DICOM, XML, HTML, HL7 v2 and FHIR JSON are told by their bytes; other text by its part\\\'s `Content-Type` when specific, else its name\\\'s extension. | [Defaults to `undefined`] |
+| **rules** | `string` | The de-identification rules, a JSON array as for `/anonymize`. Omit for the default rules. | [Optional] [Defaults to `undefined`] |
+| **confidence_threshold** | `number` | Minimum score for model detections. Does not affect regex matches. | [Optional] [Defaults to `0.5`] |
+| **embedded_rules** | `anonymize`, `anonymize_or_keep`, `remove`, `keep` | Embedded content (embedded files, OLE objects, a FHIR JSON photo\\\'s base64 `data` on Patient, Practitioner, RelatedPerson or Person). `anonymize` (default): what can be read (an Office or text file; a PNG, JPEG, WebP, BMP or TIFF image where this server reads images) is anonymized as a file of its own and written back, the rest removed. `anonymize_or_keep`: the same, the rest kept unread. `remove`: all removed. `keep`: all kept unread. Thumbnails are always removed; fonts and printer settings always kept; an Office file\\\'s pictures are read and masked where this server reads images, whatever the rule. | [Optional] [Defaults to `'anonymize'`] [Enum: anonymize, anonymize_or_keep, remove, keep] |
+| **table_headers** | `none`, `first_row`, `first_column`, `last_column` | CSV, TSV and xlsx only: where a table\\\'s headers are, in the data\\\'s order (field 1, column A), so each value is read with its header. | [Optional] [Defaults to `'none'`] [Enum: none, first_row, first_column, last_column] |
+| **models** | `string` | Ids from `GET /models`, comma-separated (or the field repeated), each type\\\'s in order of preference: the first `ready` text model runs, and, for a file with images (an image, a DICOM file\\\'s pixels, an Office file\\\'s images), the first `ready` image reader. A type named none of runs on the first ready of all, largest first, waiting at startup until one is. None named of a type is ready: a 503, with `Retry-After` while one still loads. An unknown id: a 422. Omit for the defaults. | [Optional] [Defaults to `undefined`] |
+| **dicom_options** | `string` | DICOM only: the options of the Basic Application Level Confidentiality Profile (PS3.15 Annex E) to apply, comma-separated, of: `clean_descriptors`, `retain_longitudinal_full_dates`, `retain_patient_characteristics`, `retain_device_identity`, `retain_institution_identity`, `retain_uids`. Empty for none. `clean_descriptors` scans descriptions and comments with the rules instead of removing them. | [Optional] [Defaults to `'clean_descriptors'`] |
+
+### Return type
+
+[**AnonymizeFileResponseBody**](AnonymizeFileResponseBody.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The anonymized file and its results. |  -  |
+| **422** | A field or the file is invalid; `details` says which. |  -  |
+| **500** | The request failed, or the output still held a replaced value. Retrying may help. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## anonymizeText
 
 > AnonymizeResponseBody anonymizeText(AnonymizeRequestBody)
 
 Anonymize Text
 
-Anonymize sensitive data in text.  Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
+Anonymize sensitive data in text.  Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, pseudonymize, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
 
 ### Example
 
@@ -77,8 +170,15 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
-| **404** | No such policy in the calling organization. |  -  |
-| **422** | Validation Error |  -  |
+| **400** | The body is not JSON. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **402** | Out of credits. |  -  |
+| **403** | The calling key or member has an assigned policy, so the request may not send its own rules or confidence_threshold. |  -  |
+| **409** | The policy assigned to the calling key or member cannot be read. |  -  |
+| **413** | Text too long without an account. |  -  |
+| **422** | Some fields are invalid; `details` says which. |  -  |
+| **500** | The request failed. Retrying may help. |  -  |
+| **503** | Engine unavailable. Not billed. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -142,6 +242,68 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **503** | Engine unavailable. Not billed. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listModels
+
+> Array<ModelStatus> listModels()
+
+List Models
+
+The models this server offers: text models (`type: text`, run on every request), then image readers (`type: image`, read a file\'s images), each type largest first.  A request lists ids in `models`, each type\'s in order of preference: of each type, the first `ready` runs. If none of a type it names is ready, it is refused with a 503, with `Retry-After` while one still loads. A type it names none of runs on its `default`: the first `ready`, largest first (so `default` moves as models load); at startup, before any is ready, the request waits for the first to load. An unknown id is a 422.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SensitiveDataProtectionApi,
+} from '@quba/sensitive-data-protection';
+import type { ListModelsRequest } from '@quba/sensitive-data-protection';
+
+async function example() {
+  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
+  const api = new SensitiveDataProtectionApi();
+
+  try {
+    const data = await api.listModels();
+    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
+
+[**Array<ModelStatus>**](ModelStatus.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **503** | Engine unavailable. Not billed. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -213,7 +375,13 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
-| **422** | Validation Error |  -  |
+| **400** | The body is not JSON. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **402** | Out of credits. |  -  |
+| **413** | Text too long without an account. |  -  |
+| **422** | Some fields are invalid; `details` says which. |  -  |
+| **500** | The request failed. Retrying may help. |  -  |
+| **503** | Engine unavailable. Not billed. |  -  |
 
 [[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/ShapeKind.md

@@ -0,0 +1,33 @@
+
+# ShapeKind
+
+What a shape\'s text is when it is not its own text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ShapeKind } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ShapeKind
+
+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 ShapeKind
+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/ShapeSegment.md

@@ -0,0 +1,41 @@
+
+# ShapeSegment
+
+A shape: a text box, picture, table, group; its `cNvPr` / `docPr` id and name. No `kind` for its own text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`id` | number
+`name` | string
+`kind` | [ShapeKind](ShapeKind.md)
+
+## Example
+
+```typescript
+import type { ShapeSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "name": null,
+  "kind": null,
+} satisfies ShapeSegment
+
+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 ShapeSegment
+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/SheetSegment.md

@@ -0,0 +1,39 @@
+
+# SheetSegment
+
+A worksheet: its name on the tab, and its part.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`part` | string
+
+## Example
+
+```typescript
+import type { SheetSegment } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "name": null,
+  "part": null,
+} satisfies SheetSegment
+
+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 SheetSegment
+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)
+
+