This is the public Twilio REST API.
Package
octri_twilio· Version1.0.0· 197 operations
# In the consumer project
python -m pip install /path/to/generated-sdk
# After this version is published
python -m pip install octri_twilio==1.0.0The example calls ListAccount (GET /2010-04-01/Accounts.json), a low-friction operation that requires no request arguments.
import asyncio
import os
from octri_twilio import ClientConfig, ClientAuthConfig
from octri_twilio.sdk import Twilio
from octri_twilio.client import BasicCredentials
async def main() -> None:
config = ClientConfig(
base_url="https://api.twilio.com",
auth=ClientAuthConfig(account_sid_auth_token=BasicCredentials(username=os.environ["API_USERNAME"], password=os.environ["API_PASSWORD"])),
)
client = Twilio(config)
result = await client.api20100401account.list_account()
print(result)
asyncio.run(main())Keep credentials outside source control. The quickstart reads them from the environment and the client applies them to every request.
| Scheme | ClientAuthConfig field | Sent as |
|---|---|---|
| accountSid_authToken | account_sid_auth_token |
Authorization: Basic … |
- Base URL:
https://api.twilio.com. - Transport: httpx.
- Timeout: 30,000 ms per attempt.
- Retries: up to 3 attempts for status codes
408,425,429,500,502,503,504, with 500–8,000 ms backoff. - Idempotency: disabled.
- Error telemetry is disabled by default, even when a reporting endpoint is baked into the build. Consumers must opt in explicitly.
- Telemetry PII filtering is enabled by default: common credentials and direct identifiers are recursively replaced with
[REDACTED]before reports are sent. Disable it only through the generated logging config'sfilterPii(or language-native equivalent) for a trusted private sink.
High-level operation methods return the typed response body directly. The low-level request layer returns an SdkResponse<T> envelope containing data, status, headers, request ID, latency, and attempt count.
All failure paths use a small, predictable hierarchy:
| Error | Meaning |
|---|---|
SdkValidationError |
A request argument failed an OpenAPI constraint before network I/O. |
SdkHttpError |
The server returned a non-2xx response. |
SdkNetworkError |
DNS, connection, TLS, or socket failure. |
SdkTimeoutError |
The configured per-attempt timeout elapsed. |
HTTP errors expose status_code, the response body and headers, plus request_id when the server supplies one. Preserve the request ID in support logs; it is the fastest way to correlate a failed SDK call with server-side traces.
- Operation implementations are grouped under
src/octri_twilio/methods/. - 150 component models are split by API domain under
src/octri_twilio/types/<domain>.pyortypes/<tag path>/models.py, re-exported byoctri_twilio.types. - Component schemas can choose a nested model folder with
x-octri-sdk-tags: ["Billing/Invoices"]; the first tag owns the model and/creates nesting. sdk-manifest.jsonis the language-neutral public API index: operations, request/response modes, model properties, enum values, and generation settings.- Public barrel/module exports are the compatibility boundary. Import public model names from those exports; internal domain filenames may evolve without changing model names.
Generated SDK includes schema-derived, zero-dependency mock server and network contract suite. Node.js 20+ required. Contract probes use authored response examples only; schema-synthesized routes remain available to the local server.
./scripts/mock --port 4010 starts server. ./scripts/test runs the mock contract suite, then native SDK tests. A zero-authored-example contract run succeeds with an explicit zero-test
summary; mismatches in authored examples still fail.