{"_id":"@elusion-sdk/briq","_rev":"5-2de6ea45444ec4bd4df406f98595802a","name":"@elusion-sdk/briq","dist-tags":{"latest":"1.2.5"},"versions":{"1.2.0":{"name":"@elusion-sdk/briq","version":"1.2.0","_id":"@elusion-sdk/briq@1.2.0","maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"dist":{"shasum":"9f9e80902a8c34f5db7b8dad85d0d004db204f3b","tarball":"https://registry.npmjs.org/@elusion-sdk/briq/-/briq-1.2.0.tgz","fileCount":5,"integrity":"sha512-hzuWquGljDwwv1pejIR6uvEVFULpZ8Q/d4m7Bi60hN4W8cR0sqG+LOUr3ryXOylQHYkVremdul6UOX/zbshYFA==","signatures":[{"sig":"MEQCIHU34gh6dxY+7ZoPeXWNP/zrRByFAiUxLFAoEoHVFfZyAiBpVglWV282M9O2fmkGXVls3TU5yN0pc0cbu5KEYt7S1g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":43745},"main":"dist/index.js","type":"module","module":"src/index.ts","gitHead":"6bca058fae3e0c14cf1130944f3a6d20d9c10347","scripts":{"test":"bun test","build":"bun build src/index.ts --outdir dist --target node","release":"semantic-release"},"_npmUser":{"name":"erickweyunga","email":"maverickweyunga@gmail.com"},"_npmVersion":"10.9.2","description":"To install dependencies:","directories":{},"_nodeVersion":"20.19.2","dependencies":{"dotenv":"^16.5.0","semantic-release":"^24.2.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"latest"},"peerDependencies":{"typescript":"^5"},"_npmOperationalInternal":{"tmp":"tmp/briq_1.2.0_1749971893106_0.9505516914903764","host":"s3://npm-registry-packages-npm-production"}},"1.2.1":{"name":"@elusion-sdk/briq","version":"1.2.1","keywords":["sms","briq","elusion","messaging","notifications","typescript","sdk","api","communications","text-messaging","bulk-sms"],"author":{"name":"Elution Hub","email":"elusion.lab@gmail.com"},"license":"MIT","_id":"@elusion-sdk/briq@1.2.1","maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"homepage":"https://github.com/elusionhub/briq-sdk#readme","bugs":{"url":"https://github.com/elusionhub/briq-sdk/issues"},"dist":{"shasum":"c4995ea983a9c83798453e415ee7051bd6c4dab6","tarball":"https://registry.npmjs.org/@elusion-sdk/briq/-/briq-1.2.1.tgz","fileCount":75,"integrity":"sha512-sAzh9gtFCbHGsC0Ig8jlxhqIIpg4Q1ZU2SBJtYjWWVW13vs6j/SL2/ug6DPuDWuKBKwW6QAOSgojhds+8NJ6bQ==","signatures":[{"sig":"MEQCIB+PYVgqlxc4NF846OLBJ08kW+J2wR9u52xftBlz4sBpAiBeq+p2cwtvgKAh2gSgsBCWtETH/8yd6F+KVyw9cxXc9g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":167506},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","module":"dist/index.esm.js","engines":{"bun":">=1.0.0","node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.esm.js","require":"./dist/index.js"}},"gitHead":"40631cae6f0918c48e82b8cf9dd88282e090f2d5","scripts":{"lint":"eslint src/**/*.ts","test":"bun test","build":"bun run build:clean && bun run build:cjs && bun run build:esm && bun run build:types","format":"prettier --write src/**/*.ts","release":"semantic-release","lint:fix":"eslint src/**/*.ts --fix","build:cjs":"bun build src/index.ts --outdir dist --target node --format cjs --outfile index.js","build:esm":"bun build src/index.ts --outdir dist --target node --format esm --outfile index.esm.js","test:watch":"bun test --watch","type-check":"tsc --noEmit","build:clean":"rm -rf dist","build:types":"tsc --project tsconfig.build.json","format:check":"prettier --check src/**/*.ts","test:coverage":"bun test --coverage","prepublishOnly":"bun run lint && bun run type-check && bun run build && bun run test"},"_npmUser":{"name":"erickweyunga","email":"maverickweyunga@gmail.com"},"repository":{"url":"git+https://github.com/elusionhub/briq-sdk.git","type":"git"},"_npmVersion":"10.9.2","description":"A modern TypeScript SDK for Briq SMS API integration","directories":{},"_nodeVersion":"20.19.2","dependencies":{"dotenv":"^16.5.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.29.0","prettier":"^3.5.3","@eslint/js":"^9.29.0","@types/bun":"latest","typescript":"^5.8.3","@types/node":"^24.0.1","@eslint/eslintrc":"^3.3.1","@typescript-eslint/parser":"^8.34.0","@typescript-eslint/eslint-plugin":"^8.34.0"},"peerDependencies":{"typescript":"^5"},"_npmOperationalInternal":{"tmp":"tmp/briq_1.2.1_1749978139571_0.43896711481823414","host":"s3://npm-registry-packages-npm-production"}},"1.2.2":{"name":"@elusion-sdk/briq","version":"1.2.2","keywords":["sms","briq","elusion","messaging","notifications","typescript","sdk","api","communications","text-messaging","bulk-sms"],"author":{"name":"Elution Hub","email":"elusion.lab@gmail.com"},"license":"MIT","_id":"@elusion-sdk/briq@1.2.2","maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"homepage":"https://github.com/elusionhub/briq-sdk#readme","bugs":{"url":"https://github.com/elusionhub/briq-sdk/issues"},"dist":{"shasum":"100253cc76ad84a842f159ca32277afa4f38e111","tarball":"https://registry.npmjs.org/@elusion-sdk/briq/-/briq-1.2.2.tgz","fileCount":75,"integrity":"sha512-ek1PCfFOX1wFa9dkAMsdq/QV86jhL07Xy8VPTpRK7rpaVWACyqh/+AHIx6GkdYxVuwb/unlvAbcWicMPSsAGWg==","signatures":[{"sig":"MEUCIQDui/wCb3x1qSQYgXik0jiX+txU3f4riD10urTn6mRHcwIgcFmeJvHxijxgc8fZ+udSgH2SOqaaNrQ8DIKjFoEdZmc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":167417},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","module":"dist/index.esm.js","engines":{"bun":">=1.0.0","node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.esm.js","require":"./dist/index.js"}},"gitHead":"c532762acd650bfdc703b13f5cb2af82b8480a83","scripts":{"lint":"eslint src/**/*.ts","test":"bun test","build":"bun run build:clean && bun run build:cjs && bun run build:esm && bun run build:types","format":"prettier --write src/**/*.ts","release":"semantic-release","lint:fix":"eslint src/**/*.ts --fix","build:cjs":"bun build src/index.ts --outdir dist --target node --format cjs --outfile index.js","build:esm":"bun build src/index.ts --outdir dist --target node --format esm --outfile index.esm.js","test:watch":"bun test --watch","type-check":"tsc --noEmit","build:clean":"rm -rf dist","build:types":"tsc --project tsconfig.build.json","format:check":"prettier --check src/**/*.ts","test:coverage":"bun test --coverage","prepublishOnly":"bun run lint && bun run type-check && bun run build && bun run test"},"_npmUser":{"name":"erickweyunga","email":"maverickweyunga@gmail.com"},"repository":{"url":"git+https://github.com/elusionhub/briq-sdk.git","type":"git"},"_npmVersion":"10.9.2","description":"A modern TypeScript SDK for Briq SMS API integration","directories":{},"_nodeVersion":"20.19.2","dependencies":{"dotenv":"^16.5.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.29.0","prettier":"^3.5.3","@eslint/js":"^9.29.0","@types/bun":"latest","typescript":"^5.8.3","@types/node":"^24.0.1","@eslint/eslintrc":"^3.3.1","@typescript-eslint/parser":"^8.34.0","@typescript-eslint/eslint-plugin":"^8.34.0"},"peerDependencies":{"typescript":"^5"},"_npmOperationalInternal":{"tmp":"tmp/briq_1.2.2_1749979883895_0.42812663612125346","host":"s3://npm-registry-packages-npm-production"}},"1.2.3":{"name":"@elusion-sdk/briq","version":"1.2.3","keywords":["sms","briq","elusion","messaging","notifications","typescript","sdk","api","communications","text-messaging","bulk-sms"],"author":{"name":"Elution Hub","email":"elusion.lab@gmail.com"},"license":"MIT","_id":"@elusion-sdk/briq@1.2.3","maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"homepage":"https://github.com/elusionhub/briq-sdk#readme","bugs":{"url":"https://github.com/elusionhub/briq-sdk/issues"},"dist":{"shasum":"6cbd31b26c96cfcaab00ea70a9556e50f92b62ef","tarball":"https://registry.npmjs.org/@elusion-sdk/briq/-/briq-1.2.3.tgz","fileCount":75,"integrity":"sha512-j0pXBMsqmbpYeiiwpgPiCYgEa2lQCJbh4IaNCS6rAWMpHLgRAfHM9miyNq4aP+I8iliHrAk8m4uZkeHMi2Zvgw==","signatures":[{"sig":"MEUCIQCQpo9U2T/Ly6UPr5myvk+EHtbMfpWHSYEdNYzpsbpUywIgZNWd4vZ6i2vJV6fXJqqawqqkzLEJn6DgtnaJkEWndUQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":170109},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","module":"dist/index.esm.js","engines":{"bun":">=1.0.0","node":">=18.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.esm.js","require":"./dist/index.js"}},"gitHead":"f1b94389ee0cfd4ef4a236da1ee34dbe45b21be5","scripts":{"lint":"eslint src/**/*.ts","test":"bun test","build":"bun run build:clean && bun run build:cjs && bun run build:esm && bun run build:types","format":"prettier --write src/**/*.ts","release":"semantic-release","lint:fix":"eslint src/**/*.ts --fix","build:cjs":"bun build src/index.ts --outdir dist --target node --format cjs --outfile index.js","build:esm":"bun build src/index.ts --outdir dist --target node --format esm --outfile index.esm.js","test:watch":"bun test --watch","type-check":"tsc --noEmit","build:clean":"rm -rf dist","build:types":"tsc --project tsconfig.build.json","format:check":"prettier --check src/**/*.ts","test:coverage":"bun test --coverage","prepublishOnly":"bun run lint && bun run type-check && bun run build && bun run test"},"_npmUser":{"name":"erickweyunga","actor":{"name":"erickweyunga","type":"user","email":"maverickweyunga@gmail.com"},"email":"maverickweyunga@gmail.com"},"repository":{"url":"git+https://github.com/elusionhub/briq-sdk.git","type":"git"},"_npmVersion":"10.9.3","description":"A modern TypeScript SDK for Briq SMS API integration","directories":{},"_nodeVersion":"20.19.2","dependencies":{"dotenv":"^16.5.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.29.0","prettier":"^3.5.3","@eslint/js":"^9.29.0","@types/bun":"latest","typescript":"^5.8.3","@types/node":"^20.0.0","@eslint/eslintrc":"^3.3.1","@typescript-eslint/parser":"^8.34.0","@typescript-eslint/eslint-plugin":"^8.34.0"},"peerDependencies":{"typescript":"^5"},"_npmOperationalInternal":{"tmp":"tmp/briq_1.2.3_1751256267292_0.4186017798316026","host":"s3://npm-registry-packages-npm-production"}},"1.2.5":{"name":"@elusion-sdk/briq","version":"1.2.5","description":"A modern TypeScript SDK for Briq SMS API integration","type":"module","main":"./dist/index.js","module":"dist/esm/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/index.js","types":"./dist/index.d.ts","default":"./dist/index.js"}},"scripts":{"build":"bun run build:clean && bun run build:cjs && bun run build:esm && bun run build:types","build:clean":"rm -rf dist","build:cjs":"bun build src/index.ts --outdir dist --target node --format cjs --outfile index.js","build:esm":"bun build src/index.ts --outdir dist/esm --target node --format esm","build:types":"tsc --project tsconfig.build.json","test":"bun test","test:watch":"bun test --watch","test:coverage":"bun test --coverage","lint":"eslint src/**/*.ts","lint:fix":"eslint src/**/*.ts --fix","format":"prettier --write src/**/*.ts","format:check":"prettier --check src/**/*.ts","type-check":"tsc --noEmit","prepublishOnly":"bun run lint && bun run type-check && bun run build && bun run test","release":"semantic-release"},"keywords":["sms","briq","elusion","messaging","notifications","typescript","sdk","api","communications","text-messaging","bulk-sms"],"author":{"name":"Elusion Hub","email":"elusion.lab@gmail.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/elusionhub/briq-sdk.git"},"homepage":"https://github.com/elusionhub/briq-sdk#readme","bugs":{"url":"https://github.com/elusionhub/briq-sdk/issues"},"engines":{"node":">=18.0.0","bun":">=1.0.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"devDependencies":{"@types/bun":"latest","@types/node":"^20.0.0","@typescript-eslint/eslint-plugin":"^8.34.0","@typescript-eslint/parser":"^8.34.0","@eslint/eslintrc":"^3.3.1","@eslint/js":"^9.29.0","eslint":"^9.29.0","prettier":"^3.5.3","typescript":"^5.8.3"},"peerDependencies":{"typescript":"^5"},"dependencies":{"dotenv":"^16.5.0"},"_id":"@elusion-sdk/briq@1.2.5","gitHead":"2be2b2f7fd0c3f378d25f70f2953b84b7cd1b0e2","_nodeVersion":"20.19.2","_npmVersion":"10.9.3","dist":{"integrity":"sha512-C9IAZpB7fpPsdISVMckj6TEzyli3jkd5o7aO8OsmQPbJWsNr4VP+2u7uYe0Z5t8iiFbBft9x0sjpm5OCw/Wjcg==","shasum":"cb39836630fcba6a58aa1f5dfc50ae252e860b46","tarball":"https://registry.npmjs.org/@elusion-sdk/briq/-/briq-1.2.5.tgz","fileCount":76,"unpackedSize":213827,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFyo/ELM1nE8gf6BrX4f/mnSsn+z3UQKHTuqhLJkvbshAiAc1J7O6LherqI0KQlxOgIUHnnCwNMwGQgbE6dEXkBO4g=="}]},"_npmUser":{"name":"erickweyunga","email":"maverickweyunga@gmail.com","actor":{"name":"erickweyunga","email":"maverickweyunga@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/briq_1.2.5_1751257997250_0.36636855303580185"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-15T07:18:13.045Z","modified":"2025-06-30T04:33:17.604Z","1.2.0":"2025-06-15T07:18:13.288Z","1.2.1":"2025-06-15T09:02:19.832Z","1.2.2":"2025-06-15T09:31:24.103Z","1.2.3":"2025-06-30T04:04:27.476Z","1.2.5":"2025-06-30T04:33:17.412Z"},"bugs":{"url":"https://github.com/elusionhub/briq-sdk/issues"},"author":{"name":"Elusion Hub","email":"elusion.lab@gmail.com"},"license":"MIT","homepage":"https://github.com/elusionhub/briq-sdk#readme","keywords":["sms","briq","elusion","messaging","notifications","typescript","sdk","api","communications","text-messaging","bulk-sms"],"repository":{"type":"git","url":"git+https://github.com/elusionhub/briq-sdk.git"},"description":"A modern TypeScript SDK for Briq SMS API integration","maintainers":[{"name":"erickweyunga","email":"maverickweyunga@gmail.com"}],"readme":"# Briq SMS SDK\n\nA modern TypeScript SDK for the Briq SMS API. Send messages, manage campaigns, and organize workspaces with full type safety.\n\n## Installation\n\n```bash\nnpm install @elusion-sdk/briq\n# or\nbun add @elusion-sdk/briq\n```\n\n## Quick Start\n\n```typescript\nimport { Briq } from \"@elusion-sdk/briq\";\n\nconst briq = new Briq({\n  apiKey: \"your-api-key\", // or set BRIQ_API_KEY env var\n});\n\n// Send an instant message\nconst response = await briq.messages.sendInstant({\n  recipients: [\"255700000000\"],\n  content: \"Hello from Briq!\",\n  sender_id: \"BRIQ\",\n});\n\nconsole.log(\"Message sent:\", response.data);\n```\n\n## Features\n\n- **Modern TypeScript** - Full type safety and IntelliSense\n- **Instant Messages** - Send SMS to single or multiple recipients\n- **Campaign Management** - Create and manage SMS campaigns\n- **Workspace Organization** - Organize projects and teams\n- **Message Tracking** - Get delivery status and logs\n- **Built for Speed** - Optimized for Node.js and modern runtimes\n\n## Core Services\n\n### Messages\n\n```typescript\n// Send instant message\nawait briq.messages.sendInstant({\n  recipients: [\"255700000000\", \"255700000000\"],\n  content: \"Your message here\",\n  sender_id: \"your-sender-id\",\n});\n\n// Get message logs\nconst logs = await briq.messages.getLogs();\n```\n\n### Campaigns\n\n```typescript\n// Create campaign\nconst campaign = await briq.campaigns.create({\n  name: \"Summer Sale\",\n  description: \"Promotional campaign\",\n  workspace_id: \"workspace-id\",\n  launch_date: \"2025-07-01T10:00:00Z\",\n});\n\n// Send campaign message\nawait briq.messages.sendCampaign({\n  campaign_id: campaign.data.id,\n  group_id: \"group-id\",\n  content: \"Special offer inside!\",\n  sender_id: \"your-sender-id\",\n});\n```\n\n### Workspaces\n\n```typescript\n// Create workspace\nconst workspace = await briq.workspaces.create({\n  name: \"My Project\",\n  description: \"SMS campaigns for my project\",\n});\n\n// List all workspaces\nconst workspaces = await briq.workspaces.list();\n```\n\n## Configuration\n\n```typescript\nconst briq = new Briq({\n  apiKey: \"your-api-key\",\n  baseURL: \"https://karibu.briq.tz\", // optional\n  timeout: 30000, // optional, default 30s\n  headers: {\n    // optional custom headers\n    \"X-Custom-Header\": \"value\",\n  },\n});\n```\n\n## Error Handling\n\n```typescript\ntry {\n  await briq.messages.sendInstant({\n    recipients: [\"invalid-number\"],\n    content: \"Test message\",\n    sender_id: \"BRIQ\",\n  });\n} catch (error) {\n  if (error.status === 400) {\n    console.log(\"Invalid request:\", error.message);\n  } else if (error.status === 429) {\n    console.log(\"Rate limited, try again later\");\n  } else {\n    console.log(\"Unexpected error:\", error);\n  }\n}\n```\n\n## Environment Variables\n\n```bash\n# Set your API key\nexport BRIQ_API_KEY=your-api-key-here\n\n# Optional: Custom API base URL\nexport BRIQ_BASE_URL=https://karibu.briq.tz\n```\n\n## TypeScript Support\n\nThis SDK is built with TypeScript and provides full type definitions. No need to install additional `@types` packages.\n\n## Development\n\n```bash\n# Clone and install\ngit clone https://github.com/elusionhub/briq-sdk.git\n\ncd briq-sdk\nbun install\n\n# Build\nbun run build\n```\n\n## License\n\nMIT © [Elution Hub](https://github.com/elusionhub)\n\n## Support\n\n- Email: elusion.lab@gmail.com\n- Issues: [GitHub Issues](https://github.com/elusionhub/briq-sdk/issues)\n- Docs: [API Documentation](https://github.com/elusionhub/briq-sdk#readme)\n\n```\ntypescript-sdk\n├─ assets\n├─ bun.lock\n├─ content\n├─ CONTRIBUTING.md\n├─ eslint.config.cjs\n├─ examples\n│  ├─ campaign-management.ts\n│  ├─ message-sending.ts\n│  └─ workspace-management.ts\n├─ LICENSE\n├─ package.json\n├─ README.md\n├─ release.config.cjs\n├─ src\n│  ├─ client\n│  │  ├─ BaseClient.ts\n│  │  ├─ BriqClient.ts\n│  │  └─ HttpClient.ts\n│  ├─ config\n│  │  └─ defaults.ts\n│  ├─ factory.ts\n│  ├─ index.ts\n│  ├─ services\n│  │  ├─ BaseService.ts\n│  │  ├─ CampaignService.ts\n│  │  ├─ MessageService.ts\n│  │  └─ WorkspaceService.ts\n│  ├─ types\n│  │  ├─ campaign.ts\n│  │  ├─ common.ts\n│  │  ├─ message.ts\n│  │  └─ workspace.ts\n│  └─ utils\n│     ├─ constants.ts\n│     ├─ errors.ts\n│     ├─ helpers.ts\n│     └─ validators.ts\n├─ tests\n│  └─ blank.txt\n├─ tsconfig.build.json\n└─ tsconfig.json\n\n```","readmeFilename":"README.md"}