@quba/sensitive-data-protection 0.0.12 → 0.1.0

package/README.md

@@ -78,6 +78,7 @@ All URIs are relative to *https://www.quba.co/api/sdp*
 - [ListPolicies200Response](docs/ListPolicies200Response.md)
 - [MaskRule](docs/MaskRule.md)
 - [ModelEntity](docs/ModelEntity.md)
+- [ModelError](docs/ModelError.md)
 - [ModelResult](docs/ModelResult.md)
 - [Policy](docs/Policy.md)
 - [PolicyDocument](docs/PolicyDocument.md)

package/dist/index.cjs

@@ -369,8 +369,7 @@ function AnonymizeRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"text": json["text"],
 		"rules": json["rules"] == null ? void 0 : json["rules"].map(AnonymizeRequestBodyRulesInnerFromJSON),
-		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"],
-		"policy": json["policy"] == null ? void 0 : json["policy"]
+		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"]
 	};
 }
 function AnonymizeRequestBodyToJSON(json) {
@@ -381,8 +380,7 @@ function AnonymizeRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"text": value["text"],
 		"rules": value["rules"] == null ? void 0 : value["rules"].map(AnonymizeRequestBodyRulesInnerToJSON),
-		"confidence_threshold": value["confidence_threshold"],
-		"policy": value["policy"]
+		"confidence_threshold": value["confidence_threshold"]
 	};
 }
 
@@ -944,6 +942,36 @@ function ModelEntityToJSONTyped(value, ignoreDiscriminator = false) {
 	};
 }
 
+//#endregion
+//#region src/models/ModelError.ts
+/**
+* Check if a given object implements the ModelError interface.
+*/
+function instanceOfModelError(value) {
+	if (!("error" in value) || value["error"] === void 0) return false;
+	return true;
+}
+function ModelErrorFromJSON(json) {
+	return ModelErrorFromJSONTyped(json, false);
+}
+function ModelErrorFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"error": json["error"],
+		"signup": json["signup"] == null ? void 0 : json["signup"]
+	};
+}
+function ModelErrorToJSON(json) {
+	return ModelErrorToJSONTyped(json, false);
+}
+function ModelErrorToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"error": value["error"],
+		"signup": value["signup"]
+	};
+}
+
 //#endregion
 //#region src/models/ModelResult.ts
 /**
@@ -1679,6 +1707,10 @@ exports.ModelEntityFromJSONTyped = ModelEntityFromJSONTyped;
 exports.ModelEntityToJSON = ModelEntityToJSON;
 exports.ModelEntityToJSONTyped = ModelEntityToJSONTyped;
 exports.ModelEntityTypeEnum = ModelEntityTypeEnum;
+exports.ModelErrorFromJSON = ModelErrorFromJSON;
+exports.ModelErrorFromJSONTyped = ModelErrorFromJSONTyped;
+exports.ModelErrorToJSON = ModelErrorToJSON;
+exports.ModelErrorToJSONTyped = ModelErrorToJSONTyped;
 exports.ModelResultFromJSON = ModelResultFromJSON;
 exports.ModelResultFromJSONTyped = ModelResultFromJSONTyped;
 exports.ModelResultToJSON = ModelResultToJSON;
@@ -1784,6 +1816,7 @@ exports.instanceOfHTTPValidationError = instanceOfHTTPValidationError;
 exports.instanceOfListPolicies200Response = instanceOfListPolicies200Response;
 exports.instanceOfMaskRule = instanceOfMaskRule;
 exports.instanceOfModelEntity = instanceOfModelEntity;
+exports.instanceOfModelError = instanceOfModelError;
 exports.instanceOfModelResult = instanceOfModelResult;
 exports.instanceOfPolicy = instanceOfPolicy;
 exports.instanceOfPolicyDocument = instanceOfPolicyDocument;

package/dist/index.d.cts

@@ -321,23 +321,17 @@ interface AnonymizeRequestBody {
    */
   text: string;
   /**
-   * The de-identification rules to apply. At least one is required. Optional when `policy` is supplied.
+   *
    * @type {Array<AnonymizeRequestBodyRulesInner>}
    * @memberof AnonymizeRequestBody
    */
