Installation
Basic Usage
SDK Methods
The Siren TypeScript SDK provides a clean, namespaced interface to interact with the Siren API. Below are the available methods organized by functionality.Templates
Channel Templates
Messaging
Workflows
Webhooks
Users
For Package Developers
Environment Configuration
For testing the SDK, set these environment variables:SIREN_API_KEY: Your API key from the Siren dashboardSIREN_ENV: Set todevfor development/testing (defaults toprod)
Prerequisites
- Git
- Node.js 14 or higher
- npm or yarn
Setup Steps
1
Clone the repository
2
Install dependencies
3
Set up pre-commit hooks
@trysiren/node SDK!
Code Style & Linting
Code style is enforced by:- ESLint and Prettier for code formatting
- TypeScript compiler for type checking
Running Tests
To run the test suite, use the following command from the project root directory:src/__tests__/ directory.
Submitting Changes
- Create a feature branch for your changes
- Commit your changes (pre-commit hooks will run)
- Push your branch and open a Pull Request against the
developbranch