node-ovh-ts/dist/handlers/Freefax.d.ts

OVH API wrapper library for TypeScript

import { TelephonyVoicemailProperties } from '../models/TelephonyVoicemailProperties.js';
import { TelephonyVoicefaxRoutingEnum } from '../models/TelephonyVoicefaxRoutingEnum.js';
import { TelephonyDirectoryInfo } from '../models/TelephonyDirectoryInfo.js';
import { TelephonyDirectoryWayType } from '../models/TelephonyDirectoryWayType.js';
import { FreefaxBalanceInformations } from '../models/FreefaxBalanceInformations.js';
import { TelephonyDirectoryHeadingPJ } from '../models/TelephonyDirectoryHeadingPJ.js';
import { TelephonyEntrepriseNumberInformationsTask } from '../models/TelephonyEntrepriseNumberInformationsTask.js';
import { FreefaxFreefaxProperties } from '../models/FreefaxFreefaxProperties.js';
import { ServicesService } from '../models/ServicesService.js';
import { TelephonyVoicemailNumbers } from '../models/TelephonyVoicemailNumbers.js';
import OVHBase from '../ovh.js';
import '../models/TelephonyVoicemailGreetingEnum.js';
import '../models/TelephonyServiceVoicemailAudioFormatEnum.js';
import '../models/TelephonyServiceVoicemailNotifications.js';
import '../models/TelephonyServiceVoicemailMailOptionEnum.js';
import '../models/NichandleGenderEnum.js';
import '../models/TelephonyTaskStatusEnum.js';
import '../models/TelephonyEntrepriseNumberInformations.js';
import '../models/TelephonyFaxQualityEnum.js';
import '../models/TelephonyFaxSendingTries.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../endpoints.js';

declare class FreefaxHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** Get the credit balance and the remaining pages available for all our freefax */
    getCredits: () => Promise<FreefaxBalanceInformations>;
    /** Get this object properties */
    getByServiceName: (serviceName: string) => Promise<FreefaxFreefaxProperties>;
    /** Alter this object properties */
    updateByServiceName: (serviceName: string, body: FreefaxFreefaxProperties) => Promise<void>;
    /** Generates a new password for your fax account */
    postChangePasswordByServiceName: (serviceName: string) => Promise<string>;
    /** Get this object properties */
    getDirectoryByServiceName: (serviceName: string) => Promise<TelephonyDirectoryInfo>;
    /** Alter this object properties */
    updateDirectoryByServiceName: (serviceName: string, body: TelephonyDirectoryInfo) => Promise<void>;
    /** Get company entreprise informations by providing entreprise number */
    postDirectoryFetchEntrepriseInformationsByServiceName: (serviceName: string, body: {
        entrepriseNumber: string;
    }) => Promise<TelephonyEntrepriseNumberInformationsTask>;
    /** Get directory service code from an APE code ( principal activity of the firm code ) */
    getDirectoryGetDirectoryServiceCodeByServiceName: (serviceName: string) => Promise<TelephonyDirectoryHeadingPJ[]>;
    /** Get all the way types availables */
    getDirectoryGetWayTypesByServiceName: (serviceName: string) => Promise<TelephonyDirectoryWayType[]>;
    /** Main service attached to freefax */
    getMainServiceByServiceName: (serviceName: string) => Promise<string>;
    /** Get this object properties */
    getServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Get this object properties */
    getVoicemailByServiceName: (serviceName: string) => Promise<TelephonyVoicemailProperties>;
    /** Alter this object properties */
    updateVoicemailByServiceName: (serviceName: string, body: TelephonyVoicemailProperties) => Promise<void>;
    /** Change the voicemail password. It must be 4 digit */
    updateVoicemailPasswordByServiceName: (serviceName: string, body: {
        password: string;
    }) => Promise<void>;
    /** Disable/Enable voicemail. Available only if the line has fax capabilities */
    disableVoicemailChangeRoutingByServiceName: (serviceName: string, body: {
        routing: TelephonyVoicefaxRoutingEnum;
    }) => Promise<void>;
    /** Get the status of the voicemail. Available only if the line has fax capabilities */
    getVoicemailRoutingByServiceName: (serviceName: string) => Promise<TelephonyVoicefaxRoutingEnum>;
    /** Get number for internal and external voicemail */
    getVoicemailVoicemailNumbersByServiceName: (serviceName: string) => Promise<TelephonyVoicemailNumbers>;
}

export { FreefaxHandler };