phonic 0.31.2 → 0.31.4
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 +105 -16
- package/dist/cjs/BaseClient.d.ts +40 -0
- package/dist/cjs/BaseClient.js +62 -0
- package/dist/cjs/Client.d.ts +27 -48
- package/dist/cjs/Client.js +17 -60
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -4
- package/dist/cjs/api/errors/BadRequestError.js +6 -4
- package/dist/cjs/api/errors/ConflictError.d.ts +1 -4
- package/dist/cjs/api/errors/ConflictError.js +6 -4
- package/dist/cjs/api/errors/ForbiddenError.d.ts +1 -4
- package/dist/cjs/api/errors/ForbiddenError.js +6 -4
- package/dist/cjs/api/errors/GatewayTimeoutError.d.ts +2 -5
- package/dist/cjs/api/errors/GatewayTimeoutError.js +6 -4
- package/dist/cjs/api/errors/InternalServerError.d.ts +2 -5
- package/dist/cjs/api/errors/InternalServerError.js +6 -4
- package/dist/cjs/api/errors/NotFoundError.d.ts +1 -4
- package/dist/cjs/api/errors/NotFoundError.js +6 -4
- package/dist/cjs/api/errors/UnauthorizedError.d.ts +2 -5
- package/dist/cjs/api/errors/UnauthorizedError.js +6 -4
- package/dist/cjs/api/errors/index.d.ts +4 -4
- package/dist/cjs/api/errors/index.js +4 -4
- package/dist/cjs/api/resources/agents/client/Client.d.ts +26 -47
- package/dist/cjs/api/resources/agents/client/Client.js +128 -249
- package/dist/cjs/api/resources/agents/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/client/requests/AgentsAddCustomPhoneNumberRequest.d.ts +2 -5
- package/dist/cjs/api/resources/agents/client/requests/AgentsAddCustomPhoneNumberRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.d.ts +1 -4
- package/dist/cjs/api/resources/agents/client/requests/AgentsCreateRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteCustomPhoneNumberRequest.d.ts +0 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteCustomPhoneNumberRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteRequest.d.ts +0 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsDeleteRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsGetRequest.d.ts +0 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsGetRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsListRequest.d.ts +0 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsListRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/AgentsUpdatePhoneNumberRequest.d.ts +2 -5
- package/dist/cjs/api/resources/agents/client/requests/AgentsUpdatePhoneNumberRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +9 -16
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.js +3 -3
- package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.d.ts +1 -4
- package/dist/cjs/api/resources/agents/client/requests/UpsertAgentRequest.js +1 -3
- package/dist/cjs/api/resources/agents/client/requests/index.d.ts +9 -9
- package/dist/cjs/api/resources/agents/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/agents/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agents/exports.js +21 -0
- package/dist/cjs/api/resources/agents/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/index.js +1 -1
- package/dist/cjs/api/resources/agents/types/AgentsAddCustomPhoneNumberResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsAddCustomPhoneNumberResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsCreateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsCreateResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsDeleteCustomPhoneNumberResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsDeleteCustomPhoneNumberResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsDeleteResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsDeleteResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/agents/types/AgentsGetResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/agents/types/AgentsListResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsUpdatePhoneNumberResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsUpdatePhoneNumberResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsUpdateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/agents/types/AgentsUpdateResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/AgentsUpsertResponse.d.ts +1 -4
- package/dist/cjs/api/resources/agents/types/AgentsUpsertResponse.js +1 -3
- package/dist/cjs/api/resources/agents/types/index.d.ts +6 -6
- package/dist/cjs/api/resources/agents/types/index.js +6 -6
- package/dist/cjs/api/resources/auth/client/Client.d.ts +10 -31
- package/dist/cjs/api/resources/auth/client/Client.js +20 -43
- package/dist/cjs/api/resources/auth/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/auth/client/requests/CreateSessionTokenRequest.d.ts +0 -3
- package/dist/cjs/api/resources/auth/client/requests/CreateSessionTokenRequest.js +1 -3
- package/dist/cjs/api/resources/auth/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/auth/exports.d.ts +2 -0
- package/dist/cjs/api/resources/auth/exports.js +21 -0
- package/dist/cjs/api/resources/auth/index.d.ts +1 -1
- package/dist/cjs/api/resources/auth/index.js +1 -1
- package/dist/cjs/api/resources/auth/types/AuthCreateSessionTokenResponse.d.ts +0 -3
- package/dist/cjs/api/resources/auth/types/AuthCreateSessionTokenResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +36 -51
- package/dist/cjs/api/resources/conversations/client/Client.js +134 -270
- package/dist/cjs/api/resources/conversations/client/Socket.d.ts +2 -12
- package/dist/cjs/api/resources/conversations/client/Socket.js +15 -40
- package/dist/cjs/api/resources/conversations/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListRequest.d.ts +0 -6
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/EvaluateConversationRequest.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/client/requests/EvaluateConversationRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/ExtractDataRequest.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/client/requests/ExtractDataRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/OutboundCallRequest.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/client/requests/OutboundCallRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +5 -5
- package/dist/cjs/api/resources/conversations/exports.d.ts +2 -0
- package/dist/cjs/api/resources/conversations/exports.js +21 -0
- package/dist/cjs/api/resources/conversations/index.d.ts +1 -1
- package/dist/cjs/api/resources/conversations/index.js +1 -1
- package/dist/cjs/api/resources/conversations/types/ConversationsCancelResponse.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsCancelResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsExtractDataResponse.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsExtractDataResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsGetAnalysisResponse.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsGetAnalysisResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsGetResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListEvaluationsResponse.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListEvaluationsResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListExtractionsResponse.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListExtractionsResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsOutboundCallResponse.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsOutboundCallResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsSipOutboundCallResponse.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsSipOutboundCallResponse.js +1 -3
- package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -4
- package/dist/cjs/api/resources/conversations/types/index.js +4 -4
- package/dist/cjs/api/resources/extractionSchemas/client/Client.d.ts +18 -39
- package/dist/cjs/api/resources/extractionSchemas/client/Client.js +74 -146
- package/dist/cjs/api/resources/extractionSchemas/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/extractionSchemas/client/requests/CreateExtractionSchemaRequest.d.ts +1 -4
- package/dist/cjs/api/resources/extractionSchemas/client/requests/CreateExtractionSchemaRequest.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasDeleteRequest.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasDeleteRequest.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.d.ts +1 -4
- package/dist/cjs/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/client/requests/index.d.ts +5 -5
- package/dist/cjs/api/resources/extractionSchemas/exports.d.ts +2 -0
- package/dist/cjs/api/resources/extractionSchemas/exports.js +21 -0
- package/dist/cjs/api/resources/extractionSchemas/index.d.ts +1 -1
- package/dist/cjs/api/resources/extractionSchemas/index.js +1 -1
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.js +1 -3
- package/dist/cjs/api/resources/extractionSchemas/types/index.d.ts +2 -2
- package/dist/cjs/api/resources/extractionSchemas/types/index.js +2 -2
- package/dist/cjs/api/resources/index.d.ts +13 -13
- package/dist/cjs/api/resources/index.js +17 -17
- package/dist/cjs/api/resources/projects/client/Client.d.ts +22 -43
- package/dist/cjs/api/resources/projects/client/Client.js +79 -168
- package/dist/cjs/api/resources/projects/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/projects/client/requests/CreateConversationEvalPromptRequest.d.ts +0 -3
- package/dist/cjs/api/resources/projects/client/requests/CreateConversationEvalPromptRequest.js +1 -3
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequest.d.ts +0 -3
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequest.js +1 -3
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequest.d.ts +0 -3
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequest.js +1 -3
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/projects/exports.d.ts +2 -0
- package/dist/cjs/api/resources/projects/exports.js +21 -0
- package/dist/cjs/api/resources/projects/index.d.ts +1 -1
- package/dist/cjs/api/resources/projects/index.js +1 -1
- package/dist/cjs/api/resources/projects/types/ProjectsCreateEvalPromptResponse.d.ts +0 -3
- package/dist/cjs/api/resources/projects/types/ProjectsCreateEvalPromptResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsCreateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/projects/types/ProjectsCreateResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsDeleteResponse.d.ts +0 -3
- package/dist/cjs/api/resources/projects/types/ProjectsDeleteResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/projects/types/ProjectsGetResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsListEvalPromptsResponse.d.ts +1 -4
- package/dist/cjs/api/resources/projects/types/ProjectsListEvalPromptsResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/projects/types/ProjectsListResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/ProjectsUpdateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/projects/types/ProjectsUpdateResponse.js +1 -3
- package/dist/cjs/api/resources/projects/types/index.d.ts +4 -4
- package/dist/cjs/api/resources/projects/types/index.js +4 -4
- package/dist/cjs/api/resources/tools/client/Client.d.ts +18 -39
- package/dist/cjs/api/resources/tools/client/Client.js +74 -146
- package/dist/cjs/api/resources/tools/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/client/requests/CreateToolRequest.d.ts +7 -16
- package/dist/cjs/api/resources/tools/client/requests/CreateToolRequest.js +4 -3
- package/dist/cjs/api/resources/tools/client/requests/ToolsDeleteRequest.d.ts +0 -3
- package/dist/cjs/api/resources/tools/client/requests/ToolsDeleteRequest.js +1 -3
- package/dist/cjs/api/resources/tools/client/requests/ToolsGetRequest.d.ts +0 -23
- package/dist/cjs/api/resources/tools/client/requests/ToolsGetRequest.js +1 -3
- package/dist/cjs/api/resources/tools/client/requests/ToolsListRequest.d.ts +0 -3
- package/dist/cjs/api/resources/tools/client/requests/ToolsListRequest.js +1 -3
- package/dist/cjs/api/resources/tools/client/requests/UpdateToolRequest.d.ts +7 -16
- package/dist/cjs/api/resources/tools/client/requests/UpdateToolRequest.js +4 -3
- package/dist/cjs/api/resources/tools/client/requests/index.d.ts +5 -5
- package/dist/cjs/api/resources/tools/client/requests/index.js +5 -0
- package/dist/cjs/api/resources/tools/exports.d.ts +2 -0
- package/dist/cjs/api/resources/tools/exports.js +21 -0
- package/dist/cjs/api/resources/tools/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/index.js +1 -1
- package/dist/cjs/api/resources/tools/types/ToolsCreateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/tools/types/ToolsCreateResponse.js +1 -3
- package/dist/cjs/api/resources/tools/types/ToolsDeleteResponse.d.ts +0 -3
- package/dist/cjs/api/resources/tools/types/ToolsDeleteResponse.js +1 -3
- package/dist/cjs/api/resources/tools/types/ToolsGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/tools/types/ToolsGetResponse.js +1 -3
- package/dist/cjs/api/resources/tools/types/ToolsListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/tools/types/ToolsListResponse.js +1 -3
- package/dist/cjs/api/resources/tools/types/ToolsUpdateResponse.d.ts +0 -3
- package/dist/cjs/api/resources/tools/types/ToolsUpdateResponse.js +1 -3
- package/dist/cjs/api/resources/tools/types/index.d.ts +2 -2
- package/dist/cjs/api/resources/tools/types/index.js +2 -2
- package/dist/cjs/api/resources/voices/client/Client.d.ts +12 -33
- package/dist/cjs/api/resources/voices/client/Client.js +33 -66
- package/dist/cjs/api/resources/voices/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/voices/client/requests/VoicesListRequest.d.ts +0 -3
- package/dist/cjs/api/resources/voices/client/requests/VoicesListRequest.js +1 -3
- package/dist/cjs/api/resources/voices/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/voices/exports.d.ts +2 -0
- package/dist/cjs/api/resources/voices/exports.js +21 -0
- package/dist/cjs/api/resources/voices/index.d.ts +1 -1
- package/dist/cjs/api/resources/voices/index.js +1 -1
- package/dist/cjs/api/resources/voices/types/VoicesGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/voices/types/VoicesGetResponse.js +1 -3
- package/dist/cjs/api/resources/voices/types/VoicesListResponse.d.ts +1 -4
- package/dist/cjs/api/resources/voices/types/VoicesListResponse.js +1 -3
- package/dist/cjs/api/resources/voices/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/voices/types/index.js +1 -1
- package/dist/cjs/api/types/AddSystemMessagePayload.d.ts +0 -3
- package/dist/cjs/api/types/AddSystemMessagePayload.js +1 -3
- package/dist/cjs/api/types/Agent.d.ts +11 -18
- package/dist/cjs/api/types/Agent.js +3 -3
- package/dist/cjs/api/types/AssistantChoseNotToRespondPayload.d.ts +0 -3
- package/dist/cjs/api/types/AssistantChoseNotToRespondPayload.js +1 -3
- package/dist/cjs/api/types/AssistantEndedConversationPayload.d.ts +0 -3
- package/dist/cjs/api/types/AssistantEndedConversationPayload.js +1 -3
- package/dist/cjs/api/types/AssistantFinishedSpeakingPayload.d.ts +0 -3
- package/dist/cjs/api/types/AssistantFinishedSpeakingPayload.js +1 -3
- package/dist/cjs/api/types/AssistantStartedSpeakingPayload.d.ts +0 -3
- package/dist/cjs/api/types/AssistantStartedSpeakingPayload.js +1 -3
- package/dist/cjs/api/types/AudioChunkPayload.d.ts +1 -4
- package/dist/cjs/api/types/AudioChunkPayload.js +1 -3
- package/dist/cjs/api/types/AudioChunkResponsePayload.d.ts +0 -3
- package/dist/cjs/api/types/AudioChunkResponsePayload.js +1 -3
- package/dist/cjs/api/types/BadRequestErrorBody.d.ts +1 -4
- package/dist/cjs/api/types/BadRequestErrorBody.js +1 -3
- package/dist/cjs/api/types/BasicError.d.ts +2 -5
- package/dist/cjs/api/types/BasicError.js +1 -3
- package/dist/cjs/api/types/ConfigPayload.d.ts +30 -39
- package/dist/cjs/api/types/ConfigPayload.js +4 -3
- package/dist/cjs/api/types/Conversation.d.ts +10 -19
- package/dist/cjs/api/types/Conversation.js +4 -3
- package/dist/cjs/api/types/ConversationAnalysis.d.ts +0 -3
- package/dist/cjs/api/types/ConversationAnalysis.js +1 -3
- package/dist/cjs/api/types/ConversationCreatedPayload.d.ts +0 -3
- package/dist/cjs/api/types/ConversationCreatedPayload.js +1 -3
- package/dist/cjs/api/types/ConversationEval.d.ts +0 -3
- package/dist/cjs/api/types/ConversationEval.js +1 -3
- package/dist/cjs/api/types/ConversationEvalPrompt.d.ts +0 -3
- package/dist/cjs/api/types/ConversationEvalPrompt.js +1 -3
- package/dist/cjs/api/types/ConversationEvaluation.d.ts +1 -4
- package/dist/cjs/api/types/ConversationEvaluation.js +1 -3
- package/dist/cjs/api/types/ConversationEvaluationResult.d.ts +2 -7
- package/dist/cjs/api/types/ConversationEvaluationResult.js +2 -3
- package/dist/cjs/api/types/ConversationExtraction.d.ts +1 -4
- package/dist/cjs/api/types/ConversationExtraction.js +1 -3
- package/dist/cjs/api/types/ConversationItem.d.ts +14 -19
- package/dist/cjs/api/types/ConversationItem.js +2 -3
- package/dist/cjs/api/types/CreateAgentRequest.d.ts +37 -44
- package/dist/cjs/api/types/CreateAgentRequest.js +3 -3
- package/dist/cjs/api/types/DtmfPayload.d.ts +0 -3
- package/dist/cjs/api/types/DtmfPayload.js +1 -3
- package/dist/cjs/api/types/ErrorPayload.d.ts +2 -5
- package/dist/cjs/api/types/ErrorPayload.js +1 -3
- package/dist/cjs/api/types/Error_.d.ts +1 -4
- package/dist/cjs/api/types/Error_.js +1 -3
- package/dist/cjs/api/types/ExtractionField.d.ts +3 -8
- package/dist/cjs/api/types/ExtractionField.js +2 -3
- package/dist/cjs/api/types/ExtractionSchema.d.ts +1 -4
- package/dist/cjs/api/types/ExtractionSchema.js +1 -3
- package/dist/cjs/api/types/GenerateReplyPayload.d.ts +1 -4
- package/dist/cjs/api/types/GenerateReplyPayload.js +1 -3
- package/dist/cjs/api/types/InputCancelledPayload.d.ts +0 -3
- package/dist/cjs/api/types/InputCancelledPayload.js +1 -3
- package/dist/cjs/api/types/InputTextPayload.d.ts +0 -3
- package/dist/cjs/api/types/InputTextPayload.js +1 -3
- package/dist/cjs/api/types/LanguageCode.d.ts +2 -7
- package/dist/cjs/api/types/LanguageCode.js +2 -3
- package/dist/cjs/api/types/OutboundCallConfig.d.ts +14 -17
- package/dist/cjs/api/types/OutboundCallConfig.js +1 -3
- package/dist/cjs/api/types/Project.d.ts +0 -3
- package/dist/cjs/api/types/Project.js +1 -3
- package/dist/cjs/api/types/ReadyToStartConversationPayload.d.ts +0 -3
- package/dist/cjs/api/types/ReadyToStartConversationPayload.js +1 -3
- package/dist/cjs/api/types/SetExternalIdPayload.d.ts +0 -3
- package/dist/cjs/api/types/SetExternalIdPayload.js +1 -3
- package/dist/cjs/api/types/Task.d.ts +0 -3
- package/dist/cjs/api/types/Task.js +1 -3
- package/dist/cjs/api/types/Tool.d.ts +22 -31
- package/dist/cjs/api/types/Tool.js +4 -3
- package/dist/cjs/api/types/ToolCallInterruptedPayload.d.ts +0 -3
- package/dist/cjs/api/types/ToolCallInterruptedPayload.js +1 -3
- package/dist/cjs/api/types/ToolCallOutputPayload.d.ts +1 -4
- package/dist/cjs/api/types/ToolCallOutputPayload.js +1 -3
- package/dist/cjs/api/types/ToolCallOutputProcessedPayload.d.ts +14 -17
- package/dist/cjs/api/types/ToolCallOutputProcessedPayload.js +1 -3
- package/dist/cjs/api/types/ToolCallPayload.d.ts +0 -3
- package/dist/cjs/api/types/ToolCallPayload.js +1 -3
- package/dist/cjs/api/types/ToolParameter.d.ts +7 -14
- package/dist/cjs/api/types/ToolParameter.js +10 -3
- package/dist/cjs/api/types/UpdateSystemPromptPayload.d.ts +0 -3
- package/dist/cjs/api/types/UpdateSystemPromptPayload.js +1 -3
- package/dist/cjs/api/types/UserFinishedSpeakingPayload.d.ts +0 -3
- package/dist/cjs/api/types/UserFinishedSpeakingPayload.js +1 -3
- package/dist/cjs/api/types/UserStartedSpeakingPayload.d.ts +0 -3
- package/dist/cjs/api/types/UserStartedSpeakingPayload.js +1 -3
- package/dist/cjs/api/types/ValidationError.d.ts +0 -3
- package/dist/cjs/api/types/ValidationError.js +1 -3
- package/dist/cjs/api/types/Voice.d.ts +0 -3
- package/dist/cjs/api/types/Voice.js +1 -3
- package/dist/cjs/api/types/WarningPayload.d.ts +1 -4
- package/dist/cjs/api/types/WarningPayload.js +1 -3
- package/dist/cjs/api/types/index.d.ts +38 -38
- package/dist/cjs/api/types/index.js +38 -38
- package/dist/cjs/auth/BearerAuthProvider.d.ts +20 -0
- package/dist/cjs/auth/BearerAuthProvider.js +82 -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 +5 -2
- package/dist/cjs/core/auth/BasicAuth.js +2 -1
- package/dist/cjs/core/auth/BearerToken.d.ts +3 -1
- package/dist/cjs/core/auth/BearerToken.js +7 -6
- 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 +3 -2
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/exports.d.ts +2 -0
- package/dist/cjs/core/exports.js +18 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +5 -6
- 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 +13 -5
- package/dist/cjs/core/fetcher/Fetcher.js +213 -11
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +1 -1
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
- package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +21 -7
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/cjs/core/fetcher/makeRequest.js +32 -13
- package/dist/cjs/core/fetcher/requestWithRetries.js +3 -12
- package/dist/cjs/core/fetcher/signals.d.ts +1 -7
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/headers.d.ts +2 -3
- package/dist/cjs/core/headers.js +6 -4
- package/dist/cjs/core/index.d.ts +3 -2
- package/dist/cjs/core/index.js +4 -3
- 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/runtime.js +17 -15
- 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 +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/join.js +3 -4
- package/dist/cjs/core/websocket/exports.d.ts +8 -0
- package/dist/cjs/core/websocket/exports.js +2 -0
- package/dist/cjs/core/websocket/ws.d.ts +14 -11
- package/dist/cjs/core/websocket/ws.js +42 -29
- package/dist/cjs/environments.d.ts +0 -3
- package/dist/cjs/environments.js +1 -3
- package/dist/cjs/errors/PhonicError.d.ts +1 -4
- package/dist/cjs/errors/PhonicError.js +7 -5
- package/dist/cjs/errors/PhonicTimeoutError.d.ts +0 -3
- package/dist/cjs/errors/PhonicTimeoutError.js +6 -4
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/index.d.ts +4 -2
- package/dist/cjs/index.js +8 -4
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +40 -0
- package/dist/esm/BaseClient.mjs +25 -0
- package/dist/esm/Client.d.mts +27 -48
- package/dist/esm/Client.mjs +18 -28
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -4
- package/dist/esm/api/errors/BadRequestError.mjs +6 -4
- package/dist/esm/api/errors/ConflictError.d.mts +1 -4
- package/dist/esm/api/errors/ConflictError.mjs +6 -4
- package/dist/esm/api/errors/ForbiddenError.d.mts +1 -4
- package/dist/esm/api/errors/ForbiddenError.mjs +6 -4
- package/dist/esm/api/errors/GatewayTimeoutError.d.mts +2 -5
- package/dist/esm/api/errors/GatewayTimeoutError.mjs +6 -4
- package/dist/esm/api/errors/InternalServerError.d.mts +2 -5
- package/dist/esm/api/errors/InternalServerError.mjs +6 -4
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -4
- package/dist/esm/api/errors/NotFoundError.mjs +6 -4
- package/dist/esm/api/errors/UnauthorizedError.d.mts +2 -5
- package/dist/esm/api/errors/UnauthorizedError.mjs +6 -4
- package/dist/esm/api/errors/index.d.mts +4 -4
- package/dist/esm/api/errors/index.mjs +4 -4
- package/dist/esm/api/resources/agents/client/Client.d.mts +26 -47
- package/dist/esm/api/resources/agents/client/Client.mjs +126 -247
- package/dist/esm/api/resources/agents/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/client/requests/AgentsAddCustomPhoneNumberRequest.d.mts +2 -5
- package/dist/esm/api/resources/agents/client/requests/AgentsAddCustomPhoneNumberRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.d.mts +1 -4
- package/dist/esm/api/resources/agents/client/requests/AgentsCreateRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsDeleteCustomPhoneNumberRequest.d.mts +0 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsDeleteCustomPhoneNumberRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsDeleteRequest.d.mts +0 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsDeleteRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsGetRequest.d.mts +0 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsGetRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsListRequest.d.mts +0 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsListRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/AgentsUpdatePhoneNumberRequest.d.mts +2 -5
- package/dist/esm/api/resources/agents/client/requests/AgentsUpdatePhoneNumberRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +9 -16
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.mjs +3 -3
- package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.d.mts +1 -4
- package/dist/esm/api/resources/agents/client/requests/UpsertAgentRequest.mjs +1 -3
- package/dist/esm/api/resources/agents/client/requests/index.d.mts +9 -9
- package/dist/esm/api/resources/agents/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/agents/exports.d.mts +2 -0
- package/dist/esm/api/resources/agents/exports.mjs +3 -0
- package/dist/esm/api/resources/agents/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/index.mjs +1 -1
- package/dist/esm/api/resources/agents/types/AgentsAddCustomPhoneNumberResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsAddCustomPhoneNumberResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsCreateResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsCreateResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsDeleteCustomPhoneNumberResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsDeleteCustomPhoneNumberResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsDeleteResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsDeleteResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/agents/types/AgentsGetResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsListResponse.d.mts +1 -4
- package/dist/esm/api/resources/agents/types/AgentsListResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsUpdatePhoneNumberResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsUpdatePhoneNumberResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.d.mts +0 -3
- package/dist/esm/api/resources/agents/types/AgentsUpdateResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/AgentsUpsertResponse.d.mts +1 -4
- package/dist/esm/api/resources/agents/types/AgentsUpsertResponse.mjs +1 -3
- package/dist/esm/api/resources/agents/types/index.d.mts +6 -6
- package/dist/esm/api/resources/agents/types/index.mjs +6 -6
- package/dist/esm/api/resources/auth/client/Client.d.mts +10 -31
- package/dist/esm/api/resources/auth/client/Client.mjs +18 -41
- package/dist/esm/api/resources/auth/client/index.d.mts +0 -1
- package/dist/esm/api/resources/auth/client/requests/CreateSessionTokenRequest.d.mts +0 -3
- package/dist/esm/api/resources/auth/client/requests/CreateSessionTokenRequest.mjs +1 -3
- package/dist/esm/api/resources/auth/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/auth/exports.d.mts +2 -0
- package/dist/esm/api/resources/auth/exports.mjs +3 -0
- package/dist/esm/api/resources/auth/index.d.mts +1 -1
- package/dist/esm/api/resources/auth/index.mjs +1 -1
- package/dist/esm/api/resources/auth/types/AuthCreateSessionTokenResponse.d.mts +0 -3
- package/dist/esm/api/resources/auth/types/AuthCreateSessionTokenResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/Client.d.mts +36 -51
- package/dist/esm/api/resources/conversations/client/Client.mjs +132 -268
- package/dist/esm/api/resources/conversations/client/Socket.d.mts +2 -12
- package/dist/esm/api/resources/conversations/client/Socket.mjs +15 -40
- package/dist/esm/api/resources/conversations/client/index.d.mts +0 -1
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListRequest.d.mts +0 -6
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.d.mts +1 -4
- package/dist/esm/api/resources/conversations/client/requests/ConversationsSipOutboundCallRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/EvaluateConversationRequest.d.mts +0 -3
- package/dist/esm/api/resources/conversations/client/requests/EvaluateConversationRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/ExtractDataRequest.d.mts +0 -3
- package/dist/esm/api/resources/conversations/client/requests/ExtractDataRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/OutboundCallRequest.d.mts +1 -4
- package/dist/esm/api/resources/conversations/client/requests/OutboundCallRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +5 -5
- package/dist/esm/api/resources/conversations/exports.d.mts +2 -0
- package/dist/esm/api/resources/conversations/exports.mjs +3 -0
- package/dist/esm/api/resources/conversations/index.d.mts +1 -1
- package/dist/esm/api/resources/conversations/index.mjs +1 -1
- package/dist/esm/api/resources/conversations/types/ConversationsCancelResponse.d.mts +0 -3
- package/dist/esm/api/resources/conversations/types/ConversationsCancelResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsExtractDataResponse.d.mts +0 -3
- package/dist/esm/api/resources/conversations/types/ConversationsExtractDataResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsGetAnalysisResponse.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsGetAnalysisResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsGetResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListEvaluationsResponse.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListEvaluationsResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListExtractionsResponse.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListExtractionsResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListResponse.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsOutboundCallResponse.d.mts +0 -3
- package/dist/esm/api/resources/conversations/types/ConversationsOutboundCallResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsSipOutboundCallResponse.d.mts +0 -3
- package/dist/esm/api/resources/conversations/types/ConversationsSipOutboundCallResponse.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/index.d.mts +4 -4
- package/dist/esm/api/resources/conversations/types/index.mjs +4 -4
- package/dist/esm/api/resources/extractionSchemas/client/Client.d.mts +18 -39
- package/dist/esm/api/resources/extractionSchemas/client/Client.mjs +72 -144
- package/dist/esm/api/resources/extractionSchemas/client/index.d.mts +0 -1
- package/dist/esm/api/resources/extractionSchemas/client/requests/CreateExtractionSchemaRequest.d.mts +1 -4
- package/dist/esm/api/resources/extractionSchemas/client/requests/CreateExtractionSchemaRequest.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasDeleteRequest.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasDeleteRequest.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasGetRequest.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/ExtractionSchemasListRequest.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.d.mts +1 -4
- package/dist/esm/api/resources/extractionSchemas/client/requests/UpdateExtractionSchemaRequest.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/client/requests/index.d.mts +5 -5
- package/dist/esm/api/resources/extractionSchemas/exports.d.mts +2 -0
- package/dist/esm/api/resources/extractionSchemas/exports.mjs +3 -0
- package/dist/esm/api/resources/extractionSchemas/index.d.mts +1 -1
- package/dist/esm/api/resources/extractionSchemas/index.mjs +1 -1
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasCreateResponse.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasDeleteResponse.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasGetResponse.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.d.mts +1 -4
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasListResponse.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.d.mts +0 -3
- package/dist/esm/api/resources/extractionSchemas/types/ExtractionSchemasUpdateResponse.mjs +1 -3
- package/dist/esm/api/resources/extractionSchemas/types/index.d.mts +2 -2
- package/dist/esm/api/resources/extractionSchemas/types/index.mjs +2 -2
- package/dist/esm/api/resources/index.d.mts +13 -13
- package/dist/esm/api/resources/index.mjs +13 -13
- package/dist/esm/api/resources/projects/client/Client.d.mts +22 -43
- package/dist/esm/api/resources/projects/client/Client.mjs +77 -166
- package/dist/esm/api/resources/projects/client/index.d.mts +0 -1
- package/dist/esm/api/resources/projects/client/requests/CreateConversationEvalPromptRequest.d.mts +0 -3
- package/dist/esm/api/resources/projects/client/requests/CreateConversationEvalPromptRequest.mjs +1 -3
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequest.d.mts +0 -3
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequest.mjs +1 -3
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequest.d.mts +0 -3
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequest.mjs +1 -3
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/projects/exports.d.mts +2 -0
- package/dist/esm/api/resources/projects/exports.mjs +3 -0
- package/dist/esm/api/resources/projects/index.d.mts +1 -1
- package/dist/esm/api/resources/projects/index.mjs +1 -1
- package/dist/esm/api/resources/projects/types/ProjectsCreateEvalPromptResponse.d.mts +0 -3
- package/dist/esm/api/resources/projects/types/ProjectsCreateEvalPromptResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsCreateResponse.d.mts +0 -3
- package/dist/esm/api/resources/projects/types/ProjectsCreateResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsDeleteResponse.d.mts +0 -3
- package/dist/esm/api/resources/projects/types/ProjectsDeleteResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/projects/types/ProjectsGetResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsListEvalPromptsResponse.d.mts +1 -4
- package/dist/esm/api/resources/projects/types/ProjectsListEvalPromptsResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsListResponse.d.mts +1 -4
- package/dist/esm/api/resources/projects/types/ProjectsListResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/ProjectsUpdateResponse.d.mts +0 -3
- package/dist/esm/api/resources/projects/types/ProjectsUpdateResponse.mjs +1 -3
- package/dist/esm/api/resources/projects/types/index.d.mts +4 -4
- package/dist/esm/api/resources/projects/types/index.mjs +4 -4
- package/dist/esm/api/resources/tools/client/Client.d.mts +18 -39
- package/dist/esm/api/resources/tools/client/Client.mjs +72 -144
- package/dist/esm/api/resources/tools/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/client/requests/CreateToolRequest.d.mts +7 -16
- package/dist/esm/api/resources/tools/client/requests/CreateToolRequest.mjs +4 -3
- package/dist/esm/api/resources/tools/client/requests/ToolsDeleteRequest.d.mts +0 -3
- package/dist/esm/api/resources/tools/client/requests/ToolsDeleteRequest.mjs +1 -3
- package/dist/esm/api/resources/tools/client/requests/ToolsGetRequest.d.mts +0 -23
- package/dist/esm/api/resources/tools/client/requests/ToolsGetRequest.mjs +1 -3
- package/dist/esm/api/resources/tools/client/requests/ToolsListRequest.d.mts +0 -3
- package/dist/esm/api/resources/tools/client/requests/ToolsListRequest.mjs +1 -3
- package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.d.mts +7 -16
- package/dist/esm/api/resources/tools/client/requests/UpdateToolRequest.mjs +4 -3
- package/dist/esm/api/resources/tools/client/requests/index.d.mts +5 -5
- package/dist/esm/api/resources/tools/client/requests/index.mjs +2 -1
- package/dist/esm/api/resources/tools/exports.d.mts +2 -0
- package/dist/esm/api/resources/tools/exports.mjs +3 -0
- package/dist/esm/api/resources/tools/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/index.mjs +1 -1
- package/dist/esm/api/resources/tools/types/ToolsCreateResponse.d.mts +0 -3
- package/dist/esm/api/resources/tools/types/ToolsCreateResponse.mjs +1 -3
- package/dist/esm/api/resources/tools/types/ToolsDeleteResponse.d.mts +0 -3
- package/dist/esm/api/resources/tools/types/ToolsDeleteResponse.mjs +1 -3
- package/dist/esm/api/resources/tools/types/ToolsGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/tools/types/ToolsGetResponse.mjs +1 -3
- package/dist/esm/api/resources/tools/types/ToolsListResponse.d.mts +1 -4
- package/dist/esm/api/resources/tools/types/ToolsListResponse.mjs +1 -3
- package/dist/esm/api/resources/tools/types/ToolsUpdateResponse.d.mts +0 -3
- package/dist/esm/api/resources/tools/types/ToolsUpdateResponse.mjs +1 -3
- package/dist/esm/api/resources/tools/types/index.d.mts +2 -2
- package/dist/esm/api/resources/tools/types/index.mjs +2 -2
- package/dist/esm/api/resources/voices/client/Client.d.mts +12 -33
- package/dist/esm/api/resources/voices/client/Client.mjs +31 -64
- package/dist/esm/api/resources/voices/client/index.d.mts +0 -1
- package/dist/esm/api/resources/voices/client/requests/VoicesListRequest.d.mts +0 -3
- package/dist/esm/api/resources/voices/client/requests/VoicesListRequest.mjs +1 -3
- package/dist/esm/api/resources/voices/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/voices/exports.d.mts +2 -0
- package/dist/esm/api/resources/voices/exports.mjs +3 -0
- package/dist/esm/api/resources/voices/index.d.mts +1 -1
- package/dist/esm/api/resources/voices/index.mjs +1 -1
- package/dist/esm/api/resources/voices/types/VoicesGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/voices/types/VoicesGetResponse.mjs +1 -3
- package/dist/esm/api/resources/voices/types/VoicesListResponse.d.mts +1 -4
- package/dist/esm/api/resources/voices/types/VoicesListResponse.mjs +1 -3
- package/dist/esm/api/resources/voices/types/index.d.mts +1 -1
- package/dist/esm/api/resources/voices/types/index.mjs +1 -1
- package/dist/esm/api/types/AddSystemMessagePayload.d.mts +0 -3
- package/dist/esm/api/types/AddSystemMessagePayload.mjs +1 -3
- package/dist/esm/api/types/Agent.d.mts +11 -18
- package/dist/esm/api/types/Agent.mjs +3 -3
- package/dist/esm/api/types/AssistantChoseNotToRespondPayload.d.mts +0 -3
- package/dist/esm/api/types/AssistantChoseNotToRespondPayload.mjs +1 -3
- package/dist/esm/api/types/AssistantEndedConversationPayload.d.mts +0 -3
- package/dist/esm/api/types/AssistantEndedConversationPayload.mjs +1 -3
- package/dist/esm/api/types/AssistantFinishedSpeakingPayload.d.mts +0 -3
- package/dist/esm/api/types/AssistantFinishedSpeakingPayload.mjs +1 -3
- package/dist/esm/api/types/AssistantStartedSpeakingPayload.d.mts +0 -3
- package/dist/esm/api/types/AssistantStartedSpeakingPayload.mjs +1 -3
- package/dist/esm/api/types/AudioChunkPayload.d.mts +1 -4
- package/dist/esm/api/types/AudioChunkPayload.mjs +1 -3
- package/dist/esm/api/types/AudioChunkResponsePayload.d.mts +0 -3
- package/dist/esm/api/types/AudioChunkResponsePayload.mjs +1 -3
- package/dist/esm/api/types/BadRequestErrorBody.d.mts +1 -4
- package/dist/esm/api/types/BadRequestErrorBody.mjs +1 -3
- package/dist/esm/api/types/BasicError.d.mts +2 -5
- package/dist/esm/api/types/BasicError.mjs +1 -3
- package/dist/esm/api/types/ConfigPayload.d.mts +30 -39
- package/dist/esm/api/types/ConfigPayload.mjs +4 -3
- package/dist/esm/api/types/Conversation.d.mts +10 -19
- package/dist/esm/api/types/Conversation.mjs +4 -3
- package/dist/esm/api/types/ConversationAnalysis.d.mts +0 -3
- package/dist/esm/api/types/ConversationAnalysis.mjs +1 -3
- package/dist/esm/api/types/ConversationCreatedPayload.d.mts +0 -3
- package/dist/esm/api/types/ConversationCreatedPayload.mjs +1 -3
- package/dist/esm/api/types/ConversationEval.d.mts +0 -3
- package/dist/esm/api/types/ConversationEval.mjs +1 -3
- package/dist/esm/api/types/ConversationEvalPrompt.d.mts +0 -3
- package/dist/esm/api/types/ConversationEvalPrompt.mjs +1 -3
- package/dist/esm/api/types/ConversationEvaluation.d.mts +1 -4
- package/dist/esm/api/types/ConversationEvaluation.mjs +1 -3
- package/dist/esm/api/types/ConversationEvaluationResult.d.mts +2 -7
- package/dist/esm/api/types/ConversationEvaluationResult.mjs +2 -3
- package/dist/esm/api/types/ConversationExtraction.d.mts +1 -4
- package/dist/esm/api/types/ConversationExtraction.mjs +1 -3
- package/dist/esm/api/types/ConversationItem.d.mts +14 -19
- package/dist/esm/api/types/ConversationItem.mjs +2 -3
- package/dist/esm/api/types/CreateAgentRequest.d.mts +37 -44
- package/dist/esm/api/types/CreateAgentRequest.mjs +3 -3
- package/dist/esm/api/types/DtmfPayload.d.mts +0 -3
- package/dist/esm/api/types/DtmfPayload.mjs +1 -3
- package/dist/esm/api/types/ErrorPayload.d.mts +2 -5
- package/dist/esm/api/types/ErrorPayload.mjs +1 -3
- package/dist/esm/api/types/Error_.d.mts +1 -4
- package/dist/esm/api/types/Error_.mjs +1 -3
- package/dist/esm/api/types/ExtractionField.d.mts +3 -8
- package/dist/esm/api/types/ExtractionField.mjs +2 -3
- package/dist/esm/api/types/ExtractionSchema.d.mts +1 -4
- package/dist/esm/api/types/ExtractionSchema.mjs +1 -3
- package/dist/esm/api/types/GenerateReplyPayload.d.mts +1 -4
- package/dist/esm/api/types/GenerateReplyPayload.mjs +1 -3
- package/dist/esm/api/types/InputCancelledPayload.d.mts +0 -3
- package/dist/esm/api/types/InputCancelledPayload.mjs +1 -3
- package/dist/esm/api/types/InputTextPayload.d.mts +0 -3
- package/dist/esm/api/types/InputTextPayload.mjs +1 -3
- package/dist/esm/api/types/LanguageCode.d.mts +2 -7
- package/dist/esm/api/types/LanguageCode.mjs +2 -3
- package/dist/esm/api/types/OutboundCallConfig.d.mts +14 -17
- package/dist/esm/api/types/OutboundCallConfig.mjs +1 -3
- package/dist/esm/api/types/Project.d.mts +0 -3
- package/dist/esm/api/types/Project.mjs +1 -3
- package/dist/esm/api/types/ReadyToStartConversationPayload.d.mts +0 -3
- package/dist/esm/api/types/ReadyToStartConversationPayload.mjs +1 -3
- package/dist/esm/api/types/SetExternalIdPayload.d.mts +0 -3
- package/dist/esm/api/types/SetExternalIdPayload.mjs +1 -3
- package/dist/esm/api/types/Task.d.mts +0 -3
- package/dist/esm/api/types/Task.mjs +1 -3
- package/dist/esm/api/types/Tool.d.mts +22 -31
- package/dist/esm/api/types/Tool.mjs +4 -3
- package/dist/esm/api/types/ToolCallInterruptedPayload.d.mts +0 -3
- package/dist/esm/api/types/ToolCallInterruptedPayload.mjs +1 -3
- package/dist/esm/api/types/ToolCallOutputPayload.d.mts +1 -4
- package/dist/esm/api/types/ToolCallOutputPayload.mjs +1 -3
- package/dist/esm/api/types/ToolCallOutputProcessedPayload.d.mts +14 -17
- package/dist/esm/api/types/ToolCallOutputProcessedPayload.mjs +1 -3
- package/dist/esm/api/types/ToolCallPayload.d.mts +0 -3
- package/dist/esm/api/types/ToolCallPayload.mjs +1 -3
- package/dist/esm/api/types/ToolParameter.d.mts +7 -14
- package/dist/esm/api/types/ToolParameter.mjs +10 -3
- package/dist/esm/api/types/UpdateSystemPromptPayload.d.mts +0 -3
- package/dist/esm/api/types/UpdateSystemPromptPayload.mjs +1 -3
- package/dist/esm/api/types/UserFinishedSpeakingPayload.d.mts +0 -3
- package/dist/esm/api/types/UserFinishedSpeakingPayload.mjs +1 -3
- package/dist/esm/api/types/UserStartedSpeakingPayload.d.mts +0 -3
- package/dist/esm/api/types/UserStartedSpeakingPayload.mjs +1 -3
- package/dist/esm/api/types/ValidationError.d.mts +0 -3
- package/dist/esm/api/types/ValidationError.mjs +1 -3
- package/dist/esm/api/types/Voice.d.mts +0 -3
- package/dist/esm/api/types/Voice.mjs +1 -3
- package/dist/esm/api/types/WarningPayload.d.mts +1 -4
- package/dist/esm/api/types/WarningPayload.mjs +1 -3
- package/dist/esm/api/types/index.d.mts +38 -38
- package/dist/esm/api/types/index.mjs +38 -38
- package/dist/esm/auth/BearerAuthProvider.d.mts +20 -0
- package/dist/esm/auth/BearerAuthProvider.mjs +45 -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 +5 -2
- package/dist/esm/core/auth/BasicAuth.mjs +2 -1
- package/dist/esm/core/auth/BearerToken.d.mts +3 -1
- package/dist/esm/core/auth/BearerToken.mjs +7 -6
- 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 +3 -2
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/exports.d.mts +2 -0
- package/dist/esm/core/exports.mjs +2 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +5 -6
- 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 +13 -5
- package/dist/esm/core/fetcher/Fetcher.mjs +213 -11
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +1 -1
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
- package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
- package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +21 -7
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +30 -13
- package/dist/esm/core/fetcher/requestWithRetries.mjs +3 -12
- package/dist/esm/core/fetcher/signals.d.mts +1 -7
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/headers.d.mts +2 -3
- package/dist/esm/core/headers.mjs +6 -4
- package/dist/esm/core/index.d.mts +3 -2
- package/dist/esm/core/index.mjs +3 -2
- 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/runtime.mjs +17 -15
- 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 +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/join.mjs +3 -4
- package/dist/esm/core/websocket/exports.d.mts +8 -0
- package/dist/esm/core/websocket/exports.mjs +1 -0
- package/dist/esm/core/websocket/ws.d.mts +14 -11
- package/dist/esm/core/websocket/ws.mjs +42 -29
- package/dist/esm/environments.d.mts +0 -3
- package/dist/esm/environments.mjs +1 -3
- package/dist/esm/errors/PhonicError.d.mts +1 -4
- package/dist/esm/errors/PhonicError.mjs +7 -5
- package/dist/esm/errors/PhonicTimeoutError.d.mts +0 -3
- package/dist/esm/errors/PhonicTimeoutError.mjs +6 -4
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/index.d.mts +4 -2
- package/dist/esm/index.mjs +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +92 -8
- package/reference.md +321 -329
package/reference.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
2
|
## Agents
|
|
4
|
-
|
|
5
3
|
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>({ ...params }) -> Phonic.AgentsListResponse</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
@@ -15,7 +13,6 @@
|
|
|
15
13
|
<dd>
|
|
16
14
|
|
|
17
15
|
Returns all agents in a project.
|
|
18
|
-
|
|
19
16
|
</dd>
|
|
20
17
|
</dl>
|
|
21
18
|
</dd>
|
|
@@ -31,8 +28,8 @@ Returns all agents in a project.
|
|
|
31
28
|
|
|
32
29
|
```typescript
|
|
33
30
|
await client.agents.list();
|
|
34
|
-
```
|
|
35
31
|
|
|
32
|
+
```
|
|
36
33
|
</dd>
|
|
37
34
|
</dl>
|
|
38
35
|
</dd>
|
|
@@ -46,21 +43,22 @@ await client.agents.list();
|
|
|
46
43
|
<dl>
|
|
47
44
|
<dd>
|
|
48
45
|
|
|
49
|
-
**request:** `Phonic.AgentsListRequest`
|
|
50
|
-
|
|
46
|
+
**request:** `Phonic.AgentsListRequest`
|
|
47
|
+
|
|
51
48
|
</dd>
|
|
52
49
|
</dl>
|
|
53
50
|
|
|
54
51
|
<dl>
|
|
55
52
|
<dd>
|
|
56
53
|
|
|
57
|
-
**requestOptions:** `
|
|
58
|
-
|
|
54
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
55
|
+
|
|
59
56
|
</dd>
|
|
60
57
|
</dl>
|
|
61
58
|
</dd>
|
|
62
59
|
</dl>
|
|
63
60
|
|
|
61
|
+
|
|
64
62
|
</dd>
|
|
65
63
|
</dl>
|
|
66
64
|
</details>
|
|
@@ -78,7 +76,6 @@ await client.agents.list();
|
|
|
78
76
|
<dd>
|
|
79
77
|
|
|
80
78
|
Creates a new agent in a project.
|
|
81
|
-
|
|
82
79
|
</dd>
|
|
83
80
|
</dl>
|
|
84
81
|
</dd>
|
|
@@ -105,29 +102,31 @@ await client.agents.create({
|
|
|
105
102
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
106
103
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
107
104
|
template_variables: {
|
|
108
|
-
customer_name: {
|
|
109
|
-
default_value: "David"
|
|
110
|
-
},
|
|
111
|
-
subject: {
|
|
112
|
-
default_value: "Chess",
|
|
105
|
+
"customer_name": {
|
|
106
|
+
default_value: "David"
|
|
113
107
|
},
|
|
108
|
+
"subject": {
|
|
109
|
+
default_value: "Chess"
|
|
110
|
+
}
|
|
114
111
|
},
|
|
115
112
|
tools: ["keypad_input"],
|
|
116
113
|
generate_no_input_poke_text: false,
|
|
117
114
|
no_input_poke_sec: 30,
|
|
118
115
|
no_input_poke_text: "Are you still there?",
|
|
119
|
-
|
|
116
|
+
default_language: "en",
|
|
117
|
+
additional_languages: ["es"],
|
|
118
|
+
multilingual_mode: "request",
|
|
120
119
|
boosted_keywords: ["Load ID", "dispatch"],
|
|
121
120
|
configuration_endpoint: {
|
|
122
121
|
url: "https://api.example.com/config",
|
|
123
122
|
headers: {
|
|
124
|
-
Authorization: "Bearer token123"
|
|
123
|
+
"Authorization": "Bearer token123"
|
|
125
124
|
},
|
|
126
|
-
timeout_ms: 7000
|
|
127
|
-
}
|
|
125
|
+
timeout_ms: 7000
|
|
126
|
+
}
|
|
128
127
|
});
|
|
129
|
-
```
|
|
130
128
|
|
|
129
|
+
```
|
|
131
130
|
</dd>
|
|
132
131
|
</dl>
|
|
133
132
|
</dd>
|
|
@@ -141,21 +140,22 @@ await client.agents.create({
|
|
|
141
140
|
<dl>
|
|
142
141
|
<dd>
|
|
143
142
|
|
|
144
|
-
**request:** `Phonic.AgentsCreateRequest`
|
|
145
|
-
|
|
143
|
+
**request:** `Phonic.AgentsCreateRequest`
|
|
144
|
+
|
|
146
145
|
</dd>
|
|
147
146
|
</dl>
|
|
148
147
|
|
|
149
148
|
<dl>
|
|
150
149
|
<dd>
|
|
151
150
|
|
|
152
|
-
**requestOptions:** `
|
|
153
|
-
|
|
151
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
152
|
+
|
|
154
153
|
</dd>
|
|
155
154
|
</dl>
|
|
156
155
|
</dd>
|
|
157
156
|
</dl>
|
|
158
157
|
|
|
158
|
+
|
|
159
159
|
</dd>
|
|
160
160
|
</dl>
|
|
161
161
|
</details>
|
|
@@ -173,7 +173,6 @@ await client.agents.create({
|
|
|
173
173
|
<dd>
|
|
174
174
|
|
|
175
175
|
Upserts an agent by name. If an agent with the same name already exists, it will be updated. Otherwise, it will be created.
|
|
176
|
-
|
|
177
176
|
</dd>
|
|
178
177
|
</dl>
|
|
179
178
|
</dd>
|
|
@@ -200,29 +199,31 @@ await client.agents.upsert({
|
|
|
200
199
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
201
200
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
202
201
|
template_variables: {
|
|
203
|
-
customer_name: {
|
|
204
|
-
default_value: "David"
|
|
205
|
-
},
|
|
206
|
-
subject: {
|
|
207
|
-
default_value: "Chess",
|
|
202
|
+
"customer_name": {
|
|
203
|
+
default_value: "David"
|
|
208
204
|
},
|
|
205
|
+
"subject": {
|
|
206
|
+
default_value: "Chess"
|
|
207
|
+
}
|
|
209
208
|
},
|
|
210
209
|
tools: ["keypad_input"],
|
|
211
210
|
generate_no_input_poke_text: false,
|
|
212
211
|
no_input_poke_sec: 30,
|
|
213
212
|
no_input_poke_text: "Are you still there?",
|
|
214
|
-
|
|
213
|
+
default_language: "en",
|
|
214
|
+
additional_languages: ["es"],
|
|
215
|
+
multilingual_mode: "request",
|
|
215
216
|
boosted_keywords: ["Load ID", "dispatch"],
|
|
216
217
|
configuration_endpoint: {
|
|
217
218
|
url: "https://api.example.com/config",
|
|
218
219
|
headers: {
|
|
219
|
-
Authorization: "Bearer token123"
|
|
220
|
+
"Authorization": "Bearer token123"
|
|
220
221
|
},
|
|
221
|
-
timeout_ms: 7000
|
|
222
|
-
}
|
|
222
|
+
timeout_ms: 7000
|
|
223
|
+
}
|
|
223
224
|
});
|
|
224
|
-
```
|
|
225
225
|
|
|
226
|
+
```
|
|
226
227
|
</dd>
|
|
227
228
|
</dl>
|
|
228
229
|
</dd>
|
|
@@ -236,21 +237,22 @@ await client.agents.upsert({
|
|
|
236
237
|
<dl>
|
|
237
238
|
<dd>
|
|
238
239
|
|
|
239
|
-
**request:** `Phonic.UpsertAgentRequest`
|
|
240
|
-
|
|
240
|
+
**request:** `Phonic.UpsertAgentRequest`
|
|
241
|
+
|
|
241
242
|
</dd>
|
|
242
243
|
</dl>
|
|
243
244
|
|
|
244
245
|
<dl>
|
|
245
246
|
<dd>
|
|
246
247
|
|
|
247
|
-
**requestOptions:** `
|
|
248
|
-
|
|
248
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
249
|
+
|
|
249
250
|
</dd>
|
|
250
251
|
</dl>
|
|
251
252
|
</dd>
|
|
252
253
|
</dl>
|
|
253
254
|
|
|
255
|
+
|
|
254
256
|
</dd>
|
|
255
257
|
</dl>
|
|
256
258
|
</details>
|
|
@@ -268,7 +270,6 @@ await client.agents.upsert({
|
|
|
268
270
|
<dd>
|
|
269
271
|
|
|
270
272
|
Returns an agent by name or ID.
|
|
271
|
-
|
|
272
273
|
</dd>
|
|
273
274
|
</dl>
|
|
274
275
|
</dd>
|
|
@@ -284,10 +285,10 @@ Returns an agent by name or ID.
|
|
|
284
285
|
|
|
285
286
|
```typescript
|
|
286
287
|
await client.agents.get("nameOrId", {
|
|
287
|
-
project: "main"
|
|
288
|
+
project: "main"
|
|
288
289
|
});
|
|
289
|
-
```
|
|
290
290
|
|
|
291
|
+
```
|
|
291
292
|
</dd>
|
|
292
293
|
</dl>
|
|
293
294
|
</dd>
|
|
@@ -302,28 +303,29 @@ await client.agents.get("nameOrId", {
|
|
|
302
303
|
<dd>
|
|
303
304
|
|
|
304
305
|
**nameOrId:** `string` — The name or the ID of the agent to get.
|
|
305
|
-
|
|
306
|
+
|
|
306
307
|
</dd>
|
|
307
308
|
</dl>
|
|
308
309
|
|
|
309
310
|
<dl>
|
|
310
311
|
<dd>
|
|
311
312
|
|
|
312
|
-
**request:** `Phonic.AgentsGetRequest`
|
|
313
|
-
|
|
313
|
+
**request:** `Phonic.AgentsGetRequest`
|
|
314
|
+
|
|
314
315
|
</dd>
|
|
315
316
|
</dl>
|
|
316
317
|
|
|
317
318
|
<dl>
|
|
318
319
|
<dd>
|
|
319
320
|
|
|
320
|
-
**requestOptions:** `
|
|
321
|
-
|
|
321
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
322
|
+
|
|
322
323
|
</dd>
|
|
323
324
|
</dl>
|
|
324
325
|
</dd>
|
|
325
326
|
</dl>
|
|
326
327
|
|
|
328
|
+
|
|
327
329
|
</dd>
|
|
328
330
|
</dl>
|
|
329
331
|
</details>
|
|
@@ -341,7 +343,6 @@ await client.agents.get("nameOrId", {
|
|
|
341
343
|
<dd>
|
|
342
344
|
|
|
343
345
|
Deletes an agent by name or ID.
|
|
344
|
-
|
|
345
346
|
</dd>
|
|
346
347
|
</dl>
|
|
347
348
|
</dd>
|
|
@@ -357,10 +358,10 @@ Deletes an agent by name or ID.
|
|
|
357
358
|
|
|
358
359
|
```typescript
|
|
359
360
|
await client.agents.delete("nameOrId", {
|
|
360
|
-
project: "main"
|
|
361
|
+
project: "main"
|
|
361
362
|
});
|
|
362
|
-
```
|
|
363
363
|
|
|
364
|
+
```
|
|
364
365
|
</dd>
|
|
365
366
|
</dl>
|
|
366
367
|
</dd>
|
|
@@ -375,28 +376,29 @@ await client.agents.delete("nameOrId", {
|
|
|
375
376
|
<dd>
|
|
376
377
|
|
|
377
378
|
**nameOrId:** `string` — The name or the ID of the agent to delete.
|
|
378
|
-
|
|
379
|
+
|
|
379
380
|
</dd>
|
|
380
381
|
</dl>
|
|
381
382
|
|
|
382
383
|
<dl>
|
|
383
384
|
<dd>
|
|
384
385
|
|
|
385
|
-
**request:** `Phonic.AgentsDeleteRequest`
|
|
386
|
-
|
|
386
|
+
**request:** `Phonic.AgentsDeleteRequest`
|
|
387
|
+
|
|
387
388
|
</dd>
|
|
388
389
|
</dl>
|
|
389
390
|
|
|
390
391
|
<dl>
|
|
391
392
|
<dd>
|
|
392
393
|
|
|
393
|
-
**requestOptions:** `
|
|
394
|
-
|
|
394
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
395
|
+
|
|
395
396
|
</dd>
|
|
396
397
|
</dl>
|
|
397
398
|
</dd>
|
|
398
399
|
</dl>
|
|
399
400
|
|
|
401
|
+
|
|
400
402
|
</dd>
|
|
401
403
|
</dl>
|
|
402
404
|
</details>
|
|
@@ -414,7 +416,6 @@ await client.agents.delete("nameOrId", {
|
|
|
414
416
|
<dd>
|
|
415
417
|
|
|
416
418
|
Updates an agent by name or ID.
|
|
417
|
-
|
|
418
419
|
</dd>
|
|
419
420
|
</dl>
|
|
420
421
|
</dd>
|
|
@@ -441,29 +442,31 @@ await client.agents.update("nameOrId", {
|
|
|
441
442
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
442
443
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
443
444
|
template_variables: {
|
|
444
|
-
customer_name: {
|
|
445
|
-
default_value: "David"
|
|
446
|
-
},
|
|
447
|
-
subject: {
|
|
448
|
-
default_value: "Chess",
|
|
445
|
+
"customer_name": {
|
|
446
|
+
default_value: "David"
|
|
449
447
|
},
|
|
448
|
+
"subject": {
|
|
449
|
+
default_value: "Chess"
|
|
450
|
+
}
|
|
450
451
|
},
|
|
451
452
|
tools: ["keypad_input"],
|
|
452
453
|
generate_no_input_poke_text: false,
|
|
453
454
|
no_input_poke_sec: 30,
|
|
454
455
|
no_input_poke_text: "Are you still there?",
|
|
455
|
-
|
|
456
|
+
default_language: "en",
|
|
457
|
+
additional_languages: ["es"],
|
|
458
|
+
multilingual_mode: "request",
|
|
456
459
|
boosted_keywords: ["Load ID", "dispatch"],
|
|
457
460
|
configuration_endpoint: {
|
|
458
461
|
url: "https://api.example.com/config",
|
|
459
462
|
headers: {
|
|
460
|
-
Authorization: "Bearer token123"
|
|
463
|
+
"Authorization": "Bearer token123"
|
|
461
464
|
},
|
|
462
|
-
timeout_ms: 7000
|
|
463
|
-
}
|
|
465
|
+
timeout_ms: 7000
|
|
466
|
+
}
|
|
464
467
|
});
|
|
465
|
-
```
|
|
466
468
|
|
|
469
|
+
```
|
|
467
470
|
</dd>
|
|
468
471
|
</dl>
|
|
469
472
|
</dd>
|
|
@@ -478,28 +481,29 @@ await client.agents.update("nameOrId", {
|
|
|
478
481
|
<dd>
|
|
479
482
|
|
|
480
483
|
**nameOrId:** `string` — The name or the ID of the agent to update.
|
|
481
|
-
|
|
484
|
+
|
|
482
485
|
</dd>
|
|
483
486
|
</dl>
|
|
484
487
|
|
|
485
488
|
<dl>
|
|
486
489
|
<dd>
|
|
487
490
|
|
|
488
|
-
**request:** `Phonic.UpdateAgentRequest`
|
|
489
|
-
|
|
491
|
+
**request:** `Phonic.UpdateAgentRequest`
|
|
492
|
+
|
|
490
493
|
</dd>
|
|
491
494
|
</dl>
|
|
492
495
|
|
|
493
496
|
<dl>
|
|
494
497
|
<dd>
|
|
495
498
|
|
|
496
|
-
**requestOptions:** `
|
|
497
|
-
|
|
499
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
500
|
+
|
|
498
501
|
</dd>
|
|
499
502
|
</dl>
|
|
500
503
|
</dd>
|
|
501
504
|
</dl>
|
|
502
505
|
|
|
506
|
+
|
|
503
507
|
</dd>
|
|
504
508
|
</dl>
|
|
505
509
|
</details>
|
|
@@ -517,7 +521,6 @@ await client.agents.update("nameOrId", {
|
|
|
517
521
|
<dd>
|
|
518
522
|
|
|
519
523
|
Adds a custom phone number to an agent. The user must configure their SIP trunk to point to Phonic's SIP server.
|
|
520
|
-
|
|
521
524
|
</dd>
|
|
522
525
|
</dl>
|
|
523
526
|
</dd>
|
|
@@ -538,13 +541,13 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
538
541
|
configuration_endpoint: {
|
|
539
542
|
url: "https://api.example.com/config",
|
|
540
543
|
headers: {
|
|
541
|
-
Authorization: "Bearer token123"
|
|
544
|
+
"Authorization": "Bearer token123"
|
|
542
545
|
},
|
|
543
|
-
timeout_ms: 7000
|
|
544
|
-
}
|
|
546
|
+
timeout_ms: 7000
|
|
547
|
+
}
|
|
545
548
|
});
|
|
546
|
-
```
|
|
547
549
|
|
|
550
|
+
```
|
|
548
551
|
</dd>
|
|
549
552
|
</dl>
|
|
550
553
|
</dd>
|
|
@@ -559,28 +562,29 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
559
562
|
<dd>
|
|
560
563
|
|
|
561
564
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
562
|
-
|
|
565
|
+
|
|
563
566
|
</dd>
|
|
564
567
|
</dl>
|
|
565
568
|
|
|
566
569
|
<dl>
|
|
567
570
|
<dd>
|
|
568
571
|
|
|
569
|
-
**request:** `Phonic.AgentsAddCustomPhoneNumberRequest`
|
|
570
|
-
|
|
572
|
+
**request:** `Phonic.AgentsAddCustomPhoneNumberRequest`
|
|
573
|
+
|
|
571
574
|
</dd>
|
|
572
575
|
</dl>
|
|
573
576
|
|
|
574
577
|
<dl>
|
|
575
578
|
<dd>
|
|
576
579
|
|
|
577
|
-
**requestOptions:** `
|
|
578
|
-
|
|
580
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
581
|
+
|
|
579
582
|
</dd>
|
|
580
583
|
</dl>
|
|
581
584
|
</dd>
|
|
582
585
|
</dl>
|
|
583
586
|
|
|
587
|
+
|
|
584
588
|
</dd>
|
|
585
589
|
</dl>
|
|
586
590
|
</details>
|
|
@@ -598,7 +602,6 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
598
602
|
<dd>
|
|
599
603
|
|
|
600
604
|
Deletes a custom phone number from an agent.
|
|
601
|
-
|
|
602
605
|
</dd>
|
|
603
606
|
</dl>
|
|
604
607
|
</dd>
|
|
@@ -615,10 +618,10 @@ Deletes a custom phone number from an agent.
|
|
|
615
618
|
```typescript
|
|
616
619
|
await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
617
620
|
project: "main",
|
|
618
|
-
phone_number: "+15551234567"
|
|
621
|
+
phone_number: "+15551234567"
|
|
619
622
|
});
|
|
620
|
-
```
|
|
621
623
|
|
|
624
|
+
```
|
|
622
625
|
</dd>
|
|
623
626
|
</dl>
|
|
624
627
|
</dd>
|
|
@@ -633,28 +636,29 @@ await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
|
633
636
|
<dd>
|
|
634
637
|
|
|
635
638
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
636
|
-
|
|
639
|
+
|
|
637
640
|
</dd>
|
|
638
641
|
</dl>
|
|
639
642
|
|
|
640
643
|
<dl>
|
|
641
644
|
<dd>
|
|
642
645
|
|
|
643
|
-
**request:** `Phonic.AgentsDeleteCustomPhoneNumberRequest`
|
|
644
|
-
|
|
646
|
+
**request:** `Phonic.AgentsDeleteCustomPhoneNumberRequest`
|
|
647
|
+
|
|
645
648
|
</dd>
|
|
646
649
|
</dl>
|
|
647
650
|
|
|
648
651
|
<dl>
|
|
649
652
|
<dd>
|
|
650
653
|
|
|
651
|
-
**requestOptions:** `
|
|
652
|
-
|
|
654
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
655
|
+
|
|
653
656
|
</dd>
|
|
654
657
|
</dl>
|
|
655
658
|
</dd>
|
|
656
659
|
</dl>
|
|
657
660
|
|
|
661
|
+
|
|
658
662
|
</dd>
|
|
659
663
|
</dl>
|
|
660
664
|
</details>
|
|
@@ -672,7 +676,6 @@ await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
|
672
676
|
<dd>
|
|
673
677
|
|
|
674
678
|
Updates a phone number on an agent.
|
|
675
|
-
|
|
676
679
|
</dd>
|
|
677
680
|
</dl>
|
|
678
681
|
</dd>
|
|
@@ -693,13 +696,13 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
693
696
|
configuration_endpoint: {
|
|
694
697
|
url: "https://api.example.com/config",
|
|
695
698
|
headers: {
|
|
696
|
-
Authorization: "Bearer token123"
|
|
699
|
+
"Authorization": "Bearer token123"
|
|
697
700
|
},
|
|
698
|
-
timeout_ms: 7000
|
|
699
|
-
}
|
|
701
|
+
timeout_ms: 7000
|
|
702
|
+
}
|
|
700
703
|
});
|
|
701
|
-
```
|
|
702
704
|
|
|
705
|
+
```
|
|
703
706
|
</dd>
|
|
704
707
|
</dl>
|
|
705
708
|
</dd>
|
|
@@ -714,34 +717,34 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
714
717
|
<dd>
|
|
715
718
|
|
|
716
719
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
717
|
-
|
|
720
|
+
|
|
718
721
|
</dd>
|
|
719
722
|
</dl>
|
|
720
723
|
|
|
721
724
|
<dl>
|
|
722
725
|
<dd>
|
|
723
726
|
|
|
724
|
-
**request:** `Phonic.AgentsUpdatePhoneNumberRequest`
|
|
725
|
-
|
|
727
|
+
**request:** `Phonic.AgentsUpdatePhoneNumberRequest`
|
|
728
|
+
|
|
726
729
|
</dd>
|
|
727
730
|
</dl>
|
|
728
731
|
|
|
729
732
|
<dl>
|
|
730
733
|
<dd>
|
|
731
734
|
|
|
732
|
-
**requestOptions:** `
|
|
733
|
-
|
|
735
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
736
|
+
|
|
734
737
|
</dd>
|
|
735
738
|
</dl>
|
|
736
739
|
</dd>
|
|
737
740
|
</dl>
|
|
738
741
|
|
|
742
|
+
|
|
739
743
|
</dd>
|
|
740
744
|
</dl>
|
|
741
745
|
</details>
|
|
742
746
|
|
|
743
747
|
## Tools
|
|
744
|
-
|
|
745
748
|
<details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">list</a>({ ...params }) -> Phonic.ToolsListResponse</code></summary>
|
|
746
749
|
<dl>
|
|
747
750
|
<dd>
|
|
@@ -755,7 +758,6 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
755
758
|
<dd>
|
|
756
759
|
|
|
757
760
|
Returns all custom tools for the organization.
|
|
758
|
-
|
|
759
761
|
</dd>
|
|
760
762
|
</dl>
|
|
761
763
|
</dd>
|
|
@@ -771,10 +773,10 @@ Returns all custom tools for the organization.
|
|
|
771
773
|
|
|
772
774
|
```typescript
|
|
773
775
|
await client.tools.list({
|
|
774
|
-
project: "main"
|
|
776
|
+
project: "main"
|
|
775
777
|
});
|
|
776
|
-
```
|
|
777
778
|
|
|
779
|
+
```
|
|
778
780
|
</dd>
|
|
779
781
|
</dl>
|
|
780
782
|
</dd>
|
|
@@ -788,21 +790,22 @@ await client.tools.list({
|
|
|
788
790
|
<dl>
|
|
789
791
|
<dd>
|
|
790
792
|
|
|
791
|
-
**request:** `Phonic.ToolsListRequest`
|
|
792
|
-
|
|
793
|
+
**request:** `Phonic.ToolsListRequest`
|
|
794
|
+
|
|
793
795
|
</dd>
|
|
794
796
|
</dl>
|
|
795
797
|
|
|
796
798
|
<dl>
|
|
797
799
|
<dd>
|
|
798
800
|
|
|
799
|
-
**requestOptions:** `
|
|
800
|
-
|
|
801
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
802
|
+
|
|
801
803
|
</dd>
|
|
802
804
|
</dl>
|
|
803
805
|
</dd>
|
|
804
806
|
</dl>
|
|
805
807
|
|
|
808
|
+
|
|
806
809
|
</dd>
|
|
807
810
|
</dl>
|
|
808
811
|
</details>
|
|
@@ -820,7 +823,6 @@ await client.tools.list({
|
|
|
820
823
|
<dd>
|
|
821
824
|
|
|
822
825
|
Creates a new tool in a project.
|
|
823
|
-
|
|
824
826
|
</dd>
|
|
825
827
|
</dl>
|
|
826
828
|
</dd>
|
|
@@ -841,20 +843,18 @@ await client.tools.create({
|
|
|
841
843
|
description: "Gets the specific context for fixing our printer",
|
|
842
844
|
type: "custom_context",
|
|
843
845
|
execution_mode: "sync",
|
|
844
|
-
parameters: [
|
|
845
|
-
{
|
|
846
|
+
parameters: [{
|
|
846
847
|
type: "string",
|
|
847
848
|
name: "name",
|
|
848
849
|
description: "description",
|
|
849
|
-
is_required: true
|
|
850
|
-
},
|
|
851
|
-
],
|
|
850
|
+
is_required: true
|
|
851
|
+
}],
|
|
852
852
|
require_speech_before_tool_call: false,
|
|
853
853
|
forbid_speech_after_tool_call: false,
|
|
854
|
-
allow_tool_chaining: true
|
|
854
|
+
allow_tool_chaining: true
|
|
855
855
|
});
|
|
856
|
-
```
|
|
857
856
|
|
|
857
|
+
```
|
|
858
858
|
</dd>
|
|
859
859
|
</dl>
|
|
860
860
|
</dd>
|
|
@@ -868,21 +868,22 @@ await client.tools.create({
|
|
|
868
868
|
<dl>
|
|
869
869
|
<dd>
|
|
870
870
|
|
|
871
|
-
**request:** `Phonic.CreateToolRequest`
|
|
872
|
-
|
|
871
|
+
**request:** `Phonic.CreateToolRequest`
|
|
872
|
+
|
|
873
873
|
</dd>
|
|
874
874
|
</dl>
|
|
875
875
|
|
|
876
876
|
<dl>
|
|
877
877
|
<dd>
|
|
878
878
|
|
|
879
|
-
**requestOptions:** `
|
|
880
|
-
|
|
879
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
880
|
+
|
|
881
881
|
</dd>
|
|
882
882
|
</dl>
|
|
883
883
|
</dd>
|
|
884
884
|
</dl>
|
|
885
885
|
|
|
886
|
+
|
|
886
887
|
</dd>
|
|
887
888
|
</dl>
|
|
888
889
|
</details>
|
|
@@ -900,7 +901,6 @@ await client.tools.create({
|
|
|
900
901
|
<dd>
|
|
901
902
|
|
|
902
903
|
Returns a tool by name or ID.
|
|
903
|
-
|
|
904
904
|
</dd>
|
|
905
905
|
</dl>
|
|
906
906
|
</dd>
|
|
@@ -916,10 +916,10 @@ Returns a tool by name or ID.
|
|
|
916
916
|
|
|
917
917
|
```typescript
|
|
918
918
|
await client.tools.get("nameOrId", {
|
|
919
|
-
project: "main"
|
|
919
|
+
project: "main"
|
|
920
920
|
});
|
|
921
|
-
```
|
|
922
921
|
|
|
922
|
+
```
|
|
923
923
|
</dd>
|
|
924
924
|
</dl>
|
|
925
925
|
</dd>
|
|
@@ -934,28 +934,29 @@ await client.tools.get("nameOrId", {
|
|
|
934
934
|
<dd>
|
|
935
935
|
|
|
936
936
|
**nameOrId:** `string` — The name or the ID of the tool to get.
|
|
937
|
-
|
|
937
|
+
|
|
938
938
|
</dd>
|
|
939
939
|
</dl>
|
|
940
940
|
|
|
941
941
|
<dl>
|
|
942
942
|
<dd>
|
|
943
943
|
|
|
944
|
-
**request:** `Phonic.ToolsGetRequest`
|
|
945
|
-
|
|
944
|
+
**request:** `Phonic.ToolsGetRequest`
|
|
945
|
+
|
|
946
946
|
</dd>
|
|
947
947
|
</dl>
|
|
948
948
|
|
|
949
949
|
<dl>
|
|
950
950
|
<dd>
|
|
951
951
|
|
|
952
|
-
**requestOptions:** `
|
|
953
|
-
|
|
952
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
953
|
+
|
|
954
954
|
</dd>
|
|
955
955
|
</dl>
|
|
956
956
|
</dd>
|
|
957
957
|
</dl>
|
|
958
958
|
|
|
959
|
+
|
|
959
960
|
</dd>
|
|
960
961
|
</dl>
|
|
961
962
|
</details>
|
|
@@ -973,7 +974,6 @@ await client.tools.get("nameOrId", {
|
|
|
973
974
|
<dd>
|
|
974
975
|
|
|
975
976
|
Deletes a tool by name or ID.
|
|
976
|
-
|
|
977
977
|
</dd>
|
|
978
978
|
</dl>
|
|
979
979
|
</dd>
|
|
@@ -989,10 +989,10 @@ Deletes a tool by name or ID.
|
|
|
989
989
|
|
|
990
990
|
```typescript
|
|
991
991
|
await client.tools.delete("nameOrId", {
|
|
992
|
-
project: "main"
|
|
992
|
+
project: "main"
|
|
993
993
|
});
|
|
994
|
-
```
|
|
995
994
|
|
|
995
|
+
```
|
|
996
996
|
</dd>
|
|
997
997
|
</dl>
|
|
998
998
|
</dd>
|
|
@@ -1007,28 +1007,29 @@ await client.tools.delete("nameOrId", {
|
|
|
1007
1007
|
<dd>
|
|
1008
1008
|
|
|
1009
1009
|
**nameOrId:** `string` — The name or the ID of the tool to delete.
|
|
1010
|
-
|
|
1010
|
+
|
|
1011
1011
|
</dd>
|
|
1012
1012
|
</dl>
|
|
1013
1013
|
|
|
1014
1014
|
<dl>
|
|
1015
1015
|
<dd>
|
|
1016
1016
|
|
|
1017
|
-
**request:** `Phonic.ToolsDeleteRequest`
|
|
1018
|
-
|
|
1017
|
+
**request:** `Phonic.ToolsDeleteRequest`
|
|
1018
|
+
|
|
1019
1019
|
</dd>
|
|
1020
1020
|
</dl>
|
|
1021
1021
|
|
|
1022
1022
|
<dl>
|
|
1023
1023
|
<dd>
|
|
1024
1024
|
|
|
1025
|
-
**requestOptions:** `
|
|
1026
|
-
|
|
1025
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1026
|
+
|
|
1027
1027
|
</dd>
|
|
1028
1028
|
</dl>
|
|
1029
1029
|
</dd>
|
|
1030
1030
|
</dl>
|
|
1031
1031
|
|
|
1032
|
+
|
|
1032
1033
|
</dd>
|
|
1033
1034
|
</dl>
|
|
1034
1035
|
</details>
|
|
@@ -1046,7 +1047,6 @@ await client.tools.delete("nameOrId", {
|
|
|
1046
1047
|
<dd>
|
|
1047
1048
|
|
|
1048
1049
|
Updates a tool by name or ID.
|
|
1049
|
-
|
|
1050
1050
|
</dd>
|
|
1051
1051
|
</dl>
|
|
1052
1052
|
</dd>
|
|
@@ -1065,12 +1065,12 @@ await client.tools.update("nameOrId", {
|
|
|
1065
1065
|
project: "main",
|
|
1066
1066
|
description: "Updated description for booking appointments with enhanced features",
|
|
1067
1067
|
endpoint_headers: {
|
|
1068
|
-
Authorization: "Bearer updated_token456"
|
|
1068
|
+
"Authorization": "Bearer updated_token456"
|
|
1069
1069
|
},
|
|
1070
|
-
endpoint_timeout_ms: 7000
|
|
1070
|
+
endpoint_timeout_ms: 7000
|
|
1071
1071
|
});
|
|
1072
|
-
```
|
|
1073
1072
|
|
|
1073
|
+
```
|
|
1074
1074
|
</dd>
|
|
1075
1075
|
</dl>
|
|
1076
1076
|
</dd>
|
|
@@ -1085,34 +1085,34 @@ await client.tools.update("nameOrId", {
|
|
|
1085
1085
|
<dd>
|
|
1086
1086
|
|
|
1087
1087
|
**nameOrId:** `string` — The name or the ID of the tool to update.
|
|
1088
|
-
|
|
1088
|
+
|
|
1089
1089
|
</dd>
|
|
1090
1090
|
</dl>
|
|
1091
1091
|
|
|
1092
1092
|
<dl>
|
|
1093
1093
|
<dd>
|
|
1094
1094
|
|
|
1095
|
-
**request:** `Phonic.UpdateToolRequest`
|
|
1096
|
-
|
|
1095
|
+
**request:** `Phonic.UpdateToolRequest`
|
|
1096
|
+
|
|
1097
1097
|
</dd>
|
|
1098
1098
|
</dl>
|
|
1099
1099
|
|
|
1100
1100
|
<dl>
|
|
1101
1101
|
<dd>
|
|
1102
1102
|
|
|
1103
|
-
**requestOptions:** `
|
|
1104
|
-
|
|
1103
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1104
|
+
|
|
1105
1105
|
</dd>
|
|
1106
1106
|
</dl>
|
|
1107
1107
|
</dd>
|
|
1108
1108
|
</dl>
|
|
1109
1109
|
|
|
1110
|
+
|
|
1110
1111
|
</dd>
|
|
1111
1112
|
</dl>
|
|
1112
1113
|
</details>
|
|
1113
1114
|
|
|
1114
1115
|
## ExtractionSchemas
|
|
1115
|
-
|
|
1116
1116
|
<details><summary><code>client.extractionSchemas.<a href="/src/api/resources/extractionSchemas/client/Client.ts">list</a>({ ...params }) -> Phonic.ExtractionSchemasListResponse</code></summary>
|
|
1117
1117
|
<dl>
|
|
1118
1118
|
<dd>
|
|
@@ -1126,7 +1126,6 @@ await client.tools.update("nameOrId", {
|
|
|
1126
1126
|
<dd>
|
|
1127
1127
|
|
|
1128
1128
|
Returns all extraction schemas in a project.
|
|
1129
|
-
|
|
1130
1129
|
</dd>
|
|
1131
1130
|
</dl>
|
|
1132
1131
|
</dd>
|
|
@@ -1142,10 +1141,10 @@ Returns all extraction schemas in a project.
|
|
|
1142
1141
|
|
|
1143
1142
|
```typescript
|
|
1144
1143
|
await client.extractionSchemas.list({
|
|
1145
|
-
project: "main"
|
|
1144
|
+
project: "main"
|
|
1146
1145
|
});
|
|
1147
|
-
```
|
|
1148
1146
|
|
|
1147
|
+
```
|
|
1149
1148
|
</dd>
|
|
1150
1149
|
</dl>
|
|
1151
1150
|
</dd>
|
|
@@ -1159,21 +1158,22 @@ await client.extractionSchemas.list({
|
|
|
1159
1158
|
<dl>
|
|
1160
1159
|
<dd>
|
|
1161
1160
|
|
|
1162
|
-
**request:** `Phonic.ExtractionSchemasListRequest`
|
|
1163
|
-
|
|
1161
|
+
**request:** `Phonic.ExtractionSchemasListRequest`
|
|
1162
|
+
|
|
1164
1163
|
</dd>
|
|
1165
1164
|
</dl>
|
|
1166
1165
|
|
|
1167
1166
|
<dl>
|
|
1168
1167
|
<dd>
|
|
1169
1168
|
|
|
1170
|
-
**requestOptions:** `
|
|
1171
|
-
|
|
1169
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1170
|
+
|
|
1172
1171
|
</dd>
|
|
1173
1172
|
</dl>
|
|
1174
1173
|
</dd>
|
|
1175
1174
|
</dl>
|
|
1176
1175
|
|
|
1176
|
+
|
|
1177
1177
|
</dd>
|
|
1178
1178
|
</dl>
|
|
1179
1179
|
</details>
|
|
@@ -1191,7 +1191,6 @@ await client.extractionSchemas.list({
|
|
|
1191
1191
|
<dd>
|
|
1192
1192
|
|
|
1193
1193
|
Creates a new extraction schema in a project.
|
|
1194
|
-
|
|
1195
1194
|
</dd>
|
|
1196
1195
|
</dl>
|
|
1197
1196
|
</dd>
|
|
@@ -1210,26 +1209,22 @@ await client.extractionSchemas.create({
|
|
|
1210
1209
|
project: "main",
|
|
1211
1210
|
name: "Appointment details",
|
|
1212
1211
|
prompt: "Dates should be in `9 Apr 2025` format. Prices should be in $150.00 format.",
|
|
1213
|
-
fields: [
|
|
1214
|
-
{
|
|
1212
|
+
fields: [{
|
|
1215
1213
|
name: "Date",
|
|
1216
1214
|
type: "string",
|
|
1217
|
-
description: "The date of the appointment"
|
|
1218
|
-
},
|
|
1219
|
-
{
|
|
1215
|
+
description: "The date of the appointment"
|
|
1216
|
+
}, {
|
|
1220
1217
|
name: "Copay",
|
|
1221
1218
|
type: "string",
|
|
1222
|
-
description: "Amount of money the patient pays for the appointment"
|
|
1223
|
-
},
|
|
1224
|
-
{
|
|
1219
|
+
description: "Amount of money the patient pays for the appointment"
|
|
1220
|
+
}, {
|
|
1225
1221
|
name: "Confirmed as booked",
|
|
1226
1222
|
type: "bool",
|
|
1227
|
-
description: "Is the appointment confirmed as booked?"
|
|
1228
|
-
}
|
|
1229
|
-
],
|
|
1223
|
+
description: "Is the appointment confirmed as booked?"
|
|
1224
|
+
}]
|
|
1230
1225
|
});
|
|
1231
|
-
```
|
|
1232
1226
|
|
|
1227
|
+
```
|
|
1233
1228
|
</dd>
|
|
1234
1229
|
</dl>
|
|
1235
1230
|
</dd>
|
|
@@ -1243,21 +1238,22 @@ await client.extractionSchemas.create({
|
|
|
1243
1238
|
<dl>
|
|
1244
1239
|
<dd>
|
|
1245
1240
|
|
|
1246
|
-
**request:** `Phonic.CreateExtractionSchemaRequest`
|
|
1247
|
-
|
|
1241
|
+
**request:** `Phonic.CreateExtractionSchemaRequest`
|
|
1242
|
+
|
|
1248
1243
|
</dd>
|
|
1249
1244
|
</dl>
|
|
1250
1245
|
|
|
1251
1246
|
<dl>
|
|
1252
1247
|
<dd>
|
|
1253
1248
|
|
|
1254
|
-
**requestOptions:** `
|
|
1255
|
-
|
|
1249
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1250
|
+
|
|
1256
1251
|
</dd>
|
|
1257
1252
|
</dl>
|
|
1258
1253
|
</dd>
|
|
1259
1254
|
</dl>
|
|
1260
1255
|
|
|
1256
|
+
|
|
1261
1257
|
</dd>
|
|
1262
1258
|
</dl>
|
|
1263
1259
|
</details>
|
|
@@ -1275,7 +1271,6 @@ await client.extractionSchemas.create({
|
|
|
1275
1271
|
<dd>
|
|
1276
1272
|
|
|
1277
1273
|
Returns an extraction schema by name or ID.
|
|
1278
|
-
|
|
1279
1274
|
</dd>
|
|
1280
1275
|
</dl>
|
|
1281
1276
|
</dd>
|
|
@@ -1291,10 +1286,10 @@ Returns an extraction schema by name or ID.
|
|
|
1291
1286
|
|
|
1292
1287
|
```typescript
|
|
1293
1288
|
await client.extractionSchemas.get("nameOrId", {
|
|
1294
|
-
project: "main"
|
|
1289
|
+
project: "main"
|
|
1295
1290
|
});
|
|
1296
|
-
```
|
|
1297
1291
|
|
|
1292
|
+
```
|
|
1298
1293
|
</dd>
|
|
1299
1294
|
</dl>
|
|
1300
1295
|
</dd>
|
|
@@ -1309,28 +1304,29 @@ await client.extractionSchemas.get("nameOrId", {
|
|
|
1309
1304
|
<dd>
|
|
1310
1305
|
|
|
1311
1306
|
**nameOrId:** `string` — The name or the ID of the extraction schema to get.
|
|
1312
|
-
|
|
1307
|
+
|
|
1313
1308
|
</dd>
|
|
1314
1309
|
</dl>
|
|
1315
1310
|
|
|
1316
1311
|
<dl>
|
|
1317
1312
|
<dd>
|
|
1318
1313
|
|
|
1319
|
-
**request:** `Phonic.ExtractionSchemasGetRequest`
|
|
1320
|
-
|
|
1314
|
+
**request:** `Phonic.ExtractionSchemasGetRequest`
|
|
1315
|
+
|
|
1321
1316
|
</dd>
|
|
1322
1317
|
</dl>
|
|
1323
1318
|
|
|
1324
1319
|
<dl>
|
|
1325
1320
|
<dd>
|
|
1326
1321
|
|
|
1327
|
-
**requestOptions:** `
|
|
1328
|
-
|
|
1322
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1323
|
+
|
|
1329
1324
|
</dd>
|
|
1330
1325
|
</dl>
|
|
1331
1326
|
</dd>
|
|
1332
1327
|
</dl>
|
|
1333
1328
|
|
|
1329
|
+
|
|
1334
1330
|
</dd>
|
|
1335
1331
|
</dl>
|
|
1336
1332
|
</details>
|
|
@@ -1348,7 +1344,6 @@ await client.extractionSchemas.get("nameOrId", {
|
|
|
1348
1344
|
<dd>
|
|
1349
1345
|
|
|
1350
1346
|
Deletes an extraction schema by name or ID.
|
|
1351
|
-
|
|
1352
1347
|
</dd>
|
|
1353
1348
|
</dl>
|
|
1354
1349
|
</dd>
|
|
@@ -1364,10 +1359,10 @@ Deletes an extraction schema by name or ID.
|
|
|
1364
1359
|
|
|
1365
1360
|
```typescript
|
|
1366
1361
|
await client.extractionSchemas.delete("nameOrId", {
|
|
1367
|
-
project: "main"
|
|
1362
|
+
project: "main"
|
|
1368
1363
|
});
|
|
1369
|
-
```
|
|
1370
1364
|
|
|
1365
|
+
```
|
|
1371
1366
|
</dd>
|
|
1372
1367
|
</dl>
|
|
1373
1368
|
</dd>
|
|
@@ -1382,28 +1377,29 @@ await client.extractionSchemas.delete("nameOrId", {
|
|
|
1382
1377
|
<dd>
|
|
1383
1378
|
|
|
1384
1379
|
**nameOrId:** `string` — The name or the ID of the extraction schema to delete.
|
|
1385
|
-
|
|
1380
|
+
|
|
1386
1381
|
</dd>
|
|
1387
1382
|
</dl>
|
|
1388
1383
|
|
|
1389
1384
|
<dl>
|
|
1390
1385
|
<dd>
|
|
1391
1386
|
|
|
1392
|
-
**request:** `Phonic.ExtractionSchemasDeleteRequest`
|
|
1393
|
-
|
|
1387
|
+
**request:** `Phonic.ExtractionSchemasDeleteRequest`
|
|
1388
|
+
|
|
1394
1389
|
</dd>
|
|
1395
1390
|
</dl>
|
|
1396
1391
|
|
|
1397
1392
|
<dl>
|
|
1398
1393
|
<dd>
|
|
1399
1394
|
|
|
1400
|
-
**requestOptions:** `
|
|
1401
|
-
|
|
1395
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1396
|
+
|
|
1402
1397
|
</dd>
|
|
1403
1398
|
</dl>
|
|
1404
1399
|
</dd>
|
|
1405
1400
|
</dl>
|
|
1406
1401
|
|
|
1402
|
+
|
|
1407
1403
|
</dd>
|
|
1408
1404
|
</dl>
|
|
1409
1405
|
</details>
|
|
@@ -1421,7 +1417,6 @@ await client.extractionSchemas.delete("nameOrId", {
|
|
|
1421
1417
|
<dd>
|
|
1422
1418
|
|
|
1423
1419
|
Updates an extraction schema by name or ID.
|
|
1424
|
-
|
|
1425
1420
|
</dd>
|
|
1426
1421
|
</dl>
|
|
1427
1422
|
</dd>
|
|
@@ -1440,21 +1435,18 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1440
1435
|
project: "main",
|
|
1441
1436
|
name: "Updated appointment details",
|
|
1442
1437
|
prompt: "Updated extraction instructions. Dates should be in `9 Apr 2025` format.",
|
|
1443
|
-
fields: [
|
|
1444
|
-
{
|
|
1438
|
+
fields: [{
|
|
1445
1439
|
name: "Date",
|
|
1446
1440
|
type: "string",
|
|
1447
|
-
description: "The date of the appointment"
|
|
1448
|
-
},
|
|
1449
|
-
{
|
|
1441
|
+
description: "The date of the appointment"
|
|
1442
|
+
}, {
|
|
1450
1443
|
name: "Time",
|
|
1451
1444
|
type: "string",
|
|
1452
|
-
description: "The time of the appointment"
|
|
1453
|
-
}
|
|
1454
|
-
],
|
|
1445
|
+
description: "The time of the appointment"
|
|
1446
|
+
}]
|
|
1455
1447
|
});
|
|
1456
|
-
```
|
|
1457
1448
|
|
|
1449
|
+
```
|
|
1458
1450
|
</dd>
|
|
1459
1451
|
</dl>
|
|
1460
1452
|
</dd>
|
|
@@ -1469,34 +1461,34 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1469
1461
|
<dd>
|
|
1470
1462
|
|
|
1471
1463
|
**nameOrId:** `string` — The name or the ID of the extraction schema to update.
|
|
1472
|
-
|
|
1464
|
+
|
|
1473
1465
|
</dd>
|
|
1474
1466
|
</dl>
|
|
1475
1467
|
|
|
1476
1468
|
<dl>
|
|
1477
1469
|
<dd>
|
|
1478
1470
|
|
|
1479
|
-
**request:** `Phonic.UpdateExtractionSchemaRequest`
|
|
1480
|
-
|
|
1471
|
+
**request:** `Phonic.UpdateExtractionSchemaRequest`
|
|
1472
|
+
|
|
1481
1473
|
</dd>
|
|
1482
1474
|
</dl>
|
|
1483
1475
|
|
|
1484
1476
|
<dl>
|
|
1485
1477
|
<dd>
|
|
1486
1478
|
|
|
1487
|
-
**requestOptions:** `
|
|
1488
|
-
|
|
1479
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1480
|
+
|
|
1489
1481
|
</dd>
|
|
1490
1482
|
</dl>
|
|
1491
1483
|
</dd>
|
|
1492
1484
|
</dl>
|
|
1493
1485
|
|
|
1486
|
+
|
|
1494
1487
|
</dd>
|
|
1495
1488
|
</dl>
|
|
1496
1489
|
</details>
|
|
1497
1490
|
|
|
1498
1491
|
## Voices
|
|
1499
|
-
|
|
1500
1492
|
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">list</a>({ ...params }) -> Phonic.VoicesListResponse</code></summary>
|
|
1501
1493
|
<dl>
|
|
1502
1494
|
<dd>
|
|
@@ -1510,7 +1502,6 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1510
1502
|
<dd>
|
|
1511
1503
|
|
|
1512
1504
|
Returns all available voices for a model.
|
|
1513
|
-
|
|
1514
1505
|
</dd>
|
|
1515
1506
|
</dl>
|
|
1516
1507
|
</dd>
|
|
@@ -1526,10 +1517,10 @@ Returns all available voices for a model.
|
|
|
1526
1517
|
|
|
1527
1518
|
```typescript
|
|
1528
1519
|
await client.voices.list({
|
|
1529
|
-
model: "merritt"
|
|
1520
|
+
model: "merritt"
|
|
1530
1521
|
});
|
|
1531
|
-
```
|
|
1532
1522
|
|
|
1523
|
+
```
|
|
1533
1524
|
</dd>
|
|
1534
1525
|
</dl>
|
|
1535
1526
|
</dd>
|
|
@@ -1543,21 +1534,22 @@ await client.voices.list({
|
|
|
1543
1534
|
<dl>
|
|
1544
1535
|
<dd>
|
|
1545
1536
|
|
|
1546
|
-
**request:** `Phonic.VoicesListRequest`
|
|
1547
|
-
|
|
1537
|
+
**request:** `Phonic.VoicesListRequest`
|
|
1538
|
+
|
|
1548
1539
|
</dd>
|
|
1549
1540
|
</dl>
|
|
1550
1541
|
|
|
1551
1542
|
<dl>
|
|
1552
1543
|
<dd>
|
|
1553
1544
|
|
|
1554
|
-
**requestOptions:** `
|
|
1555
|
-
|
|
1545
|
+
**requestOptions:** `VoicesClient.RequestOptions`
|
|
1546
|
+
|
|
1556
1547
|
</dd>
|
|
1557
1548
|
</dl>
|
|
1558
1549
|
</dd>
|
|
1559
1550
|
</dl>
|
|
1560
1551
|
|
|
1552
|
+
|
|
1561
1553
|
</dd>
|
|
1562
1554
|
</dl>
|
|
1563
1555
|
</details>
|
|
@@ -1575,7 +1567,6 @@ await client.voices.list({
|
|
|
1575
1567
|
<dd>
|
|
1576
1568
|
|
|
1577
1569
|
Returns a voice by ID.
|
|
1578
|
-
|
|
1579
1570
|
</dd>
|
|
1580
1571
|
</dl>
|
|
1581
1572
|
</dd>
|
|
@@ -1591,8 +1582,8 @@ Returns a voice by ID.
|
|
|
1591
1582
|
|
|
1592
1583
|
```typescript
|
|
1593
1584
|
await client.voices.get("id");
|
|
1594
|
-
```
|
|
1595
1585
|
|
|
1586
|
+
```
|
|
1596
1587
|
</dd>
|
|
1597
1588
|
</dl>
|
|
1598
1589
|
</dd>
|
|
@@ -1607,26 +1598,26 @@ await client.voices.get("id");
|
|
|
1607
1598
|
<dd>
|
|
1608
1599
|
|
|
1609
1600
|
**id:** `string` — The ID of the voice to get.
|
|
1610
|
-
|
|
1601
|
+
|
|
1611
1602
|
</dd>
|
|
1612
1603
|
</dl>
|
|
1613
1604
|
|
|
1614
1605
|
<dl>
|
|
1615
1606
|
<dd>
|
|
1616
1607
|
|
|
1617
|
-
**requestOptions:** `
|
|
1618
|
-
|
|
1608
|
+
**requestOptions:** `VoicesClient.RequestOptions`
|
|
1609
|
+
|
|
1619
1610
|
</dd>
|
|
1620
1611
|
</dl>
|
|
1621
1612
|
</dd>
|
|
1622
1613
|
</dl>
|
|
1623
1614
|
|
|
1615
|
+
|
|
1624
1616
|
</dd>
|
|
1625
1617
|
</dl>
|
|
1626
1618
|
</details>
|
|
1627
1619
|
|
|
1628
1620
|
## Conversations
|
|
1629
|
-
|
|
1630
1621
|
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">list</a>({ ...params }) -> Phonic.ConversationsListResponse</code></summary>
|
|
1631
1622
|
<dl>
|
|
1632
1623
|
<dd>
|
|
@@ -1640,7 +1631,6 @@ await client.voices.get("id");
|
|
|
1640
1631
|
<dd>
|
|
1641
1632
|
|
|
1642
1633
|
Returns conversations with optional filtering.
|
|
1643
|
-
|
|
1644
1634
|
</dd>
|
|
1645
1635
|
</dl>
|
|
1646
1636
|
</dd>
|
|
@@ -1656,8 +1646,8 @@ Returns conversations with optional filtering.
|
|
|
1656
1646
|
|
|
1657
1647
|
```typescript
|
|
1658
1648
|
await client.conversations.list();
|
|
1659
|
-
```
|
|
1660
1649
|
|
|
1650
|
+
```
|
|
1661
1651
|
</dd>
|
|
1662
1652
|
</dl>
|
|
1663
1653
|
</dd>
|
|
@@ -1671,21 +1661,22 @@ await client.conversations.list();
|
|
|
1671
1661
|
<dl>
|
|
1672
1662
|
<dd>
|
|
1673
1663
|
|
|
1674
|
-
**request:** `Phonic.ConversationsListRequest`
|
|
1675
|
-
|
|
1664
|
+
**request:** `Phonic.ConversationsListRequest`
|
|
1665
|
+
|
|
1676
1666
|
</dd>
|
|
1677
1667
|
</dl>
|
|
1678
1668
|
|
|
1679
1669
|
<dl>
|
|
1680
1670
|
<dd>
|
|
1681
1671
|
|
|
1682
|
-
**requestOptions:** `
|
|
1683
|
-
|
|
1672
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1673
|
+
|
|
1684
1674
|
</dd>
|
|
1685
1675
|
</dl>
|
|
1686
1676
|
</dd>
|
|
1687
1677
|
</dl>
|
|
1688
1678
|
|
|
1679
|
+
|
|
1689
1680
|
</dd>
|
|
1690
1681
|
</dl>
|
|
1691
1682
|
</details>
|
|
@@ -1703,7 +1694,6 @@ await client.conversations.list();
|
|
|
1703
1694
|
<dd>
|
|
1704
1695
|
|
|
1705
1696
|
Returns a conversation by ID.
|
|
1706
|
-
|
|
1707
1697
|
</dd>
|
|
1708
1698
|
</dl>
|
|
1709
1699
|
</dd>
|
|
@@ -1719,8 +1709,8 @@ Returns a conversation by ID.
|
|
|
1719
1709
|
|
|
1720
1710
|
```typescript
|
|
1721
1711
|
await client.conversations.get("id");
|
|
1722
|
-
```
|
|
1723
1712
|
|
|
1713
|
+
```
|
|
1724
1714
|
</dd>
|
|
1725
1715
|
</dl>
|
|
1726
1716
|
</dd>
|
|
@@ -1735,20 +1725,21 @@ await client.conversations.get("id");
|
|
|
1735
1725
|
<dd>
|
|
1736
1726
|
|
|
1737
1727
|
**id:** `string` — The ID of the conversation to get.
|
|
1738
|
-
|
|
1728
|
+
|
|
1739
1729
|
</dd>
|
|
1740
1730
|
</dl>
|
|
1741
1731
|
|
|
1742
1732
|
<dl>
|
|
1743
1733
|
<dd>
|
|
1744
1734
|
|
|
1745
|
-
**requestOptions:** `
|
|
1746
|
-
|
|
1735
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1736
|
+
|
|
1747
1737
|
</dd>
|
|
1748
1738
|
</dl>
|
|
1749
1739
|
</dd>
|
|
1750
1740
|
</dl>
|
|
1751
1741
|
|
|
1742
|
+
|
|
1752
1743
|
</dd>
|
|
1753
1744
|
</dl>
|
|
1754
1745
|
</details>
|
|
@@ -1766,7 +1757,6 @@ await client.conversations.get("id");
|
|
|
1766
1757
|
<dd>
|
|
1767
1758
|
|
|
1768
1759
|
Cancels an active conversation.
|
|
1769
|
-
|
|
1770
1760
|
</dd>
|
|
1771
1761
|
</dl>
|
|
1772
1762
|
</dd>
|
|
@@ -1782,8 +1772,8 @@ Cancels an active conversation.
|
|
|
1782
1772
|
|
|
1783
1773
|
```typescript
|
|
1784
1774
|
await client.conversations.cancel("id");
|
|
1785
|
-
```
|
|
1786
1775
|
|
|
1776
|
+
```
|
|
1787
1777
|
</dd>
|
|
1788
1778
|
</dl>
|
|
1789
1779
|
</dd>
|
|
@@ -1798,20 +1788,21 @@ await client.conversations.cancel("id");
|
|
|
1798
1788
|
<dd>
|
|
1799
1789
|
|
|
1800
1790
|
**id:** `string` — The ID of the conversation to cancel.
|
|
1801
|
-
|
|
1791
|
+
|
|
1802
1792
|
</dd>
|
|
1803
1793
|
</dl>
|
|
1804
1794
|
|
|
1805
1795
|
<dl>
|
|
1806
1796
|
<dd>
|
|
1807
1797
|
|
|
1808
|
-
**requestOptions:** `
|
|
1809
|
-
|
|
1798
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1799
|
+
|
|
1810
1800
|
</dd>
|
|
1811
1801
|
</dl>
|
|
1812
1802
|
</dd>
|
|
1813
1803
|
</dl>
|
|
1814
1804
|
|
|
1805
|
+
|
|
1815
1806
|
</dd>
|
|
1816
1807
|
</dl>
|
|
1817
1808
|
</details>
|
|
@@ -1829,7 +1820,6 @@ await client.conversations.cancel("id");
|
|
|
1829
1820
|
<dd>
|
|
1830
1821
|
|
|
1831
1822
|
Returns an analysis of the specified conversation.
|
|
1832
|
-
|
|
1833
1823
|
</dd>
|
|
1834
1824
|
</dl>
|
|
1835
1825
|
</dd>
|
|
@@ -1845,8 +1835,8 @@ Returns an analysis of the specified conversation.
|
|
|
1845
1835
|
|
|
1846
1836
|
```typescript
|
|
1847
1837
|
await client.conversations.getAnalysis("id");
|
|
1848
|
-
```
|
|
1849
1838
|
|
|
1839
|
+
```
|
|
1850
1840
|
</dd>
|
|
1851
1841
|
</dl>
|
|
1852
1842
|
</dd>
|
|
@@ -1861,20 +1851,21 @@ await client.conversations.getAnalysis("id");
|
|
|
1861
1851
|
<dd>
|
|
1862
1852
|
|
|
1863
1853
|
**id:** `string` — The ID of the conversation to analyze.
|
|
1864
|
-
|
|
1854
|
+
|
|
1865
1855
|
</dd>
|
|
1866
1856
|
</dl>
|
|
1867
1857
|
|
|
1868
1858
|
<dl>
|
|
1869
1859
|
<dd>
|
|
1870
1860
|
|
|
1871
|
-
**requestOptions:** `
|
|
1872
|
-
|
|
1861
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1862
|
+
|
|
1873
1863
|
</dd>
|
|
1874
1864
|
</dl>
|
|
1875
1865
|
</dd>
|
|
1876
1866
|
</dl>
|
|
1877
1867
|
|
|
1868
|
+
|
|
1878
1869
|
</dd>
|
|
1879
1870
|
</dl>
|
|
1880
1871
|
</details>
|
|
@@ -1892,7 +1883,6 @@ await client.conversations.getAnalysis("id");
|
|
|
1892
1883
|
<dd>
|
|
1893
1884
|
|
|
1894
1885
|
Returns all extractions for a conversation.
|
|
1895
|
-
|
|
1896
1886
|
</dd>
|
|
1897
1887
|
</dl>
|
|
1898
1888
|
</dd>
|
|
@@ -1908,8 +1898,8 @@ Returns all extractions for a conversation.
|
|
|
1908
1898
|
|
|
1909
1899
|
```typescript
|
|
1910
1900
|
await client.conversations.listExtractions("id");
|
|
1911
|
-
```
|
|
1912
1901
|
|
|
1902
|
+
```
|
|
1913
1903
|
</dd>
|
|
1914
1904
|
</dl>
|
|
1915
1905
|
</dd>
|
|
@@ -1924,20 +1914,21 @@ await client.conversations.listExtractions("id");
|
|
|
1924
1914
|
<dd>
|
|
1925
1915
|
|
|
1926
1916
|
**id:** `string` — The ID of the conversation to get extractions for.
|
|
1927
|
-
|
|
1917
|
+
|
|
1928
1918
|
</dd>
|
|
1929
1919
|
</dl>
|
|
1930
1920
|
|
|
1931
1921
|
<dl>
|
|
1932
1922
|
<dd>
|
|
1933
1923
|
|
|
1934
|
-
**requestOptions:** `
|
|
1935
|
-
|
|
1924
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1925
|
+
|
|
1936
1926
|
</dd>
|
|
1937
1927
|
</dl>
|
|
1938
1928
|
</dd>
|
|
1939
1929
|
</dl>
|
|
1940
1930
|
|
|
1931
|
+
|
|
1941
1932
|
</dd>
|
|
1942
1933
|
</dl>
|
|
1943
1934
|
</details>
|
|
@@ -1955,7 +1946,6 @@ await client.conversations.listExtractions("id");
|
|
|
1955
1946
|
<dd>
|
|
1956
1947
|
|
|
1957
1948
|
Extracts data from a conversation using a schema.
|
|
1958
|
-
|
|
1959
1949
|
</dd>
|
|
1960
1950
|
</dl>
|
|
1961
1951
|
</dd>
|
|
@@ -1971,10 +1961,10 @@ Extracts data from a conversation using a schema.
|
|
|
1971
1961
|
|
|
1972
1962
|
```typescript
|
|
1973
1963
|
await client.conversations.extractData("id", {
|
|
1974
|
-
schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
|
|
1964
|
+
schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
|
|
1975
1965
|
});
|
|
1976
|
-
```
|
|
1977
1966
|
|
|
1967
|
+
```
|
|
1978
1968
|
</dd>
|
|
1979
1969
|
</dl>
|
|
1980
1970
|
</dd>
|
|
@@ -1989,28 +1979,29 @@ await client.conversations.extractData("id", {
|
|
|
1989
1979
|
<dd>
|
|
1990
1980
|
|
|
1991
1981
|
**id:** `string` — The ID of the conversation to extract data from.
|
|
1992
|
-
|
|
1982
|
+
|
|
1993
1983
|
</dd>
|
|
1994
1984
|
</dl>
|
|
1995
1985
|
|
|
1996
1986
|
<dl>
|
|
1997
1987
|
<dd>
|
|
1998
1988
|
|
|
1999
|
-
**request:** `Phonic.ExtractDataRequest`
|
|
2000
|
-
|
|
1989
|
+
**request:** `Phonic.ExtractDataRequest`
|
|
1990
|
+
|
|
2001
1991
|
</dd>
|
|
2002
1992
|
</dl>
|
|
2003
1993
|
|
|
2004
1994
|
<dl>
|
|
2005
1995
|
<dd>
|
|
2006
1996
|
|
|
2007
|
-
**requestOptions:** `
|
|
2008
|
-
|
|
1997
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1998
|
+
|
|
2009
1999
|
</dd>
|
|
2010
2000
|
</dl>
|
|
2011
2001
|
</dd>
|
|
2012
2002
|
</dl>
|
|
2013
2003
|
|
|
2004
|
+
|
|
2014
2005
|
</dd>
|
|
2015
2006
|
</dl>
|
|
2016
2007
|
</details>
|
|
@@ -2028,7 +2019,6 @@ await client.conversations.extractData("id", {
|
|
|
2028
2019
|
<dd>
|
|
2029
2020
|
|
|
2030
2021
|
Returns all evaluations for a conversation.
|
|
2031
|
-
|
|
2032
2022
|
</dd>
|
|
2033
2023
|
</dl>
|
|
2034
2024
|
</dd>
|
|
@@ -2044,8 +2034,8 @@ Returns all evaluations for a conversation.
|
|
|
2044
2034
|
|
|
2045
2035
|
```typescript
|
|
2046
2036
|
await client.conversations.listEvaluations("id");
|
|
2047
|
-
```
|
|
2048
2037
|
|
|
2038
|
+
```
|
|
2049
2039
|
</dd>
|
|
2050
2040
|
</dl>
|
|
2051
2041
|
</dd>
|
|
@@ -2060,20 +2050,21 @@ await client.conversations.listEvaluations("id");
|
|
|
2060
2050
|
<dd>
|
|
2061
2051
|
|
|
2062
2052
|
**id:** `string` — The ID of the conversation to get evaluations for.
|
|
2063
|
-
|
|
2053
|
+
|
|
2064
2054
|
</dd>
|
|
2065
2055
|
</dl>
|
|
2066
2056
|
|
|
2067
2057
|
<dl>
|
|
2068
2058
|
<dd>
|
|
2069
2059
|
|
|
2070
|
-
**requestOptions:** `
|
|
2071
|
-
|
|
2060
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2061
|
+
|
|
2072
2062
|
</dd>
|
|
2073
2063
|
</dl>
|
|
2074
2064
|
</dd>
|
|
2075
2065
|
</dl>
|
|
2076
2066
|
|
|
2067
|
+
|
|
2077
2068
|
</dd>
|
|
2078
2069
|
</dl>
|
|
2079
2070
|
</details>
|
|
@@ -2091,7 +2082,6 @@ await client.conversations.listEvaluations("id");
|
|
|
2091
2082
|
<dd>
|
|
2092
2083
|
|
|
2093
2084
|
Evaluates a conversation using an evaluation prompt.
|
|
2094
|
-
|
|
2095
2085
|
</dd>
|
|
2096
2086
|
</dl>
|
|
2097
2087
|
</dd>
|
|
@@ -2107,10 +2097,10 @@ Evaluates a conversation using an evaluation prompt.
|
|
|
2107
2097
|
|
|
2108
2098
|
```typescript
|
|
2109
2099
|
await client.conversations.evaluate("id", {
|
|
2110
|
-
prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
|
|
2100
|
+
prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
|
|
2111
2101
|
});
|
|
2112
|
-
```
|
|
2113
2102
|
|
|
2103
|
+
```
|
|
2114
2104
|
</dd>
|
|
2115
2105
|
</dl>
|
|
2116
2106
|
</dd>
|
|
@@ -2125,28 +2115,29 @@ await client.conversations.evaluate("id", {
|
|
|
2125
2115
|
<dd>
|
|
2126
2116
|
|
|
2127
2117
|
**id:** `string` — The ID of the conversation to evaluate.
|
|
2128
|
-
|
|
2118
|
+
|
|
2129
2119
|
</dd>
|
|
2130
2120
|
</dl>
|
|
2131
2121
|
|
|
2132
2122
|
<dl>
|
|
2133
2123
|
<dd>
|
|
2134
2124
|
|
|
2135
|
-
**request:** `Phonic.EvaluateConversationRequest`
|
|
2136
|
-
|
|
2125
|
+
**request:** `Phonic.EvaluateConversationRequest`
|
|
2126
|
+
|
|
2137
2127
|
</dd>
|
|
2138
2128
|
</dl>
|
|
2139
2129
|
|
|
2140
2130
|
<dl>
|
|
2141
2131
|
<dd>
|
|
2142
2132
|
|
|
2143
|
-
**requestOptions:** `
|
|
2144
|
-
|
|
2133
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2134
|
+
|
|
2145
2135
|
</dd>
|
|
2146
2136
|
</dl>
|
|
2147
2137
|
</dd>
|
|
2148
2138
|
</dl>
|
|
2149
2139
|
|
|
2140
|
+
|
|
2150
2141
|
</dd>
|
|
2151
2142
|
</dl>
|
|
2152
2143
|
</details>
|
|
@@ -2164,7 +2155,6 @@ await client.conversations.evaluate("id", {
|
|
|
2164
2155
|
<dd>
|
|
2165
2156
|
|
|
2166
2157
|
Initiates a call to a given phone number using Phonic's Twilio account.
|
|
2167
|
-
|
|
2168
2158
|
</dd>
|
|
2169
2159
|
</dl>
|
|
2170
2160
|
</dd>
|
|
@@ -2186,21 +2176,23 @@ await client.conversations.outboundCall({
|
|
|
2186
2176
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
2187
2177
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
2188
2178
|
template_variables: {
|
|
2189
|
-
customer_name: "David",
|
|
2190
|
-
subject: "Chess"
|
|
2179
|
+
"customer_name": "David",
|
|
2180
|
+
"subject": "Chess"
|
|
2191
2181
|
},
|
|
2192
2182
|
voice_id: "sabrina",
|
|
2193
2183
|
generate_no_input_poke_text: false,
|
|
2194
2184
|
no_input_poke_sec: 30,
|
|
2195
2185
|
no_input_poke_text: "Are you still there?",
|
|
2196
2186
|
no_input_end_conversation_sec: 180,
|
|
2197
|
-
|
|
2187
|
+
default_language: "en",
|
|
2188
|
+
additional_languages: ["es"],
|
|
2189
|
+
multilingual_mode: "request",
|
|
2198
2190
|
boosted_keywords: ["Load ID", "dispatch"],
|
|
2199
|
-
tools: ["keypad_input"]
|
|
2200
|
-
}
|
|
2191
|
+
tools: ["keypad_input"]
|
|
2192
|
+
}
|
|
2201
2193
|
});
|
|
2202
|
-
```
|
|
2203
2194
|
|
|
2195
|
+
```
|
|
2204
2196
|
</dd>
|
|
2205
2197
|
</dl>
|
|
2206
2198
|
</dd>
|
|
@@ -2214,21 +2206,22 @@ await client.conversations.outboundCall({
|
|
|
2214
2206
|
<dl>
|
|
2215
2207
|
<dd>
|
|
2216
2208
|
|
|
2217
|
-
**request:** `Phonic.OutboundCallRequest`
|
|
2218
|
-
|
|
2209
|
+
**request:** `Phonic.OutboundCallRequest`
|
|
2210
|
+
|
|
2219
2211
|
</dd>
|
|
2220
2212
|
</dl>
|
|
2221
2213
|
|
|
2222
2214
|
<dl>
|
|
2223
2215
|
<dd>
|
|
2224
2216
|
|
|
2225
|
-
**requestOptions:** `
|
|
2226
|
-
|
|
2217
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2218
|
+
|
|
2227
2219
|
</dd>
|
|
2228
2220
|
</dl>
|
|
2229
2221
|
</dd>
|
|
2230
2222
|
</dl>
|
|
2231
2223
|
|
|
2224
|
+
|
|
2232
2225
|
</dd>
|
|
2233
2226
|
</dl>
|
|
2234
2227
|
</details>
|
|
@@ -2246,7 +2239,6 @@ await client.conversations.outboundCall({
|
|
|
2246
2239
|
<dd>
|
|
2247
2240
|
|
|
2248
2241
|
Initiates a SIP outbound call using user-supplied SIP credentials in headers.
|
|
2249
|
-
|
|
2250
2242
|
</dd>
|
|
2251
2243
|
</dl>
|
|
2252
2244
|
</dd>
|
|
@@ -2264,10 +2256,10 @@ Initiates a SIP outbound call using user-supplied SIP credentials in headers.
|
|
|
2264
2256
|
await client.conversations.sipOutboundCall({
|
|
2265
2257
|
"X-Sip-Address": "X-Sip-Address",
|
|
2266
2258
|
from_phone_number: "from_phone_number",
|
|
2267
|
-
to_phone_number: "to_phone_number"
|
|
2259
|
+
to_phone_number: "to_phone_number"
|
|
2268
2260
|
});
|
|
2269
|
-
```
|
|
2270
2261
|
|
|
2262
|
+
```
|
|
2271
2263
|
</dd>
|
|
2272
2264
|
</dl>
|
|
2273
2265
|
</dd>
|
|
@@ -2281,27 +2273,27 @@ await client.conversations.sipOutboundCall({
|
|
|
2281
2273
|
<dl>
|
|
2282
2274
|
<dd>
|
|
2283
2275
|
|
|
2284
|
-
**request:** `Phonic.ConversationsSipOutboundCallRequest`
|
|
2285
|
-
|
|
2276
|
+
**request:** `Phonic.ConversationsSipOutboundCallRequest`
|
|
2277
|
+
|
|
2286
2278
|
</dd>
|
|
2287
2279
|
</dl>
|
|
2288
2280
|
|
|
2289
2281
|
<dl>
|
|
2290
2282
|
<dd>
|
|
2291
2283
|
|
|
2292
|
-
**requestOptions:** `
|
|
2293
|
-
|
|
2284
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2285
|
+
|
|
2294
2286
|
</dd>
|
|
2295
2287
|
</dl>
|
|
2296
2288
|
</dd>
|
|
2297
2289
|
</dl>
|
|
2298
2290
|
|
|
2291
|
+
|
|
2299
2292
|
</dd>
|
|
2300
2293
|
</dl>
|
|
2301
2294
|
</details>
|
|
2302
2295
|
|
|
2303
2296
|
## Auth
|
|
2304
|
-
|
|
2305
2297
|
<details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">createSessionToken</a>({ ...params }) -> Phonic.AuthCreateSessionTokenResponse</code></summary>
|
|
2306
2298
|
<dl>
|
|
2307
2299
|
<dd>
|
|
@@ -2315,7 +2307,6 @@ await client.conversations.sipOutboundCall({
|
|
|
2315
2307
|
<dd>
|
|
2316
2308
|
|
|
2317
2309
|
Creates a short-lived session token that can be used to authenticate WebSocket connections. Session tokens are useful for client-side applications where you don't want to expose your API key.
|
|
2318
|
-
|
|
2319
2310
|
</dd>
|
|
2320
2311
|
</dl>
|
|
2321
2312
|
</dd>
|
|
@@ -2331,10 +2322,10 @@ Creates a short-lived session token that can be used to authenticate WebSocket c
|
|
|
2331
2322
|
|
|
2332
2323
|
```typescript
|
|
2333
2324
|
await client.auth.createSessionToken({
|
|
2334
|
-
ttl_seconds: 300
|
|
2325
|
+
ttl_seconds: 300
|
|
2335
2326
|
});
|
|
2336
|
-
```
|
|
2337
2327
|
|
|
2328
|
+
```
|
|
2338
2329
|
</dd>
|
|
2339
2330
|
</dl>
|
|
2340
2331
|
</dd>
|
|
@@ -2348,27 +2339,27 @@ await client.auth.createSessionToken({
|
|
|
2348
2339
|
<dl>
|
|
2349
2340
|
<dd>
|
|
2350
2341
|
|
|
2351
|
-
**request:** `Phonic.CreateSessionTokenRequest`
|
|
2352
|
-
|
|
2342
|
+
**request:** `Phonic.CreateSessionTokenRequest`
|
|
2343
|
+
|
|
2353
2344
|
</dd>
|
|
2354
2345
|
</dl>
|
|
2355
2346
|
|
|
2356
2347
|
<dl>
|
|
2357
2348
|
<dd>
|
|
2358
2349
|
|
|
2359
|
-
**requestOptions:** `
|
|
2360
|
-
|
|
2350
|
+
**requestOptions:** `AuthClient.RequestOptions`
|
|
2351
|
+
|
|
2361
2352
|
</dd>
|
|
2362
2353
|
</dl>
|
|
2363
2354
|
</dd>
|
|
2364
2355
|
</dl>
|
|
2365
2356
|
|
|
2357
|
+
|
|
2366
2358
|
</dd>
|
|
2367
2359
|
</dl>
|
|
2368
2360
|
</details>
|
|
2369
2361
|
|
|
2370
2362
|
## Projects
|
|
2371
|
-
|
|
2372
2363
|
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">list</a>() -> Phonic.ProjectsListResponse</code></summary>
|
|
2373
2364
|
<dl>
|
|
2374
2365
|
<dd>
|
|
@@ -2382,7 +2373,6 @@ await client.auth.createSessionToken({
|
|
|
2382
2373
|
<dd>
|
|
2383
2374
|
|
|
2384
2375
|
Returns all projects in a workspace.
|
|
2385
|
-
|
|
2386
2376
|
</dd>
|
|
2387
2377
|
</dl>
|
|
2388
2378
|
</dd>
|
|
@@ -2398,8 +2388,8 @@ Returns all projects in a workspace.
|
|
|
2398
2388
|
|
|
2399
2389
|
```typescript
|
|
2400
2390
|
await client.projects.list();
|
|
2401
|
-
```
|
|
2402
2391
|
|
|
2392
|
+
```
|
|
2403
2393
|
</dd>
|
|
2404
2394
|
</dl>
|
|
2405
2395
|
</dd>
|
|
@@ -2413,13 +2403,14 @@ await client.projects.list();
|
|
|
2413
2403
|
<dl>
|
|
2414
2404
|
<dd>
|
|
2415
2405
|
|
|
2416
|
-
**requestOptions:** `
|
|
2417
|
-
|
|
2406
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2407
|
+
|
|
2418
2408
|
</dd>
|
|
2419
2409
|
</dl>
|
|
2420
2410
|
</dd>
|
|
2421
2411
|
</dl>
|
|
2422
2412
|
|
|
2413
|
+
|
|
2423
2414
|
</dd>
|
|
2424
2415
|
</dl>
|
|
2425
2416
|
</details>
|
|
@@ -2437,7 +2428,6 @@ await client.projects.list();
|
|
|
2437
2428
|
<dd>
|
|
2438
2429
|
|
|
2439
2430
|
Creates a new project in a workspace.
|
|
2440
|
-
|
|
2441
2431
|
</dd>
|
|
2442
2432
|
</dl>
|
|
2443
2433
|
</dd>
|
|
@@ -2453,10 +2443,10 @@ Creates a new project in a workspace.
|
|
|
2453
2443
|
|
|
2454
2444
|
```typescript
|
|
2455
2445
|
await client.projects.create({
|
|
2456
|
-
name: "customer-support"
|
|
2446
|
+
name: "customer-support"
|
|
2457
2447
|
});
|
|
2458
|
-
```
|
|
2459
2448
|
|
|
2449
|
+
```
|
|
2460
2450
|
</dd>
|
|
2461
2451
|
</dl>
|
|
2462
2452
|
</dd>
|
|
@@ -2470,21 +2460,22 @@ await client.projects.create({
|
|
|
2470
2460
|
<dl>
|
|
2471
2461
|
<dd>
|
|
2472
2462
|
|
|
2473
|
-
**request:** `Phonic.CreateProjectRequest`
|
|
2474
|
-
|
|
2463
|
+
**request:** `Phonic.CreateProjectRequest`
|
|
2464
|
+
|
|
2475
2465
|
</dd>
|
|
2476
2466
|
</dl>
|
|
2477
2467
|
|
|
2478
2468
|
<dl>
|
|
2479
2469
|
<dd>
|
|
2480
2470
|
|
|
2481
|
-
**requestOptions:** `
|
|
2482
|
-
|
|
2471
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2472
|
+
|
|
2483
2473
|
</dd>
|
|
2484
2474
|
</dl>
|
|
2485
2475
|
</dd>
|
|
2486
2476
|
</dl>
|
|
2487
2477
|
|
|
2478
|
+
|
|
2488
2479
|
</dd>
|
|
2489
2480
|
</dl>
|
|
2490
2481
|
</details>
|
|
@@ -2502,7 +2493,6 @@ await client.projects.create({
|
|
|
2502
2493
|
<dd>
|
|
2503
2494
|
|
|
2504
2495
|
Returns a project by name or ID.
|
|
2505
|
-
|
|
2506
2496
|
</dd>
|
|
2507
2497
|
</dl>
|
|
2508
2498
|
</dd>
|
|
@@ -2518,8 +2508,8 @@ Returns a project by name or ID.
|
|
|
2518
2508
|
|
|
2519
2509
|
```typescript
|
|
2520
2510
|
await client.projects.get("nameOrId");
|
|
2521
|
-
```
|
|
2522
2511
|
|
|
2512
|
+
```
|
|
2523
2513
|
</dd>
|
|
2524
2514
|
</dl>
|
|
2525
2515
|
</dd>
|
|
@@ -2534,20 +2524,21 @@ await client.projects.get("nameOrId");
|
|
|
2534
2524
|
<dd>
|
|
2535
2525
|
|
|
2536
2526
|
**nameOrId:** `string` — The name or the ID of the project to get.
|
|
2537
|
-
|
|
2527
|
+
|
|
2538
2528
|
</dd>
|
|
2539
2529
|
</dl>
|
|
2540
2530
|
|
|
2541
2531
|
<dl>
|
|
2542
2532
|
<dd>
|
|
2543
2533
|
|
|
2544
|
-
**requestOptions:** `
|
|
2545
|
-
|
|
2534
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2535
|
+
|
|
2546
2536
|
</dd>
|
|
2547
2537
|
</dl>
|
|
2548
2538
|
</dd>
|
|
2549
2539
|
</dl>
|
|
2550
2540
|
|
|
2541
|
+
|
|
2551
2542
|
</dd>
|
|
2552
2543
|
</dl>
|
|
2553
2544
|
</details>
|
|
@@ -2565,7 +2556,6 @@ await client.projects.get("nameOrId");
|
|
|
2565
2556
|
<dd>
|
|
2566
2557
|
|
|
2567
2558
|
Deletes a project by name or ID.
|
|
2568
|
-
|
|
2569
2559
|
</dd>
|
|
2570
2560
|
</dl>
|
|
2571
2561
|
</dd>
|
|
@@ -2581,8 +2571,8 @@ Deletes a project by name or ID.
|
|
|
2581
2571
|
|
|
2582
2572
|
```typescript
|
|
2583
2573
|
await client.projects.delete("nameOrId");
|
|
2584
|
-
```
|
|
2585
2574
|
|
|
2575
|
+
```
|
|
2586
2576
|
</dd>
|
|
2587
2577
|
</dl>
|
|
2588
2578
|
</dd>
|
|
@@ -2597,20 +2587,21 @@ await client.projects.delete("nameOrId");
|
|
|
2597
2587
|
<dd>
|
|
2598
2588
|
|
|
2599
2589
|
**nameOrId:** `string` — The name or the ID of the project to delete.
|
|
2600
|
-
|
|
2590
|
+
|
|
2601
2591
|
</dd>
|
|
2602
2592
|
</dl>
|
|
2603
2593
|
|
|
2604
2594
|
<dl>
|
|
2605
2595
|
<dd>
|
|
2606
2596
|
|
|
2607
|
-
**requestOptions:** `
|
|
2608
|
-
|
|
2597
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2598
|
+
|
|
2609
2599
|
</dd>
|
|
2610
2600
|
</dl>
|
|
2611
2601
|
</dd>
|
|
2612
2602
|
</dl>
|
|
2613
2603
|
|
|
2604
|
+
|
|
2614
2605
|
</dd>
|
|
2615
2606
|
</dl>
|
|
2616
2607
|
</details>
|
|
@@ -2628,7 +2619,6 @@ await client.projects.delete("nameOrId");
|
|
|
2628
2619
|
<dd>
|
|
2629
2620
|
|
|
2630
2621
|
Updates a project by name or ID.
|
|
2631
|
-
|
|
2632
2622
|
</dd>
|
|
2633
2623
|
</dl>
|
|
2634
2624
|
</dd>
|
|
@@ -2645,10 +2635,10 @@ Updates a project by name or ID.
|
|
|
2645
2635
|
```typescript
|
|
2646
2636
|
await client.projects.update("nameOrId", {
|
|
2647
2637
|
name: "updated-customer-support",
|
|
2648
|
-
default_agent: "another-agent"
|
|
2638
|
+
default_agent: "another-agent"
|
|
2649
2639
|
});
|
|
2650
|
-
```
|
|
2651
2640
|
|
|
2641
|
+
```
|
|
2652
2642
|
</dd>
|
|
2653
2643
|
</dl>
|
|
2654
2644
|
</dd>
|
|
@@ -2663,28 +2653,29 @@ await client.projects.update("nameOrId", {
|
|
|
2663
2653
|
<dd>
|
|
2664
2654
|
|
|
2665
2655
|
**nameOrId:** `string` — The name or the ID of the project to update.
|
|
2666
|
-
|
|
2656
|
+
|
|
2667
2657
|
</dd>
|
|
2668
2658
|
</dl>
|
|
2669
2659
|
|
|
2670
2660
|
<dl>
|
|
2671
2661
|
<dd>
|
|
2672
2662
|
|
|
2673
|
-
**request:** `Phonic.UpdateProjectRequest`
|
|
2674
|
-
|
|
2663
|
+
**request:** `Phonic.UpdateProjectRequest`
|
|
2664
|
+
|
|
2675
2665
|
</dd>
|
|
2676
2666
|
</dl>
|
|
2677
2667
|
|
|
2678
2668
|
<dl>
|
|
2679
2669
|
<dd>
|
|
2680
2670
|
|
|
2681
|
-
**requestOptions:** `
|
|
2682
|
-
|
|
2671
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2672
|
+
|
|
2683
2673
|
</dd>
|
|
2684
2674
|
</dl>
|
|
2685
2675
|
</dd>
|
|
2686
2676
|
</dl>
|
|
2687
2677
|
|
|
2678
|
+
|
|
2688
2679
|
</dd>
|
|
2689
2680
|
</dl>
|
|
2690
2681
|
</details>
|
|
@@ -2702,7 +2693,6 @@ await client.projects.update("nameOrId", {
|
|
|
2702
2693
|
<dd>
|
|
2703
2694
|
|
|
2704
2695
|
Returns all conversation evaluation prompts for a project.
|
|
2705
|
-
|
|
2706
2696
|
</dd>
|
|
2707
2697
|
</dl>
|
|
2708
2698
|
</dd>
|
|
@@ -2718,8 +2708,8 @@ Returns all conversation evaluation prompts for a project.
|
|
|
2718
2708
|
|
|
2719
2709
|
```typescript
|
|
2720
2710
|
await client.projects.listEvalPrompts("id");
|
|
2721
|
-
```
|
|
2722
2711
|
|
|
2712
|
+
```
|
|
2723
2713
|
</dd>
|
|
2724
2714
|
</dl>
|
|
2725
2715
|
</dd>
|
|
@@ -2734,20 +2724,21 @@ await client.projects.listEvalPrompts("id");
|
|
|
2734
2724
|
<dd>
|
|
2735
2725
|
|
|
2736
2726
|
**id:** `string` — The ID of the project.
|
|
2737
|
-
|
|
2727
|
+
|
|
2738
2728
|
</dd>
|
|
2739
2729
|
</dl>
|
|
2740
2730
|
|
|
2741
2731
|
<dl>
|
|
2742
2732
|
<dd>
|
|
2743
2733
|
|
|
2744
|
-
**requestOptions:** `
|
|
2745
|
-
|
|
2734
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2735
|
+
|
|
2746
2736
|
</dd>
|
|
2747
2737
|
</dl>
|
|
2748
2738
|
</dd>
|
|
2749
2739
|
</dl>
|
|
2750
2740
|
|
|
2741
|
+
|
|
2751
2742
|
</dd>
|
|
2752
2743
|
</dl>
|
|
2753
2744
|
</details>
|
|
@@ -2765,7 +2756,6 @@ await client.projects.listEvalPrompts("id");
|
|
|
2765
2756
|
<dd>
|
|
2766
2757
|
|
|
2767
2758
|
Creates a new conversation evaluation prompt for a project.
|
|
2768
|
-
|
|
2769
2759
|
</dd>
|
|
2770
2760
|
</dl>
|
|
2771
2761
|
</dd>
|
|
@@ -2782,10 +2772,10 @@ Creates a new conversation evaluation prompt for a project.
|
|
|
2782
2772
|
```typescript
|
|
2783
2773
|
await client.projects.createEvalPrompt("id", {
|
|
2784
2774
|
name: "test_prompt",
|
|
2785
|
-
prompt: "The assistant used the word chocolate in the conversation"
|
|
2775
|
+
prompt: "The assistant used the word chocolate in the conversation"
|
|
2786
2776
|
});
|
|
2787
|
-
```
|
|
2788
2777
|
|
|
2778
|
+
```
|
|
2789
2779
|
</dd>
|
|
2790
2780
|
</dl>
|
|
2791
2781
|
</dd>
|
|
@@ -2800,28 +2790,30 @@ await client.projects.createEvalPrompt("id", {
|
|
|
2800
2790
|
<dd>
|
|
2801
2791
|
|
|
2802
2792
|
**id:** `string` — The ID of the project.
|
|
2803
|
-
|
|
2793
|
+
|
|
2804
2794
|
</dd>
|
|
2805
2795
|
</dl>
|
|
2806
2796
|
|
|
2807
2797
|
<dl>
|
|
2808
2798
|
<dd>
|
|
2809
2799
|
|
|
2810
|
-
**request:** `Phonic.CreateConversationEvalPromptRequest`
|
|
2811
|
-
|
|
2800
|
+
**request:** `Phonic.CreateConversationEvalPromptRequest`
|
|
2801
|
+
|
|
2812
2802
|
</dd>
|
|
2813
2803
|
</dl>
|
|
2814
2804
|
|
|
2815
2805
|
<dl>
|
|
2816
2806
|
<dd>
|
|
2817
2807
|
|
|
2818
|
-
**requestOptions:** `
|
|
2819
|
-
|
|
2808
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2809
|
+
|
|
2820
2810
|
</dd>
|
|
2821
2811
|
</dl>
|
|
2822
2812
|
</dd>
|
|
2823
2813
|
</dl>
|
|
2824
2814
|
|
|
2815
|
+
|
|
2825
2816
|
</dd>
|
|
2826
2817
|
</dl>
|
|
2827
2818
|
</details>
|
|
2819
|
+
|