@quba/sensitive-data-protection 0.2.2 → 0.2.3

package/README.md

@@ -69,6 +69,7 @@ All URIs are relative to *https://www.quba.co/api/sdp*
 ### Models
 
 - [Action](docs/Action.md)
+- [AllowRule](docs/AllowRule.md)
 - [AnonymizeFileResponseBody](docs/AnonymizeFileResponseBody.md)
 - [AnonymizeRequestBody](docs/AnonymizeRequestBody.md)
 - [AnonymizeResponseBody](docs/AnonymizeResponseBody.md)

package/dist/index.cjs

@@ -306,6 +306,140 @@ function ActionToJSONTyped(value, ignoreDiscriminator) {
 	return value;
 }
 
+//#endregion
+//#region src/models/ModelEntity.ts
+/**
+* @export
+*/
+const ModelEntityTypeEnum = { model: "model" };
+/**
+* Check if a given object implements the ModelEntity interface.
+*/
+function instanceOfModelEntity(value) {
+	if (!("type" in value) || value["type"] === void 0) return false;
+	if (!("value" in value) || value["value"] === void 0) return false;
+	return true;
+}
+function ModelEntityFromJSON(json) {
+	return ModelEntityFromJSONTyped(json, false);
+}
+function ModelEntityFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"type": json["type"],
+		"value": json["value"],
+		"threshold": json["threshold"] == null ? void 0 : json["threshold"]
+	};
+}
+function ModelEntityToJSON(json) {
+	return ModelEntityToJSONTyped(json, false);
+}
+function ModelEntityToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"type": value["type"],
+		"value": value["value"],
+		"threshold": value["threshold"]
+	};
+}
+
+//#endregion
+//#region src/models/RegexEntity.ts
+/**
+* @export
+*/
+const RegexEntityTypeEnum = { regex: "regex" };
+/**
+* Check if a given object implements the RegexEntity interface.
+*/
+function instanceOfRegexEntity(value) {
+	if (!("type" in value) || value["type"] === void 0) return false;
+	if (!("value" in value) || value["value"] === void 0) return false;
+	return true;
+}
+function RegexEntityFromJSON(json) {
+	return RegexEntityFromJSONTyped(json, false);
+}
+function RegexEntityFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"type": json["type"],
+		"value": json["value"]
+	};
+}
+function RegexEntityToJSON(json) {
+	return RegexEntityToJSONTyped(json, false);
+}
+function RegexEntityToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"type": value["type"],
+		"value": value["value"]
+	};
+}
+
+//#endregion
+//#region src/models/EntityBody.ts
+function EntityBodyFromJSON(json) {
+	return EntityBodyFromJSONTyped(json, false);
+}
+function EntityBodyFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	switch (json["type"]) {
+		case "model": return Object.assign({}, ModelEntityFromJSONTyped(json, true), { type: "model" });
+		case "regex": return Object.assign({}, RegexEntityFromJSONTyped(json, true), { type: "regex" });
+		default: return json;
+	}
+}
+function EntityBodyToJSON(json) {
+	return EntityBodyToJSONTyped(json, false);
+}
+function EntityBodyToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	switch (value["type"]) {
+		case "model": return Object.assign({}, ModelEntityToJSON(value), { type: "model" });
+		case "regex": return Object.assign({}, RegexEntityToJSON(value), { type: "regex" });
+		default: return value;
+	}
+}
+
+//#endregion
+//#region src/models/AllowRule.ts
+/**
+* @export
+*/
+const AllowRuleTypeEnum = { allow: "allow" };
+/**
+* Check if a given object implements the AllowRule interface.
+*/
+function instanceOfAllowRule(value) {
+	if (!("type" in value) || value["type"] === void 0) return false;
+	if (!("entities" in value) || value["entities"] === void 0) return false;
+	return true;
+}
+function AllowRuleFromJSON(json) {
+	return AllowRuleFromJSONTyped(json, false);
+}
+function AllowRuleFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"type": json["type"],
+		"entities": json["entities"].map(EntityBodyFromJSON),
+		"when": json["when"] == null ? void 0 : json["when"]
+	};
+}
+function AllowRuleToJSON(json) {
+	return AllowRuleToJSONTyped(json, false);
+}
+function AllowRuleToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"type": value["type"],
+		"entities": value["entities"].map(EntityBodyToJSON),
+		"when": value["when"]
+	};
+}
+
 //#endregion
 //#region src/models/Usage.ts
 /**
@@ -463,7 +597,8 @@ function FileModelResultFromJSONTyped(json, ignoreDiscriminator) {
 		"score": json["score"],
 		"input": json["input"],
 		"output": json["output"],
-		"path": json["path"]
+		"path": json["path"],
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
 	};
 }
 function FileModelResultToJSON(json) {
@@ -479,7 +614,8 @@ function FileModelResultToJSONTyped(value, ignoreDiscriminator = false) {
 		"score": value["score"],
 		"input": value["input"],
 		"output": value["output"],
-		"path": value["path"]
+		"path": value["path"],
+		"action": ActionToJSON(value["action"])
 	};
 }
 
@@ -514,7 +650,8 @@ function FileRegexResultFromJSONTyped(json, ignoreDiscriminator) {
 		"value": json["value"],
 		"input": json["input"],
 		"output": json["output"],
-		"path": json["path"]
+		"path": json["path"],
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
 	};
 }
 function FileRegexResultToJSON(json) {
@@ -529,7 +666,8 @@ function FileRegexResultToJSONTyped(value, ignoreDiscriminator = false) {
 		"value": value["value"],
 		"input": value["input"],
 		"output": value["output"],
-		"path": value["path"]
+		"path": value["path"],
+		"action": ActionToJSON(value["action"])
 	};
 }
 
@@ -602,101 +740,6 @@ function AnonymizeFileResponseBodyToJSONTyped(value, ignoreDiscriminator = false
 	};
 }
 
-//#endregion
-//#region src/models/ModelEntity.ts
-/**
-* @export
-*/
-const ModelEntityTypeEnum = { model: "model" };
-/**
-* Check if a given object implements the ModelEntity interface.
-*/
-function instanceOfModelEntity(value) {
-	if (!("type" in value) || value["type"] === void 0) return false;
-	if (!("value" in value) || value["value"] === void 0) return false;
-	return true;
-}
-function ModelEntityFromJSON(json) {
-	return ModelEntityFromJSONTyped(json, false);
-}
-function ModelEntityFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	return {
-		"type": json["type"],
-		"value": json["value"]
-	};
-}
-function ModelEntityToJSON(json) {
-	return ModelEntityToJSONTyped(json, false);
-}
-function ModelEntityToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	return {
-		"type": value["type"],
-		"value": value["value"]
-	};
-}
-
-//#endregion
-//#region src/models/RegexEntity.ts
-/**
-* @export
-*/
-const RegexEntityTypeEnum = { regex: "regex" };
-/**
-* Check if a given object implements the RegexEntity interface.
-*/
-function instanceOfRegexEntity(value) {
-	if (!("type" in value) || value["type"] === void 0) return false;
-	if (!("value" in value) || value["value"] === void 0) return false;
-	return true;
-}
-function RegexEntityFromJSON(json) {
-	return RegexEntityFromJSONTyped(json, false);
-}
-function RegexEntityFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	return {
-		"type": json["type"],
-		"value": json["value"]
-	};
-}
-function RegexEntityToJSON(json) {
-	return RegexEntityToJSONTyped(json, false);
-}
-function RegexEntityToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	return {
-		"type": value["type"],
-		"value": value["value"]
-	};
-}
-
-//#endregion
-//#region src/models/EntityBody.ts
-function EntityBodyFromJSON(json) {
-	return EntityBodyFromJSONTyped(json, false);
-}
-function EntityBodyFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	switch (json["type"]) {
-		case "model": return Object.assign({}, ModelEntityFromJSONTyped(json, true), { type: "model" });
-		case "regex": return Object.assign({}, RegexEntityFromJSONTyped(json, true), { type: "regex" });
-		default: return json;
-	}
-}
-function EntityBodyToJSON(json) {
-	return EntityBodyToJSONTyped(json, false);
-}
-function EntityBodyToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	switch (value["type"]) {
-		case "model": return Object.assign({}, ModelEntityToJSON(value), { type: "model" });
-		case "regex": return Object.assign({}, RegexEntityToJSON(value), { type: "regex" });
-		default: return value;
-	}
-}
-
 //#endregion
 //#region src/models/DetectRule.ts
 /**
@@ -719,7 +762,8 @@ function DetectRuleFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
-		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"]
 	};
 }
 function DetectRuleToJSON(json) {
@@ -730,7 +774,8 @@ function DetectRuleToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
-		"action": ActionToJSON(value["action"])
+		"action": ActionToJSON(value["action"]),
+		"when": value["when"]
 	};
 }
 
@@ -757,6 +802,7 @@ function EncryptRuleFromJSONTyped(json, ignoreDiscriminator) {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
 		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"],
 		"key": json["key"] == null ? void 0 : json["key"]
 	};
 }
@@ -769,6 +815,7 @@ function EncryptRuleToJSONTyped(value, ignoreDiscriminator = false) {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
 		"action": ActionToJSON(value["action"]),
+		"when": value["when"],
 		"key": value["key"]
 	};
 }
@@ -797,6 +844,7 @@ function HMACRuleFromJSONTyped(json, ignoreDiscriminator) {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
 		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"],
 		"key": json["key"],
 		"length": json["length"] == null ? void 0 : json["length"]
 	};
@@ -810,6 +858,7 @@ function HMACRuleToJSONTyped(value, ignoreDiscriminator = false) {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
 		"action": ActionToJSON(value["action"]),
+		"when": value["when"],
 		"key": value["key"],
 		"length": value["length"]
 	};
@@ -838,6 +887,7 @@ function MaskRuleFromJSONTyped(json, ignoreDiscriminator) {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
 		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"],
 		"masking_char": json["masking_char"] == null ? void 0 : json["masking_char"],
 		"chars_to_mask": json["chars_to_mask"] == null ? void 0 : json["chars_to_mask"],
 		"from_end": json["from_end"] == null ? void 0 : json["from_end"]
@@ -852,6 +902,7 @@ function MaskRuleToJSONTyped(value, ignoreDiscriminator = false) {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
 		"action": ActionToJSON(value["action"]),
+		"when": value["when"],
 		"masking_char": value["masking_char"],
 		"chars_to_mask": value["chars_to_mask"],
 		"from_end": value["from_end"]
@@ -881,6 +932,7 @@ function PseudonymizeRuleFromJSONTyped(json, ignoreDiscriminator) {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
 		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"],
 		"tag": json["tag"] == null ? void 0 : json["tag"]
 	};
 }
@@ -893,6 +945,7 @@ function PseudonymizeRuleToJSONTyped(value, ignoreDiscriminator = false) {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
 		"action": ActionToJSON(value["action"]),
+		"when": value["when"],
 		"tag": value["tag"]
 	};
 }
@@ -919,7 +972,8 @@ function RedactRuleFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
-		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"]
 	};
 }
 function RedactRuleToJSON(json) {
@@ -930,7 +984,8 @@ function RedactRuleToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
-		"action": ActionToJSON(value["action"])
+		"action": ActionToJSON(value["action"]),
+		"when": value["when"]
 	};
 }
 
@@ -957,6 +1012,7 @@ function ReplaceRuleFromJSONTyped(json, ignoreDiscriminator) {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
 		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"],
 		"replacement": json["replacement"] == null ? void 0 : json["replacement"]
 	};
 }
@@ -969,6 +1025,7 @@ function ReplaceRuleToJSONTyped(value, ignoreDiscriminator = false) {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
 		"action": ActionToJSON(value["action"]),
+		"when": value["when"],
 		"replacement": value["replacement"]
 	};
 }
@@ -995,7 +1052,8 @@ function SHA256RuleFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
-		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"]
 	};
 }
 function SHA256RuleToJSON(json) {
@@ -1006,7 +1064,8 @@ function SHA256RuleToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
-		"action": ActionToJSON(value["action"])
+		"action": ActionToJSON(value["action"]),
+		"when": value["when"]
 	};
 }
 
@@ -1032,7 +1091,8 @@ function SHA512RuleFromJSONTyped(json, ignoreDiscriminator) {
 	return {
 		"type": json["type"],
 		"entities": json["entities"].map(EntityBodyFromJSON),
-		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"])
+		"action": json["action"] == null ? void 0 : ActionFromJSON(json["action"]),
+		"when": json["when"] == null ? void 0 : json["when"]
 	};
 }
 function SHA512RuleToJSON(json) {
@@ -1043,7 +1103,8 @@ function SHA512RuleToJSONTyped(value, ignoreDiscriminator = false) {
 	return {
 		"type": value["type"],
 		"entities": value["entities"].map(EntityBodyToJSON),
-		"action": ActionToJSON(value["action"])
+		"action": ActionToJSON(value["action"]),
+		"when": value["when"]
 	};
 }
 
@@ -1055,6 +1116,7 @@ function RuleBodyFromJSON(json) {
 function RuleBodyFromJSONTyped(json, ignoreDiscriminator) {
 	if (json == null) return json;
 	switch (json["type"]) {
+		case "allow": return Object.assign({}, AllowRuleFromJSONTyped(json, true), { type: "allow" });
 		case "detect": return Object.assign({}, DetectRuleFromJSONTyped(json, true), { type: "detect" });
 		case "encrypt": return Object.assign({}, EncryptRuleFromJSONTyped(json, true), { type: "encrypt" });
 		case "hmac": return Object.assign({}, HMACRuleFromJSONTyped(json, true), { type: "hmac" });
@@ -1073,6 +1135,7 @@ function RuleBodyToJSON(json) {
 function RuleBodyToJSONTyped(value, ignoreDiscriminator = false) {
 	if (value == null) return value;
 	switch (value["type"]) {
+		case "allow": return Object.assign({}, AllowRuleToJSON(value), { type: "allow" });
 		case "detect": return Object.assign({}, DetectRuleToJSON(value), { type: "detect" });
 		case "encrypt": return Object.assign({}, EncryptRuleToJSON(value), { type: "encrypt" });
 		case "hmac": return Object.assign({}, HMACRuleToJSON(value), { type: "hmac" });
@@ -2692,6 +2755,7 @@ function PolicyDocumentRulesInnerFromJSON(json) {
 function PolicyDocumentRulesInnerFromJSONTyped(json, ignoreDiscriminator) {
 	if (json == null) return json;
 	switch (json["type"]) {
+		case "allow": return Object.assign({}, AllowRuleFromJSONTyped(json, true), { type: "allow" });
 		case "detect": return Object.assign({}, DetectRuleFromJSONTyped(json, true), { type: "detect" });
 		case "encrypt": return Object.assign({}, EncryptRuleFromJSONTyped(json, true), { type: "encrypt" });
 		case "hmac": return Object.assign({}, HMACRuleFromJSONTyped(json, true), { type: "hmac" });
@@ -2710,6 +2774,7 @@ function PolicyDocumentRulesInnerToJSON(json) {
 function PolicyDocumentRulesInnerToJSONTyped(value, ignoreDiscriminator = false) {
 	if (value == null) return value;
 	switch (value["type"]) {
+		case "allow": return Object.assign({}, AllowRuleToJSON(value), { type: "allow" });
 		case "detect": return Object.assign({}, DetectRuleToJSON(value), { type: "detect" });
 		case "encrypt": return Object.assign({}, EncryptRuleToJSON(value), { type: "encrypt" });
 		case "hmac": return Object.assign({}, HMACRuleToJSON(value), { type: "hmac" });
@@ -2885,7 +2950,8 @@ function FieldErrorPathInnerToJSONTyped(value, ignoreDiscriminator = false) {
 * `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
+* `invalid_key`: not a Fernet key; `invalid_condition`: not a `when` the
+* engine runs; `labels_over_budget`: the labels leave
 * the model too little room for text (see `tokens`, `limit`).
 * @export
 */
