{"analyzedAt":"2022-06-26T03:40:09.058Z","collected":{"metadata":{"name":"unismsgateway","scope":"unscoped","version":"1.2.1","description":"A unified sms gateway library that brings access to multiple sms gateways under a single API","date":"2021-12-31T19:17:45.999Z","publisher":{"username":"razakalpha","email":"saint.alpha12@gmail.com"},"maintainers":[{"username":"razakalpha","email":"saint.alpha12@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/RazakAlpha/unismsgateway.git"},"links":{"npm":"https://www.npmjs.com/package/unismsgateway","homepage":"https://github.com/RazakAlpha/unismsgateway#readme","repository":"https://github.com/RazakAlpha/unismsgateway","bugs":"https://github.com/RazakAlpha/unismsgateway/issues"},"license":"ISC","dependencies":{"hubtel-sms-extended":"^1.0.2","nestsms":"^1.2.1","routemobilesms":"^1.0.4"},"devDependencies":{"@types/node":"^17.0.4","typescript":"^4.5.4"},"releases":[{"from":"2022-05-27T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2022-03-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":1},{"from":"2021-12-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":5},{"from":"2021-06-26T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":10},{"from":"2020-06-26T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":10}],"hasSelectiveFiles":true,"readme":"# Unified Sms Gateway\n\nMost of the time a single project relies on multiple sms Gateway so it can switched if one goes off.\nHowever, each sms api specification is different from the other, hence the need to create separate implementation\nfor each sms gateway.\n\nUnified sms gateway is library that brings most common sms gateways under a Unified api.\nwhich means you only does one implementation in it works for all supported sms gateway. \nyou just have select or switch your sms platform and your code still works fine like nothing has changed\n\n\n## Usage/Examples\n\n```javascript\nconst unisms = require('unismsgateway')\n\nconst param = { clientId, // hubtel sms client Id **optional\n                clientSecret, // hubtel sms client secret ** optional\n                username, // username for route sms\n                password, // password for route sms\n                host,  // host address eg. rslr.connectbind.....\n                port} // port defaults to 8080\n\n//init with prefered platform id. route => routemobile, hubtel => hubtel sms\n// more sms services will be added or supported in the future\nconst gateway  = unisms.init({platformId:'route', param})\n\n```\n\n### SEND MESSAGE\n```javascript\n\nconst testSms = async function(){\n  try{\n    // const gateway = unisms.getSmsPlatform();\n     await gateway.quickSend({From:'xxxxx', To: xxxxxxxx, Content: 'Testing unisms', Type: 0}, (response)=>{\n      console.log(response)\n    }).then(r => {\n      console.log(r)\n    }).catch(err => {\n      console.log(err)\n    })\n  }catch(err){\n    console.log(err)\n  }\n\n\n}\n\n```\n\n### SEND PERSONALIZED MESSAGE\n```javascript\n\nconst testSms = async function(){\n  try{\n    // const gateway = unisms.getSmsPlatform();\n     await gateway.sendPersonalized({From:'xxxxx', \n                                    To: {to: 233XXXXXXXXX, values: ['Alpha', 65332]},  // [{to: 233XXXXXXXXX, values: ['Alpha', 65332]}, {to: 211XXXXXXXXX, values: ['James', 2000]}, ]\n                                    Content: 'Testing unisms', \n                                    Type: 0}).then(r => {\n      console.log(r)\n    }).catch(err => {\n      console.log(err)\n    })\n  }catch(err){\n    console.log(err)\n  }\n\n\n}\n\n```\n\n\n## supported bulk sms gateways\n\nHubtel bulk sms (Ghana) using hubtel-sms-extended\nrouteMobile sms (India) using routemobilesms\nNest SMS(Ghana) using nestsms\n\n## Roadmap\n\n- Additional browser support\n\n- Add more third party sms integrations\n\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)"},"npm":{"downloads":[{"from":"2022-06-25T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2022-06-19T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":1},{"from":"2022-05-27T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":27},{"from":"2022-03-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":125},{"from":"2021-12-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":424},{"from":"2021-06-26T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":548}],"starsCount":0},"github":{"starsCount":0,"forksCount":0,"subscribersCount":1,"issues":{"count":0,"openCount":0,"distribution":{"3600":0,"10800":0,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"RazakAlpha","commitsCount":7}],"commits":[{"from":"2022-06-19T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2022-05-27T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2022-03-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2021-12-28T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":0},{"from":"2021-06-26T00:00:00.000Z","to":"2022-06-26T00:00:00.000Z","count":7}]},"source":{"files":{"readmeSize":2491,"testsSize":0,"hasNpmIgnore":true}}},"evaluation":{"quality":{"carefulness":0.7899999999999999,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":2,"downloadsCount":41.666666666666664,"downloadsAcceleration":0.06320395738203954,"dependentsCount":0},"maintenance":{"releasesFrequency":0.935359589041096,"commitsFrequency":0.08054794520547946,"openIssues":0.7,"issuesDistribution":0.7}},"score":{"final":0.5140767357738129,"detail":{"quality":0.5232869564529817,"popularity":0.027181534218706362,"maintenance":0.9930774624610603}}}