[Epic]: Revamp Twilio Connector

[RDPerera]

Connector Name

ballerinax/twilio (Twilio) is a cloud communications platform that enables developers to build scalable communication applications, including voice, text, chat, and video.

Twilio's REST API and SDKs make it easy for developers to add communication capabilities to their applications, without the need to manage infrastructure or telecom carriers.

The Twilio library for Ballerina will make it even easier for developers to build communication applications using the Ballerina programming language. The library will provide a high-level abstraction of the Twilio REST API, so that developers do not need to worry about the underlying details.

Use Cases The Twilio can be used in a variety of applications, including:

• Sending and receiving SMS, voice, and WhatsApp messages.
• Building two-factor authentication systems.
• Developing customer relationship management (CRM) systems.
• Creating chatbots and other conversational interfaces.
• Building integrations with other communication platforms

Suggested improvement

Currently, Ballerina supports the following capabilities through the Twilio connector:

• Get Account Details
• Send SMS
• Get Message
• Send WhatsApp Message
• Make Voice Call

The task at hand is to expand the capabilities of the Ballerina Twilio connector to encompass a broader range of operations.

Implementation

Twilio services are delivered through their REST APIs.Twilio has Open API specifications for their REST APIs, enabling developers to understand and interact with their services more effectively. In fact, there are 36 distinct Open API specifications, each tailored to a specific service and version(Appendix 1). However, for our proposed connector development, we will be focusing on the Open API Specification titled "2010_04_01" which represents a widely used version encompassing 202 essential operations.

OAI Specification: https://github.com/twilio/twilio-oai/blob/main/spec/yaml/twilio_api_v2010.yaml

Using the open API specification, we are in the process of building a connector with the assistance of open API tools.

Proposed Functionalities for Twilio 4.0

• Create a new Twilio subaccount
• Retrieve a collection of accounts linked to the requester's account
• Fetch a specific account by its SID
• Modify account properties
• Handle addresses: create, list, delete, fetch, update
• Manage applications: create, retrieve list, delete, fetch, update properties
• Work with authorized connect apps: fetch instance, retrieve list
• List available phone number countries and types
• Handle account balance
• Manage outgoing calls and recordings
• Handle conferences: fetch instance, update, retrieve list
• Manage connect apps: fetch instance, update, delete, retrieve list
• Handle incoming phone numbers: update, fetch, delete, list, purchase
• Manage add-ons, keys, and media resources
• Handle messages: send, retrieve list, delete, fetch, update, create feedback
• Manage signing keys and notifications
• Handle outgoing caller IDs: fetch instance, update, delete, retrieve list
• Manage participants in a conference: fetch instance, update properties, kick, create, retrieve list
• Handle payments and queues: create session, update, remove empty queue, retrieve list
• Manage recordings: fetch instance, delete, retrieve list
• Handle add-on results and payloads: fetch instance, delete, retrieve list
• Manage recording transcriptions: fetch, delete, list
• Handle phone number SafeList: add, check, remove
• Manage short codes: fetch instance, update, retrieve list
• Manage credential list mappings and IP Access Control Lists
• Handle domains: create, fetch instance, update attributes, delete
• Manage usage records and triggers: fetch instance, update, delete, create, retrieve list
• Manage user-defined messages: create, subscribe, delete subscription

Sub Tasks

Revamping the existing Ballerina Twilio connector involves following sub tasks

• [x] Review the Ballerina connector for issues and propose improvements.
• [x] Analyze existing Twilio APIs to draft a connector design.
• [x] Build the Connector.
• [x] Create a test suite.
• [x] Write examples.
• [x] Implement the wrapper client.
• [x] Migrating connector repository to gradle
• [x] Documentation

[RDPerera]

As It's completed and released.