telnyx 7.28.0 → 7.30.0-beta.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/CHANGELOG.md +7 -0
- package/README.md +27 -0
- package/client.d.mts +37 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +37 -6
- package/client.d.ts.map +1 -1
- package/client.js +31 -0
- package/client.js.map +1 -1
- package/client.mjs +31 -0
- package/client.mjs.map +1 -1
- package/lib/login-token.d.mts +87 -0
- package/lib/login-token.d.mts.map +1 -0
- package/lib/login-token.d.ts +87 -0
- package/lib/login-token.d.ts.map +1 -0
- package/lib/login-token.js +190 -0
- package/lib/login-token.js.map +1 -0
- package/lib/login-token.mjs +151 -0
- package/lib/login-token.mjs.map +1 -0
- package/package.json +1 -1
- package/resources/addresses/actions.d.mts +19 -4
- package/resources/addresses/actions.d.mts.map +1 -1
- package/resources/addresses/actions.d.ts +19 -4
- package/resources/addresses/actions.d.ts.map +1 -1
- package/resources/ai/ai.d.mts +4 -0
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +4 -0
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js +4 -0
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs +4 -0
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +31 -27
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +31 -27
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/avatars.d.mts +9 -9
- package/resources/ai/avatars.d.ts +9 -9
- package/resources/ai/avatars.js +9 -9
- package/resources/ai/avatars.mjs +9 -9
- package/resources/ai/index.d.mts +1 -0
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +1 -0
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js +5 -3
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs +1 -0
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/tests/index.d.mts +4 -0
- package/resources/ai/tests/index.d.mts.map +1 -0
- package/resources/ai/tests/index.d.ts +4 -0
- package/resources/ai/tests/index.d.ts.map +1 -0
- package/resources/ai/tests/index.js +11 -0
- package/resources/ai/tests/index.js.map +1 -0
- package/resources/ai/tests/index.mjs +5 -0
- package/resources/ai/tests/index.mjs.map +1 -0
- package/resources/ai/tests/schedules/index.d.mts +3 -0
- package/resources/ai/tests/schedules/index.d.mts.map +1 -0
- package/resources/ai/tests/schedules/index.d.ts +3 -0
- package/resources/ai/tests/schedules/index.d.ts.map +1 -0
- package/resources/ai/tests/schedules/index.js +9 -0
- package/resources/ai/tests/schedules/index.js.map +1 -0
- package/resources/ai/tests/schedules/index.mjs +4 -0
- package/resources/ai/tests/schedules/index.mjs.map +1 -0
- package/resources/ai/tests/schedules/schedules.d.mts +10 -0
- package/resources/ai/tests/schedules/schedules.d.mts.map +1 -0
- package/resources/ai/tests/schedules/schedules.d.ts +10 -0
- package/resources/ai/tests/schedules/schedules.d.ts.map +1 -0
- package/resources/ai/tests/schedules/schedules.js +17 -0
- package/resources/ai/tests/schedules/schedules.js.map +1 -0
- package/resources/ai/tests/schedules/schedules.mjs +12 -0
- package/resources/ai/tests/schedules/schedules.mjs.map +1 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.d.mts +171 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.d.mts.map +1 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.d.ts +171 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.d.ts.map +1 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.js +88 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.js.map +1 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.mjs +84 -0
- package/resources/ai/tests/schedules/v1/cron-jobs.mjs.map +1 -0
- package/resources/ai/tests/schedules/v1/index.d.mts +3 -0
- package/resources/ai/tests/schedules/v1/index.d.mts.map +1 -0
- package/resources/ai/tests/schedules/v1/index.d.ts +3 -0
- package/resources/ai/tests/schedules/v1/index.d.ts.map +1 -0
- package/resources/ai/tests/schedules/v1/index.js +9 -0
- package/resources/ai/tests/schedules/v1/index.js.map +1 -0
- package/resources/ai/tests/schedules/v1/index.mjs +4 -0
- package/resources/ai/tests/schedules/v1/index.mjs.map +1 -0
- package/resources/ai/tests/schedules/v1/v1.d.mts +10 -0
- package/resources/ai/tests/schedules/v1/v1.d.mts.map +1 -0
- package/resources/ai/tests/schedules/v1/v1.d.ts +10 -0
- package/resources/ai/tests/schedules/v1/v1.d.ts.map +1 -0
- package/resources/ai/tests/schedules/v1/v1.js +17 -0
- package/resources/ai/tests/schedules/v1/v1.js.map +1 -0
- package/resources/ai/tests/schedules/v1/v1.mjs +12 -0
- package/resources/ai/tests/schedules/v1/v1.mjs.map +1 -0
- package/resources/ai/tests/schedules/v1.d.mts +2 -0
- package/resources/ai/tests/schedules/v1.d.mts.map +1 -0
- package/resources/ai/tests/schedules/v1.d.ts +2 -0
- package/resources/ai/tests/schedules/v1.d.ts.map +1 -0
- package/resources/ai/tests/schedules/v1.js +6 -0
- package/resources/ai/tests/schedules/v1.js.map +1 -0
- package/resources/ai/tests/schedules/v1.mjs +3 -0
- package/resources/ai/tests/schedules/v1.mjs.map +1 -0
- package/resources/ai/tests/schedules.d.mts +2 -0
- package/resources/ai/tests/schedules.d.mts.map +1 -0
- package/resources/ai/tests/schedules.d.ts +2 -0
- package/resources/ai/tests/schedules.d.ts.map +1 -0
- package/resources/ai/tests/schedules.js +6 -0
- package/resources/ai/tests/schedules.js.map +1 -0
- package/resources/ai/tests/schedules.mjs +3 -0
- package/resources/ai/tests/schedules.mjs.map +1 -0
- package/resources/ai/tests/test-framework/index.d.mts +3 -0
- package/resources/ai/tests/test-framework/index.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/index.d.ts +3 -0
- package/resources/ai/tests/test-framework/index.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/index.js +9 -0
- package/resources/ai/tests/test-framework/index.js.map +1 -0
- package/resources/ai/tests/test-framework/index.mjs +4 -0
- package/resources/ai/tests/test-framework/index.mjs.map +1 -0
- package/resources/ai/tests/test-framework/test-framework.d.mts +10 -0
- package/resources/ai/tests/test-framework/test-framework.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/test-framework.d.ts +10 -0
- package/resources/ai/tests/test-framework/test-framework.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/test-framework.js +17 -0
- package/resources/ai/tests/test-framework/test-framework.js.map +1 -0
- package/resources/ai/tests/test-framework/test-framework.mjs +12 -0
- package/resources/ai/tests/test-framework/test-framework.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/aiagents.d.mts +216 -0
- package/resources/ai/tests/test-framework/v1/aiagents.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/aiagents.d.ts +216 -0
- package/resources/ai/tests/test-framework/v1/aiagents.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/aiagents.js +93 -0
- package/resources/ai/tests/test-framework/v1/aiagents.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/aiagents.mjs +89 -0
- package/resources/ai/tests/test-framework/v1/aiagents.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/index.d.mts +6 -0
- package/resources/ai/tests/test-framework/v1/index.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/index.d.ts +6 -0
- package/resources/ai/tests/test-framework/v1/index.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/index.js +15 -0
- package/resources/ai/tests/test-framework/v1/index.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/index.mjs +7 -0
- package/resources/ai/tests/test-framework/v1/index.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/metrics.d.mts +339 -0
- package/resources/ai/tests/test-framework/v1/metrics.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/metrics.d.ts +339 -0
- package/resources/ai/tests/test-framework/v1/metrics.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/metrics.js +145 -0
- package/resources/ai/tests/test-framework/v1/metrics.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/metrics.mjs +141 -0
- package/resources/ai/tests/test-framework/v1/metrics.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/results.d.mts +207 -0
- package/resources/ai/tests/test-framework/v1/results.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/results.d.ts +207 -0
- package/resources/ai/tests/test-framework/v1/results.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/results.js +65 -0
- package/resources/ai/tests/test-framework/v1/results.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/results.mjs +61 -0
- package/resources/ai/tests/test-framework/v1/results.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/scenarios.d.mts +528 -0
- package/resources/ai/tests/test-framework/v1/scenarios.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/scenarios.d.ts +528 -0
- package/resources/ai/tests/test-framework/v1/scenarios.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/scenarios.js +222 -0
- package/resources/ai/tests/test-framework/v1/scenarios.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/scenarios.mjs +218 -0
- package/resources/ai/tests/test-framework/v1/scenarios.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1/v1.d.mts +83 -0
- package/resources/ai/tests/test-framework/v1/v1.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1/v1.d.ts +83 -0
- package/resources/ai/tests/test-framework/v1/v1.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1/v1.js +46 -0
- package/resources/ai/tests/test-framework/v1/v1.js.map +1 -0
- package/resources/ai/tests/test-framework/v1/v1.mjs +41 -0
- package/resources/ai/tests/test-framework/v1/v1.mjs.map +1 -0
- package/resources/ai/tests/test-framework/v1.d.mts +2 -0
- package/resources/ai/tests/test-framework/v1.d.mts.map +1 -0
- package/resources/ai/tests/test-framework/v1.d.ts +2 -0
- package/resources/ai/tests/test-framework/v1.d.ts.map +1 -0
- package/resources/ai/tests/test-framework/v1.js +6 -0
- package/resources/ai/tests/test-framework/v1.js.map +1 -0
- package/resources/ai/tests/test-framework/v1.mjs +3 -0
- package/resources/ai/tests/test-framework/v1.mjs.map +1 -0
- package/resources/ai/tests/test-framework.d.mts +2 -0
- package/resources/ai/tests/test-framework.d.mts.map +1 -0
- package/resources/ai/tests/test-framework.d.ts +2 -0
- package/resources/ai/tests/test-framework.d.ts.map +1 -0
- package/resources/ai/tests/test-framework.js +6 -0
- package/resources/ai/tests/test-framework.js.map +1 -0
- package/resources/ai/tests/test-framework.mjs +3 -0
- package/resources/ai/tests/test-framework.mjs.map +1 -0
- package/resources/ai/tests/tests.d.mts +14 -0
- package/resources/ai/tests/tests.d.mts.map +1 -0
- package/resources/ai/tests/tests.d.ts +14 -0
- package/resources/ai/tests/tests.d.ts.map +1 -0
- package/resources/ai/tests/tests.js +21 -0
- package/resources/ai/tests/tests.js.map +1 -0
- package/resources/ai/tests/tests.mjs +16 -0
- package/resources/ai/tests/tests.mjs.map +1 -0
- package/resources/ai/tests.d.mts +2 -0
- package/resources/ai/tests.d.mts.map +1 -0
- package/resources/ai/tests.d.ts +2 -0
- package/resources/ai/tests.d.ts.map +1 -0
- package/resources/ai/tests.js +6 -0
- package/resources/ai/tests.js.map +1 -0
- package/resources/ai/tests.mjs +3 -0
- package/resources/ai/tests.mjs.map +1 -0
- package/resources/artifact-downloads.d.mts +21 -0
- package/resources/artifact-downloads.d.mts.map +1 -0
- package/resources/artifact-downloads.d.ts +21 -0
- package/resources/artifact-downloads.d.ts.map +1 -0
- package/resources/artifact-downloads.js +26 -0
- package/resources/artifact-downloads.js.map +1 -0
- package/resources/artifact-downloads.mjs +22 -0
- package/resources/artifact-downloads.mjs.map +1 -0
- package/resources/bot-challenge.js +1 -1
- package/resources/bot-challenge.js.map +1 -1
- package/resources/bot-challenge.mjs +1 -1
- package/resources/bot-challenge.mjs.map +1 -1
- package/resources/bot-sessions.js +1 -1
- package/resources/bot-sessions.js.map +1 -1
- package/resources/bot-sessions.mjs +1 -1
- package/resources/bot-sessions.mjs.map +1 -1
- package/resources/bot-signup.js +2 -2
- package/resources/bot-signup.js.map +1 -1
- package/resources/bot-signup.mjs +2 -2
- package/resources/bot-signup.mjs.map +1 -1
- package/resources/browser-sessions/actions.d.mts +542 -0
- package/resources/browser-sessions/actions.d.mts.map +1 -0
- package/resources/browser-sessions/actions.d.ts +542 -0
- package/resources/browser-sessions/actions.d.ts.map +1 -0
- package/resources/browser-sessions/actions.js +55 -0
- package/resources/browser-sessions/actions.js.map +1 -0
- package/resources/browser-sessions/actions.mjs +51 -0
- package/resources/browser-sessions/actions.mjs.map +1 -0
- package/resources/browser-sessions/browser-sessions.d.mts +165 -0
- package/resources/browser-sessions/browser-sessions.d.mts.map +1 -0
- package/resources/browser-sessions/browser-sessions.d.ts +165 -0
- package/resources/browser-sessions/browser-sessions.d.ts.map +1 -0
- package/resources/browser-sessions/browser-sessions.js +87 -0
- package/resources/browser-sessions/browser-sessions.js.map +1 -0
- package/resources/browser-sessions/browser-sessions.mjs +82 -0
- package/resources/browser-sessions/browser-sessions.mjs.map +1 -0
- package/resources/browser-sessions/index.d.mts +3 -0
- package/resources/browser-sessions/index.d.mts.map +1 -0
- package/resources/browser-sessions/index.d.ts +3 -0
- package/resources/browser-sessions/index.d.ts.map +1 -0
- package/resources/browser-sessions/index.js +9 -0
- package/resources/browser-sessions/index.js.map +1 -0
- package/resources/browser-sessions/index.mjs +4 -0
- package/resources/browser-sessions/index.mjs.map +1 -0
- package/resources/browser-sessions.d.mts +2 -0
- package/resources/browser-sessions.d.mts.map +1 -0
- package/resources/browser-sessions.d.ts +2 -0
- package/resources/browser-sessions.d.ts.map +1 -0
- package/resources/browser-sessions.js +6 -0
- package/resources/browser-sessions.js.map +1 -0
- package/resources/browser-sessions.mjs +3 -0
- package/resources/browser-sessions.mjs.map +1 -0
- package/resources/call-control-applications.d.mts +2 -2
- package/resources/call-control-applications.d.ts +2 -2
- package/resources/calls/actions.d.mts +35 -28
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +35 -28
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/conferences/actions.d.mts +3 -2
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +3 -2
- package/resources/conferences/actions.d.ts.map +1 -1
- package/resources/email/dedicated-ips/actions.d.mts +73 -0
- package/resources/email/dedicated-ips/actions.d.mts.map +1 -0
- package/resources/email/dedicated-ips/actions.d.ts +73 -0
- package/resources/email/dedicated-ips/actions.d.ts.map +1 -0
- package/resources/email/dedicated-ips/actions.js +84 -0
- package/resources/email/dedicated-ips/actions.js.map +1 -0
- package/resources/email/dedicated-ips/actions.mjs +80 -0
- package/resources/email/dedicated-ips/actions.mjs.map +1 -0
- package/resources/email/dedicated-ips/dedicated-ips.d.mts +444 -0
- package/resources/email/dedicated-ips/dedicated-ips.d.mts.map +1 -0
- package/resources/email/dedicated-ips/dedicated-ips.d.ts +444 -0
- package/resources/email/dedicated-ips/dedicated-ips.d.ts.map +1 -0
- package/resources/email/dedicated-ips/dedicated-ips.js +142 -0
- package/resources/email/dedicated-ips/dedicated-ips.js.map +1 -0
- package/resources/email/dedicated-ips/dedicated-ips.mjs +137 -0
- package/resources/email/dedicated-ips/dedicated-ips.mjs.map +1 -0
- package/resources/email/dedicated-ips/index.d.mts +3 -0
- package/resources/email/dedicated-ips/index.d.mts.map +1 -0
- package/resources/email/dedicated-ips/index.d.ts +3 -0
- package/resources/email/dedicated-ips/index.d.ts.map +1 -0
- package/resources/email/dedicated-ips/index.js +9 -0
- package/resources/email/dedicated-ips/index.js.map +1 -0
- package/resources/email/dedicated-ips/index.mjs +4 -0
- package/resources/email/dedicated-ips/index.mjs.map +1 -0
- package/resources/email/dedicated-ips.d.mts +2 -0
- package/resources/email/dedicated-ips.d.mts.map +1 -0
- package/resources/email/dedicated-ips.d.ts +2 -0
- package/resources/email/dedicated-ips.d.ts.map +1 -0
- package/resources/email/dedicated-ips.js +6 -0
- package/resources/email/dedicated-ips.js.map +1 -0
- package/resources/email/dedicated-ips.mjs +3 -0
- package/resources/email/dedicated-ips.mjs.map +1 -0
- package/resources/email/email.d.mts +14 -0
- package/resources/email/email.d.mts.map +1 -0
- package/resources/email/email.d.ts +14 -0
- package/resources/email/email.d.ts.map +1 -0
- package/resources/email/email.js +21 -0
- package/resources/email/email.js.map +1 -0
- package/resources/email/email.mjs +16 -0
- package/resources/email/email.mjs.map +1 -0
- package/resources/email/index.d.mts +4 -0
- package/resources/email/index.d.mts.map +1 -0
- package/resources/email/index.d.ts +4 -0
- package/resources/email/index.d.ts.map +1 -0
- package/resources/email/index.js +11 -0
- package/resources/email/index.js.map +1 -0
- package/resources/email/index.mjs +5 -0
- package/resources/email/index.mjs.map +1 -0
- package/resources/email/ip-pools/index.d.mts +3 -0
- package/resources/email/ip-pools/index.d.mts.map +1 -0
- package/resources/email/ip-pools/index.d.ts +3 -0
- package/resources/email/ip-pools/index.d.ts.map +1 -0
- package/resources/email/ip-pools/index.js +9 -0
- package/resources/email/ip-pools/index.js.map +1 -0
- package/resources/email/ip-pools/index.mjs +4 -0
- package/resources/email/ip-pools/index.mjs.map +1 -0
- package/resources/email/ip-pools/ip-pools.d.mts +184 -0
- package/resources/email/ip-pools/ip-pools.d.mts.map +1 -0
- package/resources/email/ip-pools/ip-pools.d.ts +184 -0
- package/resources/email/ip-pools/ip-pools.d.ts.map +1 -0
- package/resources/email/ip-pools/ip-pools.js +102 -0
- package/resources/email/ip-pools/ip-pools.js.map +1 -0
- package/resources/email/ip-pools/ip-pools.mjs +97 -0
- package/resources/email/ip-pools/ip-pools.mjs.map +1 -0
- package/resources/email/ip-pools/ips.d.mts +83 -0
- package/resources/email/ip-pools/ips.d.mts.map +1 -0
- package/resources/email/ip-pools/ips.d.ts +83 -0
- package/resources/email/ip-pools/ips.d.ts.map +1 -0
- package/resources/email/ip-pools/ips.js +54 -0
- package/resources/email/ip-pools/ips.js.map +1 -0
- package/resources/email/ip-pools/ips.mjs +50 -0
- package/resources/email/ip-pools/ips.mjs.map +1 -0
- package/resources/email/ip-pools.d.mts +2 -0
- package/resources/email/ip-pools.d.mts.map +1 -0
- package/resources/email/ip-pools.d.ts +2 -0
- package/resources/email/ip-pools.d.ts.map +1 -0
- package/resources/email/ip-pools.js +6 -0
- package/resources/email/ip-pools.js.map +1 -0
- package/resources/email/ip-pools.mjs +3 -0
- package/resources/email/ip-pools.mjs.map +1 -0
- package/resources/email.d.mts +2 -0
- package/resources/email.d.mts.map +1 -0
- package/resources/email.d.ts +2 -0
- package/resources/email.d.ts.map +1 -0
- package/resources/email.js +6 -0
- package/resources/email.js.map +1 -0
- package/resources/email.mjs +3 -0
- package/resources/email.mjs.map +1 -0
- package/resources/fax-applications.d.mts +6 -6
- package/resources/fax-applications.d.ts +6 -6
- package/resources/fqdn-connections/fqdn-connections.d.mts +2 -2
- package/resources/fqdn-connections/fqdn-connections.d.ts +2 -2
- package/resources/index.d.mts +8 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +16 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +6 -0
- package/resources/index.mjs.map +1 -1
- package/resources/ip-connections.d.mts +4 -4
- package/resources/ip-connections.d.ts +4 -4
- package/resources/messaging-profiles/index.d.mts +1 -1
- package/resources/messaging-profiles/index.d.mts.map +1 -1
- package/resources/messaging-profiles/index.d.ts +1 -1
- package/resources/messaging-profiles/index.d.ts.map +1 -1
- package/resources/messaging-profiles/index.js.map +1 -1
- package/resources/messaging-profiles/index.mjs.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.d.mts +26 -1
- package/resources/messaging-profiles/messaging-profiles.d.mts.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.d.ts +26 -1
- package/resources/messaging-profiles/messaging-profiles.d.ts.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.js.map +1 -1
- package/resources/messaging-profiles/messaging-profiles.mjs.map +1 -1
- package/resources/network-routes.d.mts +257 -0
- package/resources/network-routes.d.mts.map +1 -0
- package/resources/network-routes.d.ts +257 -0
- package/resources/network-routes.d.ts.map +1 -0
- package/resources/network-routes.js +83 -0
- package/resources/network-routes.js.map +1 -0
- package/resources/network-routes.mjs +79 -0
- package/resources/network-routes.mjs.map +1 -0
- package/resources/pay-connectors.d.mts +378 -0
- package/resources/pay-connectors.d.mts.map +1 -0
- package/resources/pay-connectors.d.ts +378 -0
- package/resources/pay-connectors.d.ts.map +1 -0
- package/resources/pay-connectors.js +116 -0
- package/resources/pay-connectors.js.map +1 -0
- package/resources/pay-connectors.mjs +112 -0
- package/resources/pay-connectors.mjs.map +1 -0
- package/resources/public-internet-gateways.d.mts +0 -8
- package/resources/public-internet-gateways.d.mts.map +1 -1
- package/resources/public-internet-gateways.d.ts +0 -8
- package/resources/public-internet-gateways.d.ts.map +1 -1
- package/resources/spend-limits.d.mts +150 -32
- package/resources/spend-limits.d.mts.map +1 -1
- package/resources/spend-limits.d.ts +150 -32
- package/resources/spend-limits.d.ts.map +1 -1
- package/resources/spend-limits.js +26 -7
- package/resources/spend-limits.js.map +1 -1
- package/resources/spend-limits.mjs +26 -7
- package/resources/spend-limits.mjs.map +1 -1
- package/resources/telephony-credentials.d.mts +48 -2
- package/resources/telephony-credentials.d.mts.map +1 -1
- package/resources/telephony-credentials.d.ts +48 -2
- package/resources/telephony-credentials.d.ts.map +1 -1
- package/resources/telephony-credentials.js +46 -2
- package/resources/telephony-credentials.js.map +1 -1
- package/resources/telephony-credentials.mjs +46 -2
- package/resources/telephony-credentials.mjs.map +1 -1
- package/resources/texml-applications.d.mts +6 -6
- package/resources/texml-applications.d.ts +6 -6
- package/resources/text-to-speech/text-to-speech.d.mts +1 -6
- package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.ts +1 -6
- package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
- package/resources/text-to-speech/text-to-speech.js +1 -2
- package/resources/text-to-speech/text-to-speech.js.map +1 -1
- package/resources/text-to-speech/text-to-speech.mjs +1 -2
- package/resources/text-to-speech/text-to-speech.mjs.map +1 -1
- package/resources/tunnels/actions.d.mts +29 -0
- package/resources/tunnels/actions.d.mts.map +1 -0
- package/resources/tunnels/actions.d.ts +29 -0
- package/resources/tunnels/actions.d.ts.map +1 -0
- package/resources/tunnels/actions.js +28 -0
- package/resources/tunnels/actions.js.map +1 -0
- package/resources/tunnels/actions.mjs +24 -0
- package/resources/tunnels/actions.mjs.map +1 -0
- package/resources/tunnels/index.d.mts +3 -0
- package/resources/tunnels/index.d.mts.map +1 -0
- package/resources/tunnels/index.d.ts +3 -0
- package/resources/tunnels/index.d.ts.map +1 -0
- package/resources/tunnels/index.js +9 -0
- package/resources/tunnels/index.js.map +1 -0
- package/resources/tunnels/index.mjs +4 -0
- package/resources/tunnels/index.mjs.map +1 -0
- package/resources/tunnels/tunnels.d.mts +194 -0
- package/resources/tunnels/tunnels.d.mts.map +1 -0
- package/resources/tunnels/tunnels.d.ts +194 -0
- package/resources/tunnels/tunnels.d.ts.map +1 -0
- package/resources/tunnels/tunnels.js +82 -0
- package/resources/tunnels/tunnels.js.map +1 -0
- package/resources/tunnels/tunnels.mjs +77 -0
- package/resources/tunnels/tunnels.mjs.map +1 -0
- package/resources/tunnels.d.mts +2 -0
- package/resources/tunnels.d.mts.map +1 -0
- package/resources/tunnels.d.ts +2 -0
- package/resources/tunnels.d.ts.map +1 -0
- package/resources/tunnels.js +6 -0
- package/resources/tunnels.js.map +1 -0
- package/resources/tunnels.mjs +3 -0
- package/resources/tunnels.mjs.map +1 -0
- package/resources/voice-clones.d.mts +54 -8
- package/resources/voice-clones.d.mts.map +1 -1
- package/resources/voice-clones.d.ts +54 -8
- package/resources/voice-clones.d.ts.map +1 -1
- package/resources/voice-clones.js +6 -5
- package/resources/voice-clones.js.map +1 -1
- package/resources/voice-clones.mjs +6 -5
- package/resources/voice-clones.mjs.map +1 -1
- package/resources/whatsapp/hosted-signups.d.mts +2 -1
- package/resources/whatsapp/hosted-signups.d.mts.map +1 -1
- package/resources/whatsapp/hosted-signups.d.ts +2 -1
- package/resources/whatsapp/hosted-signups.d.ts.map +1 -1
- package/resources/wireguard-interfaces.d.mts +0 -8
- package/resources/wireguard-interfaces.d.mts.map +1 -1
- package/resources/wireguard-interfaces.d.ts +0 -8
- package/resources/wireguard-interfaces.d.ts.map +1 -1
- package/src/client.ts +130 -0
- package/src/lib/login-token.ts +219 -0
- package/src/resources/addresses/actions.ts +23 -4
- package/src/resources/ai/ai.ts +6 -0
- package/src/resources/ai/assistants/assistants.ts +31 -24
- package/src/resources/ai/avatars.ts +9 -9
- package/src/resources/ai/index.ts +1 -0
- package/src/resources/ai/tests/index.ts +5 -0
- package/src/resources/ai/tests/schedules/index.ts +4 -0
- package/src/resources/ai/tests/schedules/schedules.ts +15 -0
- package/src/resources/ai/tests/schedules/v1/cron-jobs.ts +248 -0
- package/src/resources/ai/tests/schedules/v1/index.ts +12 -0
- package/src/resources/ai/tests/schedules/v1/v1.ts +31 -0
- package/src/resources/ai/tests/schedules/v1.ts +3 -0
- package/src/resources/ai/tests/schedules.ts +3 -0
- package/src/resources/ai/tests/test-framework/index.ts +4 -0
- package/src/resources/ai/tests/test-framework/test-framework.ts +15 -0
- package/src/resources/ai/tests/test-framework/v1/aiagents.ts +304 -0
- package/src/resources/ai/tests/test-framework/v1/index.ts +54 -0
- package/src/resources/ai/tests/test-framework/v1/metrics.ts +491 -0
- package/src/resources/ai/tests/test-framework/v1/results.ts +304 -0
- package/src/resources/ai/tests/test-framework/v1/scenarios.ts +774 -0
- package/src/resources/ai/tests/test-framework/v1/v1.ts +214 -0
- package/src/resources/ai/tests/test-framework/v1.ts +3 -0
- package/src/resources/ai/tests/test-framework.ts +3 -0
- package/src/resources/ai/tests/tests.ts +21 -0
- package/src/resources/ai/tests.ts +3 -0
- package/src/resources/artifact-downloads.ts +39 -0
- package/src/resources/bot-challenge.ts +1 -1
- package/src/resources/bot-sessions.ts +1 -1
- package/src/resources/bot-signup.ts +2 -2
- package/src/resources/browser-sessions/actions.ts +778 -0
- package/src/resources/browser-sessions/browser-sessions.ts +278 -0
- package/src/resources/browser-sessions/index.ts +31 -0
- package/src/resources/browser-sessions.ts +3 -0
- package/src/resources/call-control-applications.ts +2 -2
- package/src/resources/calls/actions.ts +38 -27
- package/src/resources/conferences/actions.ts +3 -2
- package/src/resources/email/dedicated-ips/actions.ts +87 -0
- package/src/resources/email/dedicated-ips/dedicated-ips.ts +563 -0
- package/src/resources/email/dedicated-ips/index.ts +13 -0
- package/src/resources/email/dedicated-ips.ts +3 -0
- package/src/resources/email/email.ts +55 -0
- package/src/resources/email/index.ts +22 -0
- package/src/resources/email/ip-pools/index.ts +12 -0
- package/src/resources/email/ip-pools/ip-pools.ts +247 -0
- package/src/resources/email/ip-pools/ips.ts +112 -0
- package/src/resources/email/ip-pools.ts +3 -0
- package/src/resources/email.ts +3 -0
- package/src/resources/fax-applications.ts +6 -6
- package/src/resources/fqdn-connections/fqdn-connections.ts +2 -2
- package/src/resources/index.ts +46 -0
- package/src/resources/ip-connections.ts +4 -4
- package/src/resources/messaging-profiles/index.ts +1 -0
- package/src/resources/messaging-profiles/messaging-profiles.ts +31 -0
- package/src/resources/network-routes.ts +332 -0
- package/src/resources/pay-connectors.ts +482 -0
- package/src/resources/public-internet-gateways.ts +0 -10
- package/src/resources/spend-limits.ts +179 -36
- package/src/resources/telephony-credentials.ts +75 -2
- package/src/resources/texml-applications.ts +6 -6
- package/src/resources/text-to-speech/text-to-speech.ts +1 -7
- package/src/resources/tunnels/actions.ts +36 -0
- package/src/resources/tunnels/index.ts +13 -0
- package/src/resources/tunnels/tunnels.ts +260 -0
- package/src/resources/tunnels.ts +3 -0
- package/src/resources/voice-clones.ts +88 -8
- package/src/resources/whatsapp/hosted-signups.ts +2 -1
- package/src/resources/wireguard-interfaces.ts +0 -10
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spend-limits.d.ts","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D
|
|
1
|
+
{"version":3,"file":"spend-limits.d.ts","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlE;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9F;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAQjC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;CAQlC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEtD;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;CACpC;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;OAGG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,MAAM,EAAE,cAAc,GAAG,UAAU,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,KAAK,EAAE,cAAc,CAAC,eAAe,GAAG,IAAI,CAAC;QAE7C;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,KAAK,EAAE,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAED,UAAiB,eAAe,CAAC;QAC/B;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,MAAM,EAAE,cAAc,GAAG,UAAU,CAAC;YAEpC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;;WAGG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;;WAGG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,0BAA0B,EAAE,OAAO,CAAC;QAEpC;;WAEG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,SAAS,CAAC;AAEnD,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAExB,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,yBAAyB,CAAC;AAErD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,0BAA0B;QACzC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;;WAKG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,yBAAyB,CAAC;AAErD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,0BAA0B;QACzC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;WAEG;QACH,SAAS,EAAE,IAAI,CAAC;QAEhB;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -11,6 +11,7 @@ const path_1 = require("../internal/utils/path.js");
|
|
|
11
11
|
* - **Blocking.** When spend in a period goes above the limit (strictly greater), the product is blocked until the period ends: 00:00 UTC the next day for `daily`, 00:00 UTC on the 1st of the next month for `monthly`. A block appears within about 2 minutes (daily) or 10 minutes (monthly) of the spend being recorded.
|
|
12
12
|
* - **Changes apply immediately.** Creating, updating or deleting a limit checks the period's spend in the same request: raising the limit above the spend, or removing it, lifts that period's block, and lowering it below the spend blocks the product at once. The `evaluation` object in the response says what happened.
|
|
13
13
|
* - **Supported products.** Today only `inference` supports spend limits. A blocked account gets HTTP 403 with the error title `Inference spend limit reached` (code `10039`) on new billable chat completions, Responses, Anthropic Messages and classification requests; requests already running finish normally. Take the list of products from the list operation.
|
|
14
|
+
* - **API key limits.** For `inference`, a limit can also apply to one API key, named by `credential_id`: the key's identifier as recorded on usage, never its secret. When the key's spend goes above its own limit, only that key is blocked, with the error title `API key spend limit reached` (code `10039`); the account's other keys keep working. The API key limits of a period cannot add up to more than the total limit when the total has an amount. Only language-model requests authenticated with an API key count toward its limit.
|
|
14
15
|
* - **Limits set by Telnyx.** Telnyx support can also set a limit on your account. It is listed with `origin: operator` and you can update or delete it like your own.
|
|
15
16
|
*/
|
|
16
17
|
class SpendLimits extends resource_1.APIResource {
|
|
@@ -19,7 +20,9 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
19
20
|
* the spend so far in the period and whether the product is blocked. An entry
|
|
20
21
|
* without a limit is still listed (`limit: null`). When the spend cannot be read,
|
|
21
22
|
* the entry is returned with `spend_usd: null` and `spend_error` set. The list is
|
|
22
|
-
* not paginated.
|
|
23
|
+
* not paginated. Each entry also lists the API key limits of its product and
|
|
24
|
+
* period in `credential_limits`, with each key's spend and block. Each API key
|
|
25
|
+
* limit can be at most the total limit; together they may add up to more than it.
|
|
23
26
|
*
|
|
24
27
|
* @example
|
|
25
28
|
* ```ts
|
|
@@ -34,7 +37,9 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
34
37
|
* `amount` and `unlimited: true`. The period's spend is checked at once: if it is
|
|
35
38
|
* already above the new limit, the product is blocked immediately
|
|
36
39
|
* (`evaluation.blocked_now`). Returns 409 when a limit already exists for the
|
|
37
|
-
* product and period; update it instead.
|
|
40
|
+
* product and period; update it instead. With `credential_id`, the limit applies
|
|
41
|
+
* to that API key only: it needs an `amount`, and the period's API key limits
|
|
42
|
+
* cannot add up to more than the total limit when the total has an amount.
|
|
38
43
|
*
|
|
39
44
|
* @example
|
|
40
45
|
* ```ts
|
|
@@ -54,7 +59,11 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
54
59
|
* default limit, the product becomes unlimited for the period and the period's
|
|
55
60
|
* block is lifted (`evaluation.released`). The response carries `limit: null` and
|
|
56
61
|
* the `effective_limit_usd` that applies after the removal. Returns 404 when no
|
|
57
|
-
* limit is set.
|
|
62
|
+
* limit is set. With the `credential_id` query parameter, the request removes that
|
|
63
|
+
* API key's limit for the period and lifts the key's block in that period at once.
|
|
64
|
+
* A block under the key's limit in the other period stays
|
|
65
|
+
* (`evaluation.still_blocked_other_period`). Removing the total limit leaves the
|
|
66
|
+
* API key limits in place.
|
|
58
67
|
*
|
|
59
68
|
* @example
|
|
60
69
|
* ```ts
|
|
@@ -64,8 +73,11 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
64
73
|
* ```
|
|
65
74
|
*/
|
|
66
75
|
delete(product, params = {}, options) {
|
|
67
|
-
const { period, reason } = params ?? {};
|
|
68
|
-
return this._client.delete((0, path_1.path) `/spend_limits/${product}`, {
|
|
76
|
+
const { credential_id, period, reason } = params ?? {};
|
|
77
|
+
return this._client.delete((0, path_1.path) `/spend_limits/${product}`, {
|
|
78
|
+
query: { credential_id, period, reason },
|
|
79
|
+
...options,
|
|
80
|
+
});
|
|
69
81
|
}
|
|
70
82
|
/**
|
|
71
83
|
* Replaces the value of the existing limit for the product and period. Send
|
|
@@ -73,6 +85,9 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
73
85
|
* once: raising the limit above the spend lifts the period's block
|
|
74
86
|
* (`evaluation.released`), and lowering it below the spend blocks the product
|
|
75
87
|
* (`evaluation.blocked_now`). Returns 404 when no limit is set; create it instead.
|
|
88
|
+
* With the `credential_id` query parameter, the request changes that API key's
|
|
89
|
+
* limit; it needs an `amount`, and it can be at most the period's total limit.
|
|
90
|
+
* Lowering the total limit below the period's highest API key limit is refused.
|
|
76
91
|
*
|
|
77
92
|
* @example
|
|
78
93
|
* ```ts
|
|
@@ -83,8 +98,12 @@ class SpendLimits extends resource_1.APIResource {
|
|
|
83
98
|
* ```
|
|
84
99
|
*/
|
|
85
100
|
update(product, params, options) {
|
|
86
|
-
const { period, ...body } = params;
|
|
87
|
-
return this._client.patch((0, path_1.path) `/spend_limits/${product}`, {
|
|
101
|
+
const { credential_id, period, ...body } = params;
|
|
102
|
+
return this._client.patch((0, path_1.path) `/spend_limits/${product}`, {
|
|
103
|
+
query: { credential_id, period },
|
|
104
|
+
body,
|
|
105
|
+
...options,
|
|
106
|
+
});
|
|
88
107
|
}
|
|
89
108
|
}
|
|
90
109
|
exports.SpendLimits = SpendLimits;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spend-limits.js","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"spend-limits.js","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C;;;;;;;;;GASG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAe,EACf,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,OAAO,EAAE,EAAE;YACzD,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE;YACxC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAe,EACf,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,iBAAiB,OAAO,EAAE,EAAE;YACxD,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YAChC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtGD,kCAsGC"}
|
|
@@ -8,6 +8,7 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
8
8
|
* - **Blocking.** When spend in a period goes above the limit (strictly greater), the product is blocked until the period ends: 00:00 UTC the next day for `daily`, 00:00 UTC on the 1st of the next month for `monthly`. A block appears within about 2 minutes (daily) or 10 minutes (monthly) of the spend being recorded.
|
|
9
9
|
* - **Changes apply immediately.** Creating, updating or deleting a limit checks the period's spend in the same request: raising the limit above the spend, or removing it, lifts that period's block, and lowering it below the spend blocks the product at once. The `evaluation` object in the response says what happened.
|
|
10
10
|
* - **Supported products.** Today only `inference` supports spend limits. A blocked account gets HTTP 403 with the error title `Inference spend limit reached` (code `10039`) on new billable chat completions, Responses, Anthropic Messages and classification requests; requests already running finish normally. Take the list of products from the list operation.
|
|
11
|
+
* - **API key limits.** For `inference`, a limit can also apply to one API key, named by `credential_id`: the key's identifier as recorded on usage, never its secret. When the key's spend goes above its own limit, only that key is blocked, with the error title `API key spend limit reached` (code `10039`); the account's other keys keep working. The API key limits of a period cannot add up to more than the total limit when the total has an amount. Only language-model requests authenticated with an API key count toward its limit.
|
|
11
12
|
* - **Limits set by Telnyx.** Telnyx support can also set a limit on your account. It is listed with `origin: operator` and you can update or delete it like your own.
|
|
12
13
|
*/
|
|
13
14
|
export class SpendLimits extends APIResource {
|
|
@@ -16,7 +17,9 @@ export class SpendLimits extends APIResource {
|
|
|
16
17
|
* the spend so far in the period and whether the product is blocked. An entry
|
|
17
18
|
* without a limit is still listed (`limit: null`). When the spend cannot be read,
|
|
18
19
|
* the entry is returned with `spend_usd: null` and `spend_error` set. The list is
|
|
19
|
-
* not paginated.
|
|
20
|
+
* not paginated. Each entry also lists the API key limits of its product and
|
|
21
|
+
* period in `credential_limits`, with each key's spend and block. Each API key
|
|
22
|
+
* limit can be at most the total limit; together they may add up to more than it.
|
|
20
23
|
*
|
|
21
24
|
* @example
|
|
22
25
|
* ```ts
|
|
@@ -31,7 +34,9 @@ export class SpendLimits extends APIResource {
|
|
|
31
34
|
* `amount` and `unlimited: true`. The period's spend is checked at once: if it is
|
|
32
35
|
* already above the new limit, the product is blocked immediately
|
|
33
36
|
* (`evaluation.blocked_now`). Returns 409 when a limit already exists for the
|
|
34
|
-
* product and period; update it instead.
|
|
37
|
+
* product and period; update it instead. With `credential_id`, the limit applies
|
|
38
|
+
* to that API key only: it needs an `amount`, and the period's API key limits
|
|
39
|
+
* cannot add up to more than the total limit when the total has an amount.
|
|
35
40
|
*
|
|
36
41
|
* @example
|
|
37
42
|
* ```ts
|
|
@@ -51,7 +56,11 @@ export class SpendLimits extends APIResource {
|
|
|
51
56
|
* default limit, the product becomes unlimited for the period and the period's
|
|
52
57
|
* block is lifted (`evaluation.released`). The response carries `limit: null` and
|
|
53
58
|
* the `effective_limit_usd` that applies after the removal. Returns 404 when no
|
|
54
|
-
* limit is set.
|
|
59
|
+
* limit is set. With the `credential_id` query parameter, the request removes that
|
|
60
|
+
* API key's limit for the period and lifts the key's block in that period at once.
|
|
61
|
+
* A block under the key's limit in the other period stays
|
|
62
|
+
* (`evaluation.still_blocked_other_period`). Removing the total limit leaves the
|
|
63
|
+
* API key limits in place.
|
|
55
64
|
*
|
|
56
65
|
* @example
|
|
57
66
|
* ```ts
|
|
@@ -61,8 +70,11 @@ export class SpendLimits extends APIResource {
|
|
|
61
70
|
* ```
|
|
62
71
|
*/
|
|
63
72
|
delete(product, params = {}, options) {
|
|
64
|
-
const { period, reason } = params ?? {};
|
|
65
|
-
return this._client.delete(path `/spend_limits/${product}`, {
|
|
73
|
+
const { credential_id, period, reason } = params ?? {};
|
|
74
|
+
return this._client.delete(path `/spend_limits/${product}`, {
|
|
75
|
+
query: { credential_id, period, reason },
|
|
76
|
+
...options,
|
|
77
|
+
});
|
|
66
78
|
}
|
|
67
79
|
/**
|
|
68
80
|
* Replaces the value of the existing limit for the product and period. Send
|
|
@@ -70,6 +82,9 @@ export class SpendLimits extends APIResource {
|
|
|
70
82
|
* once: raising the limit above the spend lifts the period's block
|
|
71
83
|
* (`evaluation.released`), and lowering it below the spend blocks the product
|
|
72
84
|
* (`evaluation.blocked_now`). Returns 404 when no limit is set; create it instead.
|
|
85
|
+
* With the `credential_id` query parameter, the request changes that API key's
|
|
86
|
+
* limit; it needs an `amount`, and it can be at most the period's total limit.
|
|
87
|
+
* Lowering the total limit below the period's highest API key limit is refused.
|
|
73
88
|
*
|
|
74
89
|
* @example
|
|
75
90
|
* ```ts
|
|
@@ -80,8 +95,12 @@ export class SpendLimits extends APIResource {
|
|
|
80
95
|
* ```
|
|
81
96
|
*/
|
|
82
97
|
update(product, params, options) {
|
|
83
|
-
const { period, ...body } = params;
|
|
84
|
-
return this._client.patch(path `/spend_limits/${product}`, {
|
|
98
|
+
const { credential_id, period, ...body } = params;
|
|
99
|
+
return this._client.patch(path `/spend_limits/${product}`, {
|
|
100
|
+
query: { credential_id, period },
|
|
101
|
+
body,
|
|
102
|
+
...options,
|
|
103
|
+
});
|
|
85
104
|
}
|
|
86
105
|
}
|
|
87
106
|
//# sourceMappingURL=spend-limits.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spend-limits.mjs","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;
|
|
1
|
+
{"version":3,"file":"spend-limits.mjs","sourceRoot":"","sources":["../src/resources/spend-limits.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;GASG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAe,EACf,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,OAAO,EAAE,EAAE;YACzD,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE;YACxC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAe,EACf,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,iBAAiB,OAAO,EAAE,EAAE;YACxD,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE;YAChC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
3
|
import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../core/pagination.mjs";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
import { type LoginTokenOptions, type TokenMaterial } from "../lib/login-token.mjs";
|
|
5
6
|
export declare class TelephonyCredentials extends APIResource {
|
|
6
7
|
/**
|
|
7
8
|
* Returns a paginated list of the on-demand telephony credentials on your account,
|
|
@@ -28,7 +29,7 @@ export declare class TelephonyCredentials extends APIResource {
|
|
|
28
29
|
* });
|
|
29
30
|
* ```
|
|
30
31
|
*/
|
|
31
|
-
create(
|
|
32
|
+
create(params: TelephonyCredentialCreateParams, options?: RequestOptions): APIPromise<TelephonyCredentialCreateResponse>;
|
|
32
33
|
/**
|
|
33
34
|
* Permanently deletes the specified telephony credential, revoking any access it
|
|
34
35
|
* provided.
|
|
@@ -60,6 +61,37 @@ export declare class TelephonyCredentials extends APIResource {
|
|
|
60
61
|
* ```
|
|
61
62
|
*/
|
|
62
63
|
update(id: string, body: TelephonyCredentialUpdateParams, options?: RequestOptions): APIPromise<TelephonyCredentialUpdateResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* The material a login token is signed with (`kid`, `tel_token`,
|
|
66
|
+
* `signing_secret`), for a credential that did not come from `create`. Treat
|
|
67
|
+
* the result like the SIP password.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* const { data: tokenMaterial } =
|
|
72
|
+
* await client.telephonyCredentials.retrieveTokenMaterial('id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
retrieveTokenMaterial(id: string, options?: RequestOptions): APIPromise<TelephonyCredentialRetrieveTokenMaterialResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Mints a WebRTC login token for the credential locally: the same use as
|
|
78
|
+
* `createToken`, with no request to Telnyx per token. Uses the
|
|
79
|
+
* `token_material` of a credential from `create`, or `tokenMaterial` from the
|
|
80
|
+
* options, or fetches it once with `retrieveTokenMaterial`.
|
|
81
|
+
*
|
|
82
|
+
* `ttl` is the token lifetime in seconds, 1..86400, default one hour.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* const { data: credential } = await client.telephonyCredentials.create({
|
|
87
|
+
* connection_id: '1234567890',
|
|
88
|
+
* });
|
|
89
|
+
* const loginToken = await client.telephonyCredentials.toJwt(credential);
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
toJwt(credential: TelephonyCredential, options?: LoginTokenOptions & {
|
|
93
|
+
requestOptions?: RequestOptions | undefined;
|
|
94
|
+
}): Promise<string>;
|
|
63
95
|
/**
|
|
64
96
|
* Create an Access Token (JWT) for the credential.
|
|
65
97
|
*
|
|
@@ -114,6 +146,14 @@ export interface TelephonyCredential {
|
|
|
114
146
|
* Identifies the user this credential is associated with.
|
|
115
147
|
*/
|
|
116
148
|
user_id?: string;
|
|
149
|
+
/**
|
|
150
|
+
* What a login token is signed with. Returned by `create`; see `toJwt` and
|
|
151
|
+
* `retrieveTokenMaterial`.
|
|
152
|
+
*/
|
|
153
|
+
token_material?: TokenMaterial;
|
|
154
|
+
}
|
|
155
|
+
export interface TelephonyCredentialRetrieveTokenMaterialResponse {
|
|
156
|
+
data?: TokenMaterial;
|
|
117
157
|
}
|
|
118
158
|
export interface TelephonyCredentialCreateResponse {
|
|
119
159
|
data?: TelephonyCredential;
|
|
@@ -164,6 +204,11 @@ export declare namespace TelephonyCredentialListParams {
|
|
|
164
204
|
}
|
|
165
205
|
}
|
|
166
206
|
export interface TelephonyCredentialCreateParams {
|
|
207
|
+
/**
|
|
208
|
+
* Query param: extra fields to return. `token_material` adds what `toJwt` signs
|
|
209
|
+
* with (as sensitive as `sip_password`; keep it on the server).
|
|
210
|
+
*/
|
|
211
|
+
include?: 'token_material' | undefined;
|
|
167
212
|
/**
|
|
168
213
|
* Identifies the Credential Connection this credential is associated with.
|
|
169
214
|
*/
|
|
@@ -202,7 +247,8 @@ export interface TelephonyCredentialCreateTokenParams {
|
|
|
202
247
|
*/
|
|
203
248
|
'Idempotency-Key'?: string;
|
|
204
249
|
}
|
|
250
|
+
export type { LoginTokenOptions, TokenMaterial } from "../lib/login-token.mjs";
|
|
205
251
|
export declare namespace TelephonyCredentials {
|
|
206
|
-
export { type TelephonyCredential as TelephonyCredential, type TelephonyCredentialCreateResponse as TelephonyCredentialCreateResponse, type TelephonyCredentialRetrieveResponse as TelephonyCredentialRetrieveResponse, type TelephonyCredentialUpdateResponse as TelephonyCredentialUpdateResponse, type TelephonyCredentialDeleteResponse as TelephonyCredentialDeleteResponse, type TelephonyCredentialCreateTokenResponse as TelephonyCredentialCreateTokenResponse, type TelephonyCredentialsDefaultFlatPagination as TelephonyCredentialsDefaultFlatPagination, type TelephonyCredentialListParams as TelephonyCredentialListParams, type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams, type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams, type TelephonyCredentialCreateTokenParams as TelephonyCredentialCreateTokenParams, };
|
|
252
|
+
export { type TelephonyCredential as TelephonyCredential, type TelephonyCredentialCreateResponse as TelephonyCredentialCreateResponse, type TelephonyCredentialRetrieveResponse as TelephonyCredentialRetrieveResponse, type TelephonyCredentialUpdateResponse as TelephonyCredentialUpdateResponse, type TelephonyCredentialDeleteResponse as TelephonyCredentialDeleteResponse, type TelephonyCredentialCreateTokenResponse as TelephonyCredentialCreateTokenResponse, type TelephonyCredentialRetrieveTokenMaterialResponse as TelephonyCredentialRetrieveTokenMaterialResponse, type TokenMaterial as TokenMaterial, type TelephonyCredentialsDefaultFlatPagination as TelephonyCredentialsDefaultFlatPagination, type TelephonyCredentialListParams as TelephonyCredentialListParams, type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams, type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams, type TelephonyCredentialCreateTokenParams as TelephonyCredentialCreateTokenParams, };
|
|
207
253
|
}
|
|
208
254
|
//# sourceMappingURL=telephony-credentials.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"telephony-credentials.d.mts","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,+BAA2B;AAE1G,OAAO,EAAE,cAAc,EAAE,wCAAoC;
|
|
1
|
+
{"version":3,"file":"telephony-credentials.d.mts","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,+BAA2B;AAE1G,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,OAAO,EAAoB,KAAK,iBAAiB,EAAE,KAAK,aAAa,EAAE,+BAA2B;AAElG,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,mBAAmB,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAUhD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gDAAgD,CAAC;IAI/D;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CACT,UAAU,EAAE,mBAAmB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAAG;QAAE,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;KAAE,GAC5E,OAAO,CAAC,MAAM,CAAC;IASlB;;;;;;;;OAQG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oCAAoC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAatB;AAED,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAEnG,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,gDAAgD;IAC/D,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,MAAM,sCAAsC,GAAG,MAAM,CAAC;AAE5D,MAAM,WAAW,6BAA8B,SAAQ,2BAA2B;IAChF;;;OAGG;IACH,MAAM,CAAC,EAAE,6BAA6B,CAAC,MAAM,CAAC;CAC/C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,+BAA2B;AAE3E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,gDAAgD,IAAI,gDAAgD,EACzG,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}
|
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.js";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
3
|
import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../core/pagination.js";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
import { type LoginTokenOptions, type TokenMaterial } from "../lib/login-token.js";
|
|
5
6
|
export declare class TelephonyCredentials extends APIResource {
|
|
6
7
|
/**
|
|
7
8
|
* Returns a paginated list of the on-demand telephony credentials on your account,
|
|
@@ -28,7 +29,7 @@ export declare class TelephonyCredentials extends APIResource {
|
|
|
28
29
|
* });
|
|
29
30
|
* ```
|
|
30
31
|
*/
|
|
31
|
-
create(
|
|
32
|
+
create(params: TelephonyCredentialCreateParams, options?: RequestOptions): APIPromise<TelephonyCredentialCreateResponse>;
|
|
32
33
|
/**
|
|
33
34
|
* Permanently deletes the specified telephony credential, revoking any access it
|
|
34
35
|
* provided.
|
|
@@ -60,6 +61,37 @@ export declare class TelephonyCredentials extends APIResource {
|
|
|
60
61
|
* ```
|
|
61
62
|
*/
|
|
62
63
|
update(id: string, body: TelephonyCredentialUpdateParams, options?: RequestOptions): APIPromise<TelephonyCredentialUpdateResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* The material a login token is signed with (`kid`, `tel_token`,
|
|
66
|
+
* `signing_secret`), for a credential that did not come from `create`. Treat
|
|
67
|
+
* the result like the SIP password.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* const { data: tokenMaterial } =
|
|
72
|
+
* await client.telephonyCredentials.retrieveTokenMaterial('id');
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
retrieveTokenMaterial(id: string, options?: RequestOptions): APIPromise<TelephonyCredentialRetrieveTokenMaterialResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Mints a WebRTC login token for the credential locally: the same use as
|
|
78
|
+
* `createToken`, with no request to Telnyx per token. Uses the
|
|
79
|
+
* `token_material` of a credential from `create`, or `tokenMaterial` from the
|
|
80
|
+
* options, or fetches it once with `retrieveTokenMaterial`.
|
|
81
|
+
*
|
|
82
|
+
* `ttl` is the token lifetime in seconds, 1..86400, default one hour.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* const { data: credential } = await client.telephonyCredentials.create({
|
|
87
|
+
* connection_id: '1234567890',
|
|
88
|
+
* });
|
|
89
|
+
* const loginToken = await client.telephonyCredentials.toJwt(credential);
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
toJwt(credential: TelephonyCredential, options?: LoginTokenOptions & {
|
|
93
|
+
requestOptions?: RequestOptions | undefined;
|
|
94
|
+
}): Promise<string>;
|
|
63
95
|
/**
|
|
64
96
|
* Create an Access Token (JWT) for the credential.
|
|
65
97
|
*
|
|
@@ -114,6 +146,14 @@ export interface TelephonyCredential {
|
|
|
114
146
|
* Identifies the user this credential is associated with.
|
|
115
147
|
*/
|
|
116
148
|
user_id?: string;
|
|
149
|
+
/**
|
|
150
|
+
* What a login token is signed with. Returned by `create`; see `toJwt` and
|
|
151
|
+
* `retrieveTokenMaterial`.
|
|
152
|
+
*/
|
|
153
|
+
token_material?: TokenMaterial;
|
|
154
|
+
}
|
|
155
|
+
export interface TelephonyCredentialRetrieveTokenMaterialResponse {
|
|
156
|
+
data?: TokenMaterial;
|
|
117
157
|
}
|
|
118
158
|
export interface TelephonyCredentialCreateResponse {
|
|
119
159
|
data?: TelephonyCredential;
|
|
@@ -164,6 +204,11 @@ export declare namespace TelephonyCredentialListParams {
|
|
|
164
204
|
}
|
|
165
205
|
}
|
|
166
206
|
export interface TelephonyCredentialCreateParams {
|
|
207
|
+
/**
|
|
208
|
+
* Query param: extra fields to return. `token_material` adds what `toJwt` signs
|
|
209
|
+
* with (as sensitive as `sip_password`; keep it on the server).
|
|
210
|
+
*/
|
|
211
|
+
include?: 'token_material' | undefined;
|
|
167
212
|
/**
|
|
168
213
|
* Identifies the Credential Connection this credential is associated with.
|
|
169
214
|
*/
|
|
@@ -202,7 +247,8 @@ export interface TelephonyCredentialCreateTokenParams {
|
|
|
202
247
|
*/
|
|
203
248
|
'Idempotency-Key'?: string;
|
|
204
249
|
}
|
|
250
|
+
export type { LoginTokenOptions, TokenMaterial } from "../lib/login-token.js";
|
|
205
251
|
export declare namespace TelephonyCredentials {
|
|
206
|
-
export { type TelephonyCredential as TelephonyCredential, type TelephonyCredentialCreateResponse as TelephonyCredentialCreateResponse, type TelephonyCredentialRetrieveResponse as TelephonyCredentialRetrieveResponse, type TelephonyCredentialUpdateResponse as TelephonyCredentialUpdateResponse, type TelephonyCredentialDeleteResponse as TelephonyCredentialDeleteResponse, type TelephonyCredentialCreateTokenResponse as TelephonyCredentialCreateTokenResponse, type TelephonyCredentialsDefaultFlatPagination as TelephonyCredentialsDefaultFlatPagination, type TelephonyCredentialListParams as TelephonyCredentialListParams, type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams, type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams, type TelephonyCredentialCreateTokenParams as TelephonyCredentialCreateTokenParams, };
|
|
252
|
+
export { type TelephonyCredential as TelephonyCredential, type TelephonyCredentialCreateResponse as TelephonyCredentialCreateResponse, type TelephonyCredentialRetrieveResponse as TelephonyCredentialRetrieveResponse, type TelephonyCredentialUpdateResponse as TelephonyCredentialUpdateResponse, type TelephonyCredentialDeleteResponse as TelephonyCredentialDeleteResponse, type TelephonyCredentialCreateTokenResponse as TelephonyCredentialCreateTokenResponse, type TelephonyCredentialRetrieveTokenMaterialResponse as TelephonyCredentialRetrieveTokenMaterialResponse, type TokenMaterial as TokenMaterial, type TelephonyCredentialsDefaultFlatPagination as TelephonyCredentialsDefaultFlatPagination, type TelephonyCredentialListParams as TelephonyCredentialListParams, type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams, type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams, type TelephonyCredentialCreateTokenParams as TelephonyCredentialCreateTokenParams, };
|
|
207
253
|
}
|
|
208
254
|
//# sourceMappingURL=telephony-credentials.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"telephony-credentials.d.ts","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,8BAA2B;AAE1G,OAAO,EAAE,cAAc,EAAE,uCAAoC;
|
|
1
|
+
{"version":3,"file":"telephony-credentials.d.ts","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,8BAA2B;AAE1G,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,OAAO,EAAoB,KAAK,iBAAiB,EAAE,KAAK,aAAa,EAAE,8BAA2B;AAElG,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,mBAAmB,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAUhD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI3F;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gDAAgD,CAAC;IAI/D;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CACT,UAAU,EAAE,mBAAmB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAAG;QAAE,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;KAAE,GAC5E,OAAO,CAAC,MAAM,CAAC;IASlB;;;;;;;;OAQG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oCAAoC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;CAatB;AAED,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAEnG,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,gDAAgD;IAC/D,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,MAAM,MAAM,sCAAsC,GAAG,MAAM,CAAC;AAE5D,MAAM,WAAW,6BAA8B,SAAQ,2BAA2B;IAChF;;;OAGG;IACH,MAAM,CAAC,EAAE,6BAA6B,CAAC,MAAM,CAAC;CAC/C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,8BAA2B;AAE3E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,gDAAgD,IAAI,gDAAgD,EACzG,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}
|
|
@@ -6,6 +6,7 @@ const resource_1 = require("../core/resource.js");
|
|
|
6
6
|
const pagination_1 = require("../core/pagination.js");
|
|
7
7
|
const headers_1 = require("../internal/headers.js");
|
|
8
8
|
const path_1 = require("../internal/utils/path.js");
|
|
9
|
+
const login_token_1 = require("../lib/login-token.js");
|
|
9
10
|
class TelephonyCredentials extends resource_1.APIResource {
|
|
10
11
|
/**
|
|
11
12
|
* Returns a paginated list of the on-demand telephony credentials on your account,
|
|
@@ -37,8 +38,14 @@ class TelephonyCredentials extends resource_1.APIResource {
|
|
|
37
38
|
* });
|
|
38
39
|
* ```
|
|
39
40
|
*/
|
|
40
|
-
create(
|
|
41
|
-
|
|
41
|
+
create(params, options) {
|
|
42
|
+
// `include` is a query parameter; everything else is the body.
|
|
43
|
+
const { include, ...body } = params;
|
|
44
|
+
return this._client.post('/telephony_credentials', {
|
|
45
|
+
...(include === undefined ? {} : { query: { include } }),
|
|
46
|
+
body,
|
|
47
|
+
...options,
|
|
48
|
+
});
|
|
42
49
|
}
|
|
43
50
|
/**
|
|
44
51
|
* Permanently deletes the specified telephony credential, revoking any access it
|
|
@@ -77,6 +84,43 @@ class TelephonyCredentials extends resource_1.APIResource {
|
|
|
77
84
|
update(id, body, options) {
|
|
78
85
|
return this._client.patch((0, path_1.path) `/telephony_credentials/${id}`, { body, ...options });
|
|
79
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* The material a login token is signed with (`kid`, `tel_token`,
|
|
89
|
+
* `signing_secret`), for a credential that did not come from `create`. Treat
|
|
90
|
+
* the result like the SIP password.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* const { data: tokenMaterial } =
|
|
95
|
+
* await client.telephonyCredentials.retrieveTokenMaterial('id');
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
retrieveTokenMaterial(id, options) {
|
|
99
|
+
return this._client.get((0, path_1.path) `/telephony_credentials/${id}/token_material`, options);
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Mints a WebRTC login token for the credential locally: the same use as
|
|
103
|
+
* `createToken`, with no request to Telnyx per token. Uses the
|
|
104
|
+
* `token_material` of a credential from `create`, or `tokenMaterial` from the
|
|
105
|
+
* options, or fetches it once with `retrieveTokenMaterial`.
|
|
106
|
+
*
|
|
107
|
+
* `ttl` is the token lifetime in seconds, 1..86400, default one hour.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const { data: credential } = await client.telephonyCredentials.create({
|
|
112
|
+
* connection_id: '1234567890',
|
|
113
|
+
* });
|
|
114
|
+
* const loginToken = await client.telephonyCredentials.toJwt(credential);
|
|
115
|
+
* ```
|
|
116
|
+
*/
|
|
117
|
+
async toJwt(credential, options) {
|
|
118
|
+
const { requestOptions, ...tokenOptions } = options ?? {};
|
|
119
|
+
const tokenMaterial = tokenOptions.tokenMaterial ??
|
|
120
|
+
credential.token_material ??
|
|
121
|
+
(await this.retrieveTokenMaterial(credential.id ?? '', requestOptions)).data;
|
|
122
|
+
return (0, login_token_1.createLoginToken)(credential, { ...tokenOptions, tokenMaterial });
|
|
123
|
+
}
|
|
80
124
|
/**
|
|
81
125
|
* Create an Access Token (JWT) for the credential.
|
|
82
126
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"telephony-credentials.js","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA0G;AAC1G,oDAAmD;AAEnD,oDAA8C;
|
|
1
|
+
{"version":3,"file":"telephony-credentials.js","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA0G;AAC1G,oDAAmD;AAEnD,oDAA8C;AAC9C,uDAAkG;AAElG,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,kCAA0C,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,OAAwB;QAExB,+DAA+D;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC;YACxD,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK,CACT,UAA+B,EAC/B,OAA6E;QAE7E,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAC1D,MAAM,aAAa,GACjB,YAAY,CAAC,aAAa;YAC1B,UAAU,CAAC,cAAc;YACzB,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,OAAO,IAAA,8BAAgB,EAAC,UAAU,EAAE,EAAE,GAAG,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,EAAU,EACV,SAAkE,EAAE,EACpE,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,QAAQ,EAAE;YACjE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,YAAY;oBACpB,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBAChF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AApKD,oDAoKC"}
|
|
@@ -3,6 +3,7 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
3
3
|
import { DefaultFlatPagination } from "../core/pagination.mjs";
|
|
4
4
|
import { buildHeaders } from "../internal/headers.mjs";
|
|
5
5
|
import { path } from "../internal/utils/path.mjs";
|
|
6
|
+
import { createLoginToken } from "../lib/login-token.mjs";
|
|
6
7
|
export class TelephonyCredentials extends APIResource {
|
|
7
8
|
/**
|
|
8
9
|
* Returns a paginated list of the on-demand telephony credentials on your account,
|
|
@@ -34,8 +35,14 @@ export class TelephonyCredentials extends APIResource {
|
|
|
34
35
|
* });
|
|
35
36
|
* ```
|
|
36
37
|
*/
|
|
37
|
-
create(
|
|
38
|
-
|
|
38
|
+
create(params, options) {
|
|
39
|
+
// `include` is a query parameter; everything else is the body.
|
|
40
|
+
const { include, ...body } = params;
|
|
41
|
+
return this._client.post('/telephony_credentials', {
|
|
42
|
+
...(include === undefined ? {} : { query: { include } }),
|
|
43
|
+
body,
|
|
44
|
+
...options,
|
|
45
|
+
});
|
|
39
46
|
}
|
|
40
47
|
/**
|
|
41
48
|
* Permanently deletes the specified telephony credential, revoking any access it
|
|
@@ -74,6 +81,43 @@ export class TelephonyCredentials extends APIResource {
|
|
|
74
81
|
update(id, body, options) {
|
|
75
82
|
return this._client.patch(path `/telephony_credentials/${id}`, { body, ...options });
|
|
76
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* The material a login token is signed with (`kid`, `tel_token`,
|
|
86
|
+
* `signing_secret`), for a credential that did not come from `create`. Treat
|
|
87
|
+
* the result like the SIP password.
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```ts
|
|
91
|
+
* const { data: tokenMaterial } =
|
|
92
|
+
* await client.telephonyCredentials.retrieveTokenMaterial('id');
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
retrieveTokenMaterial(id, options) {
|
|
96
|
+
return this._client.get(path `/telephony_credentials/${id}/token_material`, options);
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Mints a WebRTC login token for the credential locally: the same use as
|
|
100
|
+
* `createToken`, with no request to Telnyx per token. Uses the
|
|
101
|
+
* `token_material` of a credential from `create`, or `tokenMaterial` from the
|
|
102
|
+
* options, or fetches it once with `retrieveTokenMaterial`.
|
|
103
|
+
*
|
|
104
|
+
* `ttl` is the token lifetime in seconds, 1..86400, default one hour.
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* const { data: credential } = await client.telephonyCredentials.create({
|
|
109
|
+
* connection_id: '1234567890',
|
|
110
|
+
* });
|
|
111
|
+
* const loginToken = await client.telephonyCredentials.toJwt(credential);
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
async toJwt(credential, options) {
|
|
115
|
+
const { requestOptions, ...tokenOptions } = options ?? {};
|
|
116
|
+
const tokenMaterial = tokenOptions.tokenMaterial ??
|
|
117
|
+
credential.token_material ??
|
|
118
|
+
(await this.retrieveTokenMaterial(credential.id ?? '', requestOptions)).data;
|
|
119
|
+
return createLoginToken(credential, { ...tokenOptions, tokenMaterial });
|
|
120
|
+
}
|
|
77
121
|
/**
|
|
78
122
|
* Create an Access Token (JWT) for the credential.
|
|
79
123
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"telephony-credentials.mjs","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,qBAAqB,EAAiD,+BAA2B;AAC1G,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;
|
|
1
|
+
{"version":3,"file":"telephony-credentials.mjs","sourceRoot":"","sources":["../src/resources/telephony-credentials.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,qBAAqB,EAAiD,+BAA2B;AAC1G,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAC9C,OAAO,EAAE,gBAAgB,EAA8C,+BAA2B;AAElG,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,qBAA0C,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,OAAwB;QAExB,+DAA+D;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE;YACjD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC;YACxD,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK,CACT,UAA+B,EAC/B,OAA6E;QAE7E,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAC1D,MAAM,aAAa,GACjB,YAAY,CAAC,aAAa;YAC1B,UAAU,CAAC,cAAc;YACzB,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,OAAO,gBAAgB,CAAC,UAAU,EAAE,EAAE,GAAG,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,EAAU,EACV,SAAkE,EAAE,EACpE,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,QAAQ,EAAE;YACjE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,MAAM,EAAE,YAAY;oBACpB,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBAChF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -171,8 +171,8 @@ export declare namespace TexmlApplication {
|
|
|
171
171
|
* in the same way a phone number is used, from a SIP endpoint. Example: the
|
|
172
172
|
* subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
|
|
173
173
|
* the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
|
|
174
|
-
* alphanumeric value.
|
|
175
|
-
*
|
|
174
|
+
* alphanumeric value. TLS signaling is supported. SRTP media encryption requires
|
|
175
|
+
* TLS transport.
|
|
176
176
|
*/
|
|
177
177
|
sip_subdomain?: string;
|
|
178
178
|
/**
|
|
@@ -328,8 +328,8 @@ export declare namespace TexmlApplicationCreateParams {
|
|
|
328
328
|
* in the same way a phone number is used, from a SIP endpoint. Example: the
|
|
329
329
|
* subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
|
|
330
330
|
* the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
|
|
331
|
-
* alphanumeric value.
|
|
332
|
-
*
|
|
331
|
+
* alphanumeric value. TLS signaling is supported. SRTP media encryption requires
|
|
332
|
+
* TLS transport.
|
|
333
333
|
*/
|
|
334
334
|
sip_subdomain?: string;
|
|
335
335
|
/**
|
|
@@ -431,8 +431,8 @@ export declare namespace TexmlApplicationUpdateParams {
|
|
|
431
431
|
* in the same way a phone number is used, from a SIP endpoint. Example: the
|
|
432
432
|
* subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
|
|
433
433
|
* the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
|
|
434
|
-
* alphanumeric value.
|
|
435
|
-
*
|
|
434
|
+
* alphanumeric value. TLS signaling is supported. SRTP media encryption requires
|
|
435
|
+
* TLS transport.
|
|
436
436
|
*/
|
|
437
437
|
sip_subdomain?: string;
|
|
438
438
|
/**
|