{"_id":"5sim-api","_rev":"2-19196b67d98b80818166262bed62977b","name":"5sim-api","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"5sim-api","version":"1.0.0","keywords":["5sim","5sim.net","sms-api","sms"],"author":{"url":"github.com/HaloKodein","name":"Purplex"},"license":"MIT","_id":"5sim-api@1.0.0","maintainers":[{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"}],"homepage":"","dist":{"shasum":"b101c268e6940ab15d78826652c3bd4961e17b1e","tarball":"https://registry.npmjs.org/5sim-api/-/5sim-api-1.0.0.tgz","fileCount":5,"integrity":"sha512-RWiojU3yKcoRs6pWPPrLltWby/wDx50TVGGu3XBO/Qrv7v9FdxyJT7Nl9m55bqdU1RHROVs4994pc33Oj4EU6A==","signatures":[{"sig":"MEUCICKUN11hcWhoGcI6BwsmXVyu/nnb+ZiRecqbH5hOYBNDAiEA13933xtO8FrY2FqSWi+oijzR26anD1BxnN1ibYHvDyM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49255},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"2f79c0cf282910f2ccdef71601237bdc546d9646","scripts":{"test":"bun test --coverage","build":"bun run build.mjs","publish":"bun run build && npm publish","prepublish":"bun run build && npm pack"},"_npmUser":{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"},"_npmVersion":"10.8.2","description":"A 5sim.net api.","directories":{},"_nodeVersion":"20.17.0","dependencies":{"axios":"^1.7.7"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"^1.0.0","typescript":"^5.2.2","@types/node":"^22.5.5","@types/axios":"^0.14.0","@biomejs/biome":"^1.9.2","bun-plugin-dts":"^0.2.1"},"_npmOperationalInternal":{"tmp":"tmp/5sim-api_1.0.0_1726764196632_0.10448620565022715","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"5sim-api","version":"1.0.1","keywords":["5sim","5sim.net","sms-api","sms"],"author":{"url":"github.com/HaloKodein","name":"Purplex"},"license":"MIT","_id":"5sim-api@1.0.1","maintainers":[{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"}],"homepage":"","dist":{"shasum":"55ab096be16de3e44857a9346e631b3be754daf5","tarball":"https://registry.npmjs.org/5sim-api/-/5sim-api-1.0.1.tgz","fileCount":5,"integrity":"sha512-PBInuBYcTeBQdnByCKuagowrBYm/E5nySTFC9xcZ6f0mP0yLv3vHERh/+yj5NbD1tW9z4ij3DwgZWIZC8uW/dA==","signatures":[{"sig":"MEQCIEwVdGqGi0QFHMHpha4/Wky1BntsY8k0H6vZcWS085JEAiA6stNFWRH1ZfTNM6pvS8D7yXQ7kce9P0+fCCrRg92b1g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":50695},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"2f79c0cf282910f2ccdef71601237bdc546d9646","scripts":{"test":"bun test --coverage","build":"bun run build.mjs","prepublish":"bun run build && npm pack"},"_npmUser":{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"},"_npmVersion":"10.8.2","description":"A 5sim.net api.","directories":{},"_nodeVersion":"20.17.0","dependencies":{"axios":"^1.7.7"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"^1.0.0","typescript":"^5.2.2","@types/node":"^22.5.5","@types/axios":"^0.14.0","@biomejs/biome":"^1.9.2","bun-plugin-dts":"^0.2.1"},"_npmOperationalInternal":{"tmp":"tmp/5sim-api_1.0.1_1726764966709_0.6454912641008292","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"5sim-api","version":"1.0.2","main":"dist/index.js","types":"dist/index.d.ts","description":"A 5sim.net api.","scripts":{"build":"bun run build.mjs","test":"bun test --coverage","prepublish":"bun run build && npm pack"},"keywords":["5sim","5sim.net","sms-api","sms"],"license":"MIT","homepage":"","author":{"name":"Purplex","url":"github.com/HaloKodein"},"devDependencies":{"@biomejs/biome":"^1.9.2","@types/axios":"^0.14.0","@types/bun":"^1.0.0","@types/node":"^22.5.5","bun-plugin-dts":"^0.2.1","typescript":"^5.2.2"},"dependencies":{"axios":"^1.7.7"},"_id":"5sim-api@1.0.2","gitHead":"2f79c0cf282910f2ccdef71601237bdc546d9646","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-OpaoRxUJmMVK37RgzQRoC3JWQVnQjtEqV+HJG0XFe77hkCci8vhKyig66Xw1+2MBmDRxv/cwAwixNiN9R2r3WA==","shasum":"f94ba82642664f886bc7a466407ebb2104ac3172","tarball":"https://registry.npmjs.org/5sim-api/-/5sim-api-1.0.2.tgz","fileCount":5,"unpackedSize":52002,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICe1DuNiVTpmz5JcKFJeWy1gQm8tbU/FpzUA+AhVbybTAiBdeSsUk9mr5SR0mgSgVtXKWn2sFXyfBjICU2B2WDsOWg=="}]},"_npmUser":{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"},"directories":{},"maintainers":[{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/5sim-api_1.0.2_1727328319392_0.13590677868839163"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-19T16:43:16.631Z","modified":"2024-09-26T05:25:19.882Z","1.0.0":"2024-09-19T16:43:16.848Z","1.0.1":"2024-09-19T16:56:07.004Z","1.0.2":"2024-09-26T05:25:19.681Z"},"author":{"name":"Purplex","url":"github.com/HaloKodein"},"license":"MIT","keywords":["5sim","5sim.net","sms-api","sms"],"description":"A 5sim.net api.","maintainers":[{"name":"codein-purple","email":"zeca.pirokinha@gmail.com"}],"readme":"# 5sim-api\r\n\r\n## GetSMS\r\n<p align=\"center\">\r\n<a href=\"https://www.npmjs.com/package/5sim-api\"><img src=\"https://img.shields.io/npm/v/5sim-api.svg?style=flat-square\" alt=\"NPM version\"></a>\r\n<a href=\"https://www.npmjs.com/package/5sim-api\"><img src=\"https://img.shields.io/npm/dt/5sim-api.svg?style=flat-square\" alt=\"NPM downloads\"></a>\r\n<a href=\"https://www.codacy.com/gh/Viiprogrammer/5sim-api/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Viiprogrammer/5sim-api&amp;utm_campaign=Badge_Grade\"><img src=\"https://app.codacy.com/project/badge/Grade/beb8f62dd6db47fb8f2dab52afc0e907\"/></a>\r\n</p>\r\n\r\n[![NPM](https://nodei.co/npm/5sim-api.png?downloads=true&stars=true)](https://nodei.co/npm/5sim-api/)\r\n\r\n5sim-api - This is [Node.js](https://nodejs.org) module that allows you to interact with the SMS services api\r\n\r\n### Description\r\nThe `5sim-api` is a powerful and easy-to-use API client for interacting with the 5sim.net service. This library allows you to manage SMS numbers, check your balance, retrieve order history, and handle incoming SMS.\r\n\r\n### Features\r\n- Retrieve user balance\r\n- Buy activation and hosting numbers\r\n- Cancel or ban numbers\r\n- Wait for incoming SMS\r\n\r\n### Installation\r\nTo install the package, run:\r\n\r\n```bash\r\nnpm install 5sim-api\r\n```\r\nYarn:\r\n```bash\r\nyarn add 5sim-api\r\n```\r\n\r\n# Usage\r\n\r\n```typescript\r\nimport { FiveSim } from '5sim-api';\r\n\r\nconst client = new FiveSim('your_api_key');\r\n\r\nasync function bootstrap() {\r\n  // Get user balance\r\n  const { balance } = await client.getUserBalance()\r\n  console.log(balance)\r\n\r\n\r\n  // Buy an activation number\r\n  const { phone } = await client.buyActivationNumber()\r\n  console.log(phone)\r\n}\r\nbootstrap()\r\n```\r\n\r\n### Balance Payload\r\n``` typescript\r\n{\r\n  id: number\r\n  email: string\r\n  vendor: string\r\n  default_forwarding_number: number\r\n  balance: number\r\n  rating: number\r\n  default_country: Country\r\n  default_operator: Operator\r\n  frozen_balance: number\r\n}\r\n```\r\n\r\n### Number Payload\r\n``` typescript\r\n{\r\n  id: number\r\n  phone: string\r\n  operator: string\r\n  product: string\r\n  price: number\r\n  status: StatusType\r\n  expires: Date\r\n  sms: null\r\n  created_at: Date\r\n  forwarding: boolean\r\n  forwarding_number: null\r\n  country: string\r\n}\r\n```\r\n\r\n# License\r\nMIT License\r\n\r\n# Author\r\nPurplex (github.com/HaloKodein)\r\n","readmeFilename":"README.md"}