@orchesty/connector-twilio 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Twilio Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-twilio)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Twilio, a cloud communication platform for building voice, VoIP, and SMS applications via a web API.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using HTTP Basic auth with your Twilio Account SID and Auth Token (Base64-encoded). The message payload is submitted as `multipart/form-data`.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `user` | Your Twilio Account SID |
|
|
17
|
+
| `password` | Your Twilio Auth Token |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `TwilioSendMessage` | Connector | Sends an SMS message via `POST /Accounts/{AccountSid}/Messages`; submits `From`, `To`, and `Body` as `multipart/form-data` |
|
|
24
|
+
|
|
25
|
+
## Setup
|
|
26
|
+
|
|
27
|
+
### Credentials
|
|
28
|
+
|
|
29
|
+
1. Log in to the [Twilio Console](https://console.twilio.com/).
|
|
30
|
+
2. On the dashboard, copy your **Account SID** and **Auth Token**.
|
|
31
|
+
3. In Orchesty, open the Twilio application settings and enter the Account SID as **User** and the Auth Token as **Password**.
|
|
32
|
+
|
|
33
|
+
### API Documentation
|
|
34
|
+
|
|
35
|
+
Twilio SMS API: [https://www.twilio.com/docs/sms/api](https://www.twilio.com/docs/sms/api)
|
|
36
|
+
|
|
37
|
+
## Installation & Usage
|
|
38
|
+
|
|
39
|
+
Install the package:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm install @orchesty/connector-twilio @orchesty/nodejs-sdk
|
|
43
|
+
# or
|
|
44
|
+
pnpm add @orchesty/connector-twilio @orchesty/nodejs-sdk
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Register the application and nodes in your Orchesty DI container:
|
|
48
|
+
|
|
49
|
+
```typescript
|
|
50
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
51
|
+
import TwilioApplication from '@orchesty/connector-twilio/dist/TwilioApplication';
|
|
52
|
+
import TwilioSendMessage from '@orchesty/connector-twilio/dist/Connector/TwilioSendMessage';
|
|
53
|
+
|
|
54
|
+
const app = new TwilioApplication();
|
|
55
|
+
container.setApplication(app);
|
|
56
|
+
container.setNode(new TwilioSendMessage(), app);
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
62
|
+
|
|
63
|
+
## Contributing
|
|
64
|
+
|
|
65
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
66
|
+
|
|
67
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
68
|
+
|
|
69
|
+
All contributions should include:
|
|
70
|
+
- Source code in `src/` following the existing connector structure
|
|
71
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
72
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-twilio",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.8",
|
|
21
21
|
"form-data": "^4.0.5"
|
|
22
22
|
},
|
|
23
23
|
"engines": {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-twilio",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"keywords": [],
|
|
12
12
|
"author": "info@hanaboso.com",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
14
|
+
"@orchesty/nodejs-sdk": "^5.0.8",
|
|
15
15
|
"form-data": "^4.0.5"
|
|
16
16
|
},
|
|
17
17
|
"engines": {
|