pnp / pnp/proxy-samples

Extend Twilio API mocks with additional endpoints

Open
#67 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
35
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Summary

The current Twilio samples (twilio-api-mocks and twilio-resilience-testing) cover 51 endpoints for the most commonly used Twilio operations. This issue tracks expanding coverage to additional Twilio API resources.

Current Coverage (51 mocks)

  • Accounts - CRUD operations
  • Messages - CRUD + Media subresource
  • Calls - CRUD + Recordings subresource
  • IncomingPhoneNumbers - CRUD + Local/TollFree/Mobile
  • AvailablePhoneNumbers - Local/TollFree/Mobile search
  • Conferences - CRUD + Participants
  • Queues - CRUD + Members
  • Recordings - CRUD + Transcriptions

Proposed Additions

High Priority (commonly used)
  • Addresses - CRUD + DependentPhoneNumbers (SID: AD)
  • Applications - CRUD for TwiML apps (SID: AP)
  • Usage Records - List + subresources (Daily, Monthly, Today, Yesterday, ThisMonth, LastMonth)
  • Usage Triggers - CRUD for usage alerts
Medium Priority
  • Transcriptions - CRUD operations
  • Notifications - List notifications
  • Outgoing Caller IDs - CRUD operations
  • Short Codes - List/Update operations
  • Keys - API key management
Lower Priority (specialized use cases)
  • SIP Domains - SIP trunking resources
  • Connect Apps - Twilio Connect
  • Authorized Connect Apps - App authorizations

Out of Scope

These are separate Twilio products with different base URLs (not part of the core 2010-04-01 API):

  • Verify API
  • Lookup API
  • Conversations API
  • Video API
  • Studio API
  • TaskRouter API
  • Flex API
  • Sync API
  • Notify API

Notes

  • Both twilio-api-mocks (success responses) and twilio-resilience-testing (error injection) should be updated together
  • Follow existing mock patterns and SID formats
  • Reference Twilio docs for accurate response schemas

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review existing endpoint patterns in the twilio-api-mocks and twilio-resilience-testing samples, then compare the proposed resources with Twilio's core 2010-04-01 documentation. Done means both samples cover the agreed endpoints with accurate response schemas, SID formats, and success/error behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.