{"_id":"@breu.io/nozl-nodejs-sdk","name":"@breu.io/nozl-nodejs-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@breu.io/nozl-nodejs-sdk","version":"1.0.0","description":"SDK for Nozl","main":"dist/index.js","scripts":{"test":"npm test","start":"ts-node index.ts","build":"tsc"},"repository":{"type":"git","url":"git+https://mahad-akhter@github.com/breuHQ/nozl-nodejs-sdk.git"},"keywords":["node","nozl","sdk"],"author":{"name":"Breu"},"license":"ISC","bugs":{"url":"https://github.com/breuHQ/nozl-nodejs-sdk/issues"},"homepage":"https://github.com/breuHQ/nozl-nodejs-sdk#readme","dependencies":{"axios":"^1.4.0","nats":"^2.11.0","pino":"^8.14.1","uuid":"^9.0.0"},"devDependencies":{"@types/node":"^20.2.4","@types/pino":"^7.0.5","@types/uuid":"^9.0.0","esbuild":"^0.17.6","eslint":"^8.33.0","eslint-config-standard":"^17.0.0","eslint-plugin-import":"^2.27.5","eslint-plugin-n":"^15.6.1","eslint-plugin-promise":"^6.1.1","jest":"^29.5.0","ts-node":"^10.9.1","typescript":"^4.9.5"},"gitHead":"61194b778509f8b00c90142ea995d895f003e210","_id":"@breu.io/nozl-nodejs-sdk@1.0.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-JySoY8S35QaeRaLeTzzEG8lTErA1QVTHdgifnUhGS2L9gWT6xIqNERVFeg1BcQ+1gcdssHaJB5qyEVBXtD4Idg==","shasum":"ca996681f9235eb34d8a1c60045846845a6d0d6f","tarball":"https://registry.npmjs.org/@breu.io/nozl-nodejs-sdk/-/nozl-nodejs-sdk-1.0.0.tgz","fileCount":7,"unpackedSize":5471,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD6mdQKZlXjiHL2IrsNRgot399kEmBMf6Cq4peqaE09wgIhANkDtBuYH69fOtXN42cKRQcHHpbNKwAl3N6sYoJRkV1R"}]},"_npmUser":{"name":"tmirza","email":"taimoor@breu.io"},"directories":{},"maintainers":[{"name":"tmirza","email":"taimoor@breu.io"},{"name":"debuggerpk","email":"yousuf@maher.pk"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nozl-nodejs-sdk_1.0.0_1686810931405_0.4488740553688333"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-15T06:35:31.349Z","1.0.0":"2023-06-15T06:35:31.591Z","modified":"2023-06-15T06:35:31.827Z"},"maintainers":[{"name":"tmirza","email":"taimoor@breu.io"},{"name":"debuggerpk","email":"yousuf@maher.pk"}],"description":"SDK for Nozl","homepage":"https://github.com/breuHQ/nozl-nodejs-sdk#readme","keywords":["node","nozl","sdk"],"repository":{"type":"git","url":"git+https://mahad-akhter@github.com/breuHQ/nozl-nodejs-sdk.git"},"author":{"name":"Breu"},"bugs":{"url":"https://github.com/breuHQ/nozl-nodejs-sdk/issues"},"license":"ISC","readme":"# nozl-nodejs-sdk\n\n## Offical JavaScript SDK for Nozl\n\n### Installation\n\n```bash\nnpm i nozl-nodejs-sdk\n```\n\n### Prerequisites\n1. A registrered service e.g Twilio, SendGrid, Stripe etc. You can register your service via Nozl dashboard.\n2. Tenant API key. A Tenant is represents a team or a group which is going\n    to use a Service.\n\n### Quick Start\n\n```javascript\nconst { Nozl, Payload } = require(\"nozl-nodejs-sdk\");\n\nconst testMsg = async () => {\n  const serviceId: string = \"a0c236b8-b401-4ced-836e-a533b480d490\"; // get this from dashboard\n  const operationId: string = \"CreateMessage\"; // get this value from Service's official OpenAPI spec.\n  const requestBody: object = {\n    To: \"RECEIVER_PHONE_NUMBER\",\n    Body: \"test message from nodejs SDK\",\n    From: \"SENDERS_PHONE_NUMBER\", // get this from twilio's console\n    user_id: \"7f47fa0c-3035-4fbf-aff1-c3f7b639cwbz\",\n  };\n  const pathParams: object = {\n    AccountSid: \"AC9f560ea30baaaf8013e4e44284eb6769\",\n  };\n  const queryParams: object = {};\n  const payload: Payload = new Payload(\n    serviceId,\n    operationId,\n    requestBody,\n    pathParams,\n    queryParams\n  );\n  const url: string = \"http://localhost:1323\"; // replace this the actual domain\n  const tenantApiKey: string = \"7a5987c7-18c7-497d-8d27-e5765471e410\"; // retrieve this after registrating a tenant.\n  const nozl: Nozl = new Nozl(url, tenantApiKey);\n\n  const data = await nozl.sendMessage(payload)\n  console.log(data)\n};\n\ntestMsg();\n```","readmeFilename":"README.md"}