@quba/sensitive-data-protection 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -3
- package/dist/index.cjs +647 -0
- package/dist/index.d.cts +633 -1
- package/dist/index.d.mts +633 -1
- package/dist/index.mjs +561 -1
- package/docs/AnonymizeRequestBody.md +36 -0
- package/docs/AnonymizeRequestBodyTransformationsInner.md +46 -0
- package/docs/AnonymizeResponseBody.md +36 -0
- package/docs/EncryptTransformation.md +38 -0
- package/docs/EntitySpanResult.md +45 -0
- package/docs/EntityTarget.md +36 -0
- package/docs/MapValueInner.md +46 -0
- package/docs/MaskTransformation.md +42 -0
- package/docs/RedactTransformation.md +36 -0
- package/docs/RegexSpanResult.md +43 -0
- package/docs/RegexTarget.md +36 -0
- package/docs/ReplaceTransformation.md +38 -0
- package/docs/SHA256Transformation.md +36 -0
- package/docs/SHA512Transformation.md +36 -0
- package/docs/SensitiveDataProtectionApi.md +69 -0
- package/docs/Targets.md +32 -0
- package/docs/TargetsAnyOfInner.md +38 -0
- package/package.json +1 -1
package/dist/index.mjs
CHANGED
|
@@ -262,6 +262,414 @@ var TextApiResponse = class {
|
|
|
262
262
|
}
|
|
263
263
|
};
|
|
264
264
|
|
|
265
|
+
//#endregion
|
|
266
|
+
//#region src/models/Targets.ts
|
|
267
|
+
/**
|
|
268
|
+
* Check if a given object implements the Targets interface.
|
|
269
|
+
*/
|
|
270
|
+
function instanceOfTargets(value) {
|
|
271
|
+
return true;
|
|
272
|
+
}
|
|
273
|
+
function TargetsFromJSON(json) {
|
|
274
|
+
return TargetsFromJSONTyped(json, false);
|
|
275
|
+
}
|
|
276
|
+
function TargetsFromJSONTyped(json, ignoreDiscriminator) {
|
|
277
|
+
return json;
|
|
278
|
+
}
|
|
279
|
+
function TargetsToJSON(json) {
|
|
280
|
+
return TargetsToJSONTyped(json, false);
|
|
281
|
+
}
|
|
282
|
+
function TargetsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
283
|
+
return value;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
//#endregion
|
|
287
|
+
//#region src/models/EncryptTransformation.ts
|
|
288
|
+
/**
|
|
289
|
+
* @export
|
|
290
|
+
*/
|
|
291
|
+
const EncryptTransformationIdEnum = { encrypt: "encrypt" };
|
|
292
|
+
/**
|
|
293
|
+
* Check if a given object implements the EncryptTransformation interface.
|
|
294
|
+
*/
|
|
295
|
+
function instanceOfEncryptTransformation(value) {
|
|
296
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
297
|
+
return true;
|
|
298
|
+
}
|
|
299
|
+
function EncryptTransformationFromJSON(json) {
|
|
300
|
+
return EncryptTransformationFromJSONTyped(json, false);
|
|
301
|
+
}
|
|
302
|
+
function EncryptTransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
303
|
+
if (json == null) return json;
|
|
304
|
+
return {
|
|
305
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
306
|
+
"targets": TargetsFromJSON(json["targets"]),
|
|
307
|
+
"key": json["key"] == null ? void 0 : json["key"]
|
|
308
|
+
};
|
|
309
|
+
}
|
|
310
|
+
function EncryptTransformationToJSON(json) {
|
|
311
|
+
return EncryptTransformationToJSONTyped(json, false);
|
|
312
|
+
}
|
|
313
|
+
function EncryptTransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
314
|
+
if (value == null) return value;
|
|
315
|
+
return {
|
|
316
|
+
"id": value["id"],
|
|
317
|
+
"targets": TargetsToJSON(value["targets"]),
|
|
318
|
+
"key": value["key"]
|
|
319
|
+
};
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
//#endregion
|
|
323
|
+
//#region src/models/MaskTransformation.ts
|
|
324
|
+
/**
|
|
325
|
+
* @export
|
|
326
|
+
*/
|
|
327
|
+
const MaskTransformationIdEnum = { mask: "mask" };
|
|
328
|
+
/**
|
|
329
|
+
* Check if a given object implements the MaskTransformation interface.
|
|
330
|
+
*/
|
|
331
|
+
function instanceOfMaskTransformation(value) {
|
|
332
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
333
|
+
return true;
|
|
334
|
+
}
|
|
335
|
+
function MaskTransformationFromJSON(json) {
|
|
336
|
+
return MaskTransformationFromJSONTyped(json, false);
|
|
337
|
+
}
|
|
338
|
+
function MaskTransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
339
|
+
if (json == null) return json;
|
|
340
|
+
return {
|
|
341
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
342
|
+
"targets": TargetsFromJSON(json["targets"]),
|
|
343
|
+
"masking_char": json["masking_char"] == null ? void 0 : json["masking_char"],
|
|
344
|
+
"chars_to_mask": json["chars_to_mask"] == null ? void 0 : json["chars_to_mask"],
|
|
345
|
+
"from_end": json["from_end"] == null ? void 0 : json["from_end"]
|
|
346
|
+
};
|
|
347
|
+
}
|
|
348
|
+
function MaskTransformationToJSON(json) {
|
|
349
|
+
return MaskTransformationToJSONTyped(json, false);
|
|
350
|
+
}
|
|
351
|
+
function MaskTransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
352
|
+
if (value == null) return value;
|
|
353
|
+
return {
|
|
354
|
+
"id": value["id"],
|
|
355
|
+
"targets": TargetsToJSON(value["targets"]),
|
|
356
|
+
"masking_char": value["masking_char"],
|
|
357
|
+
"chars_to_mask": value["chars_to_mask"],
|
|
358
|
+
"from_end": value["from_end"]
|
|
359
|
+
};
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
//#endregion
|
|
363
|
+
//#region src/models/RedactTransformation.ts
|
|
364
|
+
/**
|
|
365
|
+
* @export
|
|
366
|
+
*/
|
|
367
|
+
const RedactTransformationIdEnum = { redact: "redact" };
|
|
368
|
+
/**
|
|
369
|
+
* Check if a given object implements the RedactTransformation interface.
|
|
370
|
+
*/
|
|
371
|
+
function instanceOfRedactTransformation(value) {
|
|
372
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
373
|
+
return true;
|
|
374
|
+
}
|
|
375
|
+
function RedactTransformationFromJSON(json) {
|
|
376
|
+
return RedactTransformationFromJSONTyped(json, false);
|
|
377
|
+
}
|
|
378
|
+
function RedactTransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
379
|
+
if (json == null) return json;
|
|
380
|
+
return {
|
|
381
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
382
|
+
"targets": TargetsFromJSON(json["targets"])
|
|
383
|
+
};
|
|
384
|
+
}
|
|
385
|
+
function RedactTransformationToJSON(json) {
|
|
386
|
+
return RedactTransformationToJSONTyped(json, false);
|
|
387
|
+
}
|
|
388
|
+
function RedactTransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
389
|
+
if (value == null) return value;
|
|
390
|
+
return {
|
|
391
|
+
"id": value["id"],
|
|
392
|
+
"targets": TargetsToJSON(value["targets"])
|
|
393
|
+
};
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
//#endregion
|
|
397
|
+
//#region src/models/ReplaceTransformation.ts
|
|
398
|
+
/**
|
|
399
|
+
* @export
|
|
400
|
+
*/
|
|
401
|
+
const ReplaceTransformationIdEnum = { replace: "replace" };
|
|
402
|
+
/**
|
|
403
|
+
* Check if a given object implements the ReplaceTransformation interface.
|
|
404
|
+
*/
|
|
405
|
+
function instanceOfReplaceTransformation(value) {
|
|
406
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
407
|
+
return true;
|
|
408
|
+
}
|
|
409
|
+
function ReplaceTransformationFromJSON(json) {
|
|
410
|
+
return ReplaceTransformationFromJSONTyped(json, false);
|
|
411
|
+
}
|
|
412
|
+
function ReplaceTransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
413
|
+
if (json == null) return json;
|
|
414
|
+
return {
|
|
415
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
416
|
+
"targets": TargetsFromJSON(json["targets"]),
|
|
417
|
+
"replacement": json["replacement"] == null ? void 0 : json["replacement"]
|
|
418
|
+
};
|
|
419
|
+
}
|
|
420
|
+
function ReplaceTransformationToJSON(json) {
|
|
421
|
+
return ReplaceTransformationToJSONTyped(json, false);
|
|
422
|
+
}
|
|
423
|
+
function ReplaceTransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
424
|
+
if (value == null) return value;
|
|
425
|
+
return {
|
|
426
|
+
"id": value["id"],
|
|
427
|
+
"targets": TargetsToJSON(value["targets"]),
|
|
428
|
+
"replacement": value["replacement"]
|
|
429
|
+
};
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
//#endregion
|
|
433
|
+
//#region src/models/SHA256Transformation.ts
|
|
434
|
+
/**
|
|
435
|
+
* @export
|
|
436
|
+
*/
|
|
437
|
+
const SHA256TransformationIdEnum = { sha256: "sha256" };
|
|
438
|
+
/**
|
|
439
|
+
* Check if a given object implements the SHA256Transformation interface.
|
|
440
|
+
*/
|
|
441
|
+
function instanceOfSHA256Transformation(value) {
|
|
442
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
443
|
+
return true;
|
|
444
|
+
}
|
|
445
|
+
function SHA256TransformationFromJSON(json) {
|
|
446
|
+
return SHA256TransformationFromJSONTyped(json, false);
|
|
447
|
+
}
|
|
448
|
+
function SHA256TransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
449
|
+
if (json == null) return json;
|
|
450
|
+
return {
|
|
451
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
452
|
+
"targets": TargetsFromJSON(json["targets"])
|
|
453
|
+
};
|
|
454
|
+
}
|
|
455
|
+
function SHA256TransformationToJSON(json) {
|
|
456
|
+
return SHA256TransformationToJSONTyped(json, false);
|
|
457
|
+
}
|
|
458
|
+
function SHA256TransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
459
|
+
if (value == null) return value;
|
|
460
|
+
return {
|
|
461
|
+
"id": value["id"],
|
|
462
|
+
"targets": TargetsToJSON(value["targets"])
|
|
463
|
+
};
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
//#endregion
|
|
467
|
+
//#region src/models/SHA512Transformation.ts
|
|
468
|
+
/**
|
|
469
|
+
* @export
|
|
470
|
+
*/
|
|
471
|
+
const SHA512TransformationIdEnum = { sha512: "sha512" };
|
|
472
|
+
/**
|
|
473
|
+
* Check if a given object implements the SHA512Transformation interface.
|
|
474
|
+
*/
|
|
475
|
+
function instanceOfSHA512Transformation(value) {
|
|
476
|
+
if (!("targets" in value) || value["targets"] === void 0) return false;
|
|
477
|
+
return true;
|
|
478
|
+
}
|
|
479
|
+
function SHA512TransformationFromJSON(json) {
|
|
480
|
+
return SHA512TransformationFromJSONTyped(json, false);
|
|
481
|
+
}
|
|
482
|
+
function SHA512TransformationFromJSONTyped(json, ignoreDiscriminator) {
|
|
483
|
+
if (json == null) return json;
|
|
484
|
+
return {
|
|
485
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
486
|
+
"targets": TargetsFromJSON(json["targets"])
|
|
487
|
+
};
|
|
488
|
+
}
|
|
489
|
+
function SHA512TransformationToJSON(json) {
|
|
490
|
+
return SHA512TransformationToJSONTyped(json, false);
|
|
491
|
+
}
|
|
492
|
+
function SHA512TransformationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
493
|
+
if (value == null) return value;
|
|
494
|
+
return {
|
|
495
|
+
"id": value["id"],
|
|
496
|
+
"targets": TargetsToJSON(value["targets"])
|
|
497
|
+
};
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
//#endregion
|
|
501
|
+
//#region src/models/AnonymizeRequestBodyTransformationsInner.ts
|
|
502
|
+
function AnonymizeRequestBodyTransformationsInnerFromJSON(json) {
|
|
503
|
+
return AnonymizeRequestBodyTransformationsInnerFromJSONTyped(json, false);
|
|
504
|
+
}
|
|
505
|
+
function AnonymizeRequestBodyTransformationsInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
506
|
+
if (json == null) return json;
|
|
507
|
+
switch (json["id"]) {
|
|
508
|
+
case "encrypt": return Object.assign({}, EncryptTransformationFromJSONTyped(json, true), { id: "encrypt" });
|
|
509
|
+
case "mask": return Object.assign({}, MaskTransformationFromJSONTyped(json, true), { id: "mask" });
|
|
510
|
+
case "redact": return Object.assign({}, RedactTransformationFromJSONTyped(json, true), { id: "redact" });
|
|
511
|
+
case "replace": return Object.assign({}, ReplaceTransformationFromJSONTyped(json, true), { id: "replace" });
|
|
512
|
+
case "sha256": return Object.assign({}, SHA256TransformationFromJSONTyped(json, true), { id: "sha256" });
|
|
513
|
+
case "sha512": return Object.assign({}, SHA512TransformationFromJSONTyped(json, true), { id: "sha512" });
|
|
514
|
+
default: return json;
|
|
515
|
+
}
|
|
516
|
+
}
|
|
517
|
+
function AnonymizeRequestBodyTransformationsInnerToJSON(json) {
|
|
518
|
+
return AnonymizeRequestBodyTransformationsInnerToJSONTyped(json, false);
|
|
519
|
+
}
|
|
520
|
+
function AnonymizeRequestBodyTransformationsInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
521
|
+
if (value == null) return value;
|
|
522
|
+
switch (value["id"]) {
|
|
523
|
+
case "encrypt": return Object.assign({}, EncryptTransformationToJSON(value), { id: "encrypt" });
|
|
524
|
+
case "mask": return Object.assign({}, MaskTransformationToJSON(value), { id: "mask" });
|
|
525
|
+
case "redact": return Object.assign({}, RedactTransformationToJSON(value), { id: "redact" });
|
|
526
|
+
case "replace": return Object.assign({}, ReplaceTransformationToJSON(value), { id: "replace" });
|
|
527
|
+
case "sha256": return Object.assign({}, SHA256TransformationToJSON(value), { id: "sha256" });
|
|
528
|
+
case "sha512": return Object.assign({}, SHA512TransformationToJSON(value), { id: "sha512" });
|
|
529
|
+
default: return value;
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
//#endregion
|
|
534
|
+
//#region src/models/AnonymizeRequestBody.ts
|
|
535
|
+
/**
|
|
536
|
+
* Check if a given object implements the AnonymizeRequestBody interface.
|
|
537
|
+
*/
|
|
538
|
+
function instanceOfAnonymizeRequestBody(value) {
|
|
539
|
+
if (!("text" in value) || value["text"] === void 0) return false;
|
|
540
|
+
if (!("transformations" in value) || value["transformations"] === void 0) return false;
|
|
541
|
+
return true;
|
|
542
|
+
}
|
|
543
|
+
function AnonymizeRequestBodyFromJSON(json) {
|
|
544
|
+
return AnonymizeRequestBodyFromJSONTyped(json, false);
|
|
545
|
+
}
|
|
546
|
+
function AnonymizeRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
547
|
+
if (json == null) return json;
|
|
548
|
+
return {
|
|
549
|
+
"text": json["text"],
|
|
550
|
+
"transformations": json["transformations"].map(AnonymizeRequestBodyTransformationsInnerFromJSON)
|
|
551
|
+
};
|
|
552
|
+
}
|
|
553
|
+
function AnonymizeRequestBodyToJSON(json) {
|
|
554
|
+
return AnonymizeRequestBodyToJSONTyped(json, false);
|
|
555
|
+
}
|
|
556
|
+
function AnonymizeRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
557
|
+
if (value == null) return value;
|
|
558
|
+
return {
|
|
559
|
+
"text": value["text"],
|
|
560
|
+
"transformations": value["transformations"].map(AnonymizeRequestBodyTransformationsInnerToJSON)
|
|
561
|
+
};
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
//#endregion
|
|
565
|
+
//#region src/models/AnonymizeResponseBody.ts
|
|
566
|
+
/**
|
|
567
|
+
* Check if a given object implements the AnonymizeResponseBody interface.
|
|
568
|
+
*/
|
|
569
|
+
function instanceOfAnonymizeResponseBody(value) {
|
|
570
|
+
if (!("text" in value) || value["text"] === void 0) return false;
|
|
571
|
+
return true;
|
|
572
|
+
}
|
|
573
|
+
function AnonymizeResponseBodyFromJSON(json) {
|
|
574
|
+
return AnonymizeResponseBodyFromJSONTyped(json, false);
|
|
575
|
+
}
|
|
576
|
+
function AnonymizeResponseBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
577
|
+
if (json == null) return json;
|
|
578
|
+
return {
|
|
579
|
+
"text": json["text"],
|
|
580
|
+
"map": json["map"] == null ? void 0 : json["map"]
|
|
581
|
+
};
|
|
582
|
+
}
|
|
583
|
+
function AnonymizeResponseBodyToJSON(json) {
|
|
584
|
+
return AnonymizeResponseBodyToJSONTyped(json, false);
|
|
585
|
+
}
|
|
586
|
+
function AnonymizeResponseBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
587
|
+
if (value == null) return value;
|
|
588
|
+
return {
|
|
589
|
+
"text": value["text"],
|
|
590
|
+
"map": value["map"]
|
|
591
|
+
};
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
//#endregion
|
|
595
|
+
//#region src/models/EntitySpanResult.ts
|
|
596
|
+
/**
|
|
597
|
+
* @export
|
|
598
|
+
*/
|
|
599
|
+
const EntitySpanResultTargetEnum = { entity: "entity" };
|
|
600
|
+
/**
|
|
601
|
+
* Check if a given object implements the EntitySpanResult interface.
|
|
602
|
+
*/
|
|
603
|
+
function instanceOfEntitySpanResult(value) {
|
|
604
|
+
if (!("start" in value) || value["start"] === void 0) return false;
|
|
605
|
+
if (!("end" in value) || value["end"] === void 0) return false;
|
|
606
|
+
if (!("entity_type" in value) || value["entity_type"] === void 0) return false;
|
|
607
|
+
if (!("text" in value) || value["text"] === void 0) return false;
|
|
608
|
+
return true;
|
|
609
|
+
}
|
|
610
|
+
function EntitySpanResultFromJSON(json) {
|
|
611
|
+
return EntitySpanResultFromJSONTyped(json, false);
|
|
612
|
+
}
|
|
613
|
+
function EntitySpanResultFromJSONTyped(json, ignoreDiscriminator) {
|
|
614
|
+
if (json == null) return json;
|
|
615
|
+
return {
|
|
616
|
+
"target": json["target"] == null ? void 0 : json["target"],
|
|
617
|
+
"start": json["start"],
|
|
618
|
+
"end": json["end"],
|
|
619
|
+
"entity_type": json["entity_type"],
|
|
620
|
+
"text": json["text"],
|
|
621
|
+
"score": json["score"] == null ? void 0 : json["score"]
|
|
622
|
+
};
|
|
623
|
+
}
|
|
624
|
+
function EntitySpanResultToJSON(json) {
|
|
625
|
+
return EntitySpanResultToJSONTyped(json, false);
|
|
626
|
+
}
|
|
627
|
+
function EntitySpanResultToJSONTyped(value, ignoreDiscriminator = false) {
|
|
628
|
+
if (value == null) return value;
|
|
629
|
+
return {
|
|
630
|
+
"target": value["target"],
|
|
631
|
+
"start": value["start"],
|
|
632
|
+
"end": value["end"],
|
|
633
|
+
"entity_type": value["entity_type"],
|
|
634
|
+
"text": value["text"],
|
|
635
|
+
"score": value["score"]
|
|
636
|
+
};
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
//#endregion
|
|
640
|
+
//#region src/models/EntityTarget.ts
|
|
641
|
+
/**
|
|
642
|
+
* @export
|
|
643
|
+
*/
|
|
644
|
+
const EntityTargetIdEnum = { entity: "entity" };
|
|
645
|
+
/**
|
|
646
|
+
* Check if a given object implements the EntityTarget interface.
|
|
647
|
+
*/
|
|
648
|
+
function instanceOfEntityTarget(value) {
|
|
649
|
+
if (!("entity_type" in value) || value["entity_type"] === void 0) return false;
|
|
650
|
+
return true;
|
|
651
|
+
}
|
|
652
|
+
function EntityTargetFromJSON(json) {
|
|
653
|
+
return EntityTargetFromJSONTyped(json, false);
|
|
654
|
+
}
|
|
655
|
+
function EntityTargetFromJSONTyped(json, ignoreDiscriminator) {
|
|
656
|
+
if (json == null) return json;
|
|
657
|
+
return {
|
|
658
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
659
|
+
"entity_type": json["entity_type"]
|
|
660
|
+
};
|
|
661
|
+
}
|
|
662
|
+
function EntityTargetToJSON(json) {
|
|
663
|
+
return EntityTargetToJSONTyped(json, false);
|
|
664
|
+
}
|
|
665
|
+
function EntityTargetToJSONTyped(value, ignoreDiscriminator = false) {
|
|
666
|
+
if (value == null) return value;
|
|
667
|
+
return {
|
|
668
|
+
"id": value["id"],
|
|
669
|
+
"entity_type": value["entity_type"]
|
|
670
|
+
};
|
|
671
|
+
}
|
|
672
|
+
|
|
265
673
|
//#endregion
|
|
266
674
|
//#region src/models/ValidationErrorLocInner.ts
|
|
267
675
|
/**
|
|
@@ -340,6 +748,108 @@ function HTTPValidationErrorToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
340
748
|
return { "detail": value["detail"] == null ? void 0 : value["detail"].map(ValidationErrorToJSON) };
|
|
341
749
|
}
|
|
342
750
|
|
|
751
|
+
//#endregion
|
|
752
|
+
//#region src/models/RegexSpanResult.ts
|
|
753
|
+
/**
|
|
754
|
+
* @export
|
|
755
|
+
*/
|
|
756
|
+
const RegexSpanResultTargetEnum = { regex: "regex" };
|
|
757
|
+
/**
|
|
758
|
+
* Check if a given object implements the RegexSpanResult interface.
|
|
759
|
+
*/
|
|
760
|
+
function instanceOfRegexSpanResult(value) {
|
|
761
|
+
if (!("start" in value) || value["start"] === void 0) return false;
|
|
762
|
+
if (!("end" in value) || value["end"] === void 0) return false;
|
|
763
|
+
if (!("pattern" in value) || value["pattern"] === void 0) return false;
|
|
764
|
+
if (!("text" in value) || value["text"] === void 0) return false;
|
|
765
|
+
return true;
|
|
766
|
+
}
|
|
767
|
+
function RegexSpanResultFromJSON(json) {
|
|
768
|
+
return RegexSpanResultFromJSONTyped(json, false);
|
|
769
|
+
}
|
|
770
|
+
function RegexSpanResultFromJSONTyped(json, ignoreDiscriminator) {
|
|
771
|
+
if (json == null) return json;
|
|
772
|
+
return {
|
|
773
|
+
"target": json["target"] == null ? void 0 : json["target"],
|
|
774
|
+
"start": json["start"],
|
|
775
|
+
"end": json["end"],
|
|
776
|
+
"pattern": json["pattern"],
|
|
777
|
+
"text": json["text"]
|
|
778
|
+
};
|
|
779
|
+
}
|
|
780
|
+
function RegexSpanResultToJSON(json) {
|
|
781
|
+
return RegexSpanResultToJSONTyped(json, false);
|
|
782
|
+
}
|
|
783
|
+
function RegexSpanResultToJSONTyped(value, ignoreDiscriminator = false) {
|
|
784
|
+
if (value == null) return value;
|
|
785
|
+
return {
|
|
786
|
+
"target": value["target"],
|
|
787
|
+
"start": value["start"],
|
|
788
|
+
"end": value["end"],
|
|
789
|
+
"pattern": value["pattern"],
|
|
790
|
+
"text": value["text"]
|
|
791
|
+
};
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
//#endregion
|
|
795
|
+
//#region src/models/MapValueInner.ts
|
|
796
|
+
function MapValueInnerFromJSON(json) {
|
|
797
|
+
return MapValueInnerFromJSONTyped(json, false);
|
|
798
|
+
}
|
|
799
|
+
function MapValueInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
800
|
+
if (json == null) return json;
|
|
801
|
+
switch (json["target"]) {
|
|
802
|
+
case "entity": return Object.assign({}, EntitySpanResultFromJSONTyped(json, true), { target: "entity" });
|
|
803
|
+
case "regex": return Object.assign({}, RegexSpanResultFromJSONTyped(json, true), { target: "regex" });
|
|
804
|
+
default: return json;
|
|
805
|
+
}
|
|
806
|
+
}
|
|
807
|
+
function MapValueInnerToJSON(json) {
|
|
808
|
+
return MapValueInnerToJSONTyped(json, false);
|
|
809
|
+
}
|
|
810
|
+
function MapValueInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
811
|
+
if (value == null) return value;
|
|
812
|
+
switch (value["target"]) {
|
|
813
|
+
case "entity": return Object.assign({}, EntitySpanResultToJSON(value), { target: "entity" });
|
|
814
|
+
case "regex": return Object.assign({}, RegexSpanResultToJSON(value), { target: "regex" });
|
|
815
|
+
default: return value;
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
//#endregion
|
|
820
|
+
//#region src/models/RegexTarget.ts
|
|
821
|
+
/**
|
|
822
|
+
* @export
|
|
823
|
+
*/
|
|
824
|
+
const RegexTargetIdEnum = { regex: "regex" };
|
|
825
|
+
/**
|
|
826
|
+
* Check if a given object implements the RegexTarget interface.
|
|
827
|
+
*/
|
|
828
|
+
function instanceOfRegexTarget(value) {
|
|
829
|
+
if (!("pattern" in value) || value["pattern"] === void 0) return false;
|
|
830
|
+
return true;
|
|
831
|
+
}
|
|
832
|
+
function RegexTargetFromJSON(json) {
|
|
833
|
+
return RegexTargetFromJSONTyped(json, false);
|
|
834
|
+
}
|
|
835
|
+
function RegexTargetFromJSONTyped(json, ignoreDiscriminator) {
|
|
836
|
+
if (json == null) return json;
|
|
837
|
+
return {
|
|
838
|
+
"id": json["id"] == null ? void 0 : json["id"],
|
|
839
|
+
"pattern": json["pattern"]
|
|
840
|
+
};
|
|
841
|
+
}
|
|
842
|
+
function RegexTargetToJSON(json) {
|
|
843
|
+
return RegexTargetToJSONTyped(json, false);
|
|
844
|
+
}
|
|
845
|
+
function RegexTargetToJSONTyped(value, ignoreDiscriminator = false) {
|
|
846
|
+
if (value == null) return value;
|
|
847
|
+
return {
|
|
848
|
+
"id": value["id"],
|
|
849
|
+
"pattern": value["pattern"]
|
|
850
|
+
};
|
|
851
|
+
}
|
|
852
|
+
|
|
343
853
|
//#endregion
|
|
344
854
|
//#region src/models/ScanRequestBody.ts
|
|
345
855
|
/**
|
|
@@ -435,6 +945,31 @@ function ScanResponseBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
435
945
|
return { "results": value["results"].map(ScanResultToJSON) };
|
|
436
946
|
}
|
|
437
947
|
|
|
948
|
+
//#endregion
|
|
949
|
+
//#region src/models/TargetsAnyOfInner.ts
|
|
950
|
+
function TargetsAnyOfInnerFromJSON(json) {
|
|
951
|
+
return TargetsAnyOfInnerFromJSONTyped(json, false);
|
|
952
|
+
}
|
|
953
|
+
function TargetsAnyOfInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
954
|
+
if (json == null) return json;
|
|
955
|
+
switch (json["id"]) {
|
|
956
|
+
case "entity": return Object.assign({}, EntityTargetFromJSONTyped(json, true), { id: "entity" });
|
|
957
|
+
case "regex": return Object.assign({}, RegexTargetFromJSONTyped(json, true), { id: "regex" });
|
|
958
|
+
default: return json;
|
|
959
|
+
}
|
|
960
|
+
}
|
|
961
|
+
function TargetsAnyOfInnerToJSON(json) {
|
|
962
|
+
return TargetsAnyOfInnerToJSONTyped(json, false);
|
|
963
|
+
}
|
|
964
|
+
function TargetsAnyOfInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
965
|
+
if (value == null) return value;
|
|
966
|
+
switch (value["id"]) {
|
|
967
|
+
case "entity": return Object.assign({}, EntityTargetToJSON(value), { id: "entity" });
|
|
968
|
+
case "regex": return Object.assign({}, RegexTargetToJSON(value), { id: "regex" });
|
|
969
|
+
default: return value;
|
|
970
|
+
}
|
|
971
|
+
}
|
|
972
|
+
|
|
438
973
|
//#endregion
|
|
439
974
|
//#region src/apis/SensitiveDataProtectionApi.ts
|
|
440
975
|
/**
|
|
@@ -452,6 +987,31 @@ function ScanResponseBodyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
452
987
|
*
|
|
453
988
|
*/
|
|
454
989
|
var SensitiveDataProtectionApi = class extends BaseAPI {
|
|
990
|
+
/**
|
|
991
|
+
* Anonymize the provided text.
|
|
992
|
+
* Anonymize Text
|
|
993
|
+
*/
|
|
994
|
+
async anonymizeTextRaw(requestParameters, initOverrides) {
|
|
995
|
+
if (requestParameters["AnonymizeRequestBody"] == null) throw new RequiredError("AnonymizeRequestBody", "Required parameter \"AnonymizeRequestBody\" was null or undefined when calling anonymizeText().");
|
|
996
|
+
const queryParameters = {};
|
|
997
|
+
const headerParameters = {};
|
|
998
|
+
headerParameters["Content-Type"] = "application/json";
|
|
999
|
+
const response = await this.request({
|
|
1000
|
+
path: `/anonymize`,
|
|
1001
|
+
method: "POST",
|
|
1002
|
+
headers: headerParameters,
|
|
1003
|
+
query: queryParameters,
|
|
1004
|
+
body: AnonymizeRequestBodyToJSON(requestParameters["AnonymizeRequestBody"])
|
|
1005
|
+
}, initOverrides);
|
|
1006
|
+
return new JSONApiResponse(response, (jsonValue) => AnonymizeResponseBodyFromJSON(jsonValue));
|
|
1007
|
+
}
|
|
1008
|
+
/**
|
|
1009
|
+
* Anonymize the provided text.
|
|
1010
|
+
* Anonymize Text
|
|
1011
|
+
*/
|
|
1012
|
+
async anonymizeText(AnonymizeRequestBody, initOverrides) {
|
|
1013
|
+
return await (await this.anonymizeTextRaw({ AnonymizeRequestBody }, initOverrides)).value();
|
|
1014
|
+
}
|
|
455
1015
|
/**
|
|
456
1016
|
* Return basic health probe result.
|
|
457
1017
|
* Health
|
|
@@ -501,4 +1061,4 @@ var SensitiveDataProtectionApi = class extends BaseAPI {
|
|
|
501
1061
|
};
|
|
502
1062
|
|
|
503
1063
|
//#endregion
|
|
504
|
-
export { BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, DefaultConfig, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, RequiredError, ResponseError, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfHTTPValidationError, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
|
|
1064
|
+
export { AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeRequestBodyTransformationsInnerFromJSON, AnonymizeRequestBodyTransformationsInnerFromJSONTyped, AnonymizeRequestBodyTransformationsInnerToJSON, AnonymizeRequestBodyTransformationsInnerToJSONTyped, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, DefaultConfig, EncryptTransformationFromJSON, EncryptTransformationFromJSONTyped, EncryptTransformationIdEnum, EncryptTransformationToJSON, EncryptTransformationToJSONTyped, EntitySpanResultFromJSON, EntitySpanResultFromJSONTyped, EntitySpanResultTargetEnum, EntitySpanResultToJSON, EntitySpanResultToJSONTyped, EntityTargetFromJSON, EntityTargetFromJSONTyped, EntityTargetIdEnum, EntityTargetToJSON, EntityTargetToJSONTyped, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, MapValueInnerFromJSON, MapValueInnerFromJSONTyped, MapValueInnerToJSON, MapValueInnerToJSONTyped, MaskTransformationFromJSON, MaskTransformationFromJSONTyped, MaskTransformationIdEnum, MaskTransformationToJSON, MaskTransformationToJSONTyped, RedactTransformationFromJSON, RedactTransformationFromJSONTyped, RedactTransformationIdEnum, RedactTransformationToJSON, RedactTransformationToJSONTyped, RegexSpanResultFromJSON, RegexSpanResultFromJSONTyped, RegexSpanResultTargetEnum, RegexSpanResultToJSON, RegexSpanResultToJSONTyped, RegexTargetFromJSON, RegexTargetFromJSONTyped, RegexTargetIdEnum, RegexTargetToJSON, RegexTargetToJSONTyped, ReplaceTransformationFromJSON, ReplaceTransformationFromJSONTyped, ReplaceTransformationIdEnum, ReplaceTransformationToJSON, ReplaceTransformationToJSONTyped, RequiredError, ResponseError, SHA256TransformationFromJSON, SHA256TransformationFromJSONTyped, SHA256TransformationIdEnum, SHA256TransformationToJSON, SHA256TransformationToJSONTyped, SHA512TransformationFromJSON, SHA512TransformationFromJSONTyped, SHA512TransformationIdEnum, SHA512TransformationToJSON, SHA512TransformationToJSONTyped, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TargetsAnyOfInnerFromJSON, TargetsAnyOfInnerFromJSONTyped, TargetsAnyOfInnerToJSON, TargetsAnyOfInnerToJSONTyped, TargetsFromJSON, TargetsFromJSONTyped, TargetsToJSON, TargetsToJSONTyped, TextApiResponse, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeResponseBody, instanceOfEncryptTransformation, instanceOfEntitySpanResult, instanceOfEntityTarget, instanceOfHTTPValidationError, instanceOfMaskTransformation, instanceOfRedactTransformation, instanceOfRegexSpanResult, instanceOfRegexTarget, instanceOfReplaceTransformation, instanceOfSHA256Transformation, instanceOfSHA512Transformation, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTargets, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# AnonymizeRequestBody
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`text` | string
|
|
10
|
+
`transformations` | [Array<AnonymizeRequestBodyTransformationsInner>](AnonymizeRequestBodyTransformationsInner.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { AnonymizeRequestBody } from '@quba/sensitive-data-protection'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"text": null,
|
|
20
|
+
"transformations": null,
|
|
21
|
+
} satisfies AnonymizeRequestBody
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as AnonymizeRequestBody
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
|
|
2
|
+
# AnonymizeRequestBodyTransformationsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`targets` | [Targets](Targets.md)
|
|
11
|
+
`replacement` | string
|
|
12
|
+
`key` | string
|
|
13
|
+
`masking_char` | string
|
|
14
|
+
`chars_to_mask` | number
|
|
15
|
+
`from_end` | boolean
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { AnonymizeRequestBodyTransformationsInner } from '@quba/sensitive-data-protection'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": null,
|
|
25
|
+
"targets": null,
|
|
26
|
+
"replacement": null,
|
|
27
|
+
"key": null,
|
|
28
|
+
"masking_char": null,
|
|
29
|
+
"chars_to_mask": null,
|
|
30
|
+
"from_end": null,
|
|
31
|
+
} satisfies AnonymizeRequestBodyTransformationsInner
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as AnonymizeRequestBodyTransformationsInner
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|