@piiano/vault-client
Version:
Piiano Vault generated typescript client
28 lines • 1.3 kB
TypeScript
import type { InputObject } from './InputObject';
export type HashObjectRequest = {
object: InputObject;
/**
* A list of the properties to tokenize.
*/
props?: Array<string>;
/**
* A classification for the hash.
*/
scope?: string;
/**
* Properties used by the format preserving template for the ID generation. The templates require these properties:
* - the `primary_account_number` template requires a property of type `CC_NUMBER`. The token ID is generated from this property by retaining the first six and last four digits and randomizing the remaining digits.
* - [custom format-preserving templates](/guides/tokenize-personal-data/custom-js-format-preserving-template) do not require any properties.
*
*/
fpprops?: Array<string>;
/**
* The template used to format the generated ID. Supports:
* - `primary_account_number` that generates an ID that is a valid 16-digit PAN (credit card number).
* - function name formatted as `<bundle-name>.<function-name>` for [custom format-preserving templates](/guides/tokenize-personal-data/custom-js-format-preserving-template).
* If empty, the format of the ID is a UUID.
*
*/
fptemplate?: string;
};
//# sourceMappingURL=HashObjectRequest.d.ts.map