@quba/sensitive-data-protection 0.0.7 → 0.0.11
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 +91 -13
- package/dist/index.cjs +895 -327
- package/dist/index.d.cts +1024 -422
- package/dist/index.d.mts +1024 -422
- package/dist/index.mjs +833 -315
- package/docs/AnonymizeRequestBody.md +3 -0
- package/docs/AnonymizeRequestBodyRulesInner.md +1 -1
- package/docs/AnonymizeResponseBody.md +5 -2
- package/docs/AnonymizeResponseBodyResultsInner.md +44 -0
- package/docs/CreatePolicyRequest.md +36 -0
- package/docs/DetectRule.md +37 -0
- package/docs/DetectRuleEntitiesInner.md +36 -0
- package/docs/EncryptRule.md +2 -1
- package/docs/ListPolicies200Response.md +34 -0
- package/docs/MaskRule.md +2 -1
- package/docs/ModelEntity.md +1 -0
- package/docs/PoliciesApi.md +360 -0
- package/docs/Policy.md +44 -0
- package/docs/PolicyDocument.md +41 -0
- package/docs/PolicyDocumentRulesInner.md +46 -0
- package/docs/PolicySummary.md +42 -0
- package/docs/RedactRule.md +2 -1
- package/docs/RegexEntity.md +1 -0
- package/docs/ReplaceRule.md +2 -1
- package/docs/SHA256Rule.md +2 -1
- package/docs/SHA512Rule.md +2 -1
- package/docs/ScanRequestBody.md +1 -0
- package/docs/ScanResponseBody.md +3 -0
- package/docs/ScanResult.md +1 -0
- package/docs/SensitiveDataProtectionApi.md +23 -10
- package/docs/UpdatePolicyRequest.md +36 -0
- package/docs/Usage.md +37 -0
- package/docs/ValidationError.md +4 -0
- package/package.json +4 -3
package/dist/index.d.cts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
//#region src/runtime.d.ts
|
|
2
2
|
/**
|
|
3
3
|
* Sensitive Data Protection API
|
|
4
|
-
*
|
|
4
|
+
* 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).
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 0.0
|
|
6
|
+
* The version of the OpenAPI document: 0.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -184,12 +184,12 @@ declare class TextApiResponse {
|
|
|
184
184
|
value(): Promise<string>;
|
|
185
185
|
}
|
|
186
186
|
//#endregion
|
|
187
|
-
//#region src/models/
|
|
187
|
+
//#region src/models/DetectRuleEntitiesInner.d.ts
|
|
188
188
|
/**
|
|
189
189
|
* Sensitive Data Protection API
|
|
190
|
-
*
|
|
190
|
+
* 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).
|
|
191
191
|
*
|
|
192
|
-
* The version of the OpenAPI document: 0.0
|
|
192
|
+
* The version of the OpenAPI document: 0.1.0
|
|
193
193
|
*
|
|
194
194
|
*
|
|
195
195
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -199,313 +199,145 @@ declare class TextApiResponse {
|
|
|
199
199
|
/**
|
|
200
200
|
*
|
|
201
201
|
* @export
|
|
202
|
-
* @interface
|
|
202
|
+
* @interface DetectRuleEntitiesInner
|
|
203
203
|
*/
|
|
204
|
-
interface
|
|
205
|
-
/**
|
|
206
|
-
* Check if a given object implements the Entities interface.
|
|
207
|
-
*/
|
|
208
|
-
declare function instanceOfEntities(value: object): value is Entities;
|
|
209
|
-
declare function EntitiesFromJSON(json: any): Entities;
|
|
210
|
-
declare function EntitiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): Entities;
|
|
211
|
-
declare function EntitiesToJSON(json: any): Entities;
|
|
212
|
-
declare function EntitiesToJSONTyped(value?: Entities | null, ignoreDiscriminator?: boolean): any;
|
|
213
|
-
//#endregion
|
|
214
|
-
//#region src/models/EncryptRule.d.ts
|
|
215
|
-
/**
|
|
216
|
-
*
|
|
217
|
-
* @export
|
|
218
|
-
* @interface EncryptRule
|
|
219
|
-
*/
|
|
220
|
-
interface EncryptRule {
|
|
204
|
+
interface DetectRuleEntitiesInner {
|
|
221
205
|
/**
|
|
222
206
|
*
|
|
223
207
|
* @type {string}
|
|
224
|
-
* @memberof
|
|
225
|
-
*/
|
|
226
|
-
type?: EncryptRuleTypeEnum;
|
|
227
|
-
/**
|
|
228
|
-
*
|
|
229
|
-
* @type {Entities}
|
|
230
|
-
* @memberof EncryptRule
|
|
208
|
+
* @memberof DetectRuleEntitiesInner
|
|
231
209
|
*/
|
|
232
|
-
|
|
210
|
+
type?: DetectRuleEntitiesInnerTypeEnum;
|
|
233
211
|
/**
|
|
234
|
-
*
|
|
212
|
+
* The regular expression to match.
|
|
235
213
|
* @type {string}
|
|
236
|
-
* @memberof
|
|
214
|
+
* @memberof DetectRuleEntitiesInner
|
|
237
215
|
*/
|
|
238
|
-
|
|
216
|
+
value: string;
|
|
239
217
|
}
|
|
240
218
|
/**
|
|
241
219
|
* @export
|
|
242
220
|
*/
|
|
243
|
-
declare const
|
|
244
|
-
readonly
|
|
221
|
+
declare const DetectRuleEntitiesInnerTypeEnum: {
|
|
222
|
+
readonly model: "model";
|
|
223
|
+
readonly regex: "regex";
|
|
245
224
|
};
|
|
246
|
-
type
|
|
225
|
+
type DetectRuleEntitiesInnerTypeEnum = typeof DetectRuleEntitiesInnerTypeEnum[keyof typeof DetectRuleEntitiesInnerTypeEnum];
|
|
247
226
|
/**
|
|
248
|
-
* Check if a given object implements the
|
|
227
|
+
* Check if a given object implements the DetectRuleEntitiesInner interface.
|
|
249
228
|
*/
|
|
250
|
-
declare function
|
|
251
|
-
declare function
|
|
252
|
-
declare function
|
|
253
|
-
declare function
|
|
254
|
-
declare function
|
|
229
|
+
declare function instanceOfDetectRuleEntitiesInner(value: object): value is DetectRuleEntitiesInner;
|
|
230
|
+
declare function DetectRuleEntitiesInnerFromJSON(json: any): DetectRuleEntitiesInner;
|
|
231
|
+
declare function DetectRuleEntitiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DetectRuleEntitiesInner;
|
|
232
|
+
declare function DetectRuleEntitiesInnerToJSON(json: any): DetectRuleEntitiesInner;
|
|
233
|
+
declare function DetectRuleEntitiesInnerToJSONTyped(value?: DetectRuleEntitiesInner | null, ignoreDiscriminator?: boolean): any;
|
|
255
234
|
//#endregion
|
|
256
|
-
//#region src/models/
|
|
235
|
+
//#region src/models/AnonymizeRequestBodyRulesInner.d.ts
|
|
257
236
|
/**
|
|
258
237
|
*
|
|
259
238
|
* @export
|
|
260
|
-
* @interface
|
|
239
|
+
* @interface AnonymizeRequestBodyRulesInner
|
|
261
240
|
*/
|
|
262
|
-
interface
|
|
241
|
+
interface AnonymizeRequestBodyRulesInner {
|
|
263
242
|
/**
|
|
264
243
|
*
|
|
265
244
|
* @type {string}
|
|
266
|
-
* @memberof
|
|
245
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
267
246
|
*/
|
|
268
|
-
type?:
|
|
247
|
+
type?: AnonymizeRequestBodyRulesInnerTypeEnum;
|
|
269
248
|
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {
|
|
272
|
-
* @memberof
|
|
249
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
250
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
251
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
273
252
|
*/
|
|
274
|
-
entities:
|
|
253
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
275
254
|
/**
|
|
276
|
-
*
|
|
255
|
+
* The fixed string to substitute for each match.
|
|
277
256
|
* @type {string}
|
|
278
|
-
* @memberof
|
|
279
|
-
*/
|
|
280
|
-
masking_char?: string;
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {number}
|
|
284
|
-
* @memberof MaskRule
|
|
285
|
-
*/
|
|
286
|
-
chars_to_mask?: number | null;
|
|
287
|
-
/**
|
|
288
|
-
*
|
|
289
|
-
* @type {boolean}
|
|
290
|
-
* @memberof MaskRule
|
|
257
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
291
258
|
*/
|
|
292
|
-
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* @export
|
|
296
|
-
*/
|
|
297
|
-
declare const MaskRuleTypeEnum: {
|
|
298
|
-
readonly mask: "mask";
|
|
299
|
-
};
|
|
300
|
-
type MaskRuleTypeEnum = typeof MaskRuleTypeEnum[keyof typeof MaskRuleTypeEnum];
|
|
301
|
-
/**
|
|
302
|
-
* Check if a given object implements the MaskRule interface.
|
|
303
|
-
*/
|
|
304
|
-
declare function instanceOfMaskRule(value: object): value is MaskRule;
|
|
305
|
-
declare function MaskRuleFromJSON(json: any): MaskRule;
|
|
306
|
-
declare function MaskRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): MaskRule;
|
|
307
|
-
declare function MaskRuleToJSON(json: any): MaskRule;
|
|
308
|
-
declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminator?: boolean): any;
|
|
309
|
-
//#endregion
|
|
310
|
-
//#region src/models/RedactRule.d.ts
|
|
311
|
-
/**
|
|
312
|
-
*
|
|
313
|
-
* @export
|
|
314
|
-
* @interface RedactRule
|
|
315
|
-
*/
|
|
316
|
-
interface RedactRule {
|
|
259
|
+
replacement?: string;
|
|
317
260
|
/**
|
|
318
|
-
*
|
|
261
|
+
* Base64 Fernet key. If empty, a key is generated automatically.
|
|
319
262
|
* @type {string}
|
|
320
|
-
* @memberof
|
|
321
|
-
*/
|
|
322
|
-
type?: RedactRuleTypeEnum;
|
|
323
|
-
/**
|
|
324
|
-
*
|
|
325
|
-
* @type {Entities}
|
|
326
|
-
* @memberof RedactRule
|
|
263
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
327
264
|
*/
|
|
328
|
-
|
|
329
|
-
}
|
|
330
|
-
/**
|
|
331
|
-
* @export
|
|
332
|
-
*/
|
|
333
|
-
declare const RedactRuleTypeEnum: {
|
|
334
|
-
readonly redact: "redact";
|
|
335
|
-
};
|
|
336
|
-
type RedactRuleTypeEnum = typeof RedactRuleTypeEnum[keyof typeof RedactRuleTypeEnum];
|
|
337
|
-
/**
|
|
338
|
-
* Check if a given object implements the RedactRule interface.
|
|
339
|
-
*/
|
|
340
|
-
declare function instanceOfRedactRule(value: object): value is RedactRule;
|
|
341
|
-
declare function RedactRuleFromJSON(json: any): RedactRule;
|
|
342
|
-
declare function RedactRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): RedactRule;
|
|
343
|
-
declare function RedactRuleToJSON(json: any): RedactRule;
|
|
344
|
-
declare function RedactRuleToJSONTyped(value?: RedactRule | null, ignoreDiscriminator?: boolean): any;
|
|
345
|
-
//#endregion
|
|
346
|
-
//#region src/models/ReplaceRule.d.ts
|
|
347
|
-
/**
|
|
348
|
-
*
|
|
349
|
-
* @export
|
|
350
|
-
* @interface ReplaceRule
|
|
351
|
-
*/
|
|
352
|
-
interface ReplaceRule {
|
|
265
|
+
key?: string;
|
|
353
266
|
/**
|
|
354
|
-
*
|
|
267
|
+
* The character used to mask, e.g. '*'.
|
|
355
268
|
* @type {string}
|
|
356
|
-
* @memberof
|
|
269
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
357
270
|
*/
|
|
358
|
-
|
|
271
|
+
masking_char?: string;
|
|
359
272
|
/**
|
|
360
273
|
*
|
|
361
|
-
* @type {
|
|
362
|
-
* @memberof
|
|
274
|
+
* @type {number}
|
|
275
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
363
276
|
*/
|
|
364
|
-
|
|
277
|
+
chars_to_mask?: number;
|
|
365
278
|
/**
|
|
366
|
-
*
|
|
367
|
-
* @type {
|
|
368
|
-
* @memberof
|
|
279
|
+
* If true, mask the last N characters instead of the first N.
|
|
280
|
+
* @type {boolean}
|
|
281
|
+
* @memberof AnonymizeRequestBodyRulesInner
|
|
369
282
|
*/
|
|
370
|
-
|
|
283
|
+
from_end?: boolean;
|
|
371
284
|
}
|
|
372
285
|
/**
|
|
373
286
|
* @export
|
|
374
287
|
*/
|
|
375
|
-
declare const
|
|
288
|
+
declare const AnonymizeRequestBodyRulesInnerTypeEnum: {
|
|
376
289
|
readonly replace: "replace";
|
|
377
|
-
|
|
378
|
-
type ReplaceRuleTypeEnum = typeof ReplaceRuleTypeEnum[keyof typeof ReplaceRuleTypeEnum];
|
|
379
|
-
/**
|
|
380
|
-
* Check if a given object implements the ReplaceRule interface.
|
|
381
|
-
*/
|
|
382
|
-
declare function instanceOfReplaceRule(value: object): value is ReplaceRule;
|
|
383
|
-
declare function ReplaceRuleFromJSON(json: any): ReplaceRule;
|
|
384
|
-
declare function ReplaceRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReplaceRule;
|
|
385
|
-
declare function ReplaceRuleToJSON(json: any): ReplaceRule;
|
|
386
|
-
declare function ReplaceRuleToJSONTyped(value?: ReplaceRule | null, ignoreDiscriminator?: boolean): any;
|
|
387
|
-
//#endregion
|
|
388
|
-
//#region src/models/SHA256Rule.d.ts
|
|
389
|
-
/**
|
|
390
|
-
*
|
|
391
|
-
* @export
|
|
392
|
-
* @interface SHA256Rule
|
|
393
|
-
*/
|
|
394
|
-
interface SHA256Rule {
|
|
395
|
-
/**
|
|
396
|
-
*
|
|
397
|
-
* @type {string}
|
|
398
|
-
* @memberof SHA256Rule
|
|
399
|
-
*/
|
|
400
|
-
type?: SHA256RuleTypeEnum;
|
|
401
|
-
/**
|
|
402
|
-
*
|
|
403
|
-
* @type {Entities}
|
|
404
|
-
* @memberof SHA256Rule
|
|
405
|
-
*/
|
|
406
|
-
entities: Entities;
|
|
407
|
-
}
|
|
408
|
-
/**
|
|
409
|
-
* @export
|
|
410
|
-
*/
|
|
411
|
-
declare const SHA256RuleTypeEnum: {
|
|
290
|
+
readonly redact: "redact";
|
|
412
291
|
readonly sha256: "sha256";
|
|
413
|
-
};
|
|
414
|
-
type SHA256RuleTypeEnum = typeof SHA256RuleTypeEnum[keyof typeof SHA256RuleTypeEnum];
|
|
415
|
-
/**
|
|
416
|
-
* Check if a given object implements the SHA256Rule interface.
|
|
417
|
-
*/
|
|
418
|
-
declare function instanceOfSHA256Rule(value: object): value is SHA256Rule;
|
|
419
|
-
declare function SHA256RuleFromJSON(json: any): SHA256Rule;
|
|
420
|
-
declare function SHA256RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA256Rule;
|
|
421
|
-
declare function SHA256RuleToJSON(json: any): SHA256Rule;
|
|
422
|
-
declare function SHA256RuleToJSONTyped(value?: SHA256Rule | null, ignoreDiscriminator?: boolean): any;
|
|
423
|
-
//#endregion
|
|
424
|
-
//#region src/models/SHA512Rule.d.ts
|
|
425
|
-
/**
|
|
426
|
-
*
|
|
427
|
-
* @export
|
|
428
|
-
* @interface SHA512Rule
|
|
429
|
-
*/
|
|
430
|
-
interface SHA512Rule {
|
|
431
|
-
/**
|
|
432
|
-
*
|
|
433
|
-
* @type {string}
|
|
434
|
-
* @memberof SHA512Rule
|
|
435
|
-
*/
|
|
436
|
-
type?: SHA512RuleTypeEnum;
|
|
437
|
-
/**
|
|
438
|
-
*
|
|
439
|
-
* @type {Entities}
|
|
440
|
-
* @memberof SHA512Rule
|
|
441
|
-
*/
|
|
442
|
-
entities: Entities;
|
|
443
|
-
}
|
|
444
|
-
/**
|
|
445
|
-
* @export
|
|
446
|
-
*/
|
|
447
|
-
declare const SHA512RuleTypeEnum: {
|
|
448
292
|
readonly sha512: "sha512";
|
|
293
|
+
readonly encrypt: "encrypt";
|
|
294
|
+
readonly mask: "mask";
|
|
295
|
+
readonly detect: "detect";
|
|
449
296
|
};
|
|
450
|
-
type
|
|
451
|
-
/**
|
|
452
|
-
* Check if a given object implements the SHA512Rule interface.
|
|
453
|
-
*/
|
|
454
|
-
declare function instanceOfSHA512Rule(value: object): value is SHA512Rule;
|
|
455
|
-
declare function SHA512RuleFromJSON(json: any): SHA512Rule;
|
|
456
|
-
declare function SHA512RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA512Rule;
|
|
457
|
-
declare function SHA512RuleToJSON(json: any): SHA512Rule;
|
|
458
|
-
declare function SHA512RuleToJSONTyped(value?: SHA512Rule | null, ignoreDiscriminator?: boolean): any;
|
|
459
|
-
//#endregion
|
|
460
|
-
//#region src/models/AnonymizeRequestBodyRulesInner.d.ts
|
|
297
|
+
type AnonymizeRequestBodyRulesInnerTypeEnum = typeof AnonymizeRequestBodyRulesInnerTypeEnum[keyof typeof AnonymizeRequestBodyRulesInnerTypeEnum];
|
|
461
298
|
/**
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
* @export
|
|
299
|
+
* Check if a given object implements the AnonymizeRequestBodyRulesInner interface.
|
|
465
300
|
*/
|
|
466
|
-
|
|
467
|
-
type: 'encrypt';
|
|
468
|
-
} & EncryptRule | {
|
|
469
|
-
type: 'mask';
|
|
470
|
-
} & MaskRule | {
|
|
471
|
-
type: 'redact';
|
|
472
|
-
} & RedactRule | {
|
|
473
|
-
type: 'replace';
|
|
474
|
-
} & ReplaceRule | {
|
|
475
|
-
type: 'sha256';
|
|
476
|
-
} & SHA256Rule | {
|
|
477
|
-
type: 'sha512';
|
|
478
|
-
} & SHA512Rule;
|
|
301
|
+
declare function instanceOfAnonymizeRequestBodyRulesInner(value: object): value is AnonymizeRequestBodyRulesInner;
|
|
479
302
|
declare function AnonymizeRequestBodyRulesInnerFromJSON(json: any): AnonymizeRequestBodyRulesInner;
|
|
480
303
|
declare function AnonymizeRequestBodyRulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeRequestBodyRulesInner;
|
|
481
|
-
declare function AnonymizeRequestBodyRulesInnerToJSON(json: any):
|
|
304
|
+
declare function AnonymizeRequestBodyRulesInnerToJSON(json: any): AnonymizeRequestBodyRulesInner;
|
|
482
305
|
declare function AnonymizeRequestBodyRulesInnerToJSONTyped(value?: AnonymizeRequestBodyRulesInner | null, ignoreDiscriminator?: boolean): any;
|
|
483
306
|
//#endregion
|
|
484
307
|
//#region src/models/AnonymizeRequestBody.d.ts
|
|
485
308
|
/**
|
|
309
|
+
* Request body for the anonymize endpoint.
|
|
486
310
|
*
|
|
311
|
+
* Carries the text to anonymize and the list of de-identification rules to
|
|
312
|
+
* apply. See ``AnonymizationCommand`` for field-level details.
|
|
487
313
|
* @export
|
|
488
314
|
* @interface AnonymizeRequestBody
|
|
489
315
|
*/
|
|
490
316
|
interface AnonymizeRequestBody {
|
|
491
317
|
/**
|
|
492
|
-
*
|
|
318
|
+
* The text to scan and anonymize. At most 128 KB in UTF-8.
|
|
493
319
|
* @type {string}
|
|
494
320
|
* @memberof AnonymizeRequestBody
|
|
495
321
|
*/
|
|
496
322
|
text: string;
|
|
497
323
|
/**
|
|
498
|
-
*
|
|
324
|
+
* The de-identification rules to apply. At least one is required. Optional when `policy` is supplied.
|
|
499
325
|
* @type {Array<AnonymizeRequestBodyRulesInner>}
|
|
500
326
|
* @memberof AnonymizeRequestBody
|
|
501
327
|
*/
|
|
502
|
-
rules
|
|
328
|
+
rules?: Array<AnonymizeRequestBodyRulesInner>;
|
|
503
329
|
/**
|
|
504
330
|
*
|
|
505
331
|
* @type {number}
|
|
506
332
|
* @memberof AnonymizeRequestBody
|
|
507
333
|
*/
|
|
508
334
|
confidence_threshold?: number | null;
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof AnonymizeRequestBody
|
|
339
|
+
*/
|
|
340
|
+
policy?: string | null;
|
|
509
341
|
}
|
|
510
342
|
/**
|
|
511
343
|
* Check if a given object implements the AnonymizeRequestBody interface.
|
|
@@ -516,12 +348,59 @@ declare function AnonymizeRequestBodyFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
516
348
|
declare function AnonymizeRequestBodyToJSON(json: any): AnonymizeRequestBody;
|
|
517
349
|
declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody | null, ignoreDiscriminator?: boolean): any;
|
|
518
350
|
//#endregion
|
|
351
|
+
//#region src/models/Usage.d.ts
|
|
352
|
+
/**
|
|
353
|
+
* Sensitive Data Protection API
|
|
354
|
+
* 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).
|
|
355
|
+
*
|
|
356
|
+
* The version of the OpenAPI document: 0.1.0
|
|
357
|
+
*
|
|
358
|
+
*
|
|
359
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
360
|
+
* https://openapi-generator.tech
|
|
361
|
+
* Do not edit the class manually.
|
|
362
|
+
*/
|
|
363
|
+
/**
|
|
364
|
+
* What one request cost, the unit billing meters against.
|
|
365
|
+
*
|
|
366
|
+
* Only the text the model scanned is counted. Anonymized output is built from
|
|
367
|
+
* the input by substitution, not generated, so counting it would charge twice
|
|
368
|
+
* for the same text.
|
|
369
|
+
*
|
|
370
|
+
* Counted with the detection model's own tokenizer, excluding special tokens,
|
|
371
|
+
* so the same text always costs the same for a given model.
|
|
372
|
+
* @export
|
|
373
|
+
* @interface Usage
|
|
374
|
+
*/
|
|
375
|
+
interface Usage {
|
|
376
|
+
/**
|
|
377
|
+
* Tokens in the text the model scanned.
|
|
378
|
+
* @type {number}
|
|
379
|
+
* @memberof Usage
|
|
380
|
+
*/
|
|
381
|
+
input_tokens: number;
|
|
382
|
+
/**
|
|
383
|
+
* Milliseconds spent in the model. Excludes tokenizing, validation and serialization.
|
|
384
|
+
* @type {number}
|
|
385
|
+
* @memberof Usage
|
|
386
|
+
*/
|
|
387
|
+
inference_ms: number;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* Check if a given object implements the Usage interface.
|
|
391
|
+
*/
|
|
392
|
+
declare function instanceOfUsage(value: object): value is Usage;
|
|
393
|
+
declare function UsageFromJSON(json: any): Usage;
|
|
394
|
+
declare function UsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Usage;
|
|
395
|
+
declare function UsageToJSON(json: any): Usage;
|
|
396
|
+
declare function UsageToJSONTyped(value?: Usage | null, ignoreDiscriminator?: boolean): any;
|
|
397
|
+
//#endregion
|
|
519
398
|
//#region src/models/TextRange.d.ts
|
|
520
399
|
/**
|
|
521
400
|
* Sensitive Data Protection API
|
|
522
|
-
*
|
|
401
|
+
* 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).
|
|
523
402
|
*
|
|
524
|
-
* The version of the OpenAPI document: 0.0
|
|
403
|
+
* The version of the OpenAPI document: 0.1.0
|
|
525
404
|
*
|
|
526
405
|
*
|
|
527
406
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -562,177 +441,443 @@ declare function TextRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean)
|
|
|
562
441
|
declare function TextRangeToJSON(json: any): TextRange;
|
|
563
442
|
declare function TextRangeToJSONTyped(value?: TextRange | null, ignoreDiscriminator?: boolean): any;
|
|
564
443
|
//#endregion
|
|
565
|
-
//#region src/models/
|
|
444
|
+
//#region src/models/AnonymizeResponseBodyResultsInner.d.ts
|
|
566
445
|
/**
|
|
567
|
-
* Record of an AI model detection and its anonymization.
|
|
568
446
|
*
|
|
569
|
-
* Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
|
|
570
|
-
* and a rule anonymizes the matched text.
|
|
571
447
|
* @export
|
|
572
|
-
* @interface
|
|
448
|
+
* @interface AnonymizeResponseBodyResultsInner
|
|
573
449
|
*/
|
|
574
|
-
interface
|
|
450
|
+
interface AnonymizeResponseBodyResultsInner {
|
|
575
451
|
/**
|
|
576
452
|
*
|
|
577
453
|
* @type {string}
|
|
578
|
-
* @memberof
|
|
454
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
579
455
|
*/
|
|
580
|
-
type?:
|
|
456
|
+
type?: AnonymizeResponseBodyResultsInnerTypeEnum;
|
|
581
457
|
/**
|
|
582
458
|
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
583
459
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
460
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
585
461
|
*/
|
|
586
462
|
rule: string;
|
|
587
463
|
/**
|
|
588
|
-
* The
|
|
464
|
+
* The regex pattern that matched.
|
|
589
465
|
* @type {string}
|
|
590
|
-
* @memberof
|
|
466
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
591
467
|
*/
|
|
592
468
|
value: string;
|
|
593
469
|
/**
|
|
594
470
|
* The detected range in the original text.
|
|
595
471
|
* @type {TextRange}
|
|
596
|
-
* @memberof
|
|
472
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
597
473
|
*/
|
|
598
474
|
input: TextRange;
|
|
599
475
|
/**
|
|
600
476
|
* The anonymized range in the result text.
|
|
601
477
|
* @type {TextRange}
|
|
602
|
-
* @memberof
|
|
478
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
603
479
|
*/
|
|
604
480
|
output: TextRange;
|
|
605
481
|
/**
|
|
606
482
|
* Confidence score from the AI model (0.0–1.0).
|
|
607
483
|
* @type {number}
|
|
608
|
-
* @memberof
|
|
484
|
+
* @memberof AnonymizeResponseBodyResultsInner
|
|
609
485
|
*/
|
|
610
486
|
score?: number;
|
|
611
487
|
}
|
|
612
488
|
/**
|
|
613
489
|
* @export
|
|
614
490
|
*/
|
|
615
|
-
declare const
|
|
491
|
+
declare const AnonymizeResponseBodyResultsInnerTypeEnum: {
|
|
616
492
|
readonly model: "model";
|
|
493
|
+
readonly regex: "regex";
|
|
617
494
|
};
|
|
618
|
-
type
|
|
495
|
+
type AnonymizeResponseBodyResultsInnerTypeEnum = typeof AnonymizeResponseBodyResultsInnerTypeEnum[keyof typeof AnonymizeResponseBodyResultsInnerTypeEnum];
|
|
619
496
|
/**
|
|
620
|
-
* Check if a given object implements the
|
|
497
|
+
* Check if a given object implements the AnonymizeResponseBodyResultsInner interface.
|
|
621
498
|
*/
|
|
622
|
-
declare function
|
|
623
|
-
declare function
|
|
624
|
-
declare function
|
|
625
|
-
declare function
|
|
626
|
-
declare function
|
|
499
|
+
declare function instanceOfAnonymizeResponseBodyResultsInner(value: object): value is AnonymizeResponseBodyResultsInner;
|
|
500
|
+
declare function AnonymizeResponseBodyResultsInnerFromJSON(json: any): AnonymizeResponseBodyResultsInner;
|
|
501
|
+
declare function AnonymizeResponseBodyResultsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeResponseBodyResultsInner;
|
|
502
|
+
declare function AnonymizeResponseBodyResultsInnerToJSON(json: any): AnonymizeResponseBodyResultsInner;
|
|
503
|
+
declare function AnonymizeResponseBodyResultsInnerToJSONTyped(value?: AnonymizeResponseBodyResultsInner | null, ignoreDiscriminator?: boolean): any;
|
|
627
504
|
//#endregion
|
|
628
|
-
//#region src/models/
|
|
505
|
+
//#region src/models/AnonymizeResponseBody.d.ts
|
|
506
|
+
/**
|
|
507
|
+
* Response from the anonymize endpoint: the anonymized text and a record
|
|
508
|
+
* of every transformation that was applied.
|
|
509
|
+
* @export
|
|
510
|
+
* @interface AnonymizeResponseBody
|
|
511
|
+
*/
|
|
512
|
+
interface AnonymizeResponseBody {
|
|
513
|
+
/**
|
|
514
|
+
* The anonymized text after all rules have been applied.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof AnonymizeResponseBody
|
|
517
|
+
*/
|
|
518
|
+
text: string;
|
|
519
|
+
/**
|
|
520
|
+
* Records of each anonymization performed, ordered by position.
|
|
521
|
+
* @type {Array<AnonymizeResponseBodyResultsInner>}
|
|
522
|
+
* @memberof AnonymizeResponseBody
|
|
523
|
+
*/
|
|
524
|
+
results?: Array<AnonymizeResponseBodyResultsInner>;
|
|
525
|
+
/**
|
|
526
|
+
* Token counts for this request.
|
|
527
|
+
* @type {Usage}
|
|
528
|
+
* @memberof AnonymizeResponseBody
|
|
529
|
+
*/
|
|
530
|
+
usage: Usage;
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* Check if a given object implements the AnonymizeResponseBody interface.
|
|
534
|
+
*/
|
|
535
|
+
declare function instanceOfAnonymizeResponseBody(value: object): value is AnonymizeResponseBody;
|
|
536
|
+
declare function AnonymizeResponseBodyFromJSON(json: any): AnonymizeResponseBody;
|
|
537
|
+
declare function AnonymizeResponseBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeResponseBody;
|
|
538
|
+
declare function AnonymizeResponseBodyToJSON(json: any): AnonymizeResponseBody;
|
|
539
|
+
declare function AnonymizeResponseBodyToJSONTyped(value?: AnonymizeResponseBody | null, ignoreDiscriminator?: boolean): any;
|
|
540
|
+
//#endregion
|
|
541
|
+
//#region src/models/PolicyDocumentRulesInner.d.ts
|
|
629
542
|
/**
|
|
630
|
-
* Record of a regex detection and its anonymization.
|
|
631
543
|
*
|
|
632
|
-
* Created when a regex pattern matches text
|
|
633
|
-
* and a rule anonymizes the matched text.
|
|
634
544
|
* @export
|
|
635
|
-
* @interface
|
|
545
|
+
* @interface PolicyDocumentRulesInner
|
|
636
546
|
*/
|
|
637
|
-
interface
|
|
547
|
+
interface PolicyDocumentRulesInner {
|
|
638
548
|
/**
|
|
639
549
|
*
|
|
640
550
|
* @type {string}
|
|
641
|
-
* @memberof
|
|
551
|
+
* @memberof PolicyDocumentRulesInner
|
|
642
552
|
*/
|
|
643
|
-
type?:
|
|
553
|
+
type?: PolicyDocumentRulesInnerTypeEnum;
|
|
644
554
|
/**
|
|
645
|
-
* The rule
|
|
555
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
556
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
557
|
+
* @memberof PolicyDocumentRulesInner
|
|
558
|
+
*/
|
|
559
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
560
|
+
/**
|
|
561
|
+
* The fixed string to substitute for each match.
|
|
646
562
|
* @type {string}
|
|
647
|
-
* @memberof
|
|
563
|
+
* @memberof PolicyDocumentRulesInner
|
|
648
564
|
*/
|
|
649
|
-
|
|
565
|
+
replacement?: string;
|
|
650
566
|
/**
|
|
651
|
-
* The
|
|
567
|
+
* The character used to mask, e.g. '*'.
|
|
652
568
|
* @type {string}
|
|
653
|
-
* @memberof
|
|
569
|
+
* @memberof PolicyDocumentRulesInner
|
|
654
570
|
*/
|
|
655
|
-
|
|
571
|
+
masking_char?: string;
|
|
656
572
|
/**
|
|
657
|
-
*
|
|
658
|
-
* @type {
|
|
659
|
-
* @memberof
|
|
573
|
+
*
|
|
574
|
+
* @type {number}
|
|
575
|
+
* @memberof PolicyDocumentRulesInner
|
|
660
576
|
*/
|
|
661
|
-
|
|
577
|
+
chars_to_mask?: number;
|
|
662
578
|
/**
|
|
663
|
-
*
|
|
664
|
-
* @type {
|
|
665
|
-
* @memberof
|
|
579
|
+
* If true, mask the last N characters instead of the first N.
|
|
580
|
+
* @type {boolean}
|
|
581
|
+
* @memberof PolicyDocumentRulesInner
|
|
666
582
|
*/
|
|
667
|
-
|
|
583
|
+
from_end?: boolean;
|
|
584
|
+
/**
|
|
585
|
+
* Base64 Fernet key. If empty, a key is generated automatically.
|
|
586
|
+
* @type {string}
|
|
587
|
+
* @memberof PolicyDocumentRulesInner
|
|
588
|
+
*/
|
|
589
|
+
key?: string;
|
|
668
590
|
}
|
|
669
591
|
/**
|
|
670
592
|
* @export
|
|
671
593
|
*/
|
|
672
|
-
declare const
|
|
673
|
-
readonly
|
|
594
|
+
declare const PolicyDocumentRulesInnerTypeEnum: {
|
|
595
|
+
readonly detect: "detect";
|
|
596
|
+
readonly redact: "redact";
|
|
597
|
+
readonly replace: "replace";
|
|
598
|
+
readonly mask: "mask";
|
|
599
|
+
readonly sha256: "sha256";
|
|
600
|
+
readonly sha512: "sha512";
|
|
601
|
+
readonly encrypt: "encrypt";
|
|
674
602
|
};
|
|
675
|
-
type
|
|
603
|
+
type PolicyDocumentRulesInnerTypeEnum = typeof PolicyDocumentRulesInnerTypeEnum[keyof typeof PolicyDocumentRulesInnerTypeEnum];
|
|
676
604
|
/**
|
|
677
|
-
* Check if a given object implements the
|
|
605
|
+
* Check if a given object implements the PolicyDocumentRulesInner interface.
|
|
678
606
|
*/
|
|
679
|
-
declare function
|
|
680
|
-
declare function
|
|
681
|
-
declare function
|
|
682
|
-
declare function
|
|
683
|
-
declare function
|
|
607
|
+
declare function instanceOfPolicyDocumentRulesInner(value: object): value is PolicyDocumentRulesInner;
|
|
608
|
+
declare function PolicyDocumentRulesInnerFromJSON(json: any): PolicyDocumentRulesInner;
|
|
609
|
+
declare function PolicyDocumentRulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDocumentRulesInner;
|
|
610
|
+
declare function PolicyDocumentRulesInnerToJSON(json: any): PolicyDocumentRulesInner;
|
|
611
|
+
declare function PolicyDocumentRulesInnerToJSONTyped(value?: PolicyDocumentRulesInner | null, ignoreDiscriminator?: boolean): any;
|
|
684
612
|
//#endregion
|
|
685
|
-
//#region src/models/
|
|
613
|
+
//#region src/models/PolicyDocument.d.ts
|
|
614
|
+
/**
|
|
615
|
+
* A reusable set of de-identification rules. Rules are ORDERED: overlapping matches are resolved first-match-wins, so a detect rule placed before a transform shields those spans from being rewritten.
|
|
616
|
+
* @export
|
|
617
|
+
* @interface PolicyDocument
|
|
618
|
+
*/
|
|
619
|
+
interface PolicyDocument {
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @type {number}
|
|
623
|
+
* @memberof PolicyDocument
|
|
624
|
+
*/
|
|
625
|
+
schema_version: PolicyDocumentSchemaVersionEnum;
|
|
626
|
+
/**
|
|
627
|
+
*
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof PolicyDocument
|
|
630
|
+
*/
|
|
631
|
+
name?: string;
|
|
632
|
+
/**
|
|
633
|
+
*
|
|
634
|
+
* @type {number}
|
|
635
|
+
* @memberof PolicyDocument
|
|
636
|
+
*/
|
|
637
|
+
confidence_threshold?: number | null;
|
|
638
|
+
/**
|
|
639
|
+
*
|
|
640
|
+
* @type {Array<PolicyDocumentRulesInner>}
|
|
641
|
+
* @memberof PolicyDocument
|
|
642
|
+
*/
|
|
643
|
+
rules: Array<PolicyDocumentRulesInner>;
|
|
644
|
+
}
|
|
645
|
+
/**
|
|
646
|
+
* @export
|
|
647
|
+
*/
|
|
648
|
+
declare const PolicyDocumentSchemaVersionEnum: {
|
|
649
|
+
readonly NUMBER_1: 1;
|
|
650
|
+
};
|
|
651
|
+
type PolicyDocumentSchemaVersionEnum = typeof PolicyDocumentSchemaVersionEnum[keyof typeof PolicyDocumentSchemaVersionEnum];
|
|
652
|
+
/**
|
|
653
|
+
* Check if a given object implements the PolicyDocument interface.
|
|
654
|
+
*/
|
|
655
|
+
declare function instanceOfPolicyDocument(value: object): value is PolicyDocument;
|
|
656
|
+
declare function PolicyDocumentFromJSON(json: any): PolicyDocument;
|
|
657
|
+
declare function PolicyDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDocument;
|
|
658
|
+
declare function PolicyDocumentToJSON(json: any): PolicyDocument;
|
|
659
|
+
declare function PolicyDocumentToJSONTyped(value?: PolicyDocument | null, ignoreDiscriminator?: boolean): any;
|
|
660
|
+
//#endregion
|
|
661
|
+
//#region src/models/CreatePolicyRequest.d.ts
|
|
686
662
|
/**
|
|
687
|
-
* @type AnonymizeResponseBodySpansInner
|
|
688
663
|
*
|
|
689
664
|
* @export
|
|
665
|
+
* @interface CreatePolicyRequest
|
|
690
666
|
*/
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
667
|
+
interface CreatePolicyRequest {
|
|
668
|
+
/**
|
|
669
|
+
*
|
|
670
|
+
* @type {string}
|
|
671
|
+
* @memberof CreatePolicyRequest
|
|
672
|
+
*/
|
|
673
|
+
name: string;
|
|
674
|
+
/**
|
|
675
|
+
*
|
|
676
|
+
* @type {PolicyDocument}
|
|
677
|
+
* @memberof CreatePolicyRequest
|
|
678
|
+
*/
|
|
679
|
+
document: PolicyDocument;
|
|
680
|
+
}
|
|
681
|
+
/**
|
|
682
|
+
* Check if a given object implements the CreatePolicyRequest interface.
|
|
683
|
+
*/
|
|
684
|
+
declare function instanceOfCreatePolicyRequest(value: object): value is CreatePolicyRequest;
|
|
685
|
+
declare function CreatePolicyRequestFromJSON(json: any): CreatePolicyRequest;
|
|
686
|
+
declare function CreatePolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePolicyRequest;
|
|
687
|
+
declare function CreatePolicyRequestToJSON(json: any): CreatePolicyRequest;
|
|
688
|
+
declare function CreatePolicyRequestToJSONTyped(value?: CreatePolicyRequest | null, ignoreDiscriminator?: boolean): any;
|
|
700
689
|
//#endregion
|
|
701
|
-
//#region src/models/
|
|
690
|
+
//#region src/models/DetectRule.d.ts
|
|
702
691
|
/**
|
|
692
|
+
* Report each matched value without changing it.
|
|
703
693
|
*
|
|
694
|
+
* The match is recorded in the results like any other rule, but the text is
|
|
695
|
+
* returned untouched — this is how a policy says "flag this, don't rewrite
|
|
696
|
+
* it", which is what the browser extension needs when it must not edit the
|
|
697
|
+
* user's prompt.
|
|
698
|
+
*
|
|
699
|
+
* Because overlapping spans are resolved first-match-wins, placing a detect
|
|
700
|
+
* rule before a transform also shields those spans from being rewritten.
|
|
704
701
|
* @export
|
|
705
|
-
* @interface
|
|
702
|
+
* @interface DetectRule
|
|
706
703
|
*/
|
|
707
|
-
interface
|
|
704
|
+
interface DetectRule {
|
|
708
705
|
/**
|
|
709
706
|
*
|
|
710
707
|
* @type {string}
|
|
711
|
-
* @memberof
|
|
708
|
+
* @memberof DetectRule
|
|
712
709
|
*/
|
|
713
|
-
|
|
710
|
+
type?: DetectRuleTypeEnum;
|
|
711
|
+
/**
|
|
712
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
713
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
714
|
+
* @memberof DetectRule
|
|
715
|
+
*/
|
|
716
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* @export
|
|
720
|
+
*/
|
|
721
|
+
declare const DetectRuleTypeEnum: {
|
|
722
|
+
readonly detect: "detect";
|
|
723
|
+
};
|
|
724
|
+
type DetectRuleTypeEnum = typeof DetectRuleTypeEnum[keyof typeof DetectRuleTypeEnum];
|
|
725
|
+
/**
|
|
726
|
+
* Check if a given object implements the DetectRule interface.
|
|
727
|
+
*/
|
|
728
|
+
declare function instanceOfDetectRule(value: object): value is DetectRule;
|
|
729
|
+
declare function DetectRuleFromJSON(json: any): DetectRule;
|
|
730
|
+
declare function DetectRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): DetectRule;
|
|
731
|
+
declare function DetectRuleToJSON(json: any): DetectRule;
|
|
732
|
+
declare function DetectRuleToJSONTyped(value?: DetectRule | null, ignoreDiscriminator?: boolean): any;
|
|
733
|
+
//#endregion
|
|
734
|
+
//#region src/models/EncryptRule.d.ts
|
|
735
|
+
/**
|
|
736
|
+
* Replace each matched value with a Fernet-encrypted token.
|
|
737
|
+
*
|
|
738
|
+
* If no key is supplied, a new Fernet key is generated per rule instance.
|
|
739
|
+
* @export
|
|
740
|
+
* @interface EncryptRule
|
|
741
|
+
*/
|
|
742
|
+
interface EncryptRule {
|
|
714
743
|
/**
|
|
715
744
|
*
|
|
716
|
-
* @type {
|
|
717
|
-
* @memberof
|
|
745
|
+
* @type {string}
|
|
746
|
+
* @memberof EncryptRule
|
|
718
747
|
*/
|
|
719
|
-
|
|
748
|
+
type?: EncryptRuleTypeEnum;
|
|
749
|
+
/**
|
|
750
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
751
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
752
|
+
* @memberof EncryptRule
|
|
753
|
+
*/
|
|
754
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
755
|
+
/**
|
|
756
|
+
* Base64 Fernet key. If empty, a key is generated automatically.
|
|
757
|
+
* @type {string}
|
|
758
|
+
* @memberof EncryptRule
|
|
759
|
+
*/
|
|
760
|
+
key?: string;
|
|
720
761
|
}
|
|
721
762
|
/**
|
|
722
|
-
*
|
|
763
|
+
* @export
|
|
723
764
|
*/
|
|
724
|
-
declare
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
765
|
+
declare const EncryptRuleTypeEnum: {
|
|
766
|
+
readonly encrypt: "encrypt";
|
|
767
|
+
};
|
|
768
|
+
type EncryptRuleTypeEnum = typeof EncryptRuleTypeEnum[keyof typeof EncryptRuleTypeEnum];
|
|
769
|
+
/**
|
|
770
|
+
* Check if a given object implements the EncryptRule interface.
|
|
771
|
+
*/
|
|
772
|
+
declare function instanceOfEncryptRule(value: object): value is EncryptRule;
|
|
773
|
+
declare function EncryptRuleFromJSON(json: any): EncryptRule;
|
|
774
|
+
declare function EncryptRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): EncryptRule;
|
|
775
|
+
declare function EncryptRuleToJSON(json: any): EncryptRule;
|
|
776
|
+
declare function EncryptRuleToJSONTyped(value?: EncryptRule | null, ignoreDiscriminator?: boolean): any;
|
|
729
777
|
//#endregion
|
|
730
|
-
//#region src/models/
|
|
778
|
+
//#region src/models/ValidationErrorLocInner.d.ts
|
|
779
|
+
/**
|
|
780
|
+
* Sensitive Data Protection API
|
|
781
|
+
* 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).
|
|
782
|
+
*
|
|
783
|
+
* The version of the OpenAPI document: 0.1.0
|
|
784
|
+
*
|
|
785
|
+
*
|
|
786
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
787
|
+
* https://openapi-generator.tech
|
|
788
|
+
* Do not edit the class manually.
|
|
789
|
+
*/
|
|
790
|
+
/**
|
|
791
|
+
*
|
|
792
|
+
* @export
|
|
793
|
+
* @interface ValidationErrorLocInner
|
|
794
|
+
*/
|
|
795
|
+
interface ValidationErrorLocInner {}
|
|
796
|
+
/**
|
|
797
|
+
* Check if a given object implements the ValidationErrorLocInner interface.
|
|
798
|
+
*/
|
|
799
|
+
declare function instanceOfValidationErrorLocInner(value: object): value is ValidationErrorLocInner;
|
|
800
|
+
declare function ValidationErrorLocInnerFromJSON(json: any): ValidationErrorLocInner;
|
|
801
|
+
declare function ValidationErrorLocInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationErrorLocInner;
|
|
802
|
+
declare function ValidationErrorLocInnerToJSON(json: any): ValidationErrorLocInner;
|
|
803
|
+
declare function ValidationErrorLocInnerToJSONTyped(value?: ValidationErrorLocInner | null, ignoreDiscriminator?: boolean): any;
|
|
804
|
+
//#endregion
|
|
805
|
+
//#region src/models/ValidationError.d.ts
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @export
|
|
809
|
+
* @interface ValidationError
|
|
810
|
+
*/
|
|
811
|
+
interface ValidationError {
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {Array<ValidationErrorLocInner>}
|
|
815
|
+
* @memberof ValidationError
|
|
816
|
+
*/
|
|
817
|
+
loc: Array<ValidationErrorLocInner>;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {string}
|
|
821
|
+
* @memberof ValidationError
|
|
822
|
+
*/
|
|
823
|
+
msg: string;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof ValidationError
|
|
828
|
+
*/
|
|
829
|
+
type: string;
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
* @type {any}
|
|
833
|
+
* @memberof ValidationError
|
|
834
|
+
*/
|
|
835
|
+
input?: any | null;
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {object}
|
|
839
|
+
* @memberof ValidationError
|
|
840
|
+
*/
|
|
841
|
+
ctx?: object;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* Check if a given object implements the ValidationError interface.
|
|
845
|
+
*/
|
|
846
|
+
declare function instanceOfValidationError(value: object): value is ValidationError;
|
|
847
|
+
declare function ValidationErrorFromJSON(json: any): ValidationError;
|
|
848
|
+
declare function ValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationError;
|
|
849
|
+
declare function ValidationErrorToJSON(json: any): ValidationError;
|
|
850
|
+
declare function ValidationErrorToJSONTyped(value?: ValidationError | null, ignoreDiscriminator?: boolean): any;
|
|
851
|
+
//#endregion
|
|
852
|
+
//#region src/models/HTTPValidationError.d.ts
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @export
|
|
856
|
+
* @interface HTTPValidationError
|
|
857
|
+
*/
|
|
858
|
+
interface HTTPValidationError {
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {Array<ValidationError>}
|
|
862
|
+
* @memberof HTTPValidationError
|
|
863
|
+
*/
|
|
864
|
+
detail?: Array<ValidationError>;
|
|
865
|
+
}
|
|
866
|
+
/**
|
|
867
|
+
* Check if a given object implements the HTTPValidationError interface.
|
|
868
|
+
*/
|
|
869
|
+
declare function instanceOfHTTPValidationError(value: object): value is HTTPValidationError;
|
|
870
|
+
declare function HTTPValidationErrorFromJSON(json: any): HTTPValidationError;
|
|
871
|
+
declare function HTTPValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): HTTPValidationError;
|
|
872
|
+
declare function HTTPValidationErrorToJSON(json: any): HTTPValidationError;
|
|
873
|
+
declare function HTTPValidationErrorToJSONTyped(value?: HTTPValidationError | null, ignoreDiscriminator?: boolean): any;
|
|
874
|
+
//#endregion
|
|
875
|
+
//#region src/models/PolicySummary.d.ts
|
|
731
876
|
/**
|
|
732
877
|
* Sensitive Data Protection API
|
|
733
|
-
*
|
|
878
|
+
* 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).
|
|
734
879
|
*
|
|
735
|
-
* The version of the OpenAPI document: 0.0
|
|
880
|
+
* The version of the OpenAPI document: 0.1.0
|
|
736
881
|
*
|
|
737
882
|
*
|
|
738
883
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -742,6 +887,144 @@ declare function AnonymizeResponseBodyToJSONTyped(value?: AnonymizeResponseBody
|
|
|
742
887
|
/**
|
|
743
888
|
*
|
|
744
889
|
* @export
|
|
890
|
+
* @interface PolicySummary
|
|
891
|
+
*/
|
|
892
|
+
interface PolicySummary {
|
|
893
|
+
/**
|
|
894
|
+
*
|
|
895
|
+
* @type {string}
|
|
896
|
+
* @memberof PolicySummary
|
|
897
|
+
*/
|
|
898
|
+
id: string;
|
|
899
|
+
/**
|
|
900
|
+
*
|
|
901
|
+
* @type {string}
|
|
902
|
+
* @memberof PolicySummary
|
|
903
|
+
*/
|
|
904
|
+
name: string;
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @type {string}
|
|
908
|
+
* @memberof PolicySummary
|
|
909
|
+
*/
|
|
910
|
+
versionId: string;
|
|
911
|
+
/**
|
|
912
|
+
*
|
|
913
|
+
* @type {number}
|
|
914
|
+
* @memberof PolicySummary
|
|
915
|
+
*/
|
|
916
|
+
createdAt: number;
|
|
917
|
+
/**
|
|
918
|
+
*
|
|
919
|
+
* @type {number}
|
|
920
|
+
* @memberof PolicySummary
|
|
921
|
+
*/
|
|
922
|
+
updatedAt: number;
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* Check if a given object implements the PolicySummary interface.
|
|
926
|
+
*/
|
|
927
|
+
declare function instanceOfPolicySummary(value: object): value is PolicySummary;
|
|
928
|
+
declare function PolicySummaryFromJSON(json: any): PolicySummary;
|
|
929
|
+
declare function PolicySummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicySummary;
|
|
930
|
+
declare function PolicySummaryToJSON(json: any): PolicySummary;
|
|
931
|
+
declare function PolicySummaryToJSONTyped(value?: PolicySummary | null, ignoreDiscriminator?: boolean): any;
|
|
932
|
+
//#endregion
|
|
933
|
+
//#region src/models/ListPolicies200Response.d.ts
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @export
|
|
937
|
+
* @interface ListPolicies200Response
|
|
938
|
+
*/
|
|
939
|
+
interface ListPolicies200Response {
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {Array<PolicySummary>}
|
|
943
|
+
* @memberof ListPolicies200Response
|
|
944
|
+
*/
|
|
945
|
+
policies: Array<PolicySummary>;
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* Check if a given object implements the ListPolicies200Response interface.
|
|
949
|
+
*/
|
|
950
|
+
declare function instanceOfListPolicies200Response(value: object): value is ListPolicies200Response;
|
|
951
|
+
declare function ListPolicies200ResponseFromJSON(json: any): ListPolicies200Response;
|
|
952
|
+
declare function ListPolicies200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListPolicies200Response;
|
|
953
|
+
declare function ListPolicies200ResponseToJSON(json: any): ListPolicies200Response;
|
|
954
|
+
declare function ListPolicies200ResponseToJSONTyped(value?: ListPolicies200Response | null, ignoreDiscriminator?: boolean): any;
|
|
955
|
+
//#endregion
|
|
956
|
+
//#region src/models/MaskRule.d.ts
|
|
957
|
+
/**
|
|
958
|
+
* Mask part of each matched value with a repeated character.
|
|
959
|
+
*
|
|
960
|
+
* By default the whole value is masked; set ``chars_to_mask`` to mask only a
|
|
961
|
+
* portion, and ``from_end`` to mask the trailing characters instead of leading.
|
|
962
|
+
* @export
|
|
963
|
+
* @interface MaskRule
|
|
964
|
+
*/
|
|
965
|
+
interface MaskRule {
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @type {string}
|
|
969
|
+
* @memberof MaskRule
|
|
970
|
+
*/
|
|
971
|
+
type?: MaskRuleTypeEnum;
|
|
972
|
+
/**
|
|
973
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
974
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
975
|
+
* @memberof MaskRule
|
|
976
|
+
*/
|
|
977
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
978
|
+
/**
|
|
979
|
+
* The character used to mask, e.g. '*'.
|
|
980
|
+
* @type {string}
|
|
981
|
+
* @memberof MaskRule
|
|
982
|
+
*/
|
|
983
|
+
masking_char?: string;
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {number}
|
|
987
|
+
* @memberof MaskRule
|
|
988
|
+
*/
|
|
989
|
+
chars_to_mask?: number | null;
|
|
990
|
+
/**
|
|
991
|
+
* If true, mask the last N characters instead of the first N.
|
|
992
|
+
* @type {boolean}
|
|
993
|
+
* @memberof MaskRule
|
|
994
|
+
*/
|
|
995
|
+
from_end?: boolean;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* @export
|
|
999
|
+
*/
|
|
1000
|
+
declare const MaskRuleTypeEnum: {
|
|
1001
|
+
readonly mask: "mask";
|
|
1002
|
+
};
|
|
1003
|
+
type MaskRuleTypeEnum = typeof MaskRuleTypeEnum[keyof typeof MaskRuleTypeEnum];
|
|
1004
|
+
/**
|
|
1005
|
+
* Check if a given object implements the MaskRule interface.
|
|
1006
|
+
*/
|
|
1007
|
+
declare function instanceOfMaskRule(value: object): value is MaskRule;
|
|
1008
|
+
declare function MaskRuleFromJSON(json: any): MaskRule;
|
|
1009
|
+
declare function MaskRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): MaskRule;
|
|
1010
|
+
declare function MaskRuleToJSON(json: any): MaskRule;
|
|
1011
|
+
declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminator?: boolean): any;
|
|
1012
|
+
//#endregion
|
|
1013
|
+
//#region src/models/ModelEntity.d.ts
|
|
1014
|
+
/**
|
|
1015
|
+
* Sensitive Data Protection API
|
|
1016
|
+
* 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).
|
|
1017
|
+
*
|
|
1018
|
+
* The version of the OpenAPI document: 0.1.0
|
|
1019
|
+
*
|
|
1020
|
+
*
|
|
1021
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1022
|
+
* https://openapi-generator.tech
|
|
1023
|
+
* Do not edit the class manually.
|
|
1024
|
+
*/
|
|
1025
|
+
/**
|
|
1026
|
+
* An AI-model entity type to target, e.g. 'PERSON', 'EMAIL', 'LOCATION'.
|
|
1027
|
+
* @export
|
|
745
1028
|
* @interface ModelEntity
|
|
746
1029
|
*/
|
|
747
1030
|
interface ModelEntity {
|
|
@@ -752,34 +1035,186 @@ interface ModelEntity {
|
|
|
752
1035
|
*/
|
|
753
1036
|
type?: ModelEntityTypeEnum;
|
|
754
1037
|
/**
|
|
755
|
-
*
|
|
756
|
-
* @type {string}
|
|
757
|
-
* @memberof ModelEntity
|
|
1038
|
+
* The model entity type name, e.g. 'PERSON'.
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof ModelEntity
|
|
1041
|
+
*/
|
|
1042
|
+
value: string;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
* @export
|
|
1046
|
+
*/
|
|
1047
|
+
declare const ModelEntityTypeEnum: {
|
|
1048
|
+
readonly model: "model";
|
|
1049
|
+
};
|
|
1050
|
+
type ModelEntityTypeEnum = typeof ModelEntityTypeEnum[keyof typeof ModelEntityTypeEnum];
|
|
1051
|
+
/**
|
|
1052
|
+
* Check if a given object implements the ModelEntity interface.
|
|
1053
|
+
*/
|
|
1054
|
+
declare function instanceOfModelEntity(value: object): value is ModelEntity;
|
|
1055
|
+
declare function ModelEntityFromJSON(json: any): ModelEntity;
|
|
1056
|
+
declare function ModelEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelEntity;
|
|
1057
|
+
declare function ModelEntityToJSON(json: any): ModelEntity;
|
|
1058
|
+
declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscriminator?: boolean): any;
|
|
1059
|
+
//#endregion
|
|
1060
|
+
//#region src/models/ModelResult.d.ts
|
|
1061
|
+
/**
|
|
1062
|
+
* Record of an AI model detection and its anonymization.
|
|
1063
|
+
*
|
|
1064
|
+
* Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
|
|
1065
|
+
* and a rule anonymizes the matched text.
|
|
1066
|
+
* @export
|
|
1067
|
+
* @interface ModelResult
|
|
1068
|
+
*/
|
|
1069
|
+
interface ModelResult {
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @type {string}
|
|
1073
|
+
* @memberof ModelResult
|
|
1074
|
+
*/
|
|
1075
|
+
type?: ModelResultTypeEnum;
|
|
1076
|
+
/**
|
|
1077
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
1078
|
+
* @type {string}
|
|
1079
|
+
* @memberof ModelResult
|
|
1080
|
+
*/
|
|
1081
|
+
rule: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* The model entity type that matched, e.g. 'PERSON'.
|
|
1084
|
+
* @type {string}
|
|
1085
|
+
* @memberof ModelResult
|
|
1086
|
+
*/
|
|
1087
|
+
value: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* The detected range in the original text.
|
|
1090
|
+
* @type {TextRange}
|
|
1091
|
+
* @memberof ModelResult
|
|
1092
|
+
*/
|
|
1093
|
+
input: TextRange;
|
|
1094
|
+
/**
|
|
1095
|
+
* The anonymized range in the result text.
|
|
1096
|
+
* @type {TextRange}
|
|
1097
|
+
* @memberof ModelResult
|
|
1098
|
+
*/
|
|
1099
|
+
output: TextRange;
|
|
1100
|
+
/**
|
|
1101
|
+
* Confidence score from the AI model (0.0–1.0).
|
|
1102
|
+
* @type {number}
|
|
1103
|
+
* @memberof ModelResult
|
|
1104
|
+
*/
|
|
1105
|
+
score?: number;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* @export
|
|
1109
|
+
*/
|
|
1110
|
+
declare const ModelResultTypeEnum: {
|
|
1111
|
+
readonly model: "model";
|
|
1112
|
+
};
|
|
1113
|
+
type ModelResultTypeEnum = typeof ModelResultTypeEnum[keyof typeof ModelResultTypeEnum];
|
|
1114
|
+
/**
|
|
1115
|
+
* Check if a given object implements the ModelResult interface.
|
|
1116
|
+
*/
|
|
1117
|
+
declare function instanceOfModelResult(value: object): value is ModelResult;
|
|
1118
|
+
declare function ModelResultFromJSON(json: any): ModelResult;
|
|
1119
|
+
declare function ModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelResult;
|
|
1120
|
+
declare function ModelResultToJSON(json: any): ModelResult;
|
|
1121
|
+
declare function ModelResultToJSONTyped(value?: ModelResult | null, ignoreDiscriminator?: boolean): any;
|
|
1122
|
+
//#endregion
|
|
1123
|
+
//#region src/models/Policy.d.ts
|
|
1124
|
+
/**
|
|
1125
|
+
*
|
|
1126
|
+
* @export
|
|
1127
|
+
* @interface Policy
|
|
1128
|
+
*/
|
|
1129
|
+
interface Policy {
|
|
1130
|
+
/**
|
|
1131
|
+
*
|
|
1132
|
+
* @type {string}
|
|
1133
|
+
* @memberof Policy
|
|
1134
|
+
*/
|
|
1135
|
+
id: string;
|
|
1136
|
+
/**
|
|
1137
|
+
*
|
|
1138
|
+
* @type {string}
|
|
1139
|
+
* @memberof Policy
|
|
1140
|
+
*/
|
|
1141
|
+
name: string;
|
|
1142
|
+
/**
|
|
1143
|
+
*
|
|
1144
|
+
* @type {string}
|
|
1145
|
+
* @memberof Policy
|
|
1146
|
+
*/
|
|
1147
|
+
versionId: string;
|
|
1148
|
+
/**
|
|
1149
|
+
*
|
|
1150
|
+
* @type {PolicyDocument}
|
|
1151
|
+
* @memberof Policy
|
|
1152
|
+
*/
|
|
1153
|
+
document: PolicyDocument;
|
|
1154
|
+
/**
|
|
1155
|
+
*
|
|
1156
|
+
* @type {number}
|
|
1157
|
+
* @memberof Policy
|
|
1158
|
+
*/
|
|
1159
|
+
createdAt: number;
|
|
1160
|
+
/**
|
|
1161
|
+
*
|
|
1162
|
+
* @type {number}
|
|
1163
|
+
* @memberof Policy
|
|
1164
|
+
*/
|
|
1165
|
+
updatedAt: number;
|
|
1166
|
+
}
|
|
1167
|
+
/**
|
|
1168
|
+
* Check if a given object implements the Policy interface.
|
|
1169
|
+
*/
|
|
1170
|
+
declare function instanceOfPolicy(value: object): value is Policy;
|
|
1171
|
+
declare function PolicyFromJSON(json: any): Policy;
|
|
1172
|
+
declare function PolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): Policy;
|
|
1173
|
+
declare function PolicyToJSON(json: any): Policy;
|
|
1174
|
+
declare function PolicyToJSONTyped(value?: Policy | null, ignoreDiscriminator?: boolean): any;
|
|
1175
|
+
//#endregion
|
|
1176
|
+
//#region src/models/RedactRule.d.ts
|
|
1177
|
+
/**
|
|
1178
|
+
* Remove each matched value entirely (replace with an empty string).
|
|
1179
|
+
* @export
|
|
1180
|
+
* @interface RedactRule
|
|
1181
|
+
*/
|
|
1182
|
+
interface RedactRule {
|
|
1183
|
+
/**
|
|
1184
|
+
*
|
|
1185
|
+
* @type {string}
|
|
1186
|
+
* @memberof RedactRule
|
|
1187
|
+
*/
|
|
1188
|
+
type?: RedactRuleTypeEnum;
|
|
1189
|
+
/**
|
|
1190
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
1191
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
1192
|
+
* @memberof RedactRule
|
|
758
1193
|
*/
|
|
759
|
-
|
|
1194
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
760
1195
|
}
|
|
761
1196
|
/**
|
|
762
1197
|
* @export
|
|
763
1198
|
*/
|
|
764
|
-
declare const
|
|
765
|
-
readonly
|
|
1199
|
+
declare const RedactRuleTypeEnum: {
|
|
1200
|
+
readonly redact: "redact";
|
|
766
1201
|
};
|
|
767
|
-
type
|
|
1202
|
+
type RedactRuleTypeEnum = typeof RedactRuleTypeEnum[keyof typeof RedactRuleTypeEnum];
|
|
768
1203
|
/**
|
|
769
|
-
* Check if a given object implements the
|
|
1204
|
+
* Check if a given object implements the RedactRule interface.
|
|
770
1205
|
*/
|
|
771
|
-
declare function
|
|
772
|
-
declare function
|
|
773
|
-
declare function
|
|
774
|
-
declare function
|
|
775
|
-
declare function
|
|
1206
|
+
declare function instanceOfRedactRule(value: object): value is RedactRule;
|
|
1207
|
+
declare function RedactRuleFromJSON(json: any): RedactRule;
|
|
1208
|
+
declare function RedactRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): RedactRule;
|
|
1209
|
+
declare function RedactRuleToJSON(json: any): RedactRule;
|
|
1210
|
+
declare function RedactRuleToJSONTyped(value?: RedactRule | null, ignoreDiscriminator?: boolean): any;
|
|
776
1211
|
//#endregion
|
|
777
1212
|
//#region src/models/RegexEntity.d.ts
|
|
778
1213
|
/**
|
|
779
1214
|
* Sensitive Data Protection API
|
|
780
|
-
*
|
|
1215
|
+
* 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).
|
|
781
1216
|
*
|
|
782
|
-
* The version of the OpenAPI document: 0.0
|
|
1217
|
+
* The version of the OpenAPI document: 0.1.0
|
|
783
1218
|
*
|
|
784
1219
|
*
|
|
785
1220
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -787,7 +1222,7 @@ declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscri
|
|
|
787
1222
|
* Do not edit the class manually.
|
|
788
1223
|
*/
|
|
789
1224
|
/**
|
|
790
|
-
*
|
|
1225
|
+
* A regex pattern to target, e.g. a custom ID or date format.
|
|
791
1226
|
* @export
|
|
792
1227
|
* @interface RegexEntity
|
|
793
1228
|
*/
|
|
@@ -799,7 +1234,7 @@ interface RegexEntity {
|
|
|
799
1234
|
*/
|
|
800
1235
|
type?: RegexEntityTypeEnum;
|
|
801
1236
|
/**
|
|
802
|
-
*
|
|
1237
|
+
* The regular expression to match.
|
|
803
1238
|
* @type {string}
|
|
804
1239
|
* @memberof RegexEntity
|
|
805
1240
|
*/
|
|
@@ -821,113 +1256,183 @@ declare function RegexEntityFromJSONTyped(json: any, ignoreDiscriminator: boolea
|
|
|
821
1256
|
declare function RegexEntityToJSON(json: any): RegexEntity;
|
|
822
1257
|
declare function RegexEntityToJSONTyped(value?: RegexEntity | null, ignoreDiscriminator?: boolean): any;
|
|
823
1258
|
//#endregion
|
|
824
|
-
//#region src/models/
|
|
1259
|
+
//#region src/models/RegexResult.d.ts
|
|
825
1260
|
/**
|
|
826
|
-
*
|
|
1261
|
+
* Record of a regex detection and its anonymization.
|
|
827
1262
|
*
|
|
1263
|
+
* Created when a regex pattern matches text
|
|
1264
|
+
* and a rule anonymizes the matched text.
|
|
828
1265
|
* @export
|
|
1266
|
+
* @interface RegexResult
|
|
829
1267
|
*/
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
1268
|
+
interface RegexResult {
|
|
1269
|
+
/**
|
|
1270
|
+
*
|
|
1271
|
+
* @type {string}
|
|
1272
|
+
* @memberof RegexResult
|
|
1273
|
+
*/
|
|
1274
|
+
type?: RegexResultTypeEnum;
|
|
1275
|
+
/**
|
|
1276
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
1277
|
+
* @type {string}
|
|
1278
|
+
* @memberof RegexResult
|
|
1279
|
+
*/
|
|
1280
|
+
rule: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* The regex pattern that matched.
|
|
1283
|
+
* @type {string}
|
|
1284
|
+
* @memberof RegexResult
|
|
1285
|
+
*/
|
|
1286
|
+
value: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* The detected range in the original text.
|
|
1289
|
+
* @type {TextRange}
|
|
1290
|
+
* @memberof RegexResult
|
|
1291
|
+
*/
|
|
1292
|
+
input: TextRange;
|
|
1293
|
+
/**
|
|
1294
|
+
* The anonymized range in the result text.
|
|
1295
|
+
* @type {TextRange}
|
|
1296
|
+
* @memberof RegexResult
|
|
1297
|
+
*/
|
|
1298
|
+
output: TextRange;
|
|
1299
|
+
}
|
|
852
1300
|
/**
|
|
853
|
-
*
|
|
854
1301
|
* @export
|
|
855
|
-
* @interface ValidationErrorLocInner
|
|
856
1302
|
*/
|
|
857
|
-
|
|
1303
|
+
declare const RegexResultTypeEnum: {
|
|
1304
|
+
readonly regex: "regex";
|
|
1305
|
+
};
|
|
1306
|
+
type RegexResultTypeEnum = typeof RegexResultTypeEnum[keyof typeof RegexResultTypeEnum];
|
|
858
1307
|
/**
|
|
859
|
-
* Check if a given object implements the
|
|
1308
|
+
* Check if a given object implements the RegexResult interface.
|
|
860
1309
|
*/
|
|
861
|
-
declare function
|
|
862
|
-
declare function
|
|
863
|
-
declare function
|
|
864
|
-
declare function
|
|
865
|
-
declare function
|
|
1310
|
+
declare function instanceOfRegexResult(value: object): value is RegexResult;
|
|
1311
|
+
declare function RegexResultFromJSON(json: any): RegexResult;
|
|
1312
|
+
declare function RegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexResult;
|
|
1313
|
+
declare function RegexResultToJSON(json: any): RegexResult;
|
|
1314
|
+
declare function RegexResultToJSONTyped(value?: RegexResult | null, ignoreDiscriminator?: boolean): any;
|
|
866
1315
|
//#endregion
|
|
867
|
-
//#region src/models/
|
|
1316
|
+
//#region src/models/ReplaceRule.d.ts
|
|
868
1317
|
/**
|
|
869
|
-
*
|
|
1318
|
+
* Replace each matched value with a fixed string (default '****').
|
|
870
1319
|
* @export
|
|
871
|
-
* @interface
|
|
1320
|
+
* @interface ReplaceRule
|
|
872
1321
|
*/
|
|
873
|
-
interface
|
|
1322
|
+
interface ReplaceRule {
|
|
874
1323
|
/**
|
|
875
1324
|
*
|
|
876
|
-
* @type {
|
|
877
|
-
* @memberof
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof ReplaceRule
|
|
878
1327
|
*/
|
|
879
|
-
|
|
1328
|
+
type?: ReplaceRuleTypeEnum;
|
|
880
1329
|
/**
|
|
881
|
-
*
|
|
1330
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
1331
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
1332
|
+
* @memberof ReplaceRule
|
|
1333
|
+
*/
|
|
1334
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
1335
|
+
/**
|
|
1336
|
+
* The fixed string to substitute for each match.
|
|
882
1337
|
* @type {string}
|
|
883
|
-
* @memberof
|
|
1338
|
+
* @memberof ReplaceRule
|
|
884
1339
|
*/
|
|
885
|
-
|
|
1340
|
+
replacement?: string;
|
|
1341
|
+
}
|
|
1342
|
+
/**
|
|
1343
|
+
* @export
|
|
1344
|
+
*/
|
|
1345
|
+
declare const ReplaceRuleTypeEnum: {
|
|
1346
|
+
readonly replace: "replace";
|
|
1347
|
+
};
|
|
1348
|
+
type ReplaceRuleTypeEnum = typeof ReplaceRuleTypeEnum[keyof typeof ReplaceRuleTypeEnum];
|
|
1349
|
+
/**
|
|
1350
|
+
* Check if a given object implements the ReplaceRule interface.
|
|
1351
|
+
*/
|
|
1352
|
+
declare function instanceOfReplaceRule(value: object): value is ReplaceRule;
|
|
1353
|
+
declare function ReplaceRuleFromJSON(json: any): ReplaceRule;
|
|
1354
|
+
declare function ReplaceRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReplaceRule;
|
|
1355
|
+
declare function ReplaceRuleToJSON(json: any): ReplaceRule;
|
|
1356
|
+
declare function ReplaceRuleToJSONTyped(value?: ReplaceRule | null, ignoreDiscriminator?: boolean): any;
|
|
1357
|
+
//#endregion
|
|
1358
|
+
//#region src/models/SHA256Rule.d.ts
|
|
1359
|
+
/**
|
|
1360
|
+
* Replace each matched value with its SHA-256 hex digest.
|
|
1361
|
+
* @export
|
|
1362
|
+
* @interface SHA256Rule
|
|
1363
|
+
*/
|
|
1364
|
+
interface SHA256Rule {
|
|
886
1365
|
/**
|
|
887
1366
|
*
|
|
888
1367
|
* @type {string}
|
|
889
|
-
* @memberof
|
|
1368
|
+
* @memberof SHA256Rule
|
|
890
1369
|
*/
|
|
891
|
-
type
|
|
1370
|
+
type?: SHA256RuleTypeEnum;
|
|
1371
|
+
/**
|
|
1372
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
1373
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
1374
|
+
* @memberof SHA256Rule
|
|
1375
|
+
*/
|
|
1376
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
892
1377
|
}
|
|
893
1378
|
/**
|
|
894
|
-
*
|
|
1379
|
+
* @export
|
|
895
1380
|
*/
|
|
896
|
-
declare
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
1381
|
+
declare const SHA256RuleTypeEnum: {
|
|
1382
|
+
readonly sha256: "sha256";
|
|
1383
|
+
};
|
|
1384
|
+
type SHA256RuleTypeEnum = typeof SHA256RuleTypeEnum[keyof typeof SHA256RuleTypeEnum];
|
|
1385
|
+
/**
|
|
1386
|
+
* Check if a given object implements the SHA256Rule interface.
|
|
1387
|
+
*/
|
|
1388
|
+
declare function instanceOfSHA256Rule(value: object): value is SHA256Rule;
|
|
1389
|
+
declare function SHA256RuleFromJSON(json: any): SHA256Rule;
|
|
1390
|
+
declare function SHA256RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA256Rule;
|
|
1391
|
+
declare function SHA256RuleToJSON(json: any): SHA256Rule;
|
|
1392
|
+
declare function SHA256RuleToJSONTyped(value?: SHA256Rule | null, ignoreDiscriminator?: boolean): any;
|
|
901
1393
|
//#endregion
|
|
902
|
-
//#region src/models/
|
|
1394
|
+
//#region src/models/SHA512Rule.d.ts
|
|
903
1395
|
/**
|
|
904
|
-
*
|
|
1396
|
+
* Replace each matched value with its SHA-512 hex digest.
|
|
905
1397
|
* @export
|
|
906
|
-
* @interface
|
|
1398
|
+
* @interface SHA512Rule
|
|
907
1399
|
*/
|
|
908
|
-
interface
|
|
1400
|
+
interface SHA512Rule {
|
|
909
1401
|
/**
|
|
910
1402
|
*
|
|
911
|
-
* @type {
|
|
912
|
-
* @memberof
|
|
1403
|
+
* @type {string}
|
|
1404
|
+
* @memberof SHA512Rule
|
|
913
1405
|
*/
|
|
914
|
-
|
|
1406
|
+
type?: SHA512RuleTypeEnum;
|
|
1407
|
+
/**
|
|
1408
|
+
* The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
|
|
1409
|
+
* @type {Array<DetectRuleEntitiesInner>}
|
|
1410
|
+
* @memberof SHA512Rule
|
|
1411
|
+
*/
|
|
1412
|
+
entities: Array<DetectRuleEntitiesInner>;
|
|
915
1413
|
}
|
|
916
1414
|
/**
|
|
917
|
-
*
|
|
1415
|
+
* @export
|
|
918
1416
|
*/
|
|
919
|
-
declare
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
1417
|
+
declare const SHA512RuleTypeEnum: {
|
|
1418
|
+
readonly sha512: "sha512";
|
|
1419
|
+
};
|
|
1420
|
+
type SHA512RuleTypeEnum = typeof SHA512RuleTypeEnum[keyof typeof SHA512RuleTypeEnum];
|
|
1421
|
+
/**
|
|
1422
|
+
* Check if a given object implements the SHA512Rule interface.
|
|
1423
|
+
*/
|
|
1424
|
+
declare function instanceOfSHA512Rule(value: object): value is SHA512Rule;
|
|
1425
|
+
declare function SHA512RuleFromJSON(json: any): SHA512Rule;
|
|
1426
|
+
declare function SHA512RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA512Rule;
|
|
1427
|
+
declare function SHA512RuleToJSON(json: any): SHA512Rule;
|
|
1428
|
+
declare function SHA512RuleToJSONTyped(value?: SHA512Rule | null, ignoreDiscriminator?: boolean): any;
|
|
924
1429
|
//#endregion
|
|
925
1430
|
//#region src/models/ScanRequestBody.d.ts
|
|
926
1431
|
/**
|
|
927
1432
|
* Sensitive Data Protection API
|
|
928
|
-
*
|
|
1433
|
+
* 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).
|
|
929
1434
|
*
|
|
930
|
-
* The version of the OpenAPI document: 0.0
|
|
1435
|
+
* The version of the OpenAPI document: 0.1.0
|
|
931
1436
|
*
|
|
932
1437
|
*
|
|
933
1438
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -935,25 +1440,26 @@ declare function HTTPValidationErrorToJSONTyped(value?: HTTPValidationError | nu
|
|
|
935
1440
|
* Do not edit the class manually.
|
|
936
1441
|
*/
|
|
937
1442
|
/**
|
|
938
|
-
*
|
|
1443
|
+
* Request body for the scan endpoint: the text to inspect and which
|
|
1444
|
+
* entity types to detect.
|
|
939
1445
|
* @export
|
|
940
1446
|
* @interface ScanRequestBody
|
|
941
1447
|
*/
|
|
942
1448
|
interface ScanRequestBody {
|
|
943
1449
|
/**
|
|
944
|
-
*
|
|
1450
|
+
* The text to scan for sensitive data. At most 128 KB in UTF-8.
|
|
945
1451
|
* @type {string}
|
|
946
1452
|
* @memberof ScanRequestBody
|
|
947
1453
|
*/
|
|
948
1454
|
text: string;
|
|
949
1455
|
/**
|
|
950
|
-
*
|
|
1456
|
+
* ISO language code of the text, e.g. 'en'.
|
|
951
1457
|
* @type {string}
|
|
952
1458
|
* @memberof ScanRequestBody
|
|
953
1459
|
*/
|
|
954
1460
|
language?: string;
|
|
955
1461
|
/**
|
|
956
|
-
*
|
|
1462
|
+
* The entity types to detect, e.g. 'name', 'email', 'location'.
|
|
957
1463
|
* @type {Array<string>}
|
|
958
1464
|
* @memberof ScanRequestBody
|
|
959
1465
|
*/
|
|
@@ -977,9 +1483,9 @@ declare function ScanRequestBodyToJSONTyped(value?: ScanRequestBody | null, igno
|
|
|
977
1483
|
//#region src/models/ScanResult.d.ts
|
|
978
1484
|
/**
|
|
979
1485
|
* Sensitive Data Protection API
|
|
980
|
-
*
|
|
1486
|
+
* 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).
|
|
981
1487
|
*
|
|
982
|
-
* The version of the OpenAPI document: 0.0
|
|
1488
|
+
* The version of the OpenAPI document: 0.1.0
|
|
983
1489
|
*
|
|
984
1490
|
*
|
|
985
1491
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -987,31 +1493,31 @@ declare function ScanRequestBodyToJSONTyped(value?: ScanRequestBody | null, igno
|
|
|
987
1493
|
* Do not edit the class manually.
|
|
988
1494
|
*/
|
|
989
1495
|
/**
|
|
990
|
-
*
|
|
1496
|
+
* A single sensitive-data entity detected in scanned text.
|
|
991
1497
|
* @export
|
|
992
1498
|
* @interface ScanResult
|
|
993
1499
|
*/
|
|
994
1500
|
interface ScanResult {
|
|
995
1501
|
/**
|
|
996
|
-
*
|
|
1502
|
+
* Start character offset of the match (inclusive).
|
|
997
1503
|
* @type {number}
|
|
998
1504
|
* @memberof ScanResult
|
|
999
1505
|
*/
|
|
1000
1506
|
start: number;
|
|
1001
1507
|
/**
|
|
1002
|
-
*
|
|
1508
|
+
* End character offset of the match (exclusive).
|
|
1003
1509
|
* @type {number}
|
|
1004
1510
|
* @memberof ScanResult
|
|
1005
1511
|
*/
|
|
1006
1512
|
end: number;
|
|
1007
1513
|
/**
|
|
1008
|
-
*
|
|
1514
|
+
* Detection confidence score (0.0–1.0).
|
|
1009
1515
|
* @type {number}
|
|
1010
1516
|
* @memberof ScanResult
|
|
1011
1517
|
*/
|
|
1012
1518
|
score: number;
|
|
1013
1519
|
/**
|
|
1014
|
-
*
|
|
1520
|
+
* The detected entity type, e.g. 'email', 'name', 'location'.
|
|
1015
1521
|
* @type {string}
|
|
1016
1522
|
* @memberof ScanResult
|
|
1017
1523
|
*/
|
|
@@ -1028,17 +1534,24 @@ declare function ScanResultToJSONTyped(value?: ScanResult | null, ignoreDiscrimi
|
|
|
1028
1534
|
//#endregion
|
|
1029
1535
|
//#region src/models/ScanResponseBody.d.ts
|
|
1030
1536
|
/**
|
|
1031
|
-
*
|
|
1537
|
+
* Response from the scan endpoint: the sensitive-data entities detected in
|
|
1538
|
+
* the text.
|
|
1032
1539
|
* @export
|
|
1033
1540
|
* @interface ScanResponseBody
|
|
1034
1541
|
*/
|
|
1035
1542
|
interface ScanResponseBody {
|
|
1036
1543
|
/**
|
|
1037
|
-
*
|
|
1544
|
+
* The detected entities, each with its character range, type, and confidence score.
|
|
1038
1545
|
* @type {Array<ScanResult>}
|
|
1039
1546
|
* @memberof ScanResponseBody
|
|
1040
1547
|
*/
|
|
1041
1548
|
results: Array<ScanResult>;
|
|
1549
|
+
/**
|
|
1550
|
+
* Token counts for this request.
|
|
1551
|
+
* @type {Usage}
|
|
1552
|
+
* @memberof ScanResponseBody
|
|
1553
|
+
*/
|
|
1554
|
+
usage: Usage;
|
|
1042
1555
|
}
|
|
1043
1556
|
/**
|
|
1044
1557
|
* Check if a given object implements the ScanResponseBody interface.
|
|
@@ -1049,6 +1562,95 @@ declare function ScanResponseBodyFromJSONTyped(json: any, ignoreDiscriminator: b
|
|
|
1049
1562
|
declare function ScanResponseBodyToJSON(json: any): ScanResponseBody;
|
|
1050
1563
|
declare function ScanResponseBodyToJSONTyped(value?: ScanResponseBody | null, ignoreDiscriminator?: boolean): any;
|
|
1051
1564
|
//#endregion
|
|
1565
|
+
//#region src/models/UpdatePolicyRequest.d.ts
|
|
1566
|
+
/**
|
|
1567
|
+
*
|
|
1568
|
+
* @export
|
|
1569
|
+
* @interface UpdatePolicyRequest
|
|
1570
|
+
*/
|
|
1571
|
+
interface UpdatePolicyRequest {
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @type {string}
|
|
1575
|
+
* @memberof UpdatePolicyRequest
|
|
1576
|
+
*/
|
|
1577
|
+
name?: string;
|
|
1578
|
+
/**
|
|
1579
|
+
*
|
|
1580
|
+
* @type {PolicyDocument}
|
|
1581
|
+
* @memberof UpdatePolicyRequest
|
|
1582
|
+
*/
|
|
1583
|
+
document?: PolicyDocument;
|
|
1584
|
+
}
|
|
1585
|
+
/**
|
|
1586
|
+
* Check if a given object implements the UpdatePolicyRequest interface.
|
|
1587
|
+
*/
|
|
1588
|
+
declare function instanceOfUpdatePolicyRequest(value: object): value is UpdatePolicyRequest;
|
|
1589
|
+
declare function UpdatePolicyRequestFromJSON(json: any): UpdatePolicyRequest;
|
|
1590
|
+
declare function UpdatePolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdatePolicyRequest;
|
|
1591
|
+
declare function UpdatePolicyRequestToJSON(json: any): UpdatePolicyRequest;
|
|
1592
|
+
declare function UpdatePolicyRequestToJSONTyped(value?: UpdatePolicyRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1593
|
+
//#endregion
|
|
1594
|
+
//#region src/apis/PoliciesApi.d.ts
|
|
1595
|
+
interface CreatePolicyOperationRequest {
|
|
1596
|
+
CreatePolicyRequest: CreatePolicyRequest;
|
|
1597
|
+
}
|
|
1598
|
+
interface DeletePolicyRequest {
|
|
1599
|
+
id: string;
|
|
1600
|
+
}
|
|
1601
|
+
interface GetPolicyRequest {
|
|
1602
|
+
id: string;
|
|
1603
|
+
}
|
|
1604
|
+
interface UpdatePolicyOperationRequest {
|
|
1605
|
+
id: string;
|
|
1606
|
+
UpdatePolicyRequest: UpdatePolicyRequest;
|
|
1607
|
+
}
|
|
1608
|
+
/**
|
|
1609
|
+
*
|
|
1610
|
+
*/
|
|
1611
|
+
declare class PoliciesApi extends BaseAPI {
|
|
1612
|
+
/**
|
|
1613
|
+
* Create a policy
|
|
1614
|
+
*/
|
|
1615
|
+
createPolicyRaw(requestParameters: CreatePolicyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Policy>>;
|
|
1616
|
+
/**
|
|
1617
|
+
* Create a policy
|
|
1618
|
+
*/
|
|
1619
|
+
createPolicy(CreatePolicyRequest: CreatePolicyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Policy>;
|
|
1620
|
+
/**
|
|
1621
|
+
* Delete a policy
|
|
1622
|
+
*/
|
|
1623
|
+
deletePolicyRaw(requestParameters: DeletePolicyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>;
|
|
1624
|
+
/**
|
|
1625
|
+
* Delete a policy
|
|
1626
|
+
*/
|
|
1627
|
+
deletePolicy(id: string, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>;
|
|
1628
|
+
/**
|
|
1629
|
+
* Read a policy
|
|
1630
|
+
*/
|
|
1631
|
+
getPolicyRaw(requestParameters: GetPolicyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Policy>>;
|
|
1632
|
+
/**
|
|
1633
|
+
* Read a policy
|
|
1634
|
+
*/
|
|
1635
|
+
getPolicy(id: string, initOverrides?: RequestInit | InitOverrideFunction): Promise<Policy>;
|
|
1636
|
+
/**
|
|
1637
|
+
* List policies
|
|
1638
|
+
*/
|
|
1639
|
+
listPoliciesRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ListPolicies200Response>>;
|
|
1640
|
+
/**
|
|
1641
|
+
* List policies
|
|
1642
|
+
*/
|
|
1643
|
+
listPolicies(initOverrides?: RequestInit | InitOverrideFunction): Promise<ListPolicies200Response>;
|
|
1644
|
+
/**
|
|
1645
|
+
* Update a policy
|
|
1646
|
+
*/
|
|
1647
|
+
updatePolicyRaw(requestParameters: UpdatePolicyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Policy>>;
|
|
1648
|
+
/**
|
|
1649
|
+
* Update a policy
|
|
1650
|
+
*/
|
|
1651
|
+
updatePolicy(id: string, UpdatePolicyRequest: UpdatePolicyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Policy>;
|
|
1652
|
+
}
|
|
1653
|
+
//#endregion
|
|
1052
1654
|
//#region src/apis/SensitiveDataProtectionApi.d.ts
|
|
1053
1655
|
interface AnonymizeTextRequest {
|
|
1054
1656
|
AnonymizeRequestBody: AnonymizeRequestBody;
|
|
@@ -1061,35 +1663,35 @@ interface ScanTextRequest {
|
|
|
1061
1663
|
*/
|
|
1062
1664
|
declare class SensitiveDataProtectionApi extends BaseAPI {
|
|
1063
1665
|
/**
|
|
1064
|
-
* Anonymize the
|
|
1666
|
+
* Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
|
|
1065
1667
|
* Anonymize Text
|
|
1066
1668
|
*/
|
|
1067
1669
|
anonymizeTextRaw(requestParameters: AnonymizeTextRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AnonymizeResponseBody>>;
|
|
1068
1670
|
/**
|
|
1069
|
-
* Anonymize the
|
|
1671
|
+
* Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
|
|
1070
1672
|
* Anonymize Text
|
|
1071
1673
|
*/
|
|
1072
1674
|
anonymizeText(AnonymizeRequestBody: AnonymizeRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<AnonymizeResponseBody>;
|
|
1073
1675
|
/**
|
|
1074
|
-
*
|
|
1676
|
+
* Health check. Returns a plain-text message confirming the service is running. Use this as a liveness/readiness probe.
|
|
1075
1677
|
* Health
|
|
1076
1678
|
*/
|
|
1077
1679
|
healthCheckRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<string>>;
|
|
1078
1680
|
/**
|
|
1079
|
-
*
|
|
1681
|
+
* Health check. Returns a plain-text message confirming the service is running. Use this as a liveness/readiness probe.
|
|
1080
1682
|
* Health
|
|
1081
1683
|
*/
|
|
1082
1684
|
healthCheck(initOverrides?: RequestInit | InitOverrideFunction): Promise<string>;
|
|
1083
1685
|
/**
|
|
1084
|
-
* Scan
|
|
1686
|
+
* Scan text for sensitive data. Runs the configured detection entities over the request text and returns every match as a character range with its entity type and confidence score. Detections below the confidence threshold are omitted.
|
|
1085
1687
|
* Scan Text
|
|
1086
1688
|
*/
|
|
1087
1689
|
scanTextRaw(requestParameters: ScanTextRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ScanResponseBody>>;
|
|
1088
1690
|
/**
|
|
1089
|
-
* Scan
|
|
1691
|
+
* Scan text for sensitive data. Runs the configured detection entities over the request text and returns every match as a character range with its entity type and confidence score. Detections below the confidence threshold are omitted.
|
|
1090
1692
|
* Scan Text
|
|
1091
1693
|
*/
|
|
1092
1694
|
scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
|
|
1093
1695
|
}
|
|
1094
1696
|
//#endregion
|
|
1095
|
-
export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped,
|
|
1697
|
+
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 };
|