feat: Add RestException export to main twilio package with examples and documentation

[Copilot]

Fixes #1105 by adding RestException to the main package exports, allowing developers to import it directly from 'twilio' instead of using deep imports, and provides comprehensive examples and documentation.

Problem

Previously, developers had to use deep imports to access RestException:

// Old approach - problematic with modern TypeScript configs
import RestException from 'twilio/lib/base/RestException'

This caused issues with modern TypeScript configurations and wasn't intuitive for developers who expected to import it from the main package like other Twilio components.

Solution

Added RestException to the main package exports following the same pattern used by other components like RequestClient, and provided comprehensive examples showing how to use it effectively.

// Now supported - clean and intuitive
import { RestException } from 'twilio'

// Also works with CommonJS
const { RestException } = require('twilio')

Changes

• Added RestException import to src/index.ts
• Added both type and value exports to the TwilioSDK namespace
• Updated examples/example.js to demonstrate proper RestException handling in both callback and promise patterns
• Added comprehensive usage examples in README.md for both CommonJS and ESM with proper error handling patterns
• Maintains full TypeScript support with proper type definitions

Usage Examples

Error Handling with ESM:

import twilio, { RestException } from 'twilio';

try {
  const message = await client.messages.create({...});
} catch (error) {
  if (error instanceof RestException) {
    console.log(`Twilio Error ${error.code}: ${error.message}`);
    console.log(`Status: ${error.status}`);
    console.log(`More info: ${error.moreInfo}`);
  }
}

Error Handling with CommonJS:

const { RestException } = require('twilio');

client.messages.create({...})
  .catch((error) => {
    if (error instanceof RestException) {
      console.log(`Twilio Error ${error.code}: ${error.message}`);
    }
  });

Validation

• All existing tests pass
• TypeScript compilation succeeds
• No breaking changes to existing functionality
• Follows established export patterns in the codebase
• Examples demonstrate real-world usage patterns

This change provides a significantly better developer experience with proper documentation and examples while maintaining backward compatibility and following the library's existing conventions.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[tiwarishubham635]

@copilot update examples/example.js to catch rest exception. Also add the usage examples in readme for both commonjs and esm.

[Copilot]

@copilot update examples/example.js to catch rest exception. Also add the usage examples in readme for both commonjs and esm.

Done! I've updated examples/example.js to demonstrate RestException handling and added comprehensive usage examples in the README for both CommonJS and ESM. The examples show proper error handling patterns with instanceof RestException checks and accessing error properties like code, message, status, and moreInfo. Changes committed in 22e6269.

[tiwarishubham635]

Tested the example and readme snippets. Working fine. LGTM!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud