{"_id":"@alohi/faxplus-api","_rev":"12-d2d169479453c9a4f376df8c057404fe","name":"@alohi/faxplus-api","dist-tags":{"latest":"3.0.5"},"versions":{"2.0.1":{"name":"@alohi/faxplus-api","version":"2.0.1","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"license":"MIT","_id":"@alohi/faxplus-api@2.0.1","maintainers":[{"name":"p.belyaev","email":"p.belyaev@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"}],"homepage":"https://github.com/alohi/faxplus-js#readme","bugs":{"url":"https://github.com/alohi/faxplus-js/issues"},"dist":{"shasum":"5376c35c11091e3114427ae8166ff32063fef55d","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-2.0.1.tgz","fileCount":137,"integrity":"sha512-3zHkXqnS/JyOdxpGUZUn2V9RDuiR5dRvIfouwsyepkEYIhfQhRWdRouYo4f9O+Gt3Qxi/0ZCW4Xv6DVOBPSqnw==","signatures":[{"sig":"MEYCIQCriWY1s5wSaNVH541s1lg3a/DldkVYn+ghJgkN3JLsxAIhAP4A9kul08rIF93pJKrbpi6Ddm1nOQ/yu2KJLIkLGG70","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":295360,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg3yNACRA9TVsSAnZWagAAC0IP/iNM3iJ62Sje9S8wQZrd\nECvt1sWdWQ+M/fRK7849QIqyCDmhjC++i3T+X2QxxWnkbd9hmI4zmwaH+DMf\nZWwX8sDgMj035lVAAbU4/j6G/x7qnkxYwN4f1mH8S1O8jvPuG0JSc8DtXsHI\nU/58uwxmGCuIQv5WLn9MrgpyMzLjxeTTKm9AJLQhpXC7xpZNdJpYhi/ns8wF\npkrZUgKP5QW17g+M9Q7IMY6X0dj7PP1z3YOXYGPL4aGa7hD0W4sXubBTPeCD\nHRTKBpKqdGQijtY43Xy7TruizXOYdkDiQrXRBBdYoZGvuEdk7KxAyjz/qk0X\n5WReD1leyCYo05RCBmv9084zog4h1GPQg/kVfDFsUIqQlDPpXpRKZx8PNpG4\nnxFSZR0s2rQkfJOY+pen4xcZsq1FD1QQc3KbTRkzNihVcJn53U7jgN4M0vvQ\ncyvh9GQwByuGU6voOeUvQ7ryUaGZ2oxVaTnmiQmP5jPPMoxDAbjXDzfwM5Dw\nYF2jUSTnAX40U0hEDeqKD9MXPsWuLeIT1g5baoWojV4MgEsZ1nfNUZBn+sCa\nJ3UcUEF1aG8b7y1VMZDvfxF+uayyqdSaLKPDwE38wtjjJ/lgsyUc5XCbNDDN\n+dONa7M7BoBXpFyElKSYJ6p+XInQrrzP7RzK8LYW3ViiDsiTWmP+AS/ICcUv\nYo0X\r\n=sZHW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/index.js","gitHead":"57cc0abfe9421314c713d50e4542c4a5f0c8a68c","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"typings":"./dist/index.d.ts","_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"repository":{"url":"git+https://github.com/alohi/faxplus-js.git","type":"git"},"_npmVersion":"7.10.0","description":"API client for faxplus","directories":{},"_nodeVersion":"16.0.0","dependencies":{"chai":"^4.3.4","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","typescript":"^3.6.4","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_2.0.1_1625236287810_0.9486718183662803","host":"s3://npm-registry-packages"}},"3.0.0":{"name":"@alohi/faxplus-api","version":"3.0.0","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"license":"MIT","_id":"@alohi/faxplus-api@3.0.0","maintainers":[{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"homepage":"https://github.com/alohi/faxplus-js#readme","bugs":{"url":"https://github.com/alohi/faxplus-js/issues"},"dist":{"shasum":"79e7a36b2de1282005e262a3fa953fd7b5fb7a1e","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-3.0.0.tgz","fileCount":134,"integrity":"sha512-/N7z0309V/08DcsNtZpTj482FAaMQE2JvMilZmq5El1I2jo+rK+iuINChqe6iAcNjTZLbc0bagLWIn7YJIl+vQ==","signatures":[{"sig":"MEYCIQDkVW2+DecKnrOL7rzxG4A9VVnIxSGwy7eGxwWB/x44JgIhAMMK3TWE5QdQ65Z02HJ8s6dwgniDRTvbLX8jHWXD/IM+","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":275197,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh3WEGCRA9TVsSAnZWagAAzZAP/iGKqTAbsFHViM/OhEow\nsjUTe6fWZpcTDZQBaqq5KevWDKPMMUIxdRxZudFPTP+v9CVILskRdc38VjnX\npuHDTmi+alLK3mO3zRpuxgyOIbYUnxpkeJkek+fROvezsrJYyYxcXL5mfayN\nciJYua/P+lT9S6EvQJ82rrdfMVvYthFudOnOIx4uzwlw4QpHaNMzaatQzjfw\nRod3oWpzQI4AOnjYf3Qdczap66J7uixCofMk0+y936beH20Erc2QjHXuKw8c\naedkqIDt+9QmcL2ugIMvdrjqE7Skv63jQfnV6NkiPhtabs7AEoxi3rNtV0vz\nSsVkFEBimiBegh/Rm11EIy+f5VfHLtUo4KzrWU6dfDx3gz5/hp+n1mjz6BtF\n+xCoCiPedTbRyhfvAg8KmpnnB+B+5c1XGI9OAH4VvyMVaTULVzO23EvEDsuG\nDG3k+SSwW5F9jHmBGPn6oS/XpUGOPuP/d9H7rZZpCjKNaAH4IWt5XjCtVpbM\nNyQxQriqQR2T3zpUhy5KA0T7xysYFkZOzRDm2FU5ARl11yrQctGf4pxSHtJX\nsLu7LbTIsMnhmMIq2yGE0EZbrQMfx6yCS1KElGISps1/x/JejINGE28L/Q+z\ndAERrM8wjpClxRHiXTT1vzu7J94TuZ9V6fXa9jZP7IoGeFQVZ82EcKcOvj8r\nZ6Ze\r\n=JDqg\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"typings":"./dist/index.d.ts","_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"repository":{"url":"git+https://github.com/alohi/faxplus-js.git","type":"git"},"_npmVersion":"8.1.0","description":"API client for faxplus","directories":{},"_nodeVersion":"17.0.1","dependencies":{"chai":"^4.3.4","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","typescript":"^3.6.4","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_3.0.0_1641898246547_0.10176523032196272","host":"s3://npm-registry-packages"}},"3.0.2":{"name":"@alohi/faxplus-api","version":"3.0.2","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"_id":"@alohi/faxplus-api@3.0.2","maintainers":[{"name":"m.dietrich","email":"m.dietrich@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"dist":{"shasum":"82646af325bd31c49187a6b4cb1a02c774071859","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-3.0.2.tgz","fileCount":149,"integrity":"sha512-EbfEvkKgoY/PdcSgaAKRdNUx8yUOYSiDaOk0RqJ3LXAiRRRhY4Ey15D5EI6HwlHNCKg/LpJdOJOv+TwO/NM00g==","signatures":[{"sig":"MEYCIQC+7YP3e9P3RQ1kPQNgS1MAx+WygvcOGSIjATpSHhDdYgIhAJ8iLq2QQowqxcJHe/AF+svQ6cbZBQlyQZJd0Yyzd2Bc","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":312446,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjkMH2ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq8uhAAlRFjaUHGR3h1F/pqI3yLe2KEAnP/GtPK+kLTuVgCJHYZbihJ\r\nxUsjyI5QFQ3c6FMFyhCOPue2KRFFisIn65j19ZrchxcDrJkispnDJil836rW\r\nWMs/R0WOdCdp3B1Skp2/OFS7Khus2hObwhlSlh39pf8rAls9WAps7SMkISct\r\nSG6JNFJ1MEZTE7vJeFPdjQbQHSsBThYbxRhlOe36wpV7QRrpRsLQ136AprSl\r\ni0sXoVUbFeO+uO4ipYlLeY8njasnAQx+Bk22K0AzNYcWwhzLHVHL+IqFu65s\r\nh4/S6goVHuA6XL60A+CsnbU6WGlILsurZle6PSqnbhikPv9uT9gT6fEBFygt\r\nNpMIEYweWETbneDBqs2U57gTplE8jHTQ+iNdSstIscZrMpwf2rpvM+MI58rw\r\n8eu8MO2OUxX76qUlUk/DFUlWsKfQu+OmJlm1/vyc0E3prObTZvl141hrbSA2\r\n81GQBdzQjubHN9Q8pvQMaUhmes24Mwjj9GHNTOhHpG3lnib3M3dOm5TUgk/N\r\nTh2RR1VUZUUyR7SeSaIsssZbh3F2eWSS3SGNi5RFJ4fskWMgaUt3WrmHau92\r\nLnMyKV8iDqmJgLNRAt1KOXpFN+fJUvXoaO3vtvgz/p8ahtWeLtjhFWs1IMoP\r\nny87y32IFEutKlN0PYGgTham1Qz23gYpfLc=\r\n=6AHc\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"62ec7bd9d00a17494186226cc304f348f383e369","typings":"./dist/index.d.ts","_npmUser":{"name":"m.dietrich","email":"m.dietrich@alohi.com"},"_npmVersion":"8.5.1","description":"API client for faxplus","directories":{},"_nodeVersion":"17.6.0","dependencies":{"chai":"^4.3.4","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","typescript":"^3.6.4","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_3.0.2_1670431222285_0.7546752733718718","host":"s3://npm-registry-packages"}},"3.0.3":{"name":"@alohi/faxplus-api","version":"3.0.3","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"license":"ISC","_id":"@alohi/faxplus-api@3.0.3","maintainers":[{"name":"m.dietrich","email":"m.dietrich@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"homepage":"https://github.com/alohi/faxplus-js#readme","bugs":{"url":"https://github.com/alohi/faxplus-js/issues"},"dist":{"shasum":"1d1e8a11ae05cfcbe8e564ba29defdd8ac88370f","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-3.0.3.tgz","fileCount":149,"integrity":"sha512-gO/1kPSnu3pxFqYC5COLWPz5Z6yZcrwUTcGK6MpuhSrCWO71id8LPT8BeFNx8qeqIzpXse3PrP0m5B4iw4X7vg==","signatures":[{"sig":"MEYCIQCghroPWTAeEi052DzIzrWPmE4Q0j23UwzxVNJyEmIyNQIhANSDPD1roiiFetctvstkmAYTf8Ws/2o847HGOrq6Jpje","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":313214},"main":"index.js","gitHead":"a219749f76f9cf52cdd19dd91abd31322d3efca5","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"typings":"./dist/index.d.ts","_npmUser":{"name":"m.dietrich","email":"m.dietrich@alohi.com"},"repository":{"url":"git+https://github.com/alohi/faxplus-js.git","type":"git"},"_npmVersion":"9.8.1","description":"API client for faxplus","directories":{},"_nodeVersion":"16.13.2","dependencies":{"chai":"^4.3.10","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","typescript":"^3.6.4","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_3.0.3_1700650475958_0.09519685046885873","host":"s3://npm-registry-packages"}},"3.0.4":{"name":"@alohi/faxplus-api","version":"3.0.4","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"_id":"@alohi/faxplus-api@3.0.4","maintainers":[{"name":"m.dietrich","email":"m.dietrich@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"dist":{"shasum":"2b1b87794cd3d6521f688d5b5ed1b2d87690b985","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-3.0.4.tgz","fileCount":80,"integrity":"sha512-vc4wefzQp5YsuxDi5zenRq7o8eouWoFKETxoDBXujnqWaVAgNejdA2OsHnHJdssbewjub2Ry968MEowG+FjGOA==","signatures":[{"sig":"MEQCIAZLQuPIXuvjFK8e+2B1vYRI7GNJadAuOKFQFaJTbNT7AiBIKIR2GsdIJTfoEyG7HUd7v0O5VYVDDJRb1oJFYdvWNw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":211571},"main":"./dist/index.ts","gitHead":"28a7baf84afcf762e8698bd72f1237fa80571f73","typings":"./dist/index.ts","_npmUser":{"name":"m.dietrich","email":"m.dietrich@alohi.com"},"_npmVersion":"9.8.1","description":"API client for faxplus","directories":{},"_nodeVersion":"16.13.2","dependencies":{"chai":"^4.3.10","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_3.0.4_1711026852479_0.5222649884638877","host":"s3://npm-registry-packages"}},"3.0.5":{"name":"@alohi/faxplus-api","version":"3.0.5","keywords":["axios","fax","faxplus"],"author":{"name":"Alohi SA"},"_id":"@alohi/faxplus-api@3.0.5","maintainers":[{"name":"m.dietrich","email":"m.dietrich@alohi.com"},{"name":"ali.ghasemzadeh","email":"ali@alohi.com"},{"name":"p.belyaev","email":"p.belyaev@alohi.com"}],"dist":{"shasum":"e17b3534c3cb4873ea88a7f98bbc0892ff5981e1","tarball":"https://registry.npmjs.org/@alohi/faxplus-api/-/faxplus-api-3.0.5.tgz","fileCount":158,"integrity":"sha512-Ctq66vivaHCEha8dF3NFToBp28iwkfHfLRlJ59rJC0p81rO7xcqa4xRurgnmVCLUhvdKpwX/P2UrVdwnkXEXDQ==","signatures":[{"sig":"MEYCIQD1rHeyHF2WpwmP5Gbv+IDABEi+Karrf4//OrjyG9ebiwIhANF5CH+BWvXUeTgeikv+fgoJyPoYcngXfgr06o6hmZ8n","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":372319},"main":"./dist/index.js","typings":"./dist/index.d.ts","_npmUser":{"name":"p.belyaev","email":"p.belyaev@alohi.com"},"_npmVersion":"6.14.17","description":"API client for faxplus","directories":{},"_nodeVersion":"14.21.2","dependencies":{"chai":"^4.3.10","axios":"^0.21.1","tslib":"^2.2.0","form-data":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","mocha":"^8.4.0","typescript":"^3.6.4","@types/node":"^12.11.5"},"_npmOperationalInternal":{"tmp":"tmp/faxplus-api_3.0.5_1728899716019_0.6314144401985791","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-07-02T14:31:27.455Z","modified":"2026-01-28T17:58:36.055Z","2.0.0":"2021-07-01T13:50:04.508Z","2.0.1":"2021-07-02T14:31:27.950Z","3.0.0":"2022-01-11T10:50:46.687Z","3.0.2":"2022-12-07T16:40:22.476Z","3.0.3":"2023-11-22T10:54:36.247Z","3.0.4":"2024-03-21T13:14:12.604Z","3.0.5":"2024-10-14T09:55:16.279Z"},"author":{"name":"Alohi SA"},"keywords":["axios","fax","faxplus"],"description":"API client for faxplus","maintainers":[{"email":"ali@alohi.com","name":"ali.ghasemzadeh"},{"email":"p.belyaev@alohi.com","name":"p.belyaev"}],"readme":"# Fax.Plus JavaScript SDK\n\n<p>\n<h4>Made for third-party developers and organizations to send and receive faxes from their own software or\n    application.</h4>\n<p>\n    <a href=\"https://www.npmjs.com/package/@alohi/faxplus-api\"><img\n            src=\"https://img.shields.io/npm/v/@alohi/faxplus-api?style=flat-square\" alt=\"NPM version\"></img></a>\n    <img src=\"https://img.shields.io/badge/license-MIT-green.svg?style=flat-square\" alt=\"License\">\n</p>\n</p>\n\n<p>\n    <a href=\"https://apidoc.fax.plus\" target=\"_blank\">API Documentation 3.0.5</a>  •\n  <a href=\"https://www.fax.plus\" target=\"_blank\">Home</a>  •\n  <a href=\"https://www.fax.plus/help/\" target=\"_blank\">Help Center</a>  •\n  <a href=\"https://www.fax.plus/contact-us/\" target=\"_blank\">Contact Us</a>\n</p>\n\n- Also includes TypeScript definition\n- Only available to [Enterprise](https://www.fax.plus/pricing/) clients\n\n\n## Installation\n\n```\n// with npm\nnpm install @alohi/faxplus-api\n\n// with yarn\nyarn add @alohi/faxplus-api\n```\n\n## Getting Started\n\nExample usage:\n\n```js\nconst axios = require('axios');\nconst Configuration = require('@alohi/faxplus-api').Configuration;\nconst FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;\nconst FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;\n\nconst accessToken = \"YOUR_ACCESS_TOKEN\"\nconst configuration = new Configuration({\n    accessToken: accessToken,\n    basePath: 'https://restapi.fax.plus/v3',\n});\n\n// Get the first entry in the corporate member's inbox\nconst request = await FaxesApiFp(configuration).listFaxes({userId: \"self\"});\n\nconst response = await request(axios);\n\nconst cdrId = response.data.data.records[0].id;\n\n// Upload file\nconst request = await FilesApiFp(configuration).uploadFile(\"self\",\n  fs.createReadStream(\"./test/sample.pdf\")\n);\n\nconst response = await request(axios);\n\n// Send fax\n\n```\n\n## Documentation\nVisit the full API reference at [apidoc.fax.plus](https://apidoc.fax.plus).\n\n## Author\n© 2023 Alohi (Geneva, Switzerland) - [Alohi.com](https://alohi.com)","readmeFilename":"README.md"}