@types/facebook-nodejs-business-sdk/src/objects/serverside/utils.d.ts

TypeScript definitions for facebook-nodejs-business-sdk

/**
 * ServerSideUtils contains the Utility modules used for sending Conversions API Events
 */
export default class ServerSideUtils {
    /**
     * Normalizes and hashes the input given the field name.
     * @param  {String} [input] Value to be normalized. eg: `foo@bar.com` for email input.
     * @param  {String} [field] Key(Type) of Value to be normalized eg: 'em' for email field.
     * @return {String} Normalized and hashed value for the string.
     */
    static normalizeAndHash(input: string, field: string): any;
    /**
     * Normalizes the given country token and returns acceptable two letter ISO country code
     * @param  {String} [country] country value to be normalized.
     * @return {String} Normalized ISO country code.
     */
    static normalizeCountry(country: string): string;
    /**
     * Normalizes the given city and returns acceptable city value
     * @param  {String} [city] city value to be normalized.
     * @return {String} Normalized city value.
     */
    static normalizeCity(city: string): string;
    /**
     * Normalizes the given currency string and returns acceptable three letter ISO code
     * @param  {String} [currency] Currency value to be normalized.
     * @return {String} Normalized ISO currency code.
     */
    static normalizeCurrency(currency: string): string;
    /**
     * Normalizes the given delivery category value and returns a valid string.
     * @param  {String} [input] delivery_category input to be validated.
     * @return {String} Valid delivery_category value.
     */
    static normalizeDeliveryCategory(input: string): string;
    /**
     * @param  {String} [email] email value to be normalized.
     * @return {String} Normalized email value.
     */
    static normalizeEmail(email: string): string;
    /**
     * Normalizes the given gender and returns acceptable('f' or 'm') gender value
     * @param  {String} [gender] gender value to be normalized.
     * @return {String} Normalized gender value.
     */
    static normalizeGender(gender: string): string | null;
    /**
    * Normalizes the 5 character name field.
    * @param  {String} [name] name value to be normalized.
    * @return {String} Normalized 5 character {first,last}name field value.
    */
    static normalizeF5NameField(name: string): string;
    /**
     * Normalizes the given phone and returns acceptable phone value
     * @param  {String} [phone_number] phone number value to be normalized.
     * @return {String} Normalized phone number value.
     */
    static normalizePhone(phone_number: string): string;
    /**
     * Normalizes the given state and returns acceptable city value
     * @param  {String} [state] state value to be normalized.
     * @return {String} Normalized state value.
     */
    static normalizeState(state: string): string;
    /**
     * Normalizes the given zip/postal code and returns acceptable zip code value
     * @param  {String} [zip] zip value to be normalized.
     * @return {String} Normalized zip code value.
     */
    static normalizeZip(zip: string): string | null;
    /**
     * Normalizes the given date of birth day
     * @param  {String} [dobd] value to be normalized.
     * @return {String} Normalized value.
     */
    static normalizeDobd(dobd: string): string;
    /**
     * Normalizes the given date of birth month
     * @param  {String} [dobm] value to be normalized.
     * @return {String} Normalized value.
     */
    static normalizeDobm(dobm: string): string;
    /**
     * Normalizes the given date of birth year
     * @param  {String} [doby] value to be normalized.
     * @return {String} Normalized value.
     */
    static normalizeDoby(doby: string): string;
    /**
     * Boolean method which checks if a given number is represented in international format
     * @param  {String} phone_number that has to be tested.
     * @return {Boolean} value if a number is represented international format
     */
    static isInternationalPhoneNumber(phone_number: string): boolean;
    /**
     * Calculates the SHA 256 hash of a given non-null string.
     * @param  {String} [input] String to be hashed
     * @return {String} SHA 256 Hash of the string
     */
    static toSHA256(input?: string | null): any;
}