{"_id":"@axis-llc/africastalking","_rev":"2-d98281b5079ea6f4d0ef58fb54b0e51d","name":"@axis-llc/africastalking","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@axis-llc/africastalking","version":"0.0.1","description":"Typescript version of the Africa's Talking SDK","main":"dist/index.js","scripts":{"build":"rm -rf dist && tsc","lint":"eslint --ext .ts ./src","ts-check":"tsc --noEmit -p  .","pretest":"npm run build","test":"NODE_ENV=test nyc mocha -r ts-node/register 'test/**/*.test.ts' -t 15000","posttest":"rm -r ./dist","pre-commit-message":"echo 'Please wait, running pre-commit checks...' && exit 0"},"husky":{"hooks":{"pre-commit":"npm-run-all pre-commit-message build lint ts-check test"}},"dependencies":{"axios":"^0.19.2","body-parser":"^1.19.0","chalk":"^4.1.0","config":"^3.3.1","joi":"^14.3.1","query-string":"^6.13.1"},"devDependencies":{"@types/axios":"^0.14.0","@types/body-parser":"^1.19.0","@types/chai":"^4.2.11","@types/chai-as-promised":"^7.1.2","@types/config":"0.0.36","@types/joi":"^14.3.4","@types/mocha":"^7.0.2","@types/node":"^14.0.14","@typescript-eslint/eslint-plugin":"^3.5.0","@typescript-eslint/parser":"^3.5.0","chai":"^4.2.0","chai-as-promised":"^7.1.1","eslint":"^7.3.1","eslint-config-airbnb-typescript":"^8.0.2","eslint-plugin-import":"^2.22.0","husky":"^4.2.5","mocha":"^8.0.1","npm-run-all":"^4.1.5","nyc":"^15.1.0","ts-node":"^8.10.2","typescript":"^3.9.5"},"repository":{"type":"git","url":"git+ssh://git@github.com/axis-lls/africastalking.git"},"keywords":["africastalking","sms","chat","whatsapp","telegram","ussd","voice","payments","airtime","m-pesa","mpesa","iot"],"author":{"name":"Axis"},"license":"MIT","bugs":{"url":"https://github.com/axis-lls/africastalking/issues"},"homepage":"https://github.com/axis-lls/africastalking#readme","engines":{"node":">=10"},"gitHead":"cf914cffefe8b4798abffc36b439b216bf79d44c","_id":"@axis-llc/africastalking@0.0.1","_nodeVersion":"12.22.6","_npmVersion":"6.14.15","dist":{"integrity":"sha512-3aV8KLZGmIqlK4ddlpBZtd4wNL80N+rMufTd0QysWBeHpBqjKptcEA8ox+junq2nEpyLlBRSPNfrebbw3zx+Ag==","shasum":"b2b7221d50355a41cb45c8a21ade63ada4943ca0","tarball":"https://registry.npmjs.org/@axis-llc/africastalking/-/africastalking-0.0.1.tgz","fileCount":411,"unpackedSize":690162,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzG+MCRA9TVsSAnZWagAAeAsP/AgHd6y1Z1yDYv55k6uA\nZbMrao1lzVTTxSvzxeNwoySPhDO0hej4J/ttKng+hy9Y66xy84vgKF4y5Ehm\nX9t7erylG4nJOAZXc11ABWkIpAVpSeMZrnLbNW7CYE0BT3LfgGpYpr0CiGB+\nFSLtV5ARyFpjUaNM82MvmGAkJkmaDgwO/mrJaVV29gzv4A9VLOlzlEzlrL1A\nO1m8Ne7SZT4YuEzkNCmagVkHbxG7LqtGptuheSNIV7NB31Hk2zakOs3uLCeY\nvgKRO7KPexLr+01rzXGU7AfuSgmkMalks0Xk6Caxkdj2gXFPbeIOMxmMZ66y\n07WKzkf6hAi0Ch3G5OLZ3H8prwzkI8o2tHYDViriZD0qOZZ/rkn/Nj4V01p2\nK21BXEIbF09PRjQjmO7Pv4uKaYTBt9qVWfE9JNRbQy5d1eBppMumO4eJzXbH\ndAviFTLO/zoCy4M3aFbc+naiS9RljgrGwjjm64agQ6N+FnT/SzdrkJjV4Ub0\nQGMKm3E8O2ra9Ds8OQ6qPt4fRn1P/CEzNKTXjav++SfzDD4O0nJ97piwh5an\n+B18kS5V5UjN5UzH5lkQk+BAwm7bnZ90Cud4vyPkU20RBLxu8xbtJED1yEnJ\n+lfm2hzQLq2O0+j1A+akiUe3TNFCU7/Aalhpy3r3qIWvymh24jZVGmQ6o5Wh\ncY8i\r\n=A0VQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDop91TDFZUCYKFqKS++PGP5yCnijIblL42Z8crqVeblAIgZy2A2tn75w9uHoY+FyhUAwvahjnKTSrTZK0RaXNvvVk="}]},"_npmUser":{"name":"belvadev","email":"dev@belvadigital.com"},"directories":{},"maintainers":[{"name":"denga","email":"alex@belvadigital.com"},{"name":"shadracknicholasbelva","email":"shadrack@belvadigital.com"},{"name":"belvadev","email":"dev@belvadigital.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/africastalking_0.0.1_1634418112163_0.8307156497483543"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-16T21:01:52.093Z","0.0.1":"2021-10-16T21:01:52.295Z","modified":"2022-04-04T17:12:18.876Z"},"maintainers":[{"name":"denga","email":"alex@belvadigital.com"},{"name":"shadracknicholasbelva","email":"shadrack@belvadigital.com"},{"name":"belvadev","email":"dev@belvadigital.com"}],"description":"Typescript version of the Africa's Talking SDK","homepage":"https://github.com/axis-lls/africastalking#readme","keywords":["africastalking","sms","chat","whatsapp","telegram","ussd","voice","payments","airtime","m-pesa","mpesa","iot"],"repository":{"type":"git","url":"git+ssh://git@github.com/axis-lls/africastalking.git"},"author":{"name":"Axis"},"bugs":{"url":"https://github.com/axis-lls/africastalking/issues"},"license":"MIT","readme":"# africastalking\n\nAfrica's Talking Typescript SDK\n\n## Install\n\n```bash\nnpm install --save @axis-llc/africastalking\n```\n\n## Quick Start Example: Send an SMS\n\nThis example creates an Africa's Talking Client, and sends an SMS to two phone numbers.\n\n```ts\nimport { Client } from \"@axis-llc/africastalking\";\n\nconst client = new Client({\n  apiKey: \"YOUR_API_KEY\", // you can get this from the dashboard: https://account.africastalking.com\n  username: \"YOUR_USERNAME\", // use 'sandbox' as the value for development in the test environment\n});\n\nclient\n  .sendSms({\n    to: [\"+254xxxxxxxx\", \"+254yyyyyyyy\"],\n    message: \"Hello world\",\n  })\n  .then((response) => console.log(response))\n  .catch((error) => console.log(error));\n```\n\n## Links\n\n- [SDK Reference](./DOCS.md) (available functions, constants, types for Typescript, etc)\n- [Code examples](examples/)\n- [Rest API Reference](http://docs.africastalking.com)\n\n## Development\n\n```bash\n# install npm modules\nnpm i\n\n# eslint\nnpm run lint\n\n# typescript check\nnpm run ts-check\n\n# test\nnpm t\n\n# build\nnpm run build\n```\n\n## Note: This is a breaking version\n\nPlease note that this Typescript SDK has breaking changes from the Javascript version. It greatly changes its usage, and you will need to update your codebase to avoid errors.\n\n```js\nconst credentials = { apiKey: \"YOUR_API_KEY\", username: \"YOUR_USERNAME\" };\n\nimport { Client } from \"@axis-llc/africastalking\"; // or const { Client } = require('africastalking');\nconst client = new Client(credentials);\nclient.sendSms({\n  // options\n});\n```\n\nYou can find the complete list of new function names [here](./DOCS.md).\n\nHowever, we understand that updating the bulk of your code can be tedious, so we have given you a way to incrementally upgrade to the new version.\n\nTo use the new version, whilst still keeping the old function calls, you only need to update your require statements as follows (**the key word is `.default`**):\n\n```js\nconst africastalking = require(\"africastalking\").default(credentials);\nconst sms = africastalking.SMS;\nsms.send({\n  // options\n});\n```\n\nHowever, please note that even this way is altogether being deprecated and will be removed in future versions. Kindly make an effort to rewrite your codebase using the newer syntax.\n\nAlternatively, you can just use the Javascript version of the SDK in your codebase.\n\n## Pull Requests\n\nAny and all PRs are open.\n","readmeFilename":"README.md"}