agentphone 1.0.0 → 1.0.3
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/README.md +2 -2
- package/dist/cjs/BaseClient.d.ts +39 -0
- package/dist/cjs/BaseClient.js +62 -0
- package/dist/cjs/Client.d.ts +38 -0
- package/dist/cjs/Client.js +56 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +6 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +17 -0
- package/dist/cjs/api/index.d.ts +3 -0
- package/dist/cjs/api/index.js +19 -0
- package/dist/cjs/api/resources/agentWebhooks/client/Client.d.ts +93 -0
- package/dist/cjs/api/resources/agentWebhooks/client/Client.js +325 -0
- package/dist/cjs/api/resources/agentWebhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentWebhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/CreateOrUpdateAgentWebhookV1AgentsAgentIdWebhookPostRequest.d.ts +14 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/CreateOrUpdateAgentWebhookV1AgentsAgentIdWebhookPostRequest.js +3 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/DeleteAgentWebhookV1AgentsAgentIdWebhookDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/DeleteAgentWebhookV1AgentsAgentIdWebhookDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/GetAgentWebhookV1AgentsAgentIdWebhookGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/GetAgentWebhookV1AgentsAgentIdWebhookGetRequest.js +3 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/ListAgentDeliveriesV1AgentsAgentIdWebhookDeliveriesGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/ListAgentDeliveriesV1AgentsAgentIdWebhookDeliveriesGetRequest.js +3 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/TestAgentWebhookV1AgentsAgentIdWebhookTestPostRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/TestAgentWebhookV1AgentsAgentIdWebhookTestPostRequest.js +3 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/agentWebhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentWebhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentWebhooks/index.js +17 -0
- package/dist/cjs/api/resources/agents/client/Client.d.ts +164 -0
- package/dist/cjs/api/resources/agents/client/Client.js +568 -0
- package/dist/cjs/api/resources/agents/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agents/client/index.js +17 -0
- package/dist/cjs/api/resources/agents/client/requests/AttachNumberRequest.d.ts +11 -0
- package/dist/cjs/api/resources/agents/client/requests/AttachNumberRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +16 -0
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/DetachNumberFromAgentV1AgentsAgentIdNumbersNumberIdDeleteRequest.d.ts +11 -0
- package/dist/cjs/api/resources/agents/client/requests/DetachNumberFromAgentV1AgentsAgentIdNumbersNumberIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentCallsV1AgentsAgentIdCallsGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentCallsV1AgentsAgentIdCallsGetRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentConversationsV1AgentsAgentIdConversationsGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentConversationsV1AgentsAgentIdConversationsGetRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +17 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.js +3 -0
- package/dist/cjs/api/resources/agents/client/requests/index.d.ts +9 -0
- package/dist/cjs/api/resources/agents/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agents/index.d.ts +1 -0
- package/dist/cjs/api/resources/agents/index.js +17 -0
- package/dist/cjs/api/resources/calls/client/Client.d.ts +151 -0
- package/dist/cjs/api/resources/calls/client/Client.js +465 -0
- package/dist/cjs/api/resources/calls/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/calls/client/index.js +17 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.d.ts +21 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateWebCallRequest.d.ts +12 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateWebCallRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallTranscriptV1CallsCallIdTranscriptGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallTranscriptV1CallsCallIdTranscriptGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallV1CallsCallIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/calls/client/requests/GetCallV1CallsCallIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/ListCallsForNumberV1NumbersNumberIdCallsGetRequest.d.ts +11 -0
- package/dist/cjs/api/resources/calls/client/requests/ListCallsForNumberV1NumbersNumberIdCallsGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/StreamCallTranscriptV1CallsCallIdTranscriptStreamGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/calls/client/requests/StreamCallTranscriptV1CallsCallIdTranscriptStreamGetRequest.js +3 -0
- package/dist/cjs/api/resources/calls/client/requests/index.d.ts +7 -0
- package/dist/cjs/api/resources/calls/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/calls/index.d.ts +1 -0
- package/dist/cjs/api/resources/calls/index.js +17 -0
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +94 -0
- package/dist/cjs/api/resources/contacts/client/Client.js +341 -0
- package/dist/cjs/api/resources/contacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/contacts/client/index.js +17 -0
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +13 -0
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/DeleteContactV1ContactsContactIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/contacts/client/requests/DeleteContactV1ContactsContactIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/GetContactV1ContactsContactIdGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/contacts/client/requests/GetContactV1ContactsContactIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +13 -0
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.js +3 -0
- package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/contacts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/contacts/index.d.ts +1 -0
- package/dist/cjs/api/resources/contacts/index.js +17 -0
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +82 -0
- package/dist/cjs/api/resources/conversations/client/Client.js +301 -0
- package/dist/cjs/api/resources/conversations/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/client/index.js +17 -0
- package/dist/cjs/api/resources/conversations/client/requests/GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest.d.ts +12 -0
- package/dist/cjs/api/resources/conversations/client/requests/GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/GetConversationV1ConversationsConversationIdGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/conversations/client/requests/GetConversationV1ConversationsConversationIdGetRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationRequest.d.ts +10 -0
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationRequest.js +3 -0
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/conversations/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +18 -0
- package/dist/cjs/api/resources/index.js +57 -0
- package/dist/cjs/api/resources/messages/client/Client.d.ts +49 -0
- package/dist/cjs/api/resources/messages/client/Client.js +183 -0
- package/dist/cjs/api/resources/messages/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/client/index.js +17 -0
- package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.d.ts +15 -0
- package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.js +3 -0
- package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.d.ts +11 -0
- package/dist/cjs/api/resources/messages/client/requests/SendReactionRequest.js +3 -0
- package/dist/cjs/api/resources/messages/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/messages/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/messages/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/index.js +17 -0
- package/dist/cjs/api/resources/numbers/client/Client.d.ts +84 -0
- package/dist/cjs/api/resources/numbers/client/Client.js +285 -0
- package/dist/cjs/api/resources/numbers/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/numbers/client/index.js +17 -0
- package/dist/cjs/api/resources/numbers/client/requests/CreateNumberRequest.d.ts +9 -0
- package/dist/cjs/api/resources/numbers/client/requests/CreateNumberRequest.js +3 -0
- package/dist/cjs/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.d.ts +9 -0
- package/dist/cjs/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/numbers/client/requests/GetMessagesV1NumbersNumberIdMessagesGetRequest.d.ts +12 -0
- package/dist/cjs/api/resources/numbers/client/requests/GetMessagesV1NumbersNumberIdMessagesGetRequest.js +3 -0
- package/dist/cjs/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.js +3 -0
- package/dist/cjs/api/resources/numbers/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/numbers/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/numbers/index.d.ts +1 -0
- package/dist/cjs/api/resources/numbers/index.js +17 -0
- package/dist/cjs/api/resources/usage/client/Client.d.ts +57 -0
- package/dist/cjs/api/resources/usage/client/Client.js +211 -0
- package/dist/cjs/api/resources/usage/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/usage/client/index.js +17 -0
- package/dist/cjs/api/resources/usage/client/requests/GetDailyUsageV1UsageDailyGetRequest.d.ts +7 -0
- package/dist/cjs/api/resources/usage/client/requests/GetDailyUsageV1UsageDailyGetRequest.js +3 -0
- package/dist/cjs/api/resources/usage/client/requests/GetMonthlyUsageV1UsageMonthlyGetRequest.d.ts +7 -0
- package/dist/cjs/api/resources/usage/client/requests/GetMonthlyUsageV1UsageMonthlyGetRequest.js +3 -0
- package/dist/cjs/api/resources/usage/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/usage/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/usage/index.d.ts +1 -0
- package/dist/cjs/api/resources/usage/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +107 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +406 -0
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeliveryStatsV1WebhooksDeliveriesStatsGetRequest.d.ts +7 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeliveryStatsV1WebhooksDeliveriesStatsGetRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListDeliveriesV1WebhooksDeliveriesGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListDeliveriesV1WebhooksDeliveriesGetRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookV1WebhooksTestPostRequest.d.ts +8 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookV1WebhooksTestPostRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/index.js +17 -0
- package/dist/cjs/api/types/AgentListResponse.d.ts +5 -0
- package/dist/cjs/api/types/AgentListResponse.js +3 -0
- package/dist/cjs/api/types/AgentNumberResponse.d.ts +6 -0
- package/dist/cjs/api/types/AgentNumberResponse.js +3 -0
- package/dist/cjs/api/types/AgentResponse.d.ts +14 -0
- package/dist/cjs/api/types/AgentResponse.js +3 -0
- package/dist/cjs/api/types/AllTimeStatsResponse.d.ts +6 -0
- package/dist/cjs/api/types/AllTimeStatsResponse.js +3 -0
- package/dist/cjs/api/types/AppRoutesAgentsConversationListResponse.d.ts +6 -0
- package/dist/cjs/api/types/AppRoutesAgentsConversationListResponse.js +3 -0
- package/dist/cjs/api/types/AppRoutesAgentsConversationSummary.d.ts +11 -0
- package/dist/cjs/api/types/AppRoutesAgentsConversationSummary.js +3 -0
- package/dist/cjs/api/types/AppRoutesConversationsConversationListResponse.d.ts +6 -0
- package/dist/cjs/api/types/AppRoutesConversationsConversationListResponse.js +3 -0
- package/dist/cjs/api/types/AppRoutesConversationsConversationSummary.d.ts +12 -0
- package/dist/cjs/api/types/AppRoutesConversationsConversationSummary.js +3 -0
- package/dist/cjs/api/types/AttachNumberResponse.d.ts +5 -0
- package/dist/cjs/api/types/AttachNumberResponse.js +3 -0
- package/dist/cjs/api/types/CallListResponse.d.ts +6 -0
- package/dist/cjs/api/types/CallListResponse.js +3 -0
- package/dist/cjs/api/types/CallSummary.d.ts +13 -0
- package/dist/cjs/api/types/CallSummary.js +3 -0
- package/dist/cjs/api/types/ContactListResponse.d.ts +6 -0
- package/dist/cjs/api/types/ContactListResponse.js +3 -0
- package/dist/cjs/api/types/ContactResponse.d.ts +9 -0
- package/dist/cjs/api/types/ContactResponse.js +3 -0
- package/dist/cjs/api/types/ConversationDetail.d.ts +13 -0
- package/dist/cjs/api/types/ConversationDetail.js +3 -0
- package/dist/cjs/api/types/DailyUsagePoint.d.ts +6 -0
- package/dist/cjs/api/types/DailyUsagePoint.js +3 -0
- package/dist/cjs/api/types/DailyUsageResponse.d.ts +5 -0
- package/dist/cjs/api/types/DailyUsageResponse.js +3 -0
- package/dist/cjs/api/types/DeleteAgentResponse.d.ts +5 -0
- package/dist/cjs/api/types/DeleteAgentResponse.js +3 -0
- package/dist/cjs/api/types/HttpValidationError.d.ts +4 -0
- package/dist/cjs/api/types/HttpValidationError.js +3 -0
- package/dist/cjs/api/types/MessageInConversation.d.ts +10 -0
- package/dist/cjs/api/types/MessageInConversation.js +3 -0
- package/dist/cjs/api/types/MessageListResponse.d.ts +5 -0
- package/dist/cjs/api/types/MessageListResponse.js +3 -0
- package/dist/cjs/api/types/MessageResponse.d.ts +9 -0
- package/dist/cjs/api/types/MessageResponse.js +3 -0
- package/dist/cjs/api/types/MessagesListResponse.d.ts +5 -0
- package/dist/cjs/api/types/MessagesListResponse.js +3 -0
- package/dist/cjs/api/types/MonthlyUsagePoint.d.ts +6 -0
- package/dist/cjs/api/types/MonthlyUsagePoint.js +3 -0
- package/dist/cjs/api/types/MonthlyUsageResponse.d.ts +5 -0
- package/dist/cjs/api/types/MonthlyUsageResponse.js +3 -0
- package/dist/cjs/api/types/NumberLimits.d.ts +5 -0
- package/dist/cjs/api/types/NumberLimits.js +3 -0
- package/dist/cjs/api/types/PaginatedDeliveriesResponse.d.ts +7 -0
- package/dist/cjs/api/types/PaginatedDeliveriesResponse.js +3 -0
- package/dist/cjs/api/types/PhoneNumberListResponse.d.ts +6 -0
- package/dist/cjs/api/types/PhoneNumberListResponse.js +3 -0
- package/dist/cjs/api/types/PhoneNumberResponse.d.ts +9 -0
- package/dist/cjs/api/types/PhoneNumberResponse.js +3 -0
- package/dist/cjs/api/types/PlanInfo.d.ts +5 -0
- package/dist/cjs/api/types/PlanInfo.js +3 -0
- package/dist/cjs/api/types/PlanLimits.d.ts +7 -0
- package/dist/cjs/api/types/PlanLimits.js +3 -0
- package/dist/cjs/api/types/SendMessageResponse.d.ts +7 -0
- package/dist/cjs/api/types/SendMessageResponse.js +3 -0
- package/dist/cjs/api/types/SendReactionResponse.d.ts +6 -0
- package/dist/cjs/api/types/SendReactionResponse.js +3 -0
- package/dist/cjs/api/types/UsageResponse.d.ts +8 -0
- package/dist/cjs/api/types/UsageResponse.js +3 -0
- package/dist/cjs/api/types/UsageStats.d.ts +13 -0
- package/dist/cjs/api/types/UsageStats.js +3 -0
- package/dist/cjs/api/types/ValidationError.d.ts +11 -0
- package/dist/cjs/api/types/ValidationError.js +3 -0
- package/dist/cjs/api/types/WebhookCreateRequest.d.ts +5 -0
- package/dist/cjs/api/types/WebhookCreateRequest.js +3 -0
- package/dist/cjs/api/types/WebhookDeliveryResponse.d.ts +14 -0
- package/dist/cjs/api/types/WebhookDeliveryResponse.js +3 -0
- package/dist/cjs/api/types/WebhookDeliveryStatsResponse.d.ts +9 -0
- package/dist/cjs/api/types/WebhookDeliveryStatsResponse.js +3 -0
- package/dist/cjs/api/types/WebhookResponse.d.ts +9 -0
- package/dist/cjs/api/types/WebhookResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +39 -0
- package/dist/cjs/api/types/index.js +55 -0
- package/dist/cjs/auth/BearerAuthProvider.d.ts +20 -0
- package/dist/cjs/auth/BearerAuthProvider.js +79 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
- package/dist/cjs/core/auth/AuthProvider.js +2 -0
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +27 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +9 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/APIResponse.js +2 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +19 -0
- package/dist/cjs/core/fetcher/BinaryResponse.js +17 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +48 -0
- package/dist/cjs/core/fetcher/Fetcher.js +316 -0
- package/dist/cjs/core/fetcher/Headers.d.ts +2 -0
- package/dist/cjs/core/fetcher/Headers.js +84 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/cjs/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/cjs/core/fetcher/RawResponse.js +44 -0
- package/dist/cjs/core/fetcher/Supplier.d.ts +4 -0
- package/dist/cjs/core/fetcher/Supplier.js +22 -0
- package/dist/cjs/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/cjs/core/fetcher/createRequestUrl.js +8 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +45 -0
- package/dist/cjs/core/fetcher/getFetchFn.d.ts +1 -0
- package/dist/cjs/core/fetcher/getFetchFn.js +17 -0
- package/dist/cjs/core/fetcher/getHeader.d.ts +1 -0
- package/dist/cjs/core/fetcher/getHeader.js +11 -0
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/cjs/core/fetcher/getRequestBody.js +27 -0
- package/dist/cjs/core/fetcher/getResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +69 -0
- package/dist/cjs/core/fetcher/index.d.ts +11 -0
- package/dist/cjs/core/fetcher/index.js +17 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -0
- package/dist/cjs/core/fetcher/makeRequest.js +40 -0
- package/dist/cjs/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/cjs/core/fetcher/requestWithRetries.js +67 -0
- package/dist/cjs/core/fetcher/signals.d.ts +5 -0
- package/dist/cjs/core/fetcher/signals.js +24 -0
- package/dist/cjs/core/headers.d.ts +2 -0
- package/dist/cjs/core/headers.js +31 -0
- package/dist/cjs/core/index.d.ts +6 -0
- package/dist/cjs/core/index.js +45 -0
- package/dist/cjs/core/json.d.ts +15 -0
- package/dist/cjs/core/json.js +24 -0
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/runtime/index.d.ts +1 -0
- package/dist/cjs/core/runtime/index.js +5 -0
- package/dist/cjs/core/runtime/runtime.d.ts +9 -0
- package/dist/cjs/core/runtime/runtime.js +103 -0
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +3 -0
- package/dist/cjs/core/url/index.js +9 -0
- package/dist/cjs/core/url/join.d.ts +1 -0
- package/dist/cjs/core/url/join.js +68 -0
- package/dist/cjs/core/url/qs.d.ts +6 -0
- package/dist/cjs/core/url/qs.js +64 -0
- package/dist/cjs/environments.d.ts +4 -0
- package/dist/cjs/environments.js +7 -0
- package/dist/cjs/errors/AgentPhoneError.d.ts +12 -0
- package/dist/cjs/errors/AgentPhoneError.js +32 -0
- package/dist/cjs/errors/AgentPhoneTimeoutError.d.ts +3 -0
- package/dist/cjs/errors/AgentPhoneTimeoutError.js +15 -0
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/cjs/errors/index.d.ts +2 -0
- package/dist/cjs/errors/index.js +7 -0
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/index.d.ts +6 -0
- package/dist/cjs/index.js +48 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +4 -0
- package/dist/esm/BaseClient.d.mts +39 -0
- package/dist/esm/BaseClient.mjs +25 -0
- package/dist/esm/Client.d.mts +38 -0
- package/dist/esm/Client.mjs +52 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +6 -0
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/index.d.mts +3 -0
- package/dist/esm/api/index.mjs +3 -0
- package/dist/esm/api/resources/agentWebhooks/client/Client.d.mts +93 -0
- package/dist/esm/api/resources/agentWebhooks/client/Client.mjs +288 -0
- package/dist/esm/api/resources/agentWebhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentWebhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/CreateOrUpdateAgentWebhookV1AgentsAgentIdWebhookPostRequest.d.mts +14 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/CreateOrUpdateAgentWebhookV1AgentsAgentIdWebhookPostRequest.mjs +2 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/DeleteAgentWebhookV1AgentsAgentIdWebhookDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/DeleteAgentWebhookV1AgentsAgentIdWebhookDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/GetAgentWebhookV1AgentsAgentIdWebhookGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/GetAgentWebhookV1AgentsAgentIdWebhookGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/ListAgentDeliveriesV1AgentsAgentIdWebhookDeliveriesGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/ListAgentDeliveriesV1AgentsAgentIdWebhookDeliveriesGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/TestAgentWebhookV1AgentsAgentIdWebhookTestPostRequest.d.mts +9 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/TestAgentWebhookV1AgentsAgentIdWebhookTestPostRequest.mjs +2 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/agentWebhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentWebhooks/index.d.mts +1 -0
- package/dist/esm/api/resources/agentWebhooks/index.mjs +1 -0
- package/dist/esm/api/resources/agents/client/Client.d.mts +164 -0
- package/dist/esm/api/resources/agents/client/Client.mjs +531 -0
- package/dist/esm/api/resources/agents/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agents/client/index.mjs +1 -0
- package/dist/esm/api/resources/agents/client/requests/AttachNumberRequest.d.mts +11 -0
- package/dist/esm/api/resources/agents/client/requests/AttachNumberRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +16 -0
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/agents/client/requests/DeleteAgentV1AgentsAgentIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/DetachNumberFromAgentV1AgentsAgentIdNumbersNumberIdDeleteRequest.d.mts +11 -0
- package/dist/esm/api/resources/agents/client/requests/DetachNumberFromAgentV1AgentsAgentIdNumbersNumberIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/agents/client/requests/GetAgentV1AgentsAgentIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentCallsV1AgentsAgentIdCallsGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentCallsV1AgentsAgentIdCallsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentConversationsV1AgentsAgentIdConversationsGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentConversationsV1AgentsAgentIdConversationsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/agents/client/requests/ListAgentsV1AgentsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +17 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/agents/client/requests/index.d.mts +9 -0
- package/dist/esm/api/resources/agents/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agents/index.d.mts +1 -0
- package/dist/esm/api/resources/agents/index.mjs +1 -0
- package/dist/esm/api/resources/calls/client/Client.d.mts +151 -0
- package/dist/esm/api/resources/calls/client/Client.mjs +428 -0
- package/dist/esm/api/resources/calls/client/index.d.mts +1 -0
- package/dist/esm/api/resources/calls/client/index.mjs +1 -0
- package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.d.mts +21 -0
- package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/CreateWebCallRequest.d.mts +12 -0
- package/dist/esm/api/resources/calls/client/requests/CreateWebCallRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallTranscriptV1CallsCallIdTranscriptGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallTranscriptV1CallsCallIdTranscriptGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallV1CallsCallIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/calls/client/requests/GetCallV1CallsCallIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/ListCallsForNumberV1NumbersNumberIdCallsGetRequest.d.mts +11 -0
- package/dist/esm/api/resources/calls/client/requests/ListCallsForNumberV1NumbersNumberIdCallsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.d.mts +16 -0
- package/dist/esm/api/resources/calls/client/requests/ListCallsV1CallsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/StreamCallTranscriptV1CallsCallIdTranscriptStreamGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/calls/client/requests/StreamCallTranscriptV1CallsCallIdTranscriptStreamGetRequest.mjs +2 -0
- package/dist/esm/api/resources/calls/client/requests/index.d.mts +7 -0
- package/dist/esm/api/resources/calls/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/calls/index.d.mts +1 -0
- package/dist/esm/api/resources/calls/index.mjs +1 -0
- package/dist/esm/api/resources/contacts/client/Client.d.mts +94 -0
- package/dist/esm/api/resources/contacts/client/Client.mjs +304 -0
- package/dist/esm/api/resources/contacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/contacts/client/index.mjs +1 -0
- package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +13 -0
- package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.mjs +2 -0
- package/dist/esm/api/resources/contacts/client/requests/DeleteContactV1ContactsContactIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/contacts/client/requests/DeleteContactV1ContactsContactIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/contacts/client/requests/GetContactV1ContactsContactIdGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/contacts/client/requests/GetContactV1ContactsContactIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/contacts/client/requests/ListContactsV1ContactsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +13 -0
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.mjs +2 -0
- package/dist/esm/api/resources/contacts/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/contacts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/contacts/index.d.mts +1 -0
- package/dist/esm/api/resources/contacts/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/client/Client.d.mts +82 -0
- package/dist/esm/api/resources/conversations/client/Client.mjs +264 -0
- package/dist/esm/api/resources/conversations/client/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/client/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/client/requests/GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest.d.mts +12 -0
- package/dist/esm/api/resources/conversations/client/requests/GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/GetConversationV1ConversationsConversationIdGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/conversations/client/requests/GetConversationV1ConversationsConversationIdGetRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsV1ConversationsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationRequest.d.mts +10 -0
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationRequest.mjs +2 -0
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/conversations/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +18 -0
- package/dist/esm/api/resources/index.mjs +18 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +49 -0
- package/dist/esm/api/resources/messages/client/Client.mjs +146 -0
- package/dist/esm/api/resources/messages/client/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/client/index.mjs +1 -0
- package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.d.mts +15 -0
- package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.mjs +2 -0
- package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.d.mts +11 -0
- package/dist/esm/api/resources/messages/client/requests/SendReactionRequest.mjs +2 -0
- package/dist/esm/api/resources/messages/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/messages/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/messages/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/index.mjs +1 -0
- package/dist/esm/api/resources/numbers/client/Client.d.mts +84 -0
- package/dist/esm/api/resources/numbers/client/Client.mjs +248 -0
- package/dist/esm/api/resources/numbers/client/index.d.mts +1 -0
- package/dist/esm/api/resources/numbers/client/index.mjs +1 -0
- package/dist/esm/api/resources/numbers/client/requests/CreateNumberRequest.d.mts +9 -0
- package/dist/esm/api/resources/numbers/client/requests/CreateNumberRequest.mjs +2 -0
- package/dist/esm/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.d.mts +9 -0
- package/dist/esm/api/resources/numbers/client/requests/DeleteNumberV1NumbersNumberIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/numbers/client/requests/GetMessagesV1NumbersNumberIdMessagesGetRequest.d.mts +12 -0
- package/dist/esm/api/resources/numbers/client/requests/GetMessagesV1NumbersNumberIdMessagesGetRequest.mjs +2 -0
- package/dist/esm/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/numbers/client/requests/ListNumbersV1NumbersGetRequest.mjs +2 -0
- package/dist/esm/api/resources/numbers/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/numbers/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/numbers/index.d.mts +1 -0
- package/dist/esm/api/resources/numbers/index.mjs +1 -0
- package/dist/esm/api/resources/usage/client/Client.d.mts +57 -0
- package/dist/esm/api/resources/usage/client/Client.mjs +174 -0
- package/dist/esm/api/resources/usage/client/index.d.mts +1 -0
- package/dist/esm/api/resources/usage/client/index.mjs +1 -0
- package/dist/esm/api/resources/usage/client/requests/GetDailyUsageV1UsageDailyGetRequest.d.mts +7 -0
- package/dist/esm/api/resources/usage/client/requests/GetDailyUsageV1UsageDailyGetRequest.mjs +2 -0
- package/dist/esm/api/resources/usage/client/requests/GetMonthlyUsageV1UsageMonthlyGetRequest.d.mts +7 -0
- package/dist/esm/api/resources/usage/client/requests/GetMonthlyUsageV1UsageMonthlyGetRequest.mjs +2 -0
- package/dist/esm/api/resources/usage/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/usage/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/usage/index.d.mts +1 -0
- package/dist/esm/api/resources/usage/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +107 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +369 -0
- package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeliveryStatsV1WebhooksDeliveriesStatsGetRequest.d.mts +7 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeliveryStatsV1WebhooksDeliveriesStatsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListDeliveriesV1WebhooksDeliveriesGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListDeliveriesV1WebhooksDeliveriesGetRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookV1WebhooksTestPostRequest.d.mts +8 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookV1WebhooksTestPostRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/index.mjs +1 -0
- package/dist/esm/api/types/AgentListResponse.d.mts +5 -0
- package/dist/esm/api/types/AgentListResponse.mjs +2 -0
- package/dist/esm/api/types/AgentNumberResponse.d.mts +6 -0
- package/dist/esm/api/types/AgentNumberResponse.mjs +2 -0
- package/dist/esm/api/types/AgentResponse.d.mts +14 -0
- package/dist/esm/api/types/AgentResponse.mjs +2 -0
- package/dist/esm/api/types/AllTimeStatsResponse.d.mts +6 -0
- package/dist/esm/api/types/AllTimeStatsResponse.mjs +2 -0
- package/dist/esm/api/types/AppRoutesAgentsConversationListResponse.d.mts +6 -0
- package/dist/esm/api/types/AppRoutesAgentsConversationListResponse.mjs +2 -0
- package/dist/esm/api/types/AppRoutesAgentsConversationSummary.d.mts +11 -0
- package/dist/esm/api/types/AppRoutesAgentsConversationSummary.mjs +2 -0
- package/dist/esm/api/types/AppRoutesConversationsConversationListResponse.d.mts +6 -0
- package/dist/esm/api/types/AppRoutesConversationsConversationListResponse.mjs +2 -0
- package/dist/esm/api/types/AppRoutesConversationsConversationSummary.d.mts +12 -0
- package/dist/esm/api/types/AppRoutesConversationsConversationSummary.mjs +2 -0
- package/dist/esm/api/types/AttachNumberResponse.d.mts +5 -0
- package/dist/esm/api/types/AttachNumberResponse.mjs +2 -0
- package/dist/esm/api/types/CallListResponse.d.mts +6 -0
- package/dist/esm/api/types/CallListResponse.mjs +2 -0
- package/dist/esm/api/types/CallSummary.d.mts +13 -0
- package/dist/esm/api/types/CallSummary.mjs +2 -0
- package/dist/esm/api/types/ContactListResponse.d.mts +6 -0
- package/dist/esm/api/types/ContactListResponse.mjs +2 -0
- package/dist/esm/api/types/ContactResponse.d.mts +9 -0
- package/dist/esm/api/types/ContactResponse.mjs +2 -0
- package/dist/esm/api/types/ConversationDetail.d.mts +13 -0
- package/dist/esm/api/types/ConversationDetail.mjs +2 -0
- package/dist/esm/api/types/DailyUsagePoint.d.mts +6 -0
- package/dist/esm/api/types/DailyUsagePoint.mjs +2 -0
- package/dist/esm/api/types/DailyUsageResponse.d.mts +5 -0
- package/dist/esm/api/types/DailyUsageResponse.mjs +2 -0
- package/dist/esm/api/types/DeleteAgentResponse.d.mts +5 -0
- package/dist/esm/api/types/DeleteAgentResponse.mjs +2 -0
- package/dist/esm/api/types/HttpValidationError.d.mts +4 -0
- package/dist/esm/api/types/HttpValidationError.mjs +2 -0
- package/dist/esm/api/types/MessageInConversation.d.mts +10 -0
- package/dist/esm/api/types/MessageInConversation.mjs +2 -0
- package/dist/esm/api/types/MessageListResponse.d.mts +5 -0
- package/dist/esm/api/types/MessageListResponse.mjs +2 -0
- package/dist/esm/api/types/MessageResponse.d.mts +9 -0
- package/dist/esm/api/types/MessageResponse.mjs +2 -0
- package/dist/esm/api/types/MessagesListResponse.d.mts +5 -0
- package/dist/esm/api/types/MessagesListResponse.mjs +2 -0
- package/dist/esm/api/types/MonthlyUsagePoint.d.mts +6 -0
- package/dist/esm/api/types/MonthlyUsagePoint.mjs +2 -0
- package/dist/esm/api/types/MonthlyUsageResponse.d.mts +5 -0
- package/dist/esm/api/types/MonthlyUsageResponse.mjs +2 -0
- package/dist/esm/api/types/NumberLimits.d.mts +5 -0
- package/dist/esm/api/types/NumberLimits.mjs +2 -0
- package/dist/esm/api/types/PaginatedDeliveriesResponse.d.mts +7 -0
- package/dist/esm/api/types/PaginatedDeliveriesResponse.mjs +2 -0
- package/dist/esm/api/types/PhoneNumberListResponse.d.mts +6 -0
- package/dist/esm/api/types/PhoneNumberListResponse.mjs +2 -0
- package/dist/esm/api/types/PhoneNumberResponse.d.mts +9 -0
- package/dist/esm/api/types/PhoneNumberResponse.mjs +2 -0
- package/dist/esm/api/types/PlanInfo.d.mts +5 -0
- package/dist/esm/api/types/PlanInfo.mjs +2 -0
- package/dist/esm/api/types/PlanLimits.d.mts +7 -0
- package/dist/esm/api/types/PlanLimits.mjs +2 -0
- package/dist/esm/api/types/SendMessageResponse.d.mts +7 -0
- package/dist/esm/api/types/SendMessageResponse.mjs +2 -0
- package/dist/esm/api/types/SendReactionResponse.d.mts +6 -0
- package/dist/esm/api/types/SendReactionResponse.mjs +2 -0
- package/dist/esm/api/types/UsageResponse.d.mts +8 -0
- package/dist/esm/api/types/UsageResponse.mjs +2 -0
- package/dist/esm/api/types/UsageStats.d.mts +13 -0
- package/dist/esm/api/types/UsageStats.mjs +2 -0
- package/dist/esm/api/types/ValidationError.d.mts +11 -0
- package/dist/esm/api/types/ValidationError.mjs +2 -0
- package/dist/esm/api/types/WebhookCreateRequest.d.mts +5 -0
- package/dist/esm/api/types/WebhookCreateRequest.mjs +2 -0
- package/dist/esm/api/types/WebhookDeliveryResponse.d.mts +14 -0
- package/dist/esm/api/types/WebhookDeliveryResponse.mjs +2 -0
- package/dist/esm/api/types/WebhookDeliveryStatsResponse.d.mts +9 -0
- package/dist/esm/api/types/WebhookDeliveryStatsResponse.mjs +2 -0
- package/dist/esm/api/types/WebhookResponse.d.mts +9 -0
- package/dist/esm/api/types/WebhookResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +39 -0
- package/dist/esm/api/types/index.mjs +39 -0
- package/dist/esm/auth/BearerAuthProvider.d.mts +20 -0
- package/dist/esm/auth/BearerAuthProvider.mjs +42 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +24 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +3 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/APIResponse.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +19 -0
- package/dist/esm/core/fetcher/BinaryResponse.mjs +14 -0
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +48 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +312 -0
- package/dist/esm/core/fetcher/Headers.d.mts +2 -0
- package/dist/esm/core/fetcher/Headers.mjs +82 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +58 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.mjs +99 -0
- package/dist/esm/core/fetcher/RawResponse.d.mts +29 -0
- package/dist/esm/core/fetcher/RawResponse.mjs +40 -0
- package/dist/esm/core/fetcher/Supplier.d.mts +4 -0
- package/dist/esm/core/fetcher/Supplier.mjs +19 -0
- package/dist/esm/core/fetcher/createRequestUrl.d.mts +1 -0
- package/dist/esm/core/fetcher/createRequestUrl.mjs +5 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +42 -0
- package/dist/esm/core/fetcher/getFetchFn.d.mts +1 -0
- package/dist/esm/core/fetcher/getFetchFn.mjs +14 -0
- package/dist/esm/core/fetcher/getHeader.d.mts +1 -0
- package/dist/esm/core/fetcher/getHeader.mjs +8 -0
- package/dist/esm/core/fetcher/getRequestBody.d.mts +7 -0
- package/dist/esm/core/fetcher/getRequestBody.mjs +24 -0
- package/dist/esm/core/fetcher/getResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +66 -0
- package/dist/esm/core/fetcher/index.d.mts +11 -0
- package/dist/esm/core/fetcher/index.mjs +6 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -0
- package/dist/esm/core/fetcher/makeRequest.mjs +36 -0
- package/dist/esm/core/fetcher/requestWithRetries.d.mts +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +64 -0
- package/dist/esm/core/fetcher/signals.d.mts +5 -0
- package/dist/esm/core/fetcher/signals.mjs +20 -0
- package/dist/esm/core/headers.d.mts +2 -0
- package/dist/esm/core/headers.mjs +27 -0
- package/dist/esm/core/index.d.mts +6 -0
- package/dist/esm/core/index.mjs +6 -0
- package/dist/esm/core/json.d.mts +15 -0
- package/dist/esm/core/json.mjs +19 -0
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/runtime/index.d.mts +1 -0
- package/dist/esm/core/runtime/index.mjs +1 -0
- package/dist/esm/core/runtime/runtime.d.mts +9 -0
- package/dist/esm/core/runtime/runtime.mjs +100 -0
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +3 -0
- package/dist/esm/core/url/index.mjs +3 -0
- package/dist/esm/core/url/join.d.mts +1 -0
- package/dist/esm/core/url/join.mjs +65 -0
- package/dist/esm/core/url/qs.d.mts +6 -0
- package/dist/esm/core/url/qs.mjs +61 -0
- package/dist/esm/environments.d.mts +4 -0
- package/dist/esm/environments.mjs +4 -0
- package/dist/esm/errors/AgentPhoneError.d.mts +12 -0
- package/dist/esm/errors/AgentPhoneError.mjs +28 -0
- package/dist/esm/errors/AgentPhoneTimeoutError.d.mts +3 -0
- package/dist/esm/errors/AgentPhoneTimeoutError.mjs +11 -0
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/dist/esm/errors/index.d.mts +2 -0
- package/dist/esm/errors/index.mjs +2 -0
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/index.d.mts +6 -0
- package/dist/esm/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -0
- package/dist/esm/version.mjs +1 -0
- package/package.json +2 -2
- package/reference.md +1436 -94
package/reference.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
<dl>
|
|
13
13
|
<dd>
|
|
14
14
|
|
|
15
|
-
List all agents for this
|
|
15
|
+
List all agents for this account.
|
|
16
16
|
</dd>
|
|
17
17
|
</dl>
|
|
18
18
|
</dd>
|
|
@@ -282,7 +282,7 @@ await client.agents.deleteAgent({
|
|
|
282
282
|
Update an agent's configuration.
|
|
283
283
|
|
|
284
284
|
Use this to change voice mode, system prompt, greeting, or voice.
|
|
285
|
-
Switching voiceMode to "hosted" re-provisions the
|
|
285
|
+
Switching voiceMode to "hosted" re-provisions the voice agent with built-in LLM.
|
|
286
286
|
</dd>
|
|
287
287
|
</dl>
|
|
288
288
|
</dd>
|
|
@@ -349,7 +349,7 @@ await client.agents.updateAgent({
|
|
|
349
349
|
|
|
350
350
|
Attach an existing phone number to an agent.
|
|
351
351
|
|
|
352
|
-
The number must belong to the same
|
|
352
|
+
The number must belong to the same account and not be released.
|
|
353
353
|
</dd>
|
|
354
354
|
</dl>
|
|
355
355
|
</dd>
|
|
@@ -399,6 +399,74 @@ await client.agents.attachNumberToAgent({
|
|
|
399
399
|
</dl>
|
|
400
400
|
|
|
401
401
|
|
|
402
|
+
</dd>
|
|
403
|
+
</dl>
|
|
404
|
+
</details>
|
|
405
|
+
|
|
406
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">detachNumberFromAgent</a>({ ...params }) -> unknown</code></summary>
|
|
407
|
+
<dl>
|
|
408
|
+
<dd>
|
|
409
|
+
|
|
410
|
+
#### 📝 Description
|
|
411
|
+
|
|
412
|
+
<dl>
|
|
413
|
+
<dd>
|
|
414
|
+
|
|
415
|
+
<dl>
|
|
416
|
+
<dd>
|
|
417
|
+
|
|
418
|
+
Detach a phone number from an agent (sets agentId to null).
|
|
419
|
+
|
|
420
|
+
The number remains active and can be re-attached to any agent.
|
|
421
|
+
</dd>
|
|
422
|
+
</dl>
|
|
423
|
+
</dd>
|
|
424
|
+
</dl>
|
|
425
|
+
|
|
426
|
+
#### 🔌 Usage
|
|
427
|
+
|
|
428
|
+
<dl>
|
|
429
|
+
<dd>
|
|
430
|
+
|
|
431
|
+
<dl>
|
|
432
|
+
<dd>
|
|
433
|
+
|
|
434
|
+
```typescript
|
|
435
|
+
await client.agents.detachNumberFromAgent({
|
|
436
|
+
agent_id: "agent_id",
|
|
437
|
+
number_id: "number_id"
|
|
438
|
+
});
|
|
439
|
+
|
|
440
|
+
```
|
|
441
|
+
</dd>
|
|
442
|
+
</dl>
|
|
443
|
+
</dd>
|
|
444
|
+
</dl>
|
|
445
|
+
|
|
446
|
+
#### ⚙️ Parameters
|
|
447
|
+
|
|
448
|
+
<dl>
|
|
449
|
+
<dd>
|
|
450
|
+
|
|
451
|
+
<dl>
|
|
452
|
+
<dd>
|
|
453
|
+
|
|
454
|
+
**request:** `AgentPhone.DetachNumberFromAgentV1AgentsAgentIdNumbersNumberIdDeleteRequest`
|
|
455
|
+
|
|
456
|
+
</dd>
|
|
457
|
+
</dl>
|
|
458
|
+
|
|
459
|
+
<dl>
|
|
460
|
+
<dd>
|
|
461
|
+
|
|
462
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
463
|
+
|
|
464
|
+
</dd>
|
|
465
|
+
</dl>
|
|
466
|
+
</dd>
|
|
467
|
+
</dl>
|
|
468
|
+
|
|
469
|
+
|
|
402
470
|
</dd>
|
|
403
471
|
</dl>
|
|
404
472
|
</details>
|
|
@@ -546,7 +614,7 @@ await client.agents.listAgentCalls({
|
|
|
546
614
|
<dl>
|
|
547
615
|
<dd>
|
|
548
616
|
|
|
549
|
-
List all phone numbers for this
|
|
617
|
+
List all phone numbers for this account.
|
|
550
618
|
</dd>
|
|
551
619
|
</dl>
|
|
552
620
|
</dd>
|
|
@@ -818,7 +886,7 @@ await client.numbers.deleteNumber({
|
|
|
818
886
|
<dl>
|
|
819
887
|
<dd>
|
|
820
888
|
|
|
821
|
-
Get the webhook configuration for this
|
|
889
|
+
Get the master webhook configuration for this account.
|
|
822
890
|
</dd>
|
|
823
891
|
</dl>
|
|
824
892
|
</dd>
|
|
@@ -873,7 +941,7 @@ await client.webhooks.getWebhook();
|
|
|
873
941
|
<dl>
|
|
874
942
|
<dd>
|
|
875
943
|
|
|
876
|
-
Register or update the webhook URL for this
|
|
944
|
+
Register or update the webhook URL for this account.
|
|
877
945
|
|
|
878
946
|
If a webhook already exists, it will be updated.
|
|
879
947
|
A new secret is generated each time.
|
|
@@ -944,7 +1012,7 @@ await client.webhooks.createOrUpdateWebhook({
|
|
|
944
1012
|
<dl>
|
|
945
1013
|
<dd>
|
|
946
1014
|
|
|
947
|
-
Remove the webhook for this
|
|
1015
|
+
Remove the master webhook for this account.
|
|
948
1016
|
</dd>
|
|
949
1017
|
</dl>
|
|
950
1018
|
</dd>
|
|
@@ -987,7 +1055,7 @@ await client.webhooks.deleteWebhook();
|
|
|
987
1055
|
</dl>
|
|
988
1056
|
</details>
|
|
989
1057
|
|
|
990
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listDeliveries</a>({ ...params }) -> AgentPhone.
|
|
1058
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listDeliveries</a>({ ...params }) -> AgentPhone.PaginatedDeliveriesResponse</code></summary>
|
|
991
1059
|
<dl>
|
|
992
1060
|
<dd>
|
|
993
1061
|
|
|
@@ -999,7 +1067,7 @@ await client.webhooks.deleteWebhook();
|
|
|
999
1067
|
<dl>
|
|
1000
1068
|
<dd>
|
|
1001
1069
|
|
|
1002
|
-
Get
|
|
1070
|
+
Get paginated webhook delivery attempts for all account webhooks.
|
|
1003
1071
|
</dd>
|
|
1004
1072
|
</dl>
|
|
1005
1073
|
</dd>
|
|
@@ -1050,7 +1118,7 @@ await client.webhooks.listDeliveries();
|
|
|
1050
1118
|
</dl>
|
|
1051
1119
|
</details>
|
|
1052
1120
|
|
|
1053
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">
|
|
1121
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deliveryStats</a>({ ...params }) -> AgentPhone.WebhookDeliveryStatsResponse</code></summary>
|
|
1054
1122
|
<dl>
|
|
1055
1123
|
<dd>
|
|
1056
1124
|
|
|
@@ -1062,9 +1130,70 @@ await client.webhooks.listDeliveries();
|
|
|
1062
1130
|
<dl>
|
|
1063
1131
|
<dd>
|
|
1064
1132
|
|
|
1065
|
-
|
|
1133
|
+
Aggregated delivery stats for the account's webhooks over the last N hours.
|
|
1134
|
+
</dd>
|
|
1135
|
+
</dl>
|
|
1136
|
+
</dd>
|
|
1137
|
+
</dl>
|
|
1066
1138
|
|
|
1067
|
-
|
|
1139
|
+
#### 🔌 Usage
|
|
1140
|
+
|
|
1141
|
+
<dl>
|
|
1142
|
+
<dd>
|
|
1143
|
+
|
|
1144
|
+
<dl>
|
|
1145
|
+
<dd>
|
|
1146
|
+
|
|
1147
|
+
```typescript
|
|
1148
|
+
await client.webhooks.deliveryStats();
|
|
1149
|
+
|
|
1150
|
+
```
|
|
1151
|
+
</dd>
|
|
1152
|
+
</dl>
|
|
1153
|
+
</dd>
|
|
1154
|
+
</dl>
|
|
1155
|
+
|
|
1156
|
+
#### ⚙️ Parameters
|
|
1157
|
+
|
|
1158
|
+
<dl>
|
|
1159
|
+
<dd>
|
|
1160
|
+
|
|
1161
|
+
<dl>
|
|
1162
|
+
<dd>
|
|
1163
|
+
|
|
1164
|
+
**request:** `AgentPhone.DeliveryStatsV1WebhooksDeliveriesStatsGetRequest`
|
|
1165
|
+
|
|
1166
|
+
</dd>
|
|
1167
|
+
</dl>
|
|
1168
|
+
|
|
1169
|
+
<dl>
|
|
1170
|
+
<dd>
|
|
1171
|
+
|
|
1172
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1173
|
+
|
|
1174
|
+
</dd>
|
|
1175
|
+
</dl>
|
|
1176
|
+
</dd>
|
|
1177
|
+
</dl>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
</dd>
|
|
1181
|
+
</dl>
|
|
1182
|
+
</details>
|
|
1183
|
+
|
|
1184
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">allTimeStats</a>() -> AgentPhone.AllTimeStatsResponse</code></summary>
|
|
1185
|
+
<dl>
|
|
1186
|
+
<dd>
|
|
1187
|
+
|
|
1188
|
+
#### 📝 Description
|
|
1189
|
+
|
|
1190
|
+
<dl>
|
|
1191
|
+
<dd>
|
|
1192
|
+
|
|
1193
|
+
<dl>
|
|
1194
|
+
<dd>
|
|
1195
|
+
|
|
1196
|
+
Lightweight all-time delivery counts using indexed COUNT queries.
|
|
1068
1197
|
</dd>
|
|
1069
1198
|
</dl>
|
|
1070
1199
|
</dd>
|
|
@@ -1079,7 +1208,7 @@ Sends a fake message payload to the configured URL.
|
|
|
1079
1208
|
<dd>
|
|
1080
1209
|
|
|
1081
1210
|
```typescript
|
|
1082
|
-
await client.webhooks.
|
|
1211
|
+
await client.webhooks.allTimeStats();
|
|
1083
1212
|
|
|
1084
1213
|
```
|
|
1085
1214
|
</dd>
|
|
@@ -1107,8 +1236,7 @@ await client.webhooks.testWebhook();
|
|
|
1107
1236
|
</dl>
|
|
1108
1237
|
</details>
|
|
1109
1238
|
|
|
1110
|
-
|
|
1111
|
-
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">listConversations</a>({ ...params }) -> AgentPhone.AppRoutesConversationsConversationListResponse</code></summary>
|
|
1239
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>({ ...params }) -> unknown</code></summary>
|
|
1112
1240
|
<dl>
|
|
1113
1241
|
<dd>
|
|
1114
1242
|
|
|
@@ -1120,9 +1248,11 @@ await client.webhooks.testWebhook();
|
|
|
1120
1248
|
<dl>
|
|
1121
1249
|
<dd>
|
|
1122
1250
|
|
|
1123
|
-
|
|
1251
|
+
Send a test webhook to verify the endpoint is working.
|
|
1124
1252
|
|
|
1125
|
-
|
|
1253
|
+
Sends a fake message payload to the configured URL.
|
|
1254
|
+
Pass ?agentId=... to control which agent appears in the payload;
|
|
1255
|
+
otherwise the first agent in the account is used.
|
|
1126
1256
|
</dd>
|
|
1127
1257
|
</dl>
|
|
1128
1258
|
</dd>
|
|
@@ -1137,7 +1267,7 @@ Sorted by most recent activity (lastMessageAt desc).
|
|
|
1137
1267
|
<dd>
|
|
1138
1268
|
|
|
1139
1269
|
```typescript
|
|
1140
|
-
await client.
|
|
1270
|
+
await client.webhooks.testWebhook();
|
|
1141
1271
|
|
|
1142
1272
|
```
|
|
1143
1273
|
</dd>
|
|
@@ -1153,7 +1283,7 @@ await client.conversations.listConversations();
|
|
|
1153
1283
|
<dl>
|
|
1154
1284
|
<dd>
|
|
1155
1285
|
|
|
1156
|
-
**request:** `AgentPhone.
|
|
1286
|
+
**request:** `AgentPhone.TestWebhookV1WebhooksTestPostRequest`
|
|
1157
1287
|
|
|
1158
1288
|
</dd>
|
|
1159
1289
|
</dl>
|
|
@@ -1161,7 +1291,7 @@ await client.conversations.listConversations();
|
|
|
1161
1291
|
<dl>
|
|
1162
1292
|
<dd>
|
|
1163
1293
|
|
|
1164
|
-
**requestOptions:** `
|
|
1294
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1165
1295
|
|
|
1166
1296
|
</dd>
|
|
1167
1297
|
</dl>
|
|
@@ -1173,7 +1303,8 @@ await client.conversations.listConversations();
|
|
|
1173
1303
|
</dl>
|
|
1174
1304
|
</details>
|
|
1175
1305
|
|
|
1176
|
-
|
|
1306
|
+
## AgentWebhooks
|
|
1307
|
+
<details><summary><code>client.agentWebhooks.<a href="/src/api/resources/agentWebhooks/client/Client.ts">getAgentWebhook</a>({ ...params }) -> AgentPhone.WebhookResponse | null</code></summary>
|
|
1177
1308
|
<dl>
|
|
1178
1309
|
<dd>
|
|
1179
1310
|
|
|
@@ -1185,7 +1316,7 @@ await client.conversations.listConversations();
|
|
|
1185
1316
|
<dl>
|
|
1186
1317
|
<dd>
|
|
1187
1318
|
|
|
1188
|
-
Get
|
|
1319
|
+
Get the webhook configuration for a specific agent.
|
|
1189
1320
|
</dd>
|
|
1190
1321
|
</dl>
|
|
1191
1322
|
</dd>
|
|
@@ -1200,8 +1331,8 @@ Get a conversation with its recent messages.
|
|
|
1200
1331
|
<dd>
|
|
1201
1332
|
|
|
1202
1333
|
```typescript
|
|
1203
|
-
await client.
|
|
1204
|
-
|
|
1334
|
+
await client.agentWebhooks.getAgentWebhook({
|
|
1335
|
+
agent_id: "agent_id"
|
|
1205
1336
|
});
|
|
1206
1337
|
|
|
1207
1338
|
```
|
|
@@ -1218,7 +1349,7 @@ await client.conversations.getConversation({
|
|
|
1218
1349
|
<dl>
|
|
1219
1350
|
<dd>
|
|
1220
1351
|
|
|
1221
|
-
**request:** `AgentPhone.
|
|
1352
|
+
**request:** `AgentPhone.GetAgentWebhookV1AgentsAgentIdWebhookGetRequest`
|
|
1222
1353
|
|
|
1223
1354
|
</dd>
|
|
1224
1355
|
</dl>
|
|
@@ -1226,7 +1357,7 @@ await client.conversations.getConversation({
|
|
|
1226
1357
|
<dl>
|
|
1227
1358
|
<dd>
|
|
1228
1359
|
|
|
1229
|
-
**requestOptions:** `
|
|
1360
|
+
**requestOptions:** `AgentWebhooksClient.RequestOptions`
|
|
1230
1361
|
|
|
1231
1362
|
</dd>
|
|
1232
1363
|
</dl>
|
|
@@ -1238,7 +1369,7 @@ await client.conversations.getConversation({
|
|
|
1238
1369
|
</dl>
|
|
1239
1370
|
</details>
|
|
1240
1371
|
|
|
1241
|
-
<details><summary><code>client.
|
|
1372
|
+
<details><summary><code>client.agentWebhooks.<a href="/src/api/resources/agentWebhooks/client/Client.ts">createOrUpdateAgentWebhook</a>({ ...params }) -> AgentPhone.WebhookResponse</code></summary>
|
|
1242
1373
|
<dl>
|
|
1243
1374
|
<dd>
|
|
1244
1375
|
|
|
@@ -1250,14 +1381,9 @@ await client.conversations.getConversation({
|
|
|
1250
1381
|
<dl>
|
|
1251
1382
|
<dd>
|
|
1252
1383
|
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
Use this to store custom context for AI agents:
|
|
1256
|
-
- Customer information (name, account ID)
|
|
1257
|
-
- Business context (order ID, ticket number)
|
|
1258
|
-
- Session state (current topic, preferences)
|
|
1384
|
+
Register or update a webhook URL for a specific agent.
|
|
1259
1385
|
|
|
1260
|
-
|
|
1386
|
+
When set, this agent's events are delivered here instead of the account default webhook.
|
|
1261
1387
|
</dd>
|
|
1262
1388
|
</dl>
|
|
1263
1389
|
</dd>
|
|
@@ -1272,8 +1398,11 @@ The metadata is included in webhook payloads as `conversationState`.
|
|
|
1272
1398
|
<dd>
|
|
1273
1399
|
|
|
1274
1400
|
```typescript
|
|
1275
|
-
await client.
|
|
1276
|
-
|
|
1401
|
+
await client.agentWebhooks.createOrUpdateAgentWebhook({
|
|
1402
|
+
agent_id: "agent_id",
|
|
1403
|
+
body: {
|
|
1404
|
+
url: "url"
|
|
1405
|
+
}
|
|
1277
1406
|
});
|
|
1278
1407
|
|
|
1279
1408
|
```
|
|
@@ -1290,7 +1419,7 @@ await client.conversations.updateConversation({
|
|
|
1290
1419
|
<dl>
|
|
1291
1420
|
<dd>
|
|
1292
1421
|
|
|
1293
|
-
**request:** `AgentPhone.
|
|
1422
|
+
**request:** `AgentPhone.CreateOrUpdateAgentWebhookV1AgentsAgentIdWebhookPostRequest`
|
|
1294
1423
|
|
|
1295
1424
|
</dd>
|
|
1296
1425
|
</dl>
|
|
@@ -1298,7 +1427,7 @@ await client.conversations.updateConversation({
|
|
|
1298
1427
|
<dl>
|
|
1299
1428
|
<dd>
|
|
1300
1429
|
|
|
1301
|
-
**requestOptions:** `
|
|
1430
|
+
**requestOptions:** `AgentWebhooksClient.RequestOptions`
|
|
1302
1431
|
|
|
1303
1432
|
</dd>
|
|
1304
1433
|
</dl>
|
|
@@ -1310,7 +1439,7 @@ await client.conversations.updateConversation({
|
|
|
1310
1439
|
</dl>
|
|
1311
1440
|
</details>
|
|
1312
1441
|
|
|
1313
|
-
<details><summary><code>client.
|
|
1442
|
+
<details><summary><code>client.agentWebhooks.<a href="/src/api/resources/agentWebhooks/client/Client.ts">deleteAgentWebhook</a>({ ...params }) -> unknown</code></summary>
|
|
1314
1443
|
<dl>
|
|
1315
1444
|
<dd>
|
|
1316
1445
|
|
|
@@ -1322,9 +1451,7 @@ await client.conversations.updateConversation({
|
|
|
1322
1451
|
<dl>
|
|
1323
1452
|
<dd>
|
|
1324
1453
|
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
Use before/after for cursor-based pagination.
|
|
1454
|
+
Remove the webhook for a specific agent.
|
|
1328
1455
|
</dd>
|
|
1329
1456
|
</dl>
|
|
1330
1457
|
</dd>
|
|
@@ -1339,8 +1466,8 @@ Use before/after for cursor-based pagination.
|
|
|
1339
1466
|
<dd>
|
|
1340
1467
|
|
|
1341
1468
|
```typescript
|
|
1342
|
-
await client.
|
|
1343
|
-
|
|
1469
|
+
await client.agentWebhooks.deleteAgentWebhook({
|
|
1470
|
+
agent_id: "agent_id"
|
|
1344
1471
|
});
|
|
1345
1472
|
|
|
1346
1473
|
```
|
|
@@ -1357,7 +1484,7 @@ await client.conversations.getConversationMessages({
|
|
|
1357
1484
|
<dl>
|
|
1358
1485
|
<dd>
|
|
1359
1486
|
|
|
1360
|
-
**request:** `AgentPhone.
|
|
1487
|
+
**request:** `AgentPhone.DeleteAgentWebhookV1AgentsAgentIdWebhookDeleteRequest`
|
|
1361
1488
|
|
|
1362
1489
|
</dd>
|
|
1363
1490
|
</dl>
|
|
@@ -1365,7 +1492,7 @@ await client.conversations.getConversationMessages({
|
|
|
1365
1492
|
<dl>
|
|
1366
1493
|
<dd>
|
|
1367
1494
|
|
|
1368
|
-
**requestOptions:** `
|
|
1495
|
+
**requestOptions:** `AgentWebhooksClient.RequestOptions`
|
|
1369
1496
|
|
|
1370
1497
|
</dd>
|
|
1371
1498
|
</dl>
|
|
@@ -1377,8 +1504,7 @@ await client.conversations.getConversationMessages({
|
|
|
1377
1504
|
</dl>
|
|
1378
1505
|
</details>
|
|
1379
1506
|
|
|
1380
|
-
|
|
1381
|
-
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">listCalls</a>({ ...params }) -> unknown</code></summary>
|
|
1507
|
+
<details><summary><code>client.agentWebhooks.<a href="/src/api/resources/agentWebhooks/client/Client.ts">listAgentDeliveries</a>({ ...params }) -> AgentPhone.WebhookDeliveryResponse[]</code></summary>
|
|
1382
1508
|
<dl>
|
|
1383
1509
|
<dd>
|
|
1384
1510
|
|
|
@@ -1390,7 +1516,7 @@ await client.conversations.getConversationMessages({
|
|
|
1390
1516
|
<dl>
|
|
1391
1517
|
<dd>
|
|
1392
1518
|
|
|
1393
|
-
|
|
1519
|
+
Get recent webhook delivery attempts for a specific agent's webhook.
|
|
1394
1520
|
</dd>
|
|
1395
1521
|
</dl>
|
|
1396
1522
|
</dd>
|
|
@@ -1405,7 +1531,9 @@ List all calls for this project.
|
|
|
1405
1531
|
<dd>
|
|
1406
1532
|
|
|
1407
1533
|
```typescript
|
|
1408
|
-
await client.
|
|
1534
|
+
await client.agentWebhooks.listAgentDeliveries({
|
|
1535
|
+
agent_id: "agent_id"
|
|
1536
|
+
});
|
|
1409
1537
|
|
|
1410
1538
|
```
|
|
1411
1539
|
</dd>
|
|
@@ -1421,7 +1549,7 @@ await client.calls.listCalls();
|
|
|
1421
1549
|
<dl>
|
|
1422
1550
|
<dd>
|
|
1423
1551
|
|
|
1424
|
-
**request:** `AgentPhone.
|
|
1552
|
+
**request:** `AgentPhone.ListAgentDeliveriesV1AgentsAgentIdWebhookDeliveriesGetRequest`
|
|
1425
1553
|
|
|
1426
1554
|
</dd>
|
|
1427
1555
|
</dl>
|
|
@@ -1429,7 +1557,7 @@ await client.calls.listCalls();
|
|
|
1429
1557
|
<dl>
|
|
1430
1558
|
<dd>
|
|
1431
1559
|
|
|
1432
|
-
**requestOptions:** `
|
|
1560
|
+
**requestOptions:** `AgentWebhooksClient.RequestOptions`
|
|
1433
1561
|
|
|
1434
1562
|
</dd>
|
|
1435
1563
|
</dl>
|
|
@@ -1441,7 +1569,7 @@ await client.calls.listCalls();
|
|
|
1441
1569
|
</dl>
|
|
1442
1570
|
</details>
|
|
1443
1571
|
|
|
1444
|
-
<details><summary><code>client.
|
|
1572
|
+
<details><summary><code>client.agentWebhooks.<a href="/src/api/resources/agentWebhooks/client/Client.ts">testAgentWebhook</a>({ ...params }) -> unknown</code></summary>
|
|
1445
1573
|
<dl>
|
|
1446
1574
|
<dd>
|
|
1447
1575
|
|
|
@@ -1453,18 +1581,7 @@ await client.calls.listCalls();
|
|
|
1453
1581
|
<dl>
|
|
1454
1582
|
<dd>
|
|
1455
1583
|
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
This endpoint allows you to programmatically make phone calls from your agent
|
|
1459
|
-
to any phone number. The call will use the agent's assigned phone number as the
|
|
1460
|
-
caller ID.
|
|
1461
|
-
|
|
1462
|
-
Flow:
|
|
1463
|
-
1. Validates the agent belongs to your project and has a phone number
|
|
1464
|
-
2. Initiates a call via Twilio from the agent's number to the destination
|
|
1465
|
-
3. When recipient answers, speaks the initial greeting (if provided)
|
|
1466
|
-
4. Listens for recipient's speech and sends to your webhook
|
|
1467
|
-
5. Continues conversation using your webhook responses
|
|
1584
|
+
Send a test webhook to the agent's webhook endpoint.
|
|
1468
1585
|
</dd>
|
|
1469
1586
|
</dl>
|
|
1470
1587
|
</dd>
|
|
@@ -1479,9 +1596,8 @@ Flow:
|
|
|
1479
1596
|
<dd>
|
|
1480
1597
|
|
|
1481
1598
|
```typescript
|
|
1482
|
-
await client.
|
|
1483
|
-
|
|
1484
|
-
toNumber: "toNumber"
|
|
1599
|
+
await client.agentWebhooks.testAgentWebhook({
|
|
1600
|
+
agent_id: "agent_id"
|
|
1485
1601
|
});
|
|
1486
1602
|
|
|
1487
1603
|
```
|
|
@@ -1498,7 +1614,7 @@ await client.calls.createOutboundCall({
|
|
|
1498
1614
|
<dl>
|
|
1499
1615
|
<dd>
|
|
1500
1616
|
|
|
1501
|
-
**request:** `AgentPhone.
|
|
1617
|
+
**request:** `AgentPhone.TestAgentWebhookV1AgentsAgentIdWebhookTestPostRequest`
|
|
1502
1618
|
|
|
1503
1619
|
</dd>
|
|
1504
1620
|
</dl>
|
|
@@ -1506,7 +1622,7 @@ await client.calls.createOutboundCall({
|
|
|
1506
1622
|
<dl>
|
|
1507
1623
|
<dd>
|
|
1508
1624
|
|
|
1509
|
-
**requestOptions:** `
|
|
1625
|
+
**requestOptions:** `AgentWebhooksClient.RequestOptions`
|
|
1510
1626
|
|
|
1511
1627
|
</dd>
|
|
1512
1628
|
</dl>
|
|
@@ -1518,7 +1634,8 @@ await client.calls.createOutboundCall({
|
|
|
1518
1634
|
</dl>
|
|
1519
1635
|
</details>
|
|
1520
1636
|
|
|
1521
|
-
|
|
1637
|
+
## Contacts
|
|
1638
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">listContacts</a>({ ...params }) -> AgentPhone.ContactListResponse</code></summary>
|
|
1522
1639
|
<dl>
|
|
1523
1640
|
<dd>
|
|
1524
1641
|
|
|
@@ -1530,7 +1647,9 @@ await client.calls.createOutboundCall({
|
|
|
1530
1647
|
<dl>
|
|
1531
1648
|
<dd>
|
|
1532
1649
|
|
|
1533
|
-
|
|
1650
|
+
List all contacts for this account.
|
|
1651
|
+
|
|
1652
|
+
Optional `search` query filters by name or phone number (case-insensitive contains).
|
|
1534
1653
|
</dd>
|
|
1535
1654
|
</dl>
|
|
1536
1655
|
</dd>
|
|
@@ -1545,9 +1664,7 @@ Get a specific call with its transcripts.
|
|
|
1545
1664
|
<dd>
|
|
1546
1665
|
|
|
1547
1666
|
```typescript
|
|
1548
|
-
await client.
|
|
1549
|
-
call_id: "call_id"
|
|
1550
|
-
});
|
|
1667
|
+
await client.contacts.listContacts();
|
|
1551
1668
|
|
|
1552
1669
|
```
|
|
1553
1670
|
</dd>
|
|
@@ -1563,7 +1680,7 @@ await client.calls.getCall({
|
|
|
1563
1680
|
<dl>
|
|
1564
1681
|
<dd>
|
|
1565
1682
|
|
|
1566
|
-
**request:** `AgentPhone.
|
|
1683
|
+
**request:** `AgentPhone.ListContactsV1ContactsGetRequest`
|
|
1567
1684
|
|
|
1568
1685
|
</dd>
|
|
1569
1686
|
</dl>
|
|
@@ -1571,7 +1688,7 @@ await client.calls.getCall({
|
|
|
1571
1688
|
<dl>
|
|
1572
1689
|
<dd>
|
|
1573
1690
|
|
|
1574
|
-
**requestOptions:** `
|
|
1691
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1575
1692
|
|
|
1576
1693
|
</dd>
|
|
1577
1694
|
</dl>
|
|
@@ -1583,7 +1700,7 @@ await client.calls.getCall({
|
|
|
1583
1700
|
</dl>
|
|
1584
1701
|
</details>
|
|
1585
1702
|
|
|
1586
|
-
<details><summary><code>client.
|
|
1703
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">createContact</a>({ ...params }) -> AgentPhone.ContactResponse</code></summary>
|
|
1587
1704
|
<dl>
|
|
1588
1705
|
<dd>
|
|
1589
1706
|
|
|
@@ -1595,7 +1712,10 @@ await client.calls.getCall({
|
|
|
1595
1712
|
<dl>
|
|
1596
1713
|
<dd>
|
|
1597
1714
|
|
|
1598
|
-
|
|
1715
|
+
Create a new contact.
|
|
1716
|
+
|
|
1717
|
+
Phone number is normalized to E.164 format. Returns 409 if a contact
|
|
1718
|
+
with this phone number already exists for the project.
|
|
1599
1719
|
</dd>
|
|
1600
1720
|
</dl>
|
|
1601
1721
|
</dd>
|
|
@@ -1610,8 +1730,9 @@ List all calls for a specific phone number.
|
|
|
1610
1730
|
<dd>
|
|
1611
1731
|
|
|
1612
1732
|
```typescript
|
|
1613
|
-
await client.
|
|
1614
|
-
|
|
1733
|
+
await client.contacts.createContact({
|
|
1734
|
+
phoneNumber: "phoneNumber",
|
|
1735
|
+
name: "name"
|
|
1615
1736
|
});
|
|
1616
1737
|
|
|
1617
1738
|
```
|
|
@@ -1628,7 +1749,7 @@ await client.calls.listCallsForNumber({
|
|
|
1628
1749
|
<dl>
|
|
1629
1750
|
<dd>
|
|
1630
1751
|
|
|
1631
|
-
**request:** `AgentPhone.
|
|
1752
|
+
**request:** `AgentPhone.CreateContactRequest`
|
|
1632
1753
|
|
|
1633
1754
|
</dd>
|
|
1634
1755
|
</dl>
|
|
@@ -1636,7 +1757,7 @@ await client.calls.listCallsForNumber({
|
|
|
1636
1757
|
<dl>
|
|
1637
1758
|
<dd>
|
|
1638
1759
|
|
|
1639
|
-
**requestOptions:** `
|
|
1760
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1640
1761
|
|
|
1641
1762
|
</dd>
|
|
1642
1763
|
</dl>
|
|
@@ -1648,8 +1769,7 @@ await client.calls.listCallsForNumber({
|
|
|
1648
1769
|
</dl>
|
|
1649
1770
|
</details>
|
|
1650
1771
|
|
|
1651
|
-
|
|
1652
|
-
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsage</a>() -> AgentPhone.UsageResponse</code></summary>
|
|
1772
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getContact</a>({ ...params }) -> AgentPhone.ContactResponse</code></summary>
|
|
1653
1773
|
<dl>
|
|
1654
1774
|
<dd>
|
|
1655
1775
|
|
|
@@ -1661,13 +1781,7 @@ await client.calls.listCallsForNumber({
|
|
|
1661
1781
|
<dl>
|
|
1662
1782
|
<dd>
|
|
1663
1783
|
|
|
1664
|
-
Get
|
|
1665
|
-
|
|
1666
|
-
Returns:
|
|
1667
|
-
- Phone number limits (used/limit/remaining)
|
|
1668
|
-
- Message statistics (total, last 24h, last 7 days)
|
|
1669
|
-
- Call statistics (total, last 24h, last 7 days)
|
|
1670
|
-
- Webhook delivery statistics
|
|
1784
|
+
Get a single contact by ID.
|
|
1671
1785
|
</dd>
|
|
1672
1786
|
</dl>
|
|
1673
1787
|
</dd>
|
|
@@ -1682,7 +1796,9 @@ Returns:
|
|
|
1682
1796
|
<dd>
|
|
1683
1797
|
|
|
1684
1798
|
```typescript
|
|
1685
|
-
await client.
|
|
1799
|
+
await client.contacts.getContact({
|
|
1800
|
+
contact_id: "contact_id"
|
|
1801
|
+
});
|
|
1686
1802
|
|
|
1687
1803
|
```
|
|
1688
1804
|
</dd>
|
|
@@ -1698,7 +1814,1233 @@ await client.usage.getUsage();
|
|
|
1698
1814
|
<dl>
|
|
1699
1815
|
<dd>
|
|
1700
1816
|
|
|
1701
|
-
**
|
|
1817
|
+
**request:** `AgentPhone.GetContactV1ContactsContactIdGetRequest`
|
|
1818
|
+
|
|
1819
|
+
</dd>
|
|
1820
|
+
</dl>
|
|
1821
|
+
|
|
1822
|
+
<dl>
|
|
1823
|
+
<dd>
|
|
1824
|
+
|
|
1825
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1826
|
+
|
|
1827
|
+
</dd>
|
|
1828
|
+
</dl>
|
|
1829
|
+
</dd>
|
|
1830
|
+
</dl>
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
</dd>
|
|
1834
|
+
</dl>
|
|
1835
|
+
</details>
|
|
1836
|
+
|
|
1837
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">deleteContact</a>({ ...params }) -> void</code></summary>
|
|
1838
|
+
<dl>
|
|
1839
|
+
<dd>
|
|
1840
|
+
|
|
1841
|
+
#### 📝 Description
|
|
1842
|
+
|
|
1843
|
+
<dl>
|
|
1844
|
+
<dd>
|
|
1845
|
+
|
|
1846
|
+
<dl>
|
|
1847
|
+
<dd>
|
|
1848
|
+
|
|
1849
|
+
Delete a contact.
|
|
1850
|
+
</dd>
|
|
1851
|
+
</dl>
|
|
1852
|
+
</dd>
|
|
1853
|
+
</dl>
|
|
1854
|
+
|
|
1855
|
+
#### 🔌 Usage
|
|
1856
|
+
|
|
1857
|
+
<dl>
|
|
1858
|
+
<dd>
|
|
1859
|
+
|
|
1860
|
+
<dl>
|
|
1861
|
+
<dd>
|
|
1862
|
+
|
|
1863
|
+
```typescript
|
|
1864
|
+
await client.contacts.deleteContact({
|
|
1865
|
+
contact_id: "contact_id"
|
|
1866
|
+
});
|
|
1867
|
+
|
|
1868
|
+
```
|
|
1869
|
+
</dd>
|
|
1870
|
+
</dl>
|
|
1871
|
+
</dd>
|
|
1872
|
+
</dl>
|
|
1873
|
+
|
|
1874
|
+
#### ⚙️ Parameters
|
|
1875
|
+
|
|
1876
|
+
<dl>
|
|
1877
|
+
<dd>
|
|
1878
|
+
|
|
1879
|
+
<dl>
|
|
1880
|
+
<dd>
|
|
1881
|
+
|
|
1882
|
+
**request:** `AgentPhone.DeleteContactV1ContactsContactIdDeleteRequest`
|
|
1883
|
+
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
|
|
1887
|
+
<dl>
|
|
1888
|
+
<dd>
|
|
1889
|
+
|
|
1890
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1891
|
+
|
|
1892
|
+
</dd>
|
|
1893
|
+
</dl>
|
|
1894
|
+
</dd>
|
|
1895
|
+
</dl>
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
</dd>
|
|
1899
|
+
</dl>
|
|
1900
|
+
</details>
|
|
1901
|
+
|
|
1902
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">updateContact</a>({ ...params }) -> AgentPhone.ContactResponse</code></summary>
|
|
1903
|
+
<dl>
|
|
1904
|
+
<dd>
|
|
1905
|
+
|
|
1906
|
+
#### 📝 Description
|
|
1907
|
+
|
|
1908
|
+
<dl>
|
|
1909
|
+
<dd>
|
|
1910
|
+
|
|
1911
|
+
<dl>
|
|
1912
|
+
<dd>
|
|
1913
|
+
|
|
1914
|
+
Update a contact's fields.
|
|
1915
|
+
|
|
1916
|
+
If phoneNumber is updated, it's re-normalized and checked for uniqueness (409 on conflict).
|
|
1917
|
+
</dd>
|
|
1918
|
+
</dl>
|
|
1919
|
+
</dd>
|
|
1920
|
+
</dl>
|
|
1921
|
+
|
|
1922
|
+
#### 🔌 Usage
|
|
1923
|
+
|
|
1924
|
+
<dl>
|
|
1925
|
+
<dd>
|
|
1926
|
+
|
|
1927
|
+
<dl>
|
|
1928
|
+
<dd>
|
|
1929
|
+
|
|
1930
|
+
```typescript
|
|
1931
|
+
await client.contacts.updateContact({
|
|
1932
|
+
contact_id: "contact_id"
|
|
1933
|
+
});
|
|
1934
|
+
|
|
1935
|
+
```
|
|
1936
|
+
</dd>
|
|
1937
|
+
</dl>
|
|
1938
|
+
</dd>
|
|
1939
|
+
</dl>
|
|
1940
|
+
|
|
1941
|
+
#### ⚙️ Parameters
|
|
1942
|
+
|
|
1943
|
+
<dl>
|
|
1944
|
+
<dd>
|
|
1945
|
+
|
|
1946
|
+
<dl>
|
|
1947
|
+
<dd>
|
|
1948
|
+
|
|
1949
|
+
**request:** `AgentPhone.UpdateContactRequest`
|
|
1950
|
+
|
|
1951
|
+
</dd>
|
|
1952
|
+
</dl>
|
|
1953
|
+
|
|
1954
|
+
<dl>
|
|
1955
|
+
<dd>
|
|
1956
|
+
|
|
1957
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1958
|
+
|
|
1959
|
+
</dd>
|
|
1960
|
+
</dl>
|
|
1961
|
+
</dd>
|
|
1962
|
+
</dl>
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
</dd>
|
|
1966
|
+
</dl>
|
|
1967
|
+
</details>
|
|
1968
|
+
|
|
1969
|
+
## Conversations
|
|
1970
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">listConversations</a>({ ...params }) -> AgentPhone.AppRoutesConversationsConversationListResponse</code></summary>
|
|
1971
|
+
<dl>
|
|
1972
|
+
<dd>
|
|
1973
|
+
|
|
1974
|
+
#### 📝 Description
|
|
1975
|
+
|
|
1976
|
+
<dl>
|
|
1977
|
+
<dd>
|
|
1978
|
+
|
|
1979
|
+
<dl>
|
|
1980
|
+
<dd>
|
|
1981
|
+
|
|
1982
|
+
List all conversations for this account.
|
|
1983
|
+
|
|
1984
|
+
Sorted by most recent activity (lastMessageAt desc).
|
|
1985
|
+
</dd>
|
|
1986
|
+
</dl>
|
|
1987
|
+
</dd>
|
|
1988
|
+
</dl>
|
|
1989
|
+
|
|
1990
|
+
#### 🔌 Usage
|
|
1991
|
+
|
|
1992
|
+
<dl>
|
|
1993
|
+
<dd>
|
|
1994
|
+
|
|
1995
|
+
<dl>
|
|
1996
|
+
<dd>
|
|
1997
|
+
|
|
1998
|
+
```typescript
|
|
1999
|
+
await client.conversations.listConversations();
|
|
2000
|
+
|
|
2001
|
+
```
|
|
2002
|
+
</dd>
|
|
2003
|
+
</dl>
|
|
2004
|
+
</dd>
|
|
2005
|
+
</dl>
|
|
2006
|
+
|
|
2007
|
+
#### ⚙️ Parameters
|
|
2008
|
+
|
|
2009
|
+
<dl>
|
|
2010
|
+
<dd>
|
|
2011
|
+
|
|
2012
|
+
<dl>
|
|
2013
|
+
<dd>
|
|
2014
|
+
|
|
2015
|
+
**request:** `AgentPhone.ListConversationsV1ConversationsGetRequest`
|
|
2016
|
+
|
|
2017
|
+
</dd>
|
|
2018
|
+
</dl>
|
|
2019
|
+
|
|
2020
|
+
<dl>
|
|
2021
|
+
<dd>
|
|
2022
|
+
|
|
2023
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2024
|
+
|
|
2025
|
+
</dd>
|
|
2026
|
+
</dl>
|
|
2027
|
+
</dd>
|
|
2028
|
+
</dl>
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
</dd>
|
|
2032
|
+
</dl>
|
|
2033
|
+
</details>
|
|
2034
|
+
|
|
2035
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getConversation</a>({ ...params }) -> AgentPhone.ConversationDetail</code></summary>
|
|
2036
|
+
<dl>
|
|
2037
|
+
<dd>
|
|
2038
|
+
|
|
2039
|
+
#### 📝 Description
|
|
2040
|
+
|
|
2041
|
+
<dl>
|
|
2042
|
+
<dd>
|
|
2043
|
+
|
|
2044
|
+
<dl>
|
|
2045
|
+
<dd>
|
|
2046
|
+
|
|
2047
|
+
Get a conversation with its recent messages.
|
|
2048
|
+
</dd>
|
|
2049
|
+
</dl>
|
|
2050
|
+
</dd>
|
|
2051
|
+
</dl>
|
|
2052
|
+
|
|
2053
|
+
#### 🔌 Usage
|
|
2054
|
+
|
|
2055
|
+
<dl>
|
|
2056
|
+
<dd>
|
|
2057
|
+
|
|
2058
|
+
<dl>
|
|
2059
|
+
<dd>
|
|
2060
|
+
|
|
2061
|
+
```typescript
|
|
2062
|
+
await client.conversations.getConversation({
|
|
2063
|
+
conversation_id: "conversation_id"
|
|
2064
|
+
});
|
|
2065
|
+
|
|
2066
|
+
```
|
|
2067
|
+
</dd>
|
|
2068
|
+
</dl>
|
|
2069
|
+
</dd>
|
|
2070
|
+
</dl>
|
|
2071
|
+
|
|
2072
|
+
#### ⚙️ Parameters
|
|
2073
|
+
|
|
2074
|
+
<dl>
|
|
2075
|
+
<dd>
|
|
2076
|
+
|
|
2077
|
+
<dl>
|
|
2078
|
+
<dd>
|
|
2079
|
+
|
|
2080
|
+
**request:** `AgentPhone.GetConversationV1ConversationsConversationIdGetRequest`
|
|
2081
|
+
|
|
2082
|
+
</dd>
|
|
2083
|
+
</dl>
|
|
2084
|
+
|
|
2085
|
+
<dl>
|
|
2086
|
+
<dd>
|
|
2087
|
+
|
|
2088
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2089
|
+
|
|
2090
|
+
</dd>
|
|
2091
|
+
</dl>
|
|
2092
|
+
</dd>
|
|
2093
|
+
</dl>
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
</dd>
|
|
2097
|
+
</dl>
|
|
2098
|
+
</details>
|
|
2099
|
+
|
|
2100
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateConversation</a>({ ...params }) -> AgentPhone.ConversationDetail</code></summary>
|
|
2101
|
+
<dl>
|
|
2102
|
+
<dd>
|
|
2103
|
+
|
|
2104
|
+
#### 📝 Description
|
|
2105
|
+
|
|
2106
|
+
<dl>
|
|
2107
|
+
<dd>
|
|
2108
|
+
|
|
2109
|
+
<dl>
|
|
2110
|
+
<dd>
|
|
2111
|
+
|
|
2112
|
+
Update conversation metadata (state).
|
|
2113
|
+
|
|
2114
|
+
Use this to store custom context for AI agents:
|
|
2115
|
+
- Customer information (name, account ID)
|
|
2116
|
+
- Business context (order ID, ticket number)
|
|
2117
|
+
- Session state (current topic, preferences)
|
|
2118
|
+
|
|
2119
|
+
The metadata is included in webhook payloads as `conversationState`.
|
|
2120
|
+
</dd>
|
|
2121
|
+
</dl>
|
|
2122
|
+
</dd>
|
|
2123
|
+
</dl>
|
|
2124
|
+
|
|
2125
|
+
#### 🔌 Usage
|
|
2126
|
+
|
|
2127
|
+
<dl>
|
|
2128
|
+
<dd>
|
|
2129
|
+
|
|
2130
|
+
<dl>
|
|
2131
|
+
<dd>
|
|
2132
|
+
|
|
2133
|
+
```typescript
|
|
2134
|
+
await client.conversations.updateConversation({
|
|
2135
|
+
conversation_id: "conversation_id"
|
|
2136
|
+
});
|
|
2137
|
+
|
|
2138
|
+
```
|
|
2139
|
+
</dd>
|
|
2140
|
+
</dl>
|
|
2141
|
+
</dd>
|
|
2142
|
+
</dl>
|
|
2143
|
+
|
|
2144
|
+
#### ⚙️ Parameters
|
|
2145
|
+
|
|
2146
|
+
<dl>
|
|
2147
|
+
<dd>
|
|
2148
|
+
|
|
2149
|
+
<dl>
|
|
2150
|
+
<dd>
|
|
2151
|
+
|
|
2152
|
+
**request:** `AgentPhone.UpdateConversationRequest`
|
|
2153
|
+
|
|
2154
|
+
</dd>
|
|
2155
|
+
</dl>
|
|
2156
|
+
|
|
2157
|
+
<dl>
|
|
2158
|
+
<dd>
|
|
2159
|
+
|
|
2160
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2161
|
+
|
|
2162
|
+
</dd>
|
|
2163
|
+
</dl>
|
|
2164
|
+
</dd>
|
|
2165
|
+
</dl>
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
</dd>
|
|
2169
|
+
</dl>
|
|
2170
|
+
</details>
|
|
2171
|
+
|
|
2172
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getConversationMessages</a>({ ...params }) -> AgentPhone.MessagesListResponse</code></summary>
|
|
2173
|
+
<dl>
|
|
2174
|
+
<dd>
|
|
2175
|
+
|
|
2176
|
+
#### 📝 Description
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
<dl>
|
|
2182
|
+
<dd>
|
|
2183
|
+
|
|
2184
|
+
Get paginated messages for a conversation.
|
|
2185
|
+
|
|
2186
|
+
Use before/after for cursor-based pagination.
|
|
2187
|
+
</dd>
|
|
2188
|
+
</dl>
|
|
2189
|
+
</dd>
|
|
2190
|
+
</dl>
|
|
2191
|
+
|
|
2192
|
+
#### 🔌 Usage
|
|
2193
|
+
|
|
2194
|
+
<dl>
|
|
2195
|
+
<dd>
|
|
2196
|
+
|
|
2197
|
+
<dl>
|
|
2198
|
+
<dd>
|
|
2199
|
+
|
|
2200
|
+
```typescript
|
|
2201
|
+
await client.conversations.getConversationMessages({
|
|
2202
|
+
conversation_id: "conversation_id"
|
|
2203
|
+
});
|
|
2204
|
+
|
|
2205
|
+
```
|
|
2206
|
+
</dd>
|
|
2207
|
+
</dl>
|
|
2208
|
+
</dd>
|
|
2209
|
+
</dl>
|
|
2210
|
+
|
|
2211
|
+
#### ⚙️ Parameters
|
|
2212
|
+
|
|
2213
|
+
<dl>
|
|
2214
|
+
<dd>
|
|
2215
|
+
|
|
2216
|
+
<dl>
|
|
2217
|
+
<dd>
|
|
2218
|
+
|
|
2219
|
+
**request:** `AgentPhone.GetConversationMessagesV1ConversationsConversationIdMessagesGetRequest`
|
|
2220
|
+
|
|
2221
|
+
</dd>
|
|
2222
|
+
</dl>
|
|
2223
|
+
|
|
2224
|
+
<dl>
|
|
2225
|
+
<dd>
|
|
2226
|
+
|
|
2227
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2228
|
+
|
|
2229
|
+
</dd>
|
|
2230
|
+
</dl>
|
|
2231
|
+
</dd>
|
|
2232
|
+
</dl>
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
</dd>
|
|
2236
|
+
</dl>
|
|
2237
|
+
</details>
|
|
2238
|
+
|
|
2239
|
+
## Calls
|
|
2240
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">listCalls</a>({ ...params }) -> unknown</code></summary>
|
|
2241
|
+
<dl>
|
|
2242
|
+
<dd>
|
|
2243
|
+
|
|
2244
|
+
#### 📝 Description
|
|
2245
|
+
|
|
2246
|
+
<dl>
|
|
2247
|
+
<dd>
|
|
2248
|
+
|
|
2249
|
+
<dl>
|
|
2250
|
+
<dd>
|
|
2251
|
+
|
|
2252
|
+
List all calls for this account.
|
|
2253
|
+
</dd>
|
|
2254
|
+
</dl>
|
|
2255
|
+
</dd>
|
|
2256
|
+
</dl>
|
|
2257
|
+
|
|
2258
|
+
#### 🔌 Usage
|
|
2259
|
+
|
|
2260
|
+
<dl>
|
|
2261
|
+
<dd>
|
|
2262
|
+
|
|
2263
|
+
<dl>
|
|
2264
|
+
<dd>
|
|
2265
|
+
|
|
2266
|
+
```typescript
|
|
2267
|
+
await client.calls.listCalls();
|
|
2268
|
+
|
|
2269
|
+
```
|
|
2270
|
+
</dd>
|
|
2271
|
+
</dl>
|
|
2272
|
+
</dd>
|
|
2273
|
+
</dl>
|
|
2274
|
+
|
|
2275
|
+
#### ⚙️ Parameters
|
|
2276
|
+
|
|
2277
|
+
<dl>
|
|
2278
|
+
<dd>
|
|
2279
|
+
|
|
2280
|
+
<dl>
|
|
2281
|
+
<dd>
|
|
2282
|
+
|
|
2283
|
+
**request:** `AgentPhone.ListCallsV1CallsGetRequest`
|
|
2284
|
+
|
|
2285
|
+
</dd>
|
|
2286
|
+
</dl>
|
|
2287
|
+
|
|
2288
|
+
<dl>
|
|
2289
|
+
<dd>
|
|
2290
|
+
|
|
2291
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2292
|
+
|
|
2293
|
+
</dd>
|
|
2294
|
+
</dl>
|
|
2295
|
+
</dd>
|
|
2296
|
+
</dl>
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
</dd>
|
|
2300
|
+
</dl>
|
|
2301
|
+
</details>
|
|
2302
|
+
|
|
2303
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">createOutboundCall</a>({ ...params }) -> unknown</code></summary>
|
|
2304
|
+
<dl>
|
|
2305
|
+
<dd>
|
|
2306
|
+
|
|
2307
|
+
#### 📝 Description
|
|
2308
|
+
|
|
2309
|
+
<dl>
|
|
2310
|
+
<dd>
|
|
2311
|
+
|
|
2312
|
+
<dl>
|
|
2313
|
+
<dd>
|
|
2314
|
+
|
|
2315
|
+
Initiate an outbound call.
|
|
2316
|
+
|
|
2317
|
+
This endpoint allows you to programmatically make phone calls from your agent
|
|
2318
|
+
to any phone number. Use `fromNumberId` to pick which of the agent's numbers
|
|
2319
|
+
to use as caller ID; if omitted, the first assigned number is used.
|
|
2320
|
+
|
|
2321
|
+
Flow:
|
|
2322
|
+
1. Validates the agent belongs to your account and has a phone number
|
|
2323
|
+
2. Initiates a call from the agent's number to the destination
|
|
2324
|
+
3. When recipient answers, speaks the initial greeting (if provided)
|
|
2325
|
+
4. Listens for recipient's speech and sends to your webhook
|
|
2326
|
+
5. Continues conversation using your webhook responses
|
|
2327
|
+
</dd>
|
|
2328
|
+
</dl>
|
|
2329
|
+
</dd>
|
|
2330
|
+
</dl>
|
|
2331
|
+
|
|
2332
|
+
#### 🔌 Usage
|
|
2333
|
+
|
|
2334
|
+
<dl>
|
|
2335
|
+
<dd>
|
|
2336
|
+
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
```typescript
|
|
2341
|
+
await client.calls.createOutboundCall({
|
|
2342
|
+
agentId: "agentId",
|
|
2343
|
+
toNumber: "toNumber"
|
|
2344
|
+
});
|
|
2345
|
+
|
|
2346
|
+
```
|
|
2347
|
+
</dd>
|
|
2348
|
+
</dl>
|
|
2349
|
+
</dd>
|
|
2350
|
+
</dl>
|
|
2351
|
+
|
|
2352
|
+
#### ⚙️ Parameters
|
|
2353
|
+
|
|
2354
|
+
<dl>
|
|
2355
|
+
<dd>
|
|
2356
|
+
|
|
2357
|
+
<dl>
|
|
2358
|
+
<dd>
|
|
2359
|
+
|
|
2360
|
+
**request:** `AgentPhone.CreateOutboundCallRequest`
|
|
2361
|
+
|
|
2362
|
+
</dd>
|
|
2363
|
+
</dl>
|
|
2364
|
+
|
|
2365
|
+
<dl>
|
|
2366
|
+
<dd>
|
|
2367
|
+
|
|
2368
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2369
|
+
|
|
2370
|
+
</dd>
|
|
2371
|
+
</dl>
|
|
2372
|
+
</dd>
|
|
2373
|
+
</dl>
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
</dd>
|
|
2377
|
+
</dl>
|
|
2378
|
+
</details>
|
|
2379
|
+
|
|
2380
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">createWebCall</a>({ ...params }) -> unknown</code></summary>
|
|
2381
|
+
<dl>
|
|
2382
|
+
<dd>
|
|
2383
|
+
|
|
2384
|
+
#### 📝 Description
|
|
2385
|
+
|
|
2386
|
+
<dl>
|
|
2387
|
+
<dd>
|
|
2388
|
+
|
|
2389
|
+
<dl>
|
|
2390
|
+
<dd>
|
|
2391
|
+
|
|
2392
|
+
Create a browser-based web call.
|
|
2393
|
+
|
|
2394
|
+
Returns an access token that your frontend passes to the AgentPhone Web SDK
|
|
2395
|
+
(`agentphone-web-sdk`) to start the call in the browser. The token
|
|
2396
|
+
expires 30 seconds after creation.
|
|
2397
|
+
|
|
2398
|
+
Flow:
|
|
2399
|
+
1. Validates the agent belongs to your account
|
|
2400
|
+
2. Creates a web call and returns an access token
|
|
2401
|
+
3. Your client calls `webClient.startCall({ accessToken })` to connect
|
|
2402
|
+
4. Call lifecycle (transcripts, webhooks) works the same as phone calls
|
|
2403
|
+
</dd>
|
|
2404
|
+
</dl>
|
|
2405
|
+
</dd>
|
|
2406
|
+
</dl>
|
|
2407
|
+
|
|
2408
|
+
#### 🔌 Usage
|
|
2409
|
+
|
|
2410
|
+
<dl>
|
|
2411
|
+
<dd>
|
|
2412
|
+
|
|
2413
|
+
<dl>
|
|
2414
|
+
<dd>
|
|
2415
|
+
|
|
2416
|
+
```typescript
|
|
2417
|
+
await client.calls.createWebCall({
|
|
2418
|
+
agentId: "agentId"
|
|
2419
|
+
});
|
|
2420
|
+
|
|
2421
|
+
```
|
|
2422
|
+
</dd>
|
|
2423
|
+
</dl>
|
|
2424
|
+
</dd>
|
|
2425
|
+
</dl>
|
|
2426
|
+
|
|
2427
|
+
#### ⚙️ Parameters
|
|
2428
|
+
|
|
2429
|
+
<dl>
|
|
2430
|
+
<dd>
|
|
2431
|
+
|
|
2432
|
+
<dl>
|
|
2433
|
+
<dd>
|
|
2434
|
+
|
|
2435
|
+
**request:** `AgentPhone.CreateWebCallRequest`
|
|
2436
|
+
|
|
2437
|
+
</dd>
|
|
2438
|
+
</dl>
|
|
2439
|
+
|
|
2440
|
+
<dl>
|
|
2441
|
+
<dd>
|
|
2442
|
+
|
|
2443
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2444
|
+
|
|
2445
|
+
</dd>
|
|
2446
|
+
</dl>
|
|
2447
|
+
</dd>
|
|
2448
|
+
</dl>
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
</dd>
|
|
2452
|
+
</dl>
|
|
2453
|
+
</details>
|
|
2454
|
+
|
|
2455
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">getCall</a>({ ...params }) -> unknown</code></summary>
|
|
2456
|
+
<dl>
|
|
2457
|
+
<dd>
|
|
2458
|
+
|
|
2459
|
+
#### 📝 Description
|
|
2460
|
+
|
|
2461
|
+
<dl>
|
|
2462
|
+
<dd>
|
|
2463
|
+
|
|
2464
|
+
<dl>
|
|
2465
|
+
<dd>
|
|
2466
|
+
|
|
2467
|
+
Get a specific call with its transcripts.
|
|
2468
|
+
</dd>
|
|
2469
|
+
</dl>
|
|
2470
|
+
</dd>
|
|
2471
|
+
</dl>
|
|
2472
|
+
|
|
2473
|
+
#### 🔌 Usage
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
<dl>
|
|
2479
|
+
<dd>
|
|
2480
|
+
|
|
2481
|
+
```typescript
|
|
2482
|
+
await client.calls.getCall({
|
|
2483
|
+
call_id: "call_id"
|
|
2484
|
+
});
|
|
2485
|
+
|
|
2486
|
+
```
|
|
2487
|
+
</dd>
|
|
2488
|
+
</dl>
|
|
2489
|
+
</dd>
|
|
2490
|
+
</dl>
|
|
2491
|
+
|
|
2492
|
+
#### ⚙️ Parameters
|
|
2493
|
+
|
|
2494
|
+
<dl>
|
|
2495
|
+
<dd>
|
|
2496
|
+
|
|
2497
|
+
<dl>
|
|
2498
|
+
<dd>
|
|
2499
|
+
|
|
2500
|
+
**request:** `AgentPhone.GetCallV1CallsCallIdGetRequest`
|
|
2501
|
+
|
|
2502
|
+
</dd>
|
|
2503
|
+
</dl>
|
|
2504
|
+
|
|
2505
|
+
<dl>
|
|
2506
|
+
<dd>
|
|
2507
|
+
|
|
2508
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2509
|
+
|
|
2510
|
+
</dd>
|
|
2511
|
+
</dl>
|
|
2512
|
+
</dd>
|
|
2513
|
+
</dl>
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
</dd>
|
|
2517
|
+
</dl>
|
|
2518
|
+
</details>
|
|
2519
|
+
|
|
2520
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">getCallTranscript</a>({ ...params }) -> unknown</code></summary>
|
|
2521
|
+
<dl>
|
|
2522
|
+
<dd>
|
|
2523
|
+
|
|
2524
|
+
#### 📝 Description
|
|
2525
|
+
|
|
2526
|
+
<dl>
|
|
2527
|
+
<dd>
|
|
2528
|
+
|
|
2529
|
+
<dl>
|
|
2530
|
+
<dd>
|
|
2531
|
+
|
|
2532
|
+
Get the full transcript for a call.
|
|
2533
|
+
|
|
2534
|
+
Returns the complete, ordered transcript regardless of the webhook
|
|
2535
|
+
contextLimit setting. Each entry contains the user utterance and
|
|
2536
|
+
the corresponding agent response (when available).
|
|
2537
|
+
</dd>
|
|
2538
|
+
</dl>
|
|
2539
|
+
</dd>
|
|
2540
|
+
</dl>
|
|
2541
|
+
|
|
2542
|
+
#### 🔌 Usage
|
|
2543
|
+
|
|
2544
|
+
<dl>
|
|
2545
|
+
<dd>
|
|
2546
|
+
|
|
2547
|
+
<dl>
|
|
2548
|
+
<dd>
|
|
2549
|
+
|
|
2550
|
+
```typescript
|
|
2551
|
+
await client.calls.getCallTranscript({
|
|
2552
|
+
call_id: "call_id"
|
|
2553
|
+
});
|
|
2554
|
+
|
|
2555
|
+
```
|
|
2556
|
+
</dd>
|
|
2557
|
+
</dl>
|
|
2558
|
+
</dd>
|
|
2559
|
+
</dl>
|
|
2560
|
+
|
|
2561
|
+
#### ⚙️ Parameters
|
|
2562
|
+
|
|
2563
|
+
<dl>
|
|
2564
|
+
<dd>
|
|
2565
|
+
|
|
2566
|
+
<dl>
|
|
2567
|
+
<dd>
|
|
2568
|
+
|
|
2569
|
+
**request:** `AgentPhone.GetCallTranscriptV1CallsCallIdTranscriptGetRequest`
|
|
2570
|
+
|
|
2571
|
+
</dd>
|
|
2572
|
+
</dl>
|
|
2573
|
+
|
|
2574
|
+
<dl>
|
|
2575
|
+
<dd>
|
|
2576
|
+
|
|
2577
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2578
|
+
|
|
2579
|
+
</dd>
|
|
2580
|
+
</dl>
|
|
2581
|
+
</dd>
|
|
2582
|
+
</dl>
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
</dd>
|
|
2586
|
+
</dl>
|
|
2587
|
+
</details>
|
|
2588
|
+
|
|
2589
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">streamCallTranscript</a>({ ...params }) -> unknown</code></summary>
|
|
2590
|
+
<dl>
|
|
2591
|
+
<dd>
|
|
2592
|
+
|
|
2593
|
+
#### 📝 Description
|
|
2594
|
+
|
|
2595
|
+
<dl>
|
|
2596
|
+
<dd>
|
|
2597
|
+
|
|
2598
|
+
<dl>
|
|
2599
|
+
<dd>
|
|
2600
|
+
|
|
2601
|
+
Stream a call's transcript via Server-Sent Events.
|
|
2602
|
+
|
|
2603
|
+
On connect the server replays all existing transcript turns from the
|
|
2604
|
+
database, then streams new turns in real time as they arrive from the
|
|
2605
|
+
voice provider. A ``: heartbeat`` comment is sent every 15 s to keep
|
|
2606
|
+
proxies alive. The stream closes after sending an ``ended`` event
|
|
2607
|
+
when the call completes (or immediately after replay if the call has
|
|
2608
|
+
already ended).
|
|
2609
|
+
|
|
2610
|
+
Works for both live and completed calls — same URL either way.
|
|
2611
|
+
</dd>
|
|
2612
|
+
</dl>
|
|
2613
|
+
</dd>
|
|
2614
|
+
</dl>
|
|
2615
|
+
|
|
2616
|
+
#### 🔌 Usage
|
|
2617
|
+
|
|
2618
|
+
<dl>
|
|
2619
|
+
<dd>
|
|
2620
|
+
|
|
2621
|
+
<dl>
|
|
2622
|
+
<dd>
|
|
2623
|
+
|
|
2624
|
+
```typescript
|
|
2625
|
+
await client.calls.streamCallTranscript({
|
|
2626
|
+
call_id: "call_id"
|
|
2627
|
+
});
|
|
2628
|
+
|
|
2629
|
+
```
|
|
2630
|
+
</dd>
|
|
2631
|
+
</dl>
|
|
2632
|
+
</dd>
|
|
2633
|
+
</dl>
|
|
2634
|
+
|
|
2635
|
+
#### ⚙️ Parameters
|
|
2636
|
+
|
|
2637
|
+
<dl>
|
|
2638
|
+
<dd>
|
|
2639
|
+
|
|
2640
|
+
<dl>
|
|
2641
|
+
<dd>
|
|
2642
|
+
|
|
2643
|
+
**request:** `AgentPhone.StreamCallTranscriptV1CallsCallIdTranscriptStreamGetRequest`
|
|
2644
|
+
|
|
2645
|
+
</dd>
|
|
2646
|
+
</dl>
|
|
2647
|
+
|
|
2648
|
+
<dl>
|
|
2649
|
+
<dd>
|
|
2650
|
+
|
|
2651
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2652
|
+
|
|
2653
|
+
</dd>
|
|
2654
|
+
</dl>
|
|
2655
|
+
</dd>
|
|
2656
|
+
</dl>
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
</dd>
|
|
2660
|
+
</dl>
|
|
2661
|
+
</details>
|
|
2662
|
+
|
|
2663
|
+
<details><summary><code>client.calls.<a href="/src/api/resources/calls/client/Client.ts">listCallsForNumber</a>({ ...params }) -> unknown</code></summary>
|
|
2664
|
+
<dl>
|
|
2665
|
+
<dd>
|
|
2666
|
+
|
|
2667
|
+
#### 📝 Description
|
|
2668
|
+
|
|
2669
|
+
<dl>
|
|
2670
|
+
<dd>
|
|
2671
|
+
|
|
2672
|
+
<dl>
|
|
2673
|
+
<dd>
|
|
2674
|
+
|
|
2675
|
+
List all calls for a specific phone number.
|
|
2676
|
+
</dd>
|
|
2677
|
+
</dl>
|
|
2678
|
+
</dd>
|
|
2679
|
+
</dl>
|
|
2680
|
+
|
|
2681
|
+
#### 🔌 Usage
|
|
2682
|
+
|
|
2683
|
+
<dl>
|
|
2684
|
+
<dd>
|
|
2685
|
+
|
|
2686
|
+
<dl>
|
|
2687
|
+
<dd>
|
|
2688
|
+
|
|
2689
|
+
```typescript
|
|
2690
|
+
await client.calls.listCallsForNumber({
|
|
2691
|
+
number_id: "number_id"
|
|
2692
|
+
});
|
|
2693
|
+
|
|
2694
|
+
```
|
|
2695
|
+
</dd>
|
|
2696
|
+
</dl>
|
|
2697
|
+
</dd>
|
|
2698
|
+
</dl>
|
|
2699
|
+
|
|
2700
|
+
#### ⚙️ Parameters
|
|
2701
|
+
|
|
2702
|
+
<dl>
|
|
2703
|
+
<dd>
|
|
2704
|
+
|
|
2705
|
+
<dl>
|
|
2706
|
+
<dd>
|
|
2707
|
+
|
|
2708
|
+
**request:** `AgentPhone.ListCallsForNumberV1NumbersNumberIdCallsGetRequest`
|
|
2709
|
+
|
|
2710
|
+
</dd>
|
|
2711
|
+
</dl>
|
|
2712
|
+
|
|
2713
|
+
<dl>
|
|
2714
|
+
<dd>
|
|
2715
|
+
|
|
2716
|
+
**requestOptions:** `CallsClient.RequestOptions`
|
|
2717
|
+
|
|
2718
|
+
</dd>
|
|
2719
|
+
</dl>
|
|
2720
|
+
</dd>
|
|
2721
|
+
</dl>
|
|
2722
|
+
|
|
2723
|
+
|
|
2724
|
+
</dd>
|
|
2725
|
+
</dl>
|
|
2726
|
+
</details>
|
|
2727
|
+
|
|
2728
|
+
## Usage
|
|
2729
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getUsage</a>() -> AgentPhone.UsageResponse</code></summary>
|
|
2730
|
+
<dl>
|
|
2731
|
+
<dd>
|
|
2732
|
+
|
|
2733
|
+
#### 📝 Description
|
|
2734
|
+
|
|
2735
|
+
<dl>
|
|
2736
|
+
<dd>
|
|
2737
|
+
|
|
2738
|
+
<dl>
|
|
2739
|
+
<dd>
|
|
2740
|
+
|
|
2741
|
+
Get usage statistics for the current account.
|
|
2742
|
+
|
|
2743
|
+
Returns:
|
|
2744
|
+
- Phone number limits (used/limit/remaining)
|
|
2745
|
+
- Message statistics (total, last 24h, last 7 days, last 30 days)
|
|
2746
|
+
- Call statistics (total, last 24h, last 7 days, last 30 days)
|
|
2747
|
+
- Webhook delivery statistics
|
|
2748
|
+
</dd>
|
|
2749
|
+
</dl>
|
|
2750
|
+
</dd>
|
|
2751
|
+
</dl>
|
|
2752
|
+
|
|
2753
|
+
#### 🔌 Usage
|
|
2754
|
+
|
|
2755
|
+
<dl>
|
|
2756
|
+
<dd>
|
|
2757
|
+
|
|
2758
|
+
<dl>
|
|
2759
|
+
<dd>
|
|
2760
|
+
|
|
2761
|
+
```typescript
|
|
2762
|
+
await client.usage.getUsage();
|
|
2763
|
+
|
|
2764
|
+
```
|
|
2765
|
+
</dd>
|
|
2766
|
+
</dl>
|
|
2767
|
+
</dd>
|
|
2768
|
+
</dl>
|
|
2769
|
+
|
|
2770
|
+
#### ⚙️ Parameters
|
|
2771
|
+
|
|
2772
|
+
<dl>
|
|
2773
|
+
<dd>
|
|
2774
|
+
|
|
2775
|
+
<dl>
|
|
2776
|
+
<dd>
|
|
2777
|
+
|
|
2778
|
+
**requestOptions:** `UsageClient.RequestOptions`
|
|
2779
|
+
|
|
2780
|
+
</dd>
|
|
2781
|
+
</dl>
|
|
2782
|
+
</dd>
|
|
2783
|
+
</dl>
|
|
2784
|
+
|
|
2785
|
+
|
|
2786
|
+
</dd>
|
|
2787
|
+
</dl>
|
|
2788
|
+
</details>
|
|
2789
|
+
|
|
2790
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getDailyUsage</a>({ ...params }) -> AgentPhone.DailyUsageResponse</code></summary>
|
|
2791
|
+
<dl>
|
|
2792
|
+
<dd>
|
|
2793
|
+
|
|
2794
|
+
#### 📝 Description
|
|
2795
|
+
|
|
2796
|
+
<dl>
|
|
2797
|
+
<dd>
|
|
2798
|
+
|
|
2799
|
+
<dl>
|
|
2800
|
+
<dd>
|
|
2801
|
+
|
|
2802
|
+
Get daily usage breakdown for the last N days (up to 365).
|
|
2803
|
+
Returns per-day counts of messages, calls, and webhook deliveries.
|
|
2804
|
+
</dd>
|
|
2805
|
+
</dl>
|
|
2806
|
+
</dd>
|
|
2807
|
+
</dl>
|
|
2808
|
+
|
|
2809
|
+
#### 🔌 Usage
|
|
2810
|
+
|
|
2811
|
+
<dl>
|
|
2812
|
+
<dd>
|
|
2813
|
+
|
|
2814
|
+
<dl>
|
|
2815
|
+
<dd>
|
|
2816
|
+
|
|
2817
|
+
```typescript
|
|
2818
|
+
await client.usage.getDailyUsage();
|
|
2819
|
+
|
|
2820
|
+
```
|
|
2821
|
+
</dd>
|
|
2822
|
+
</dl>
|
|
2823
|
+
</dd>
|
|
2824
|
+
</dl>
|
|
2825
|
+
|
|
2826
|
+
#### ⚙️ Parameters
|
|
2827
|
+
|
|
2828
|
+
<dl>
|
|
2829
|
+
<dd>
|
|
2830
|
+
|
|
2831
|
+
<dl>
|
|
2832
|
+
<dd>
|
|
2833
|
+
|
|
2834
|
+
**request:** `AgentPhone.GetDailyUsageV1UsageDailyGetRequest`
|
|
2835
|
+
|
|
2836
|
+
</dd>
|
|
2837
|
+
</dl>
|
|
2838
|
+
|
|
2839
|
+
<dl>
|
|
2840
|
+
<dd>
|
|
2841
|
+
|
|
2842
|
+
**requestOptions:** `UsageClient.RequestOptions`
|
|
2843
|
+
|
|
2844
|
+
</dd>
|
|
2845
|
+
</dl>
|
|
2846
|
+
</dd>
|
|
2847
|
+
</dl>
|
|
2848
|
+
|
|
2849
|
+
|
|
2850
|
+
</dd>
|
|
2851
|
+
</dl>
|
|
2852
|
+
</details>
|
|
2853
|
+
|
|
2854
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">getMonthlyUsage</a>({ ...params }) -> AgentPhone.MonthlyUsageResponse</code></summary>
|
|
2855
|
+
<dl>
|
|
2856
|
+
<dd>
|
|
2857
|
+
|
|
2858
|
+
#### 📝 Description
|
|
2859
|
+
|
|
2860
|
+
<dl>
|
|
2861
|
+
<dd>
|
|
2862
|
+
|
|
2863
|
+
<dl>
|
|
2864
|
+
<dd>
|
|
2865
|
+
|
|
2866
|
+
Get monthly usage aggregation for the last N months.
|
|
2867
|
+
Returns per-month totals of messages, calls, and webhook deliveries.
|
|
2868
|
+
</dd>
|
|
2869
|
+
</dl>
|
|
2870
|
+
</dd>
|
|
2871
|
+
</dl>
|
|
2872
|
+
|
|
2873
|
+
#### 🔌 Usage
|
|
2874
|
+
|
|
2875
|
+
<dl>
|
|
2876
|
+
<dd>
|
|
2877
|
+
|
|
2878
|
+
<dl>
|
|
2879
|
+
<dd>
|
|
2880
|
+
|
|
2881
|
+
```typescript
|
|
2882
|
+
await client.usage.getMonthlyUsage();
|
|
2883
|
+
|
|
2884
|
+
```
|
|
2885
|
+
</dd>
|
|
2886
|
+
</dl>
|
|
2887
|
+
</dd>
|
|
2888
|
+
</dl>
|
|
2889
|
+
|
|
2890
|
+
#### ⚙️ Parameters
|
|
2891
|
+
|
|
2892
|
+
<dl>
|
|
2893
|
+
<dd>
|
|
2894
|
+
|
|
2895
|
+
<dl>
|
|
2896
|
+
<dd>
|
|
2897
|
+
|
|
2898
|
+
**request:** `AgentPhone.GetMonthlyUsageV1UsageMonthlyGetRequest`
|
|
2899
|
+
|
|
2900
|
+
</dd>
|
|
2901
|
+
</dl>
|
|
2902
|
+
|
|
2903
|
+
<dl>
|
|
2904
|
+
<dd>
|
|
2905
|
+
|
|
2906
|
+
**requestOptions:** `UsageClient.RequestOptions`
|
|
2907
|
+
|
|
2908
|
+
</dd>
|
|
2909
|
+
</dl>
|
|
2910
|
+
</dd>
|
|
2911
|
+
</dl>
|
|
2912
|
+
|
|
2913
|
+
|
|
2914
|
+
</dd>
|
|
2915
|
+
</dl>
|
|
2916
|
+
</details>
|
|
2917
|
+
|
|
2918
|
+
## Messages
|
|
2919
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendMessage</a>({ ...params }) -> AgentPhone.SendMessageResponse</code></summary>
|
|
2920
|
+
<dl>
|
|
2921
|
+
<dd>
|
|
2922
|
+
|
|
2923
|
+
#### 📝 Description
|
|
2924
|
+
|
|
2925
|
+
<dl>
|
|
2926
|
+
<dd>
|
|
2927
|
+
|
|
2928
|
+
<dl>
|
|
2929
|
+
<dd>
|
|
2930
|
+
|
|
2931
|
+
Send an outbound message (SMS or iMessage) via the provider assigned to the number.
|
|
2932
|
+
</dd>
|
|
2933
|
+
</dl>
|
|
2934
|
+
</dd>
|
|
2935
|
+
</dl>
|
|
2936
|
+
|
|
2937
|
+
#### 🔌 Usage
|
|
2938
|
+
|
|
2939
|
+
<dl>
|
|
2940
|
+
<dd>
|
|
2941
|
+
|
|
2942
|
+
<dl>
|
|
2943
|
+
<dd>
|
|
2944
|
+
|
|
2945
|
+
```typescript
|
|
2946
|
+
await client.messages.sendMessage({
|
|
2947
|
+
agent_id: "agent_id",
|
|
2948
|
+
to_number: "to_number",
|
|
2949
|
+
body: "body"
|
|
2950
|
+
});
|
|
2951
|
+
|
|
2952
|
+
```
|
|
2953
|
+
</dd>
|
|
2954
|
+
</dl>
|
|
2955
|
+
</dd>
|
|
2956
|
+
</dl>
|
|
2957
|
+
|
|
2958
|
+
#### ⚙️ Parameters
|
|
2959
|
+
|
|
2960
|
+
<dl>
|
|
2961
|
+
<dd>
|
|
2962
|
+
|
|
2963
|
+
<dl>
|
|
2964
|
+
<dd>
|
|
2965
|
+
|
|
2966
|
+
**request:** `AgentPhone.SendMessageRequest`
|
|
2967
|
+
|
|
2968
|
+
</dd>
|
|
2969
|
+
</dl>
|
|
2970
|
+
|
|
2971
|
+
<dl>
|
|
2972
|
+
<dd>
|
|
2973
|
+
|
|
2974
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
2975
|
+
|
|
2976
|
+
</dd>
|
|
2977
|
+
</dl>
|
|
2978
|
+
</dd>
|
|
2979
|
+
</dl>
|
|
2980
|
+
|
|
2981
|
+
|
|
2982
|
+
</dd>
|
|
2983
|
+
</dl>
|
|
2984
|
+
</details>
|
|
2985
|
+
|
|
2986
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">sendReaction</a>({ ...params }) -> AgentPhone.SendReactionResponse</code></summary>
|
|
2987
|
+
<dl>
|
|
2988
|
+
<dd>
|
|
2989
|
+
|
|
2990
|
+
#### 📝 Description
|
|
2991
|
+
|
|
2992
|
+
<dl>
|
|
2993
|
+
<dd>
|
|
2994
|
+
|
|
2995
|
+
<dl>
|
|
2996
|
+
<dd>
|
|
2997
|
+
|
|
2998
|
+
Send a tapback reaction to a message (iMessage only).
|
|
2999
|
+
|
|
3000
|
+
Reactions are an iMessage feature. Attempting to react to a message
|
|
3001
|
+
sent via an SMS/Twilio number will return a clear error.
|
|
3002
|
+
</dd>
|
|
3003
|
+
</dl>
|
|
3004
|
+
</dd>
|
|
3005
|
+
</dl>
|
|
3006
|
+
|
|
3007
|
+
#### 🔌 Usage
|
|
3008
|
+
|
|
3009
|
+
<dl>
|
|
3010
|
+
<dd>
|
|
3011
|
+
|
|
3012
|
+
<dl>
|
|
3013
|
+
<dd>
|
|
3014
|
+
|
|
3015
|
+
```typescript
|
|
3016
|
+
await client.messages.sendReaction({
|
|
3017
|
+
message_id: "message_id",
|
|
3018
|
+
reaction: "reaction"
|
|
3019
|
+
});
|
|
3020
|
+
|
|
3021
|
+
```
|
|
3022
|
+
</dd>
|
|
3023
|
+
</dl>
|
|
3024
|
+
</dd>
|
|
3025
|
+
</dl>
|
|
3026
|
+
|
|
3027
|
+
#### ⚙️ Parameters
|
|
3028
|
+
|
|
3029
|
+
<dl>
|
|
3030
|
+
<dd>
|
|
3031
|
+
|
|
3032
|
+
<dl>
|
|
3033
|
+
<dd>
|
|
3034
|
+
|
|
3035
|
+
**request:** `AgentPhone.SendReactionRequest`
|
|
3036
|
+
|
|
3037
|
+
</dd>
|
|
3038
|
+
</dl>
|
|
3039
|
+
|
|
3040
|
+
<dl>
|
|
3041
|
+
<dd>
|
|
3042
|
+
|
|
3043
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
1702
3044
|
|
|
1703
3045
|
</dd>
|
|
1704
3046
|
</dl>
|