Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@signalwire/compatibility-api

signalwire8.5kMIT3.1.4TypeScript support: included

SignalWire Compatibility API

signalwire, voice, laml, sms, rest, api

readme

SignalWire Compatibility SDK

Build Status NPM

The SignalWire Compatibility SDK is designed to make migrating your existing phone or messaging application easy and quick, while giving you access to our next generation APIs and endpoints to help you take your application to the next level.

Getting Started

Read the implementation documentation, guides and API Reference at the official SignalWire Compatibility SDK Documentation site.

Contributing

SignalWire Compatibility SDK is open source and maintained by the SignalWire team, but we are very grateful for everyone who has contributed and assisted so far.

If you'd like to contribute, feel free to visit our Slack channel and read our developer section to get the code running in your local environment.

Developers

The Compatibility SDK is a package inside the compatibility-api-js repository. To setup the dev environment follow these steps:

  1. Download the installer for the LTS version of Node.js. This is the best way to also install npm.
  2. Fork the compatibility-api-js repository and clone it.
  3. Create a new branch from main for your change.
  4. Run npm install to install global dependencies.
  5. Make changes!

Versioning

SignalWire Compatibility SDK follows Semantic Versioning 2.0 as defined at http://semver.org.

License

@signalwire/compatibility-api-js is copyright © 2018-2023 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

changelog

@signalwire/compatibility-api

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning.

[3.1.4] - 2023-08-30

Fixed

  • Restore create() and update() methods on FaxInstance and FaxListInstance namespaces.

[3.1.3] - 2023-08-04

Changed

  • Add a warning message on the validateRequest method to inform the user to use a different SDK to validate Relay requests.

[3.1.2] - 2023-06-28

Fixed

  • Properly export CompatibilityApi and include src folder in the package.

[3.1.1] - 2023-06-28

Fixed

  • Fix typescript declaration.

[3.1.0] - 2023-05-17

Added

  • Add support for AI noun.
  • Validate the X-SignalWire-Signature header for the inbound request.