@cityssm/consigno-cloud-api/utilities.d.ts

An unofficial wrapper around the ConsignO Cloud API.

/**
 * Reads a file and converts its content to a base64 encoded string.
 * @param filePath - The path to the file to be read.
 * @returns A promise that resolves to the base64 encoded string of the file content.
 * @throws Will throw an error if the file cannot be read.
 */
export declare function fileToBase64(filePath: string): Promise<string>;
/**
 * Converts a Uint8Array to a base64 string.
 * @param data - The Uint8Array data to convert to a base64 string.
 * @returns The base64 encoded string.
 */
export declare function uintArrayToBase64(data: Uint8Array): string;
/**
 * Validates a workflow ID.
 * The ID should be a 24-character hexadecimal string.
 * @param workflowId - The ID of the workflow to validate.
 * @returns True if the workflow ID is valid, false otherwise.
 */
export declare function validateWorkflowId(workflowId: string): boolean;
/**
 * Formats a phone number to the format accepted by the Consigno Cloud API.
 * The formatted phone number will be in the format +1XXXXXXXXXX.
 * Any extension will be returned separately.
 * @param unformattedPhoneNumber - The phone number to format.
 * @returns An object containing the formatted phone number and any extension.
 */
export declare function formatPhoneNumber(unformattedPhoneNumber: string): {
    phone: string;
    phoneExt: string;
};
declare const _default: {
    fileToBase64: typeof fileToBase64;
    formatPhoneNumber: typeof formatPhoneNumber;
    uintArrayToBase64: typeof uintArrayToBase64;
    validateWorkflowId: typeof validateWorkflowId;
};
export default _default;