-  rules?: Array<AnonymizeRequestBodyRulesInner>;
+  rules?: Array<AnonymizeRequestBodyRulesInner> | null;
   /**
    *
    * @type {number}
    * @memberof AnonymizeRequestBody
    */
   confidence_threshold?: number | null;
-  /**
-   *
-   * @type {string}
-   * @memberof AnonymizeRequestBody
-   */
-  policy?: string | null;
 }
 /**
  * Check if a given object implements the AnonymizeRequestBody interface.
@@ -1023,7 +1017,7 @@ declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminato
  * Do not edit the class manually.
  */
 /**
- * An AI-model entity type to target, e.g. 'PERSON', 'EMAIL', 'LOCATION'.
+ * An AI-model entity type to target, e.g. 'person', 'email', 'phone_number'.
  * @export
  * @interface ModelEntity
  */
@@ -1035,7 +1029,7 @@ interface ModelEntity {
    */
   type?: ModelEntityTypeEnum;
   /**
-   * The model entity type name, e.g. 'PERSON'.
+   * The model entity type name, e.g. 'person'.
    * @type {string}
    * @memberof ModelEntity
    */
@@ -1057,11 +1051,51 @@ declare function ModelEntityFromJSONTyped(json: any, ignoreDiscriminator: boolea
 declare function ModelEntityToJSON(json: any): ModelEntity;
 declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscriminator?: boolean): any;
 //#endregion
+//#region src/models/ModelError.d.ts
+/**
+ * Sensitive Data Protection API
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ModelError
+ */
+interface ModelError {
+  /**
+   *
+   * @type {string}
+   * @memberof ModelError
+   */
+  error: string;
+  /**
+   * Present on anonymous refusals: an account lifts the limit.
+   * @type {boolean}
+   * @memberof ModelError
+   */
+  signup?: boolean;
+}
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+declare function instanceOfModelError(value: object): value is ModelError;
+declare function ModelErrorFromJSON(json: any): ModelError;
+declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError;
+declare function ModelErrorToJSON(json: any): ModelError;
+declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any;
+//#endregion
 //#region src/models/ModelResult.d.ts
 /**
  * Record of an AI model detection and its anonymization.
  *
- * Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
+ * Created when an AI model identifies an entity (e.g. person, email)
  * and a rule anonymizes the matched text.
  * @export
  * @interface ModelResult
@@ -1080,7 +1114,7 @@ interface ModelResult {
    */
   rule: string;
   /**
-   * The model entity type that matched, e.g. 'PERSON'.
+   * The model entity type that matched, e.g. 'person'.
    * @type {string}
    * @memberof ModelResult
    */
@@ -1459,7 +1493,7 @@ interface ScanRequestBody {
    */
   language?: string;
   /**
-   * The entity types to detect, e.g. 'name', 'email', 'location'.
+   * The entity types to detect, e.g. 'person', 'email', 'phone_number'. Defaults to personal, health, payment and credential identifiers.
    * @type {Array<string>}
    * @memberof ScanRequestBody
    */
@@ -1694,4 +1728,4 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
   scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
 }
 //#endregion
-export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInner, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleEntitiesInner, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, ErrorContext, FetchAPI, FetchError, FetchParams, GetPolicyRequest, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
+export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInner, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleEntitiesInner, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, ErrorContext, FetchAPI, FetchError, FetchParams, GetPolicyRequest, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelError, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelError, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };

package/dist/index.d.mts

