westfax/index.d.ts

Interact with the WestFax Secure Cloud Fax API to send and receive faxes.

declare module 'westfax' {
  export interface WestFaxConfig {
    baseUrl?: string;
    responseEncoding?: string;
    username?: string;
    password?: string;
    productId?: string;
    cookies?: boolean;
  }

  export interface SendFaxOptions {
    jobName?: string;
    header?: string;
    billingCode?: string;
    /**
     * Destination fax number(s). Can be a single string or an array of strings for multiple recipients.
     * Maximum of 20 fax numbers allowed when passing an array.
     */
    numbers: string | string[];
    file: string | Buffer | NodeJS.ReadableStream;
    filename?: string;
    csid?: string;
    ani?: string;
    startDate?: string;
    faxQuality?: 'Fine' | 'Normal';
    feedbackEmail?: string;
    callbackUrl?: string;
  }

  export interface FaxIdentifier {
    Id: string;
    Direction: 'Inbound' | 'Outbound';
  }

  export interface ApiResponse {
    Success: boolean;
    Result: any;
    Error?: string;
  }

  class WestFax {
    constructor(config?: WestFaxConfig);
    
    getProductId(): Promise<string | null>;
    getProductList(): Promise<ApiResponse>;
    getF2EProductList(): Promise<ApiResponse>;
    
    sendFax(options: SendFaxOptions): Promise<ApiResponse>;
    
    getFaxDocuments(faxIds: FaxIdentifier | FaxIdentifier[], format?: string): Promise<ApiResponse>;
    changeFaxFilterValue(faxIds: FaxIdentifier | FaxIdentifier[], filter: string): Promise<ApiResponse>;
    getFaxDescriptionsUsingIds(faxIds: FaxIdentifier | FaxIdentifier[]): Promise<ApiResponse>;
    getProductsWithInboundFaxes(filter?: string): Promise<ApiResponse>;
  }

  export default WestFax;
}