UNPKG

node-ovh-ts

Version:

OVH API wrapper library for TypeScript

1 lines 7.12 kB
{"version":3,"sources":["../src/handlers/Freefax.ts"],"sourcesContent":["/* WARNING: This file is auto-generated . Do not edit manually. */\n\nimport { TelephonyVoicemailProperties } from '../models/TelephonyVoicemailProperties';\nimport { TelephonyVoicefaxRoutingEnum } from '../models/TelephonyVoicefaxRoutingEnum';\nimport { TelephonyDirectoryInfo } from '../models/TelephonyDirectoryInfo';\nimport { TelephonyDirectoryWayType } from '../models/TelephonyDirectoryWayType';\nimport { FreefaxBalanceInformations } from '../models/FreefaxBalanceInformations';\nimport { TelephonyDirectoryHeadingPJ } from '../models/TelephonyDirectoryHeadingPJ';\nimport { TelephonyEntrepriseNumberInformationsTask } from '../models/TelephonyEntrepriseNumberInformationsTask';\nimport { FreefaxFreefaxProperties } from '../models/FreefaxFreefaxProperties';\nimport { ServicesService } from '../models/ServicesService';\nimport { TelephonyVoicemailNumbers } from '../models/TelephonyVoicemailNumbers';\nimport OVHBase from '../ovh';\n\nclass FreefaxHandler {\n ovh: OVHBase;\n\n constructor(ovh: OVHBase) {\n this.ovh = ovh;\n }\n\n /** List available services */\n list = (): Promise<string[]> => {\n return this.ovh.request('GET', '/freefax');\n };\n\n /** Get the credit balance and the remaining pages available for all our freefax */\n getCredits = (): Promise<FreefaxBalanceInformations> => {\n return this.ovh.request('GET', '/freefax/credits');\n };\n\n /** Get this object properties */\n getByServiceName = (serviceName: string): Promise<FreefaxFreefaxProperties> => {\n return this.ovh.request('GET', `/freefax/${serviceName}`);\n };\n\n /** Alter this object properties */\n updateByServiceName = (serviceName: string, body: FreefaxFreefaxProperties): Promise<void> => {\n return this.ovh.request('PUT', `/freefax/${serviceName}`, body);\n };\n\n /** Generates a new password for your fax account */\n postChangePasswordByServiceName = (serviceName: string): Promise<string> => {\n return this.ovh.request('POST', `/freefax/${serviceName}/changePassword`);\n };\n\n /** Get this object properties */\n getDirectoryByServiceName = (serviceName: string): Promise<TelephonyDirectoryInfo> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/directory`);\n };\n\n /** Alter this object properties */\n updateDirectoryByServiceName = (\n serviceName: string,\n body: TelephonyDirectoryInfo\n ): Promise<void> => {\n return this.ovh.request('PUT', `/freefax/${serviceName}/directory`, body);\n };\n\n /** Get company entreprise informations by providing entreprise number */\n postDirectoryFetchEntrepriseInformationsByServiceName = (\n serviceName: string,\n body: { entrepriseNumber: string }\n ): Promise<TelephonyEntrepriseNumberInformationsTask> => {\n return this.ovh.request(\n 'POST',\n `/freefax/${serviceName}/directory/fetchEntrepriseInformations`,\n body\n );\n };\n\n /** Get directory service code from an APE code ( principal activity of the firm code ) */\n getDirectoryGetDirectoryServiceCodeByServiceName = (\n serviceName: string\n ): Promise<TelephonyDirectoryHeadingPJ[]> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/directory/getDirectoryServiceCode`);\n };\n\n /** Get all the way types availables */\n getDirectoryGetWayTypesByServiceName = (\n serviceName: string\n ): Promise<TelephonyDirectoryWayType[]> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/directory/getWayTypes`);\n };\n\n /** Main service attached to freefax */\n getMainServiceByServiceName = (serviceName: string): Promise<string> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/mainService`);\n };\n\n /** Get this object properties */\n getServiceInfosByServiceName = (serviceName: string): Promise<ServicesService> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/serviceInfos`);\n };\n\n /** Alter this object properties */\n updateServiceInfosByServiceName = (serviceName: string, body: ServicesService): Promise<void> => {\n return this.ovh.request('PUT', `/freefax/${serviceName}/serviceInfos`, body);\n };\n\n /** Get this object properties */\n getVoicemailByServiceName = (serviceName: string): Promise<TelephonyVoicemailProperties> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/voicemail`);\n };\n\n /** Alter this object properties */\n updateVoicemailByServiceName = (\n serviceName: string,\n body: TelephonyVoicemailProperties\n ): Promise<void> => {\n return this.ovh.request('PUT', `/freefax/${serviceName}/voicemail`, body);\n };\n\n /** Change the voicemail password. It must be 4 digit */\n updateVoicemailPasswordByServiceName = (\n serviceName: string,\n body: { password: string }\n ): Promise<void> => {\n return this.ovh.request('POST', `/freefax/${serviceName}/voicemail/changePassword`, body);\n };\n\n /** Disable/Enable voicemail. Available only if the line has fax capabilities */\n disableVoicemailChangeRoutingByServiceName = (\n serviceName: string,\n body: { routing: TelephonyVoicefaxRoutingEnum }\n ): Promise<void> => {\n return this.ovh.request('POST', `/freefax/${serviceName}/voicemail/changeRouting`, body);\n };\n\n /** Get the status of the voicemail. Available only if the line has fax capabilities */\n getVoicemailRoutingByServiceName = (\n serviceName: string\n ): Promise<TelephonyVoicefaxRoutingEnum> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/voicemail/routing`);\n };\n\n /** Get number for internal and external voicemail */\n getVoicemailVoicemailNumbersByServiceName = (\n serviceName: string\n ): Promise<TelephonyVoicemailNumbers> => {\n return this.ovh.request('GET', `/freefax/${serviceName}/voicemail/voicemailNumbers`);\n };\n}\n\nexport { FreefaxHandler };\n"],"mappings":"AAcA,IAAMA,EAAN,KAAqB,CAGnB,YAAYC,EAAc,CAK1B,UAAO,IACE,KAAK,IAAI,QAAQ,MAAO,UAAU,EAI3C,gBAAa,IACJ,KAAK,IAAI,QAAQ,MAAO,kBAAkB,EAInD,sBAAoBC,GACX,KAAK,IAAI,QAAQ,MAAO,YAAYA,GAAa,EAI1D,yBAAsB,CAACA,EAAqBC,IACnC,KAAK,IAAI,QAAQ,MAAO,YAAYD,IAAeC,CAAI,EAIhE,qCAAmCD,GAC1B,KAAK,IAAI,QAAQ,OAAQ,YAAYA,kBAA4B,EAI1E,+BAA6BA,GACpB,KAAK,IAAI,QAAQ,MAAO,YAAYA,aAAuB,EAIpE,kCAA+B,CAC7BA,EACAC,IAEO,KAAK,IAAI,QAAQ,MAAO,YAAYD,cAAyBC,CAAI,EAI1E,2DAAwD,CACtDD,EACAC,IAEO,KAAK,IAAI,QACd,OACA,YAAYD,0CACZC,CACF,EAIF,sDACED,GAEO,KAAK,IAAI,QAAQ,MAAO,YAAYA,qCAA+C,EAI5F,0CACEA,GAEO,KAAK,IAAI,QAAQ,MAAO,YAAYA,yBAAmC,EAIhF,iCAA+BA,GACtB,KAAK,IAAI,QAAQ,MAAO,YAAYA,eAAyB,EAItE,kCAAgCA,GACvB,KAAK,IAAI,QAAQ,MAAO,YAAYA,gBAA0B,EAIvE,qCAAkC,CAACA,EAAqBC,IAC/C,KAAK,IAAI,QAAQ,MAAO,YAAYD,iBAA4BC,CAAI,EAI7E,+BAA6BD,GACpB,KAAK,IAAI,QAAQ,MAAO,YAAYA,aAAuB,EAIpE,kCAA+B,CAC7BA,EACAC,IAEO,KAAK,IAAI,QAAQ,MAAO,YAAYD,cAAyBC,CAAI,EAI1E,0CAAuC,CACrCD,EACAC,IAEO,KAAK,IAAI,QAAQ,OAAQ,YAAYD,6BAAwCC,CAAI,EAI1F,gDAA6C,CAC3CD,EACAC,IAEO,KAAK,IAAI,QAAQ,OAAQ,YAAYD,4BAAuCC,CAAI,EAIzF,sCACED,GAEO,KAAK,IAAI,QAAQ,MAAO,YAAYA,qBAA+B,EAI5E,+CACEA,GAEO,KAAK,IAAI,QAAQ,MAAO,YAAYA,8BAAwC,EA1HnF,KAAK,IAAMD,CACb,CA2HF","names":["FreefaxHandler","ovh","serviceName","body"]}