@@ -321,23 +321,17 @@ interface AnonymizeRequestBody {
    */
   text: string;
   /**
-   * The de-identification rules to apply. At least one is required. Optional when `policy` is supplied.
+   *
    * @type {Array<AnonymizeRequestBodyRulesInner>}
    * @memberof AnonymizeRequestBody
    */
-  rules?: Array<AnonymizeRequestBodyRulesInner>;
+  rules?: Array<AnonymizeRequestBodyRulesInner> | null;
   /**
    *
    * @type {number}
    * @memberof AnonymizeRequestBody
    */
   confidence_threshold?: number | null;
-  /**
-   *
-   * @type {string}
-   * @memberof AnonymizeRequestBody
-   */
-  policy?: string | null;
 }
 /**
  * Check if a given object implements the AnonymizeRequestBody interface.
@@ -1023,7 +1017,7 @@ declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminato
  * Do not edit the class manually.
  */
 /**
- * An AI-model entity type to target, e.g. 'PERSON', 'EMAIL', 'LOCATION'.
+ * An AI-model entity type to target, e.g. 'person', 'email', 'phone_number'.
  * @export
  * @interface ModelEntity
  */
@@ -1035,7 +1029,7 @@ interface ModelEntity {
    */
   type?: ModelEntityTypeEnum;
   /**
-   * The model entity type name, e.g. 'PERSON'.
+   * The model entity type name, e.g. 'person'.
    * @type {string}
    * @memberof ModelEntity
    */
@@ -1057,11 +1051,51 @@ declare function ModelEntityFromJSONTyped(json: any, ignoreDiscriminator: boolea
 declare function ModelEntityToJSON(json: any): ModelEntity;
 declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscriminator?: boolean): any;
 //#endregion
+//#region src/models/ModelError.d.ts
+/**
+ * Sensitive Data Protection API
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ModelError
+ */
+interface ModelError {
+  /**
+   *
+   * @type {string}
+   * @memberof ModelError
+   */
+  error: string;
+  /**
+   * Present on anonymous refusals: an account lifts the limit.
+   * @type {boolean}
+   * @memberof ModelError
+   */
+  signup?: boolean;
+}
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+declare function instanceOfModelError(value: object): value is ModelError;
+declare function ModelErrorFromJSON(json: any): ModelError;
+declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError;
+declare function ModelErrorToJSON(json: any): ModelError;
+declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any;
+//#endregion
 //#region src/models/ModelResult.d.ts
 /**
  * Record of an AI model detection and its anonymization.
  *
- * Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
+ * Created when an AI model identifies an entity (e.g. person, email)
  * and a rule anonymizes the matched text.
  * @export
  * @interface ModelResult
@@ -1080,7 +1114,7 @@ interface ModelResult {
    */
   rule: string;
   /**
-   * The model entity type that matched, e.g. 'PERSON'.
+   * The model entity type that matched, e.g. 'person'.
    * @type {string}
    * @memberof ModelResult
    */
@@ -1459,7 +1493,7 @@ interface ScanRequestBody {
    */
   language?: string;
   /**
-   * The entity types to detect, e.g. 'name', 'email', 'location'.
+   * The entity types to detect, e.g. 'person', 'email', 'phone_number'. Defaults to personal, health, payment and credential identifiers.
    * @type {Array<string>}
    * @memberof ScanRequestBody
    */
@@ -1694,4 +1728,4 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
   scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
 }
 //#endregion
-export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInner, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleEntitiesInner, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, ErrorContext, FetchAPI, FetchError, FetchParams, GetPolicyRequest, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
+export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInner, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleEntitiesInner, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, ErrorContext, FetchAPI, FetchError, FetchParams, GetPolicyRequest, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelError, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelError, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };

package/dist/index.mjs

@@ -368,8 +368,7 @@ function AnonymizeRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"text": json["text"],
 		"rules": json["rules"] == null ? void 0 : json["rules"].map(AnonymizeRequestBodyRulesInnerFromJSON),
-		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"],
-		"policy": json["policy"] == null ? void 0 : json["policy"]
+		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"]
 	};
 }
 function AnonymizeRequestBodyToJSON(json) {
@@ -380,8 +379,7 @@ function AnonymizeRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"text": value["text"],
 		"rules": value["rules"] == null ? void 0 : value["rules"].map(AnonymizeRequestBodyRulesInnerToJSON),
-		"confidence_threshold": value["confidence_threshold"],
-		"policy": value["policy"]
+		"confidence_threshold": value["confidence_threshold"]
 	};
 }
 