@@ -2902,6 +2968,7 @@ const FieldErrorCode = {
 	unknown_type: "unknown_type",
 	invalid_pattern: "invalid_pattern",
 	invalid_key: "invalid_key",
+	invalid_condition: "invalid_condition",
 	labels_over_budget: "labels_over_budget"
 };
 function instanceOfFieldErrorCode(value) {
@@ -3688,6 +3755,11 @@ exports.ActionFromJSON = ActionFromJSON;
 exports.ActionFromJSONTyped = ActionFromJSONTyped;
 exports.ActionToJSON = ActionToJSON;
 exports.ActionToJSONTyped = ActionToJSONTyped;
+exports.AllowRuleFromJSON = AllowRuleFromJSON;
+exports.AllowRuleFromJSONTyped = AllowRuleFromJSONTyped;
+exports.AllowRuleToJSON = AllowRuleToJSON;
+exports.AllowRuleToJSONTyped = AllowRuleToJSONTyped;
+exports.AllowRuleTypeEnum = AllowRuleTypeEnum;
 exports.AnonymizeFileEmbeddedRulesEnum = AnonymizeFileEmbeddedRulesEnum;
 exports.AnonymizeFileResponseBodyFromJSON = AnonymizeFileResponseBodyFromJSON;
 exports.AnonymizeFileResponseBodyFromJSONTyped = AnonymizeFileResponseBodyFromJSONTyped;
@@ -4081,6 +4153,7 @@ exports.VoidApiResponse = VoidApiResponse;
 exports.canConsumeForm = canConsumeForm;
 exports.exists = exists;
 exports.instanceOfAction = instanceOfAction;
+exports.instanceOfAllowRule = instanceOfAllowRule;
 exports.instanceOfAnonymizeFileResponseBody = instanceOfAnonymizeFileResponseBody;
 exports.instanceOfAnonymizeRequestBody = instanceOfAnonymizeRequestBody;
 exports.instanceOfAnonymizeResponseBody = instanceOfAnonymizeResponseBody;