@@ -943,6 +941,36 @@ function ModelEntityToJSONTyped(value, ignoreDiscriminator = false) {
 	};
 }
 
+//#endregion
+//#region src/models/ModelError.ts
+/**
+* Check if a given object implements the ModelError interface.
+*/
+function instanceOfModelError(value) {
+	if (!("error" in value) || value["error"] === void 0) return false;
+	return true;
+}
+function ModelErrorFromJSON(json) {
+	return ModelErrorFromJSONTyped(json, false);
+}
+function ModelErrorFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"error": json["error"],
+		"signup": json["signup"] == null ? void 0 : json["signup"]
+	};
+}
+function ModelErrorToJSON(json) {
+	return ModelErrorToJSONTyped(json, false);
+}
+function ModelErrorToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"error": value["error"],
+		"signup": value["signup"]
+	};
+}
+
 //#endregion
 //#region src/models/ModelResult.ts
 /**
@@ -1615,4 +1643,4 @@ var SensitiveDataProtectionApi = class extends BaseAPI {
 };
 
 //#endregion
-export { AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequiredError, ResponseError, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
+export { AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequiredError, ResponseError, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelError, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };

package/docs/AnonymizeRequestBody.md

@@ -10,7 +10,6 @@ Name | Type
 `text` | string
 `rules` | [Array<AnonymizeRequestBodyRulesInner>](AnonymizeRequestBodyRulesInner.md)
 `confidence_threshold` | number
-`policy` | string
 
 ## Example
 
@@ -22,7 +21,6 @@ const example = {
   "text": null,
   "rules": null,
   "confidence_threshold": null,
-  "policy": null,
 } satisfies AnonymizeRequestBody
 
 console.log(example)

package/docs/ModelEntity.md

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

package/docs/ModelError.md

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

@@ -1,7 +1,7 @@
 
 # ModelResult
 
-Record of an AI model detection and its anonymization.  Created when an AI model identifies an entity (e.g. PERSON, EMAIL) and a rule anonymizes the matched text.
+Record of an AI model detection and its anonymization.  Created when an AI model identifies an entity (e.g. person, email) and a rule anonymizes the matched text.
 
 ## Properties
 

package/docs/PoliciesApi.md

@@ -77,6 +77,8 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **201** | The created policy. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **409** | A policy with that name already exists. |  -  |
 | **422** | The document failed validation. |  -  |
 
@@ -141,14 +143,17 @@ example().catch(console.error);
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **204** | Deleted. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **404** | No such policy in this organization. |  -  |
+| **409** | Members or API keys are held to the policy. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -218,6 +223,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The policy and its latest document. |  -  |
+| **401** | Missing or invalid API key. |  -  |
 | **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)
@@ -280,6 +286,7 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The calling organization\'s policies. |  -  |
+| **401** | Missing or invalid API key. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -352,6 +359,8 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | The updated policy. |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **403** | The caller may not do this. API keys hold no role, so they cannot change policies. |  -  |
 | **404** | No such policy in this organization. |  -  |
 | **409** | A policy with that name already exists. |  -  |
 | **422** | The document failed validation. |  -  |

package/docs/SensitiveDataProtectionApi.md

@@ -77,8 +77,13 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
-| **404** | No such policy in the calling organization. |  -  |
+| **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** | Validation Error |  -  |
+| **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 +147,8 @@ 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)
 
@@ -213,7 +220,11 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **401** | Missing or invalid API key. |  -  |
+| **402** | Out of credits. |  -  |
+| **413** | Text too long without an account. |  -  |
 | **422** | Validation Error |  -  |
+| **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/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "type": "module",
   "homepage": "https://www.quba.co",
-  "version": "0.0.12",
+  "version": "0.1.0",
   "keywords": [
     "sensitive data protection",
     "sdp",