phonic 0.31.2 → 0.31.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +102 -15
- 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 +309 -325
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,12 +102,12 @@ 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,
|
|
@@ -121,13 +118,13 @@ await client.agents.create({
|
|
|
121
118
|
configuration_endpoint: {
|
|
122
119
|
url: "https://api.example.com/config",
|
|
123
120
|
headers: {
|
|
124
|
-
Authorization: "Bearer token123"
|
|
121
|
+
"Authorization": "Bearer token123"
|
|
125
122
|
},
|
|
126
|
-
timeout_ms: 7000
|
|
127
|
-
}
|
|
123
|
+
timeout_ms: 7000
|
|
124
|
+
}
|
|
128
125
|
});
|
|
129
|
-
```
|
|
130
126
|
|
|
127
|
+
```
|
|
131
128
|
</dd>
|
|
132
129
|
</dl>
|
|
133
130
|
</dd>
|
|
@@ -141,21 +138,22 @@ await client.agents.create({
|
|
|
141
138
|
<dl>
|
|
142
139
|
<dd>
|
|
143
140
|
|
|
144
|
-
**request:** `Phonic.AgentsCreateRequest`
|
|
145
|
-
|
|
141
|
+
**request:** `Phonic.AgentsCreateRequest`
|
|
142
|
+
|
|
146
143
|
</dd>
|
|
147
144
|
</dl>
|
|
148
145
|
|
|
149
146
|
<dl>
|
|
150
147
|
<dd>
|
|
151
148
|
|
|
152
|
-
**requestOptions:** `
|
|
153
|
-
|
|
149
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
150
|
+
|
|
154
151
|
</dd>
|
|
155
152
|
</dl>
|
|
156
153
|
</dd>
|
|
157
154
|
</dl>
|
|
158
155
|
|
|
156
|
+
|
|
159
157
|
</dd>
|
|
160
158
|
</dl>
|
|
161
159
|
</details>
|
|
@@ -173,7 +171,6 @@ await client.agents.create({
|
|
|
173
171
|
<dd>
|
|
174
172
|
|
|
175
173
|
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
174
|
</dd>
|
|
178
175
|
</dl>
|
|
179
176
|
</dd>
|
|
@@ -200,12 +197,12 @@ await client.agents.upsert({
|
|
|
200
197
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
201
198
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
202
199
|
template_variables: {
|
|
203
|
-
customer_name: {
|
|
204
|
-
default_value: "David"
|
|
205
|
-
},
|
|
206
|
-
subject: {
|
|
207
|
-
default_value: "Chess",
|
|
200
|
+
"customer_name": {
|
|
201
|
+
default_value: "David"
|
|
208
202
|
},
|
|
203
|
+
"subject": {
|
|
204
|
+
default_value: "Chess"
|
|
205
|
+
}
|
|
209
206
|
},
|
|
210
207
|
tools: ["keypad_input"],
|
|
211
208
|
generate_no_input_poke_text: false,
|
|
@@ -216,13 +213,13 @@ await client.agents.upsert({
|
|
|
216
213
|
configuration_endpoint: {
|
|
217
214
|
url: "https://api.example.com/config",
|
|
218
215
|
headers: {
|
|
219
|
-
Authorization: "Bearer token123"
|
|
216
|
+
"Authorization": "Bearer token123"
|
|
220
217
|
},
|
|
221
|
-
timeout_ms: 7000
|
|
222
|
-
}
|
|
218
|
+
timeout_ms: 7000
|
|
219
|
+
}
|
|
223
220
|
});
|
|
224
|
-
```
|
|
225
221
|
|
|
222
|
+
```
|
|
226
223
|
</dd>
|
|
227
224
|
</dl>
|
|
228
225
|
</dd>
|
|
@@ -236,21 +233,22 @@ await client.agents.upsert({
|
|
|
236
233
|
<dl>
|
|
237
234
|
<dd>
|
|
238
235
|
|
|
239
|
-
**request:** `Phonic.UpsertAgentRequest`
|
|
240
|
-
|
|
236
|
+
**request:** `Phonic.UpsertAgentRequest`
|
|
237
|
+
|
|
241
238
|
</dd>
|
|
242
239
|
</dl>
|
|
243
240
|
|
|
244
241
|
<dl>
|
|
245
242
|
<dd>
|
|
246
243
|
|
|
247
|
-
**requestOptions:** `
|
|
248
|
-
|
|
244
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
245
|
+
|
|
249
246
|
</dd>
|
|
250
247
|
</dl>
|
|
251
248
|
</dd>
|
|
252
249
|
</dl>
|
|
253
250
|
|
|
251
|
+
|
|
254
252
|
</dd>
|
|
255
253
|
</dl>
|
|
256
254
|
</details>
|
|
@@ -268,7 +266,6 @@ await client.agents.upsert({
|
|
|
268
266
|
<dd>
|
|
269
267
|
|
|
270
268
|
Returns an agent by name or ID.
|
|
271
|
-
|
|
272
269
|
</dd>
|
|
273
270
|
</dl>
|
|
274
271
|
</dd>
|
|
@@ -284,10 +281,10 @@ Returns an agent by name or ID.
|
|
|
284
281
|
|
|
285
282
|
```typescript
|
|
286
283
|
await client.agents.get("nameOrId", {
|
|
287
|
-
project: "main"
|
|
284
|
+
project: "main"
|
|
288
285
|
});
|
|
289
|
-
```
|
|
290
286
|
|
|
287
|
+
```
|
|
291
288
|
</dd>
|
|
292
289
|
</dl>
|
|
293
290
|
</dd>
|
|
@@ -302,28 +299,29 @@ await client.agents.get("nameOrId", {
|
|
|
302
299
|
<dd>
|
|
303
300
|
|
|
304
301
|
**nameOrId:** `string` — The name or the ID of the agent to get.
|
|
305
|
-
|
|
302
|
+
|
|
306
303
|
</dd>
|
|
307
304
|
</dl>
|
|
308
305
|
|
|
309
306
|
<dl>
|
|
310
307
|
<dd>
|
|
311
308
|
|
|
312
|
-
**request:** `Phonic.AgentsGetRequest`
|
|
313
|
-
|
|
309
|
+
**request:** `Phonic.AgentsGetRequest`
|
|
310
|
+
|
|
314
311
|
</dd>
|
|
315
312
|
</dl>
|
|
316
313
|
|
|
317
314
|
<dl>
|
|
318
315
|
<dd>
|
|
319
316
|
|
|
320
|
-
**requestOptions:** `
|
|
321
|
-
|
|
317
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
318
|
+
|
|
322
319
|
</dd>
|
|
323
320
|
</dl>
|
|
324
321
|
</dd>
|
|
325
322
|
</dl>
|
|
326
323
|
|
|
324
|
+
|
|
327
325
|
</dd>
|
|
328
326
|
</dl>
|
|
329
327
|
</details>
|
|
@@ -341,7 +339,6 @@ await client.agents.get("nameOrId", {
|
|
|
341
339
|
<dd>
|
|
342
340
|
|
|
343
341
|
Deletes an agent by name or ID.
|
|
344
|
-
|
|
345
342
|
</dd>
|
|
346
343
|
</dl>
|
|
347
344
|
</dd>
|
|
@@ -357,10 +354,10 @@ Deletes an agent by name or ID.
|
|
|
357
354
|
|
|
358
355
|
```typescript
|
|
359
356
|
await client.agents.delete("nameOrId", {
|
|
360
|
-
project: "main"
|
|
357
|
+
project: "main"
|
|
361
358
|
});
|
|
362
|
-
```
|
|
363
359
|
|
|
360
|
+
```
|
|
364
361
|
</dd>
|
|
365
362
|
</dl>
|
|
366
363
|
</dd>
|
|
@@ -375,28 +372,29 @@ await client.agents.delete("nameOrId", {
|
|
|
375
372
|
<dd>
|
|
376
373
|
|
|
377
374
|
**nameOrId:** `string` — The name or the ID of the agent to delete.
|
|
378
|
-
|
|
375
|
+
|
|
379
376
|
</dd>
|
|
380
377
|
</dl>
|
|
381
378
|
|
|
382
379
|
<dl>
|
|
383
380
|
<dd>
|
|
384
381
|
|
|
385
|
-
**request:** `Phonic.AgentsDeleteRequest`
|
|
386
|
-
|
|
382
|
+
**request:** `Phonic.AgentsDeleteRequest`
|
|
383
|
+
|
|
387
384
|
</dd>
|
|
388
385
|
</dl>
|
|
389
386
|
|
|
390
387
|
<dl>
|
|
391
388
|
<dd>
|
|
392
389
|
|
|
393
|
-
**requestOptions:** `
|
|
394
|
-
|
|
390
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
391
|
+
|
|
395
392
|
</dd>
|
|
396
393
|
</dl>
|
|
397
394
|
</dd>
|
|
398
395
|
</dl>
|
|
399
396
|
|
|
397
|
+
|
|
400
398
|
</dd>
|
|
401
399
|
</dl>
|
|
402
400
|
</details>
|
|
@@ -414,7 +412,6 @@ await client.agents.delete("nameOrId", {
|
|
|
414
412
|
<dd>
|
|
415
413
|
|
|
416
414
|
Updates an agent by name or ID.
|
|
417
|
-
|
|
418
415
|
</dd>
|
|
419
416
|
</dl>
|
|
420
417
|
</dd>
|
|
@@ -441,12 +438,12 @@ await client.agents.update("nameOrId", {
|
|
|
441
438
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
442
439
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
443
440
|
template_variables: {
|
|
444
|
-
customer_name: {
|
|
445
|
-
default_value: "David"
|
|
446
|
-
},
|
|
447
|
-
subject: {
|
|
448
|
-
default_value: "Chess",
|
|
441
|
+
"customer_name": {
|
|
442
|
+
default_value: "David"
|
|
449
443
|
},
|
|
444
|
+
"subject": {
|
|
445
|
+
default_value: "Chess"
|
|
446
|
+
}
|
|
450
447
|
},
|
|
451
448
|
tools: ["keypad_input"],
|
|
452
449
|
generate_no_input_poke_text: false,
|
|
@@ -457,13 +454,13 @@ await client.agents.update("nameOrId", {
|
|
|
457
454
|
configuration_endpoint: {
|
|
458
455
|
url: "https://api.example.com/config",
|
|
459
456
|
headers: {
|
|
460
|
-
Authorization: "Bearer token123"
|
|
457
|
+
"Authorization": "Bearer token123"
|
|
461
458
|
},
|
|
462
|
-
timeout_ms: 7000
|
|
463
|
-
}
|
|
459
|
+
timeout_ms: 7000
|
|
460
|
+
}
|
|
464
461
|
});
|
|
465
|
-
```
|
|
466
462
|
|
|
463
|
+
```
|
|
467
464
|
</dd>
|
|
468
465
|
</dl>
|
|
469
466
|
</dd>
|
|
@@ -478,28 +475,29 @@ await client.agents.update("nameOrId", {
|
|
|
478
475
|
<dd>
|
|
479
476
|
|
|
480
477
|
**nameOrId:** `string` — The name or the ID of the agent to update.
|
|
481
|
-
|
|
478
|
+
|
|
482
479
|
</dd>
|
|
483
480
|
</dl>
|
|
484
481
|
|
|
485
482
|
<dl>
|
|
486
483
|
<dd>
|
|
487
484
|
|
|
488
|
-
**request:** `Phonic.UpdateAgentRequest`
|
|
489
|
-
|
|
485
|
+
**request:** `Phonic.UpdateAgentRequest`
|
|
486
|
+
|
|
490
487
|
</dd>
|
|
491
488
|
</dl>
|
|
492
489
|
|
|
493
490
|
<dl>
|
|
494
491
|
<dd>
|
|
495
492
|
|
|
496
|
-
**requestOptions:** `
|
|
497
|
-
|
|
493
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
494
|
+
|
|
498
495
|
</dd>
|
|
499
496
|
</dl>
|
|
500
497
|
</dd>
|
|
501
498
|
</dl>
|
|
502
499
|
|
|
500
|
+
|
|
503
501
|
</dd>
|
|
504
502
|
</dl>
|
|
505
503
|
</details>
|
|
@@ -517,7 +515,6 @@ await client.agents.update("nameOrId", {
|
|
|
517
515
|
<dd>
|
|
518
516
|
|
|
519
517
|
Adds a custom phone number to an agent. The user must configure their SIP trunk to point to Phonic's SIP server.
|
|
520
|
-
|
|
521
518
|
</dd>
|
|
522
519
|
</dl>
|
|
523
520
|
</dd>
|
|
@@ -538,13 +535,13 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
538
535
|
configuration_endpoint: {
|
|
539
536
|
url: "https://api.example.com/config",
|
|
540
537
|
headers: {
|
|
541
|
-
Authorization: "Bearer token123"
|
|
538
|
+
"Authorization": "Bearer token123"
|
|
542
539
|
},
|
|
543
|
-
timeout_ms: 7000
|
|
544
|
-
}
|
|
540
|
+
timeout_ms: 7000
|
|
541
|
+
}
|
|
545
542
|
});
|
|
546
|
-
```
|
|
547
543
|
|
|
544
|
+
```
|
|
548
545
|
</dd>
|
|
549
546
|
</dl>
|
|
550
547
|
</dd>
|
|
@@ -559,28 +556,29 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
559
556
|
<dd>
|
|
560
557
|
|
|
561
558
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
562
|
-
|
|
559
|
+
|
|
563
560
|
</dd>
|
|
564
561
|
</dl>
|
|
565
562
|
|
|
566
563
|
<dl>
|
|
567
564
|
<dd>
|
|
568
565
|
|
|
569
|
-
**request:** `Phonic.AgentsAddCustomPhoneNumberRequest`
|
|
570
|
-
|
|
566
|
+
**request:** `Phonic.AgentsAddCustomPhoneNumberRequest`
|
|
567
|
+
|
|
571
568
|
</dd>
|
|
572
569
|
</dl>
|
|
573
570
|
|
|
574
571
|
<dl>
|
|
575
572
|
<dd>
|
|
576
573
|
|
|
577
|
-
**requestOptions:** `
|
|
578
|
-
|
|
574
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
575
|
+
|
|
579
576
|
</dd>
|
|
580
577
|
</dl>
|
|
581
578
|
</dd>
|
|
582
579
|
</dl>
|
|
583
580
|
|
|
581
|
+
|
|
584
582
|
</dd>
|
|
585
583
|
</dl>
|
|
586
584
|
</details>
|
|
@@ -598,7 +596,6 @@ await client.agents.addCustomPhoneNumber("nameOrId", {
|
|
|
598
596
|
<dd>
|
|
599
597
|
|
|
600
598
|
Deletes a custom phone number from an agent.
|
|
601
|
-
|
|
602
599
|
</dd>
|
|
603
600
|
</dl>
|
|
604
601
|
</dd>
|
|
@@ -615,10 +612,10 @@ Deletes a custom phone number from an agent.
|
|
|
615
612
|
```typescript
|
|
616
613
|
await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
617
614
|
project: "main",
|
|
618
|
-
phone_number: "+15551234567"
|
|
615
|
+
phone_number: "+15551234567"
|
|
619
616
|
});
|
|
620
|
-
```
|
|
621
617
|
|
|
618
|
+
```
|
|
622
619
|
</dd>
|
|
623
620
|
</dl>
|
|
624
621
|
</dd>
|
|
@@ -633,28 +630,29 @@ await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
|
633
630
|
<dd>
|
|
634
631
|
|
|
635
632
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
636
|
-
|
|
633
|
+
|
|
637
634
|
</dd>
|
|
638
635
|
</dl>
|
|
639
636
|
|
|
640
637
|
<dl>
|
|
641
638
|
<dd>
|
|
642
639
|
|
|
643
|
-
**request:** `Phonic.AgentsDeleteCustomPhoneNumberRequest`
|
|
644
|
-
|
|
640
|
+
**request:** `Phonic.AgentsDeleteCustomPhoneNumberRequest`
|
|
641
|
+
|
|
645
642
|
</dd>
|
|
646
643
|
</dl>
|
|
647
644
|
|
|
648
645
|
<dl>
|
|
649
646
|
<dd>
|
|
650
647
|
|
|
651
|
-
**requestOptions:** `
|
|
652
|
-
|
|
648
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
649
|
+
|
|
653
650
|
</dd>
|
|
654
651
|
</dl>
|
|
655
652
|
</dd>
|
|
656
653
|
</dl>
|
|
657
654
|
|
|
655
|
+
|
|
658
656
|
</dd>
|
|
659
657
|
</dl>
|
|
660
658
|
</details>
|
|
@@ -672,7 +670,6 @@ await client.agents.deleteCustomPhoneNumber("nameOrId", {
|
|
|
672
670
|
<dd>
|
|
673
671
|
|
|
674
672
|
Updates a phone number on an agent.
|
|
675
|
-
|
|
676
673
|
</dd>
|
|
677
674
|
</dl>
|
|
678
675
|
</dd>
|
|
@@ -693,13 +690,13 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
693
690
|
configuration_endpoint: {
|
|
694
691
|
url: "https://api.example.com/config",
|
|
695
692
|
headers: {
|
|
696
|
-
Authorization: "Bearer token123"
|
|
693
|
+
"Authorization": "Bearer token123"
|
|
697
694
|
},
|
|
698
|
-
timeout_ms: 7000
|
|
699
|
-
}
|
|
695
|
+
timeout_ms: 7000
|
|
696
|
+
}
|
|
700
697
|
});
|
|
701
|
-
```
|
|
702
698
|
|
|
699
|
+
```
|
|
703
700
|
</dd>
|
|
704
701
|
</dl>
|
|
705
702
|
</dd>
|
|
@@ -714,34 +711,34 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
714
711
|
<dd>
|
|
715
712
|
|
|
716
713
|
**nameOrId:** `string` — The name or the ID of the agent.
|
|
717
|
-
|
|
714
|
+
|
|
718
715
|
</dd>
|
|
719
716
|
</dl>
|
|
720
717
|
|
|
721
718
|
<dl>
|
|
722
719
|
<dd>
|
|
723
720
|
|
|
724
|
-
**request:** `Phonic.AgentsUpdatePhoneNumberRequest`
|
|
725
|
-
|
|
721
|
+
**request:** `Phonic.AgentsUpdatePhoneNumberRequest`
|
|
722
|
+
|
|
726
723
|
</dd>
|
|
727
724
|
</dl>
|
|
728
725
|
|
|
729
726
|
<dl>
|
|
730
727
|
<dd>
|
|
731
728
|
|
|
732
|
-
**requestOptions:** `
|
|
733
|
-
|
|
729
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
730
|
+
|
|
734
731
|
</dd>
|
|
735
732
|
</dl>
|
|
736
733
|
</dd>
|
|
737
734
|
</dl>
|
|
738
735
|
|
|
736
|
+
|
|
739
737
|
</dd>
|
|
740
738
|
</dl>
|
|
741
739
|
</details>
|
|
742
740
|
|
|
743
741
|
## Tools
|
|
744
|
-
|
|
745
742
|
<details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">list</a>({ ...params }) -> Phonic.ToolsListResponse</code></summary>
|
|
746
743
|
<dl>
|
|
747
744
|
<dd>
|
|
@@ -755,7 +752,6 @@ await client.agents.updatePhoneNumber("nameOrId", {
|
|
|
755
752
|
<dd>
|
|
756
753
|
|
|
757
754
|
Returns all custom tools for the organization.
|
|
758
|
-
|
|
759
755
|
</dd>
|
|
760
756
|
</dl>
|
|
761
757
|
</dd>
|
|
@@ -771,10 +767,10 @@ Returns all custom tools for the organization.
|
|
|
771
767
|
|
|
772
768
|
```typescript
|
|
773
769
|
await client.tools.list({
|
|
774
|
-
project: "main"
|
|
770
|
+
project: "main"
|
|
775
771
|
});
|
|
776
|
-
```
|
|
777
772
|
|
|
773
|
+
```
|
|
778
774
|
</dd>
|
|
779
775
|
</dl>
|
|
780
776
|
</dd>
|
|
@@ -788,21 +784,22 @@ await client.tools.list({
|
|
|
788
784
|
<dl>
|
|
789
785
|
<dd>
|
|
790
786
|
|
|
791
|
-
**request:** `Phonic.ToolsListRequest`
|
|
792
|
-
|
|
787
|
+
**request:** `Phonic.ToolsListRequest`
|
|
788
|
+
|
|
793
789
|
</dd>
|
|
794
790
|
</dl>
|
|
795
791
|
|
|
796
792
|
<dl>
|
|
797
793
|
<dd>
|
|
798
794
|
|
|
799
|
-
**requestOptions:** `
|
|
800
|
-
|
|
795
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
796
|
+
|
|
801
797
|
</dd>
|
|
802
798
|
</dl>
|
|
803
799
|
</dd>
|
|
804
800
|
</dl>
|
|
805
801
|
|
|
802
|
+
|
|
806
803
|
</dd>
|
|
807
804
|
</dl>
|
|
808
805
|
</details>
|
|
@@ -820,7 +817,6 @@ await client.tools.list({
|
|
|
820
817
|
<dd>
|
|
821
818
|
|
|
822
819
|
Creates a new tool in a project.
|
|
823
|
-
|
|
824
820
|
</dd>
|
|
825
821
|
</dl>
|
|
826
822
|
</dd>
|
|
@@ -841,20 +837,18 @@ await client.tools.create({
|
|
|
841
837
|
description: "Gets the specific context for fixing our printer",
|
|
842
838
|
type: "custom_context",
|
|
843
839
|
execution_mode: "sync",
|
|
844
|
-
parameters: [
|
|
845
|
-
{
|
|
840
|
+
parameters: [{
|
|
846
841
|
type: "string",
|
|
847
842
|
name: "name",
|
|
848
843
|
description: "description",
|
|
849
|
-
is_required: true
|
|
850
|
-
},
|
|
851
|
-
],
|
|
844
|
+
is_required: true
|
|
845
|
+
}],
|
|
852
846
|
require_speech_before_tool_call: false,
|
|
853
847
|
forbid_speech_after_tool_call: false,
|
|
854
|
-
allow_tool_chaining: true
|
|
848
|
+
allow_tool_chaining: true
|
|
855
849
|
});
|
|
856
|
-
```
|
|
857
850
|
|
|
851
|
+
```
|
|
858
852
|
</dd>
|
|
859
853
|
</dl>
|
|
860
854
|
</dd>
|
|
@@ -868,21 +862,22 @@ await client.tools.create({
|
|
|
868
862
|
<dl>
|
|
869
863
|
<dd>
|
|
870
864
|
|
|
871
|
-
**request:** `Phonic.CreateToolRequest`
|
|
872
|
-
|
|
865
|
+
**request:** `Phonic.CreateToolRequest`
|
|
866
|
+
|
|
873
867
|
</dd>
|
|
874
868
|
</dl>
|
|
875
869
|
|
|
876
870
|
<dl>
|
|
877
871
|
<dd>
|
|
878
872
|
|
|
879
|
-
**requestOptions:** `
|
|
880
|
-
|
|
873
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
874
|
+
|
|
881
875
|
</dd>
|
|
882
876
|
</dl>
|
|
883
877
|
</dd>
|
|
884
878
|
</dl>
|
|
885
879
|
|
|
880
|
+
|
|
886
881
|
</dd>
|
|
887
882
|
</dl>
|
|
888
883
|
</details>
|
|
@@ -900,7 +895,6 @@ await client.tools.create({
|
|
|
900
895
|
<dd>
|
|
901
896
|
|
|
902
897
|
Returns a tool by name or ID.
|
|
903
|
-
|
|
904
898
|
</dd>
|
|
905
899
|
</dl>
|
|
906
900
|
</dd>
|
|
@@ -916,10 +910,10 @@ Returns a tool by name or ID.
|
|
|
916
910
|
|
|
917
911
|
```typescript
|
|
918
912
|
await client.tools.get("nameOrId", {
|
|
919
|
-
project: "main"
|
|
913
|
+
project: "main"
|
|
920
914
|
});
|
|
921
|
-
```
|
|
922
915
|
|
|
916
|
+
```
|
|
923
917
|
</dd>
|
|
924
918
|
</dl>
|
|
925
919
|
</dd>
|
|
@@ -934,28 +928,29 @@ await client.tools.get("nameOrId", {
|
|
|
934
928
|
<dd>
|
|
935
929
|
|
|
936
930
|
**nameOrId:** `string` — The name or the ID of the tool to get.
|
|
937
|
-
|
|
931
|
+
|
|
938
932
|
</dd>
|
|
939
933
|
</dl>
|
|
940
934
|
|
|
941
935
|
<dl>
|
|
942
936
|
<dd>
|
|
943
937
|
|
|
944
|
-
**request:** `Phonic.ToolsGetRequest`
|
|
945
|
-
|
|
938
|
+
**request:** `Phonic.ToolsGetRequest`
|
|
939
|
+
|
|
946
940
|
</dd>
|
|
947
941
|
</dl>
|
|
948
942
|
|
|
949
943
|
<dl>
|
|
950
944
|
<dd>
|
|
951
945
|
|
|
952
|
-
**requestOptions:** `
|
|
953
|
-
|
|
946
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
947
|
+
|
|
954
948
|
</dd>
|
|
955
949
|
</dl>
|
|
956
950
|
</dd>
|
|
957
951
|
</dl>
|
|
958
952
|
|
|
953
|
+
|
|
959
954
|
</dd>
|
|
960
955
|
</dl>
|
|
961
956
|
</details>
|
|
@@ -973,7 +968,6 @@ await client.tools.get("nameOrId", {
|
|
|
973
968
|
<dd>
|
|
974
969
|
|
|
975
970
|
Deletes a tool by name or ID.
|
|
976
|
-
|
|
977
971
|
</dd>
|
|
978
972
|
</dl>
|
|
979
973
|
</dd>
|
|
@@ -989,10 +983,10 @@ Deletes a tool by name or ID.
|
|
|
989
983
|
|
|
990
984
|
```typescript
|
|
991
985
|
await client.tools.delete("nameOrId", {
|
|
992
|
-
project: "main"
|
|
986
|
+
project: "main"
|
|
993
987
|
});
|
|
994
|
-
```
|
|
995
988
|
|
|
989
|
+
```
|
|
996
990
|
</dd>
|
|
997
991
|
</dl>
|
|
998
992
|
</dd>
|
|
@@ -1007,28 +1001,29 @@ await client.tools.delete("nameOrId", {
|
|
|
1007
1001
|
<dd>
|
|
1008
1002
|
|
|
1009
1003
|
**nameOrId:** `string` — The name or the ID of the tool to delete.
|
|
1010
|
-
|
|
1004
|
+
|
|
1011
1005
|
</dd>
|
|
1012
1006
|
</dl>
|
|
1013
1007
|
|
|
1014
1008
|
<dl>
|
|
1015
1009
|
<dd>
|
|
1016
1010
|
|
|
1017
|
-
**request:** `Phonic.ToolsDeleteRequest`
|
|
1018
|
-
|
|
1011
|
+
**request:** `Phonic.ToolsDeleteRequest`
|
|
1012
|
+
|
|
1019
1013
|
</dd>
|
|
1020
1014
|
</dl>
|
|
1021
1015
|
|
|
1022
1016
|
<dl>
|
|
1023
1017
|
<dd>
|
|
1024
1018
|
|
|
1025
|
-
**requestOptions:** `
|
|
1026
|
-
|
|
1019
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1020
|
+
|
|
1027
1021
|
</dd>
|
|
1028
1022
|
</dl>
|
|
1029
1023
|
</dd>
|
|
1030
1024
|
</dl>
|
|
1031
1025
|
|
|
1026
|
+
|
|
1032
1027
|
</dd>
|
|
1033
1028
|
</dl>
|
|
1034
1029
|
</details>
|
|
@@ -1046,7 +1041,6 @@ await client.tools.delete("nameOrId", {
|
|
|
1046
1041
|
<dd>
|
|
1047
1042
|
|
|
1048
1043
|
Updates a tool by name or ID.
|
|
1049
|
-
|
|
1050
1044
|
</dd>
|
|
1051
1045
|
</dl>
|
|
1052
1046
|
</dd>
|
|
@@ -1065,12 +1059,12 @@ await client.tools.update("nameOrId", {
|
|
|
1065
1059
|
project: "main",
|
|
1066
1060
|
description: "Updated description for booking appointments with enhanced features",
|
|
1067
1061
|
endpoint_headers: {
|
|
1068
|
-
Authorization: "Bearer updated_token456"
|
|
1062
|
+
"Authorization": "Bearer updated_token456"
|
|
1069
1063
|
},
|
|
1070
|
-
endpoint_timeout_ms: 7000
|
|
1064
|
+
endpoint_timeout_ms: 7000
|
|
1071
1065
|
});
|
|
1072
|
-
```
|
|
1073
1066
|
|
|
1067
|
+
```
|
|
1074
1068
|
</dd>
|
|
1075
1069
|
</dl>
|
|
1076
1070
|
</dd>
|
|
@@ -1085,34 +1079,34 @@ await client.tools.update("nameOrId", {
|
|
|
1085
1079
|
<dd>
|
|
1086
1080
|
|
|
1087
1081
|
**nameOrId:** `string` — The name or the ID of the tool to update.
|
|
1088
|
-
|
|
1082
|
+
|
|
1089
1083
|
</dd>
|
|
1090
1084
|
</dl>
|
|
1091
1085
|
|
|
1092
1086
|
<dl>
|
|
1093
1087
|
<dd>
|
|
1094
1088
|
|
|
1095
|
-
**request:** `Phonic.UpdateToolRequest`
|
|
1096
|
-
|
|
1089
|
+
**request:** `Phonic.UpdateToolRequest`
|
|
1090
|
+
|
|
1097
1091
|
</dd>
|
|
1098
1092
|
</dl>
|
|
1099
1093
|
|
|
1100
1094
|
<dl>
|
|
1101
1095
|
<dd>
|
|
1102
1096
|
|
|
1103
|
-
**requestOptions:** `
|
|
1104
|
-
|
|
1097
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1098
|
+
|
|
1105
1099
|
</dd>
|
|
1106
1100
|
</dl>
|
|
1107
1101
|
</dd>
|
|
1108
1102
|
</dl>
|
|
1109
1103
|
|
|
1104
|
+
|
|
1110
1105
|
</dd>
|
|
1111
1106
|
</dl>
|
|
1112
1107
|
</details>
|
|
1113
1108
|
|
|
1114
1109
|
## ExtractionSchemas
|
|
1115
|
-
|
|
1116
1110
|
<details><summary><code>client.extractionSchemas.<a href="/src/api/resources/extractionSchemas/client/Client.ts">list</a>({ ...params }) -> Phonic.ExtractionSchemasListResponse</code></summary>
|
|
1117
1111
|
<dl>
|
|
1118
1112
|
<dd>
|
|
@@ -1126,7 +1120,6 @@ await client.tools.update("nameOrId", {
|
|
|
1126
1120
|
<dd>
|
|
1127
1121
|
|
|
1128
1122
|
Returns all extraction schemas in a project.
|
|
1129
|
-
|
|
1130
1123
|
</dd>
|
|
1131
1124
|
</dl>
|
|
1132
1125
|
</dd>
|
|
@@ -1142,10 +1135,10 @@ Returns all extraction schemas in a project.
|
|
|
1142
1135
|
|
|
1143
1136
|
```typescript
|
|
1144
1137
|
await client.extractionSchemas.list({
|
|
1145
|
-
project: "main"
|
|
1138
|
+
project: "main"
|
|
1146
1139
|
});
|
|
1147
|
-
```
|
|
1148
1140
|
|
|
1141
|
+
```
|
|
1149
1142
|
</dd>
|
|
1150
1143
|
</dl>
|
|
1151
1144
|
</dd>
|
|
@@ -1159,21 +1152,22 @@ await client.extractionSchemas.list({
|
|
|
1159
1152
|
<dl>
|
|
1160
1153
|
<dd>
|
|
1161
1154
|
|
|
1162
|
-
**request:** `Phonic.ExtractionSchemasListRequest`
|
|
1163
|
-
|
|
1155
|
+
**request:** `Phonic.ExtractionSchemasListRequest`
|
|
1156
|
+
|
|
1164
1157
|
</dd>
|
|
1165
1158
|
</dl>
|
|
1166
1159
|
|
|
1167
1160
|
<dl>
|
|
1168
1161
|
<dd>
|
|
1169
1162
|
|
|
1170
|
-
**requestOptions:** `
|
|
1171
|
-
|
|
1163
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1164
|
+
|
|
1172
1165
|
</dd>
|
|
1173
1166
|
</dl>
|
|
1174
1167
|
</dd>
|
|
1175
1168
|
</dl>
|
|
1176
1169
|
|
|
1170
|
+
|
|
1177
1171
|
</dd>
|
|
1178
1172
|
</dl>
|
|
1179
1173
|
</details>
|
|
@@ -1191,7 +1185,6 @@ await client.extractionSchemas.list({
|
|
|
1191
1185
|
<dd>
|
|
1192
1186
|
|
|
1193
1187
|
Creates a new extraction schema in a project.
|
|
1194
|
-
|
|
1195
1188
|
</dd>
|
|
1196
1189
|
</dl>
|
|
1197
1190
|
</dd>
|
|
@@ -1210,26 +1203,22 @@ await client.extractionSchemas.create({
|
|
|
1210
1203
|
project: "main",
|
|
1211
1204
|
name: "Appointment details",
|
|
1212
1205
|
prompt: "Dates should be in `9 Apr 2025` format. Prices should be in $150.00 format.",
|
|
1213
|
-
fields: [
|
|
1214
|
-
{
|
|
1206
|
+
fields: [{
|
|
1215
1207
|
name: "Date",
|
|
1216
1208
|
type: "string",
|
|
1217
|
-
description: "The date of the appointment"
|
|
1218
|
-
},
|
|
1219
|
-
{
|
|
1209
|
+
description: "The date of the appointment"
|
|
1210
|
+
}, {
|
|
1220
1211
|
name: "Copay",
|
|
1221
1212
|
type: "string",
|
|
1222
|
-
description: "Amount of money the patient pays for the appointment"
|
|
1223
|
-
},
|
|
1224
|
-
{
|
|
1213
|
+
description: "Amount of money the patient pays for the appointment"
|
|
1214
|
+
}, {
|
|
1225
1215
|
name: "Confirmed as booked",
|
|
1226
1216
|
type: "bool",
|
|
1227
|
-
description: "Is the appointment confirmed as booked?"
|
|
1228
|
-
}
|
|
1229
|
-
],
|
|
1217
|
+
description: "Is the appointment confirmed as booked?"
|
|
1218
|
+
}]
|
|
1230
1219
|
});
|
|
1231
|
-
```
|
|
1232
1220
|
|
|
1221
|
+
```
|
|
1233
1222
|
</dd>
|
|
1234
1223
|
</dl>
|
|
1235
1224
|
</dd>
|
|
@@ -1243,21 +1232,22 @@ await client.extractionSchemas.create({
|
|
|
1243
1232
|
<dl>
|
|
1244
1233
|
<dd>
|
|
1245
1234
|
|
|
1246
|
-
**request:** `Phonic.CreateExtractionSchemaRequest`
|
|
1247
|
-
|
|
1235
|
+
**request:** `Phonic.CreateExtractionSchemaRequest`
|
|
1236
|
+
|
|
1248
1237
|
</dd>
|
|
1249
1238
|
</dl>
|
|
1250
1239
|
|
|
1251
1240
|
<dl>
|
|
1252
1241
|
<dd>
|
|
1253
1242
|
|
|
1254
|
-
**requestOptions:** `
|
|
1255
|
-
|
|
1243
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1244
|
+
|
|
1256
1245
|
</dd>
|
|
1257
1246
|
</dl>
|
|
1258
1247
|
</dd>
|
|
1259
1248
|
</dl>
|
|
1260
1249
|
|
|
1250
|
+
|
|
1261
1251
|
</dd>
|
|
1262
1252
|
</dl>
|
|
1263
1253
|
</details>
|
|
@@ -1275,7 +1265,6 @@ await client.extractionSchemas.create({
|
|
|
1275
1265
|
<dd>
|
|
1276
1266
|
|
|
1277
1267
|
Returns an extraction schema by name or ID.
|
|
1278
|
-
|
|
1279
1268
|
</dd>
|
|
1280
1269
|
</dl>
|
|
1281
1270
|
</dd>
|
|
@@ -1291,10 +1280,10 @@ Returns an extraction schema by name or ID.
|
|
|
1291
1280
|
|
|
1292
1281
|
```typescript
|
|
1293
1282
|
await client.extractionSchemas.get("nameOrId", {
|
|
1294
|
-
project: "main"
|
|
1283
|
+
project: "main"
|
|
1295
1284
|
});
|
|
1296
|
-
```
|
|
1297
1285
|
|
|
1286
|
+
```
|
|
1298
1287
|
</dd>
|
|
1299
1288
|
</dl>
|
|
1300
1289
|
</dd>
|
|
@@ -1309,28 +1298,29 @@ await client.extractionSchemas.get("nameOrId", {
|
|
|
1309
1298
|
<dd>
|
|
1310
1299
|
|
|
1311
1300
|
**nameOrId:** `string` — The name or the ID of the extraction schema to get.
|
|
1312
|
-
|
|
1301
|
+
|
|
1313
1302
|
</dd>
|
|
1314
1303
|
</dl>
|
|
1315
1304
|
|
|
1316
1305
|
<dl>
|
|
1317
1306
|
<dd>
|
|
1318
1307
|
|
|
1319
|
-
**request:** `Phonic.ExtractionSchemasGetRequest`
|
|
1320
|
-
|
|
1308
|
+
**request:** `Phonic.ExtractionSchemasGetRequest`
|
|
1309
|
+
|
|
1321
1310
|
</dd>
|
|
1322
1311
|
</dl>
|
|
1323
1312
|
|
|
1324
1313
|
<dl>
|
|
1325
1314
|
<dd>
|
|
1326
1315
|
|
|
1327
|
-
**requestOptions:** `
|
|
1328
|
-
|
|
1316
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1317
|
+
|
|
1329
1318
|
</dd>
|
|
1330
1319
|
</dl>
|
|
1331
1320
|
</dd>
|
|
1332
1321
|
</dl>
|
|
1333
1322
|
|
|
1323
|
+
|
|
1334
1324
|
</dd>
|
|
1335
1325
|
</dl>
|
|
1336
1326
|
</details>
|
|
@@ -1348,7 +1338,6 @@ await client.extractionSchemas.get("nameOrId", {
|
|
|
1348
1338
|
<dd>
|
|
1349
1339
|
|
|
1350
1340
|
Deletes an extraction schema by name or ID.
|
|
1351
|
-
|
|
1352
1341
|
</dd>
|
|
1353
1342
|
</dl>
|
|
1354
1343
|
</dd>
|
|
@@ -1364,10 +1353,10 @@ Deletes an extraction schema by name or ID.
|
|
|
1364
1353
|
|
|
1365
1354
|
```typescript
|
|
1366
1355
|
await client.extractionSchemas.delete("nameOrId", {
|
|
1367
|
-
project: "main"
|
|
1356
|
+
project: "main"
|
|
1368
1357
|
});
|
|
1369
|
-
```
|
|
1370
1358
|
|
|
1359
|
+
```
|
|
1371
1360
|
</dd>
|
|
1372
1361
|
</dl>
|
|
1373
1362
|
</dd>
|
|
@@ -1382,28 +1371,29 @@ await client.extractionSchemas.delete("nameOrId", {
|
|
|
1382
1371
|
<dd>
|
|
1383
1372
|
|
|
1384
1373
|
**nameOrId:** `string` — The name or the ID of the extraction schema to delete.
|
|
1385
|
-
|
|
1374
|
+
|
|
1386
1375
|
</dd>
|
|
1387
1376
|
</dl>
|
|
1388
1377
|
|
|
1389
1378
|
<dl>
|
|
1390
1379
|
<dd>
|
|
1391
1380
|
|
|
1392
|
-
**request:** `Phonic.ExtractionSchemasDeleteRequest`
|
|
1393
|
-
|
|
1381
|
+
**request:** `Phonic.ExtractionSchemasDeleteRequest`
|
|
1382
|
+
|
|
1394
1383
|
</dd>
|
|
1395
1384
|
</dl>
|
|
1396
1385
|
|
|
1397
1386
|
<dl>
|
|
1398
1387
|
<dd>
|
|
1399
1388
|
|
|
1400
|
-
**requestOptions:** `
|
|
1401
|
-
|
|
1389
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1390
|
+
|
|
1402
1391
|
</dd>
|
|
1403
1392
|
</dl>
|
|
1404
1393
|
</dd>
|
|
1405
1394
|
</dl>
|
|
1406
1395
|
|
|
1396
|
+
|
|
1407
1397
|
</dd>
|
|
1408
1398
|
</dl>
|
|
1409
1399
|
</details>
|
|
@@ -1421,7 +1411,6 @@ await client.extractionSchemas.delete("nameOrId", {
|
|
|
1421
1411
|
<dd>
|
|
1422
1412
|
|
|
1423
1413
|
Updates an extraction schema by name or ID.
|
|
1424
|
-
|
|
1425
1414
|
</dd>
|
|
1426
1415
|
</dl>
|
|
1427
1416
|
</dd>
|
|
@@ -1440,21 +1429,18 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1440
1429
|
project: "main",
|
|
1441
1430
|
name: "Updated appointment details",
|
|
1442
1431
|
prompt: "Updated extraction instructions. Dates should be in `9 Apr 2025` format.",
|
|
1443
|
-
fields: [
|
|
1444
|
-
{
|
|
1432
|
+
fields: [{
|
|
1445
1433
|
name: "Date",
|
|
1446
1434
|
type: "string",
|
|
1447
|
-
description: "The date of the appointment"
|
|
1448
|
-
},
|
|
1449
|
-
{
|
|
1435
|
+
description: "The date of the appointment"
|
|
1436
|
+
}, {
|
|
1450
1437
|
name: "Time",
|
|
1451
1438
|
type: "string",
|
|
1452
|
-
description: "The time of the appointment"
|
|
1453
|
-
}
|
|
1454
|
-
],
|
|
1439
|
+
description: "The time of the appointment"
|
|
1440
|
+
}]
|
|
1455
1441
|
});
|
|
1456
|
-
```
|
|
1457
1442
|
|
|
1443
|
+
```
|
|
1458
1444
|
</dd>
|
|
1459
1445
|
</dl>
|
|
1460
1446
|
</dd>
|
|
@@ -1469,34 +1455,34 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1469
1455
|
<dd>
|
|
1470
1456
|
|
|
1471
1457
|
**nameOrId:** `string` — The name or the ID of the extraction schema to update.
|
|
1472
|
-
|
|
1458
|
+
|
|
1473
1459
|
</dd>
|
|
1474
1460
|
</dl>
|
|
1475
1461
|
|
|
1476
1462
|
<dl>
|
|
1477
1463
|
<dd>
|
|
1478
1464
|
|
|
1479
|
-
**request:** `Phonic.UpdateExtractionSchemaRequest`
|
|
1480
|
-
|
|
1465
|
+
**request:** `Phonic.UpdateExtractionSchemaRequest`
|
|
1466
|
+
|
|
1481
1467
|
</dd>
|
|
1482
1468
|
</dl>
|
|
1483
1469
|
|
|
1484
1470
|
<dl>
|
|
1485
1471
|
<dd>
|
|
1486
1472
|
|
|
1487
|
-
**requestOptions:** `
|
|
1488
|
-
|
|
1473
|
+
**requestOptions:** `ExtractionSchemasClient.RequestOptions`
|
|
1474
|
+
|
|
1489
1475
|
</dd>
|
|
1490
1476
|
</dl>
|
|
1491
1477
|
</dd>
|
|
1492
1478
|
</dl>
|
|
1493
1479
|
|
|
1480
|
+
|
|
1494
1481
|
</dd>
|
|
1495
1482
|
</dl>
|
|
1496
1483
|
</details>
|
|
1497
1484
|
|
|
1498
1485
|
## Voices
|
|
1499
|
-
|
|
1500
1486
|
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">list</a>({ ...params }) -> Phonic.VoicesListResponse</code></summary>
|
|
1501
1487
|
<dl>
|
|
1502
1488
|
<dd>
|
|
@@ -1510,7 +1496,6 @@ await client.extractionSchemas.update("nameOrId", {
|
|
|
1510
1496
|
<dd>
|
|
1511
1497
|
|
|
1512
1498
|
Returns all available voices for a model.
|
|
1513
|
-
|
|
1514
1499
|
</dd>
|
|
1515
1500
|
</dl>
|
|
1516
1501
|
</dd>
|
|
@@ -1526,10 +1511,10 @@ Returns all available voices for a model.
|
|
|
1526
1511
|
|
|
1527
1512
|
```typescript
|
|
1528
1513
|
await client.voices.list({
|
|
1529
|
-
model: "merritt"
|
|
1514
|
+
model: "merritt"
|
|
1530
1515
|
});
|
|
1531
|
-
```
|
|
1532
1516
|
|
|
1517
|
+
```
|
|
1533
1518
|
</dd>
|
|
1534
1519
|
</dl>
|
|
1535
1520
|
</dd>
|
|
@@ -1543,21 +1528,22 @@ await client.voices.list({
|
|
|
1543
1528
|
<dl>
|
|
1544
1529
|
<dd>
|
|
1545
1530
|
|
|
1546
|
-
**request:** `Phonic.VoicesListRequest`
|
|
1547
|
-
|
|
1531
|
+
**request:** `Phonic.VoicesListRequest`
|
|
1532
|
+
|
|
1548
1533
|
</dd>
|
|
1549
1534
|
</dl>
|
|
1550
1535
|
|
|
1551
1536
|
<dl>
|
|
1552
1537
|
<dd>
|
|
1553
1538
|
|
|
1554
|
-
**requestOptions:** `
|
|
1555
|
-
|
|
1539
|
+
**requestOptions:** `VoicesClient.RequestOptions`
|
|
1540
|
+
|
|
1556
1541
|
</dd>
|
|
1557
1542
|
</dl>
|
|
1558
1543
|
</dd>
|
|
1559
1544
|
</dl>
|
|
1560
1545
|
|
|
1546
|
+
|
|
1561
1547
|
</dd>
|
|
1562
1548
|
</dl>
|
|
1563
1549
|
</details>
|
|
@@ -1575,7 +1561,6 @@ await client.voices.list({
|
|
|
1575
1561
|
<dd>
|
|
1576
1562
|
|
|
1577
1563
|
Returns a voice by ID.
|
|
1578
|
-
|
|
1579
1564
|
</dd>
|
|
1580
1565
|
</dl>
|
|
1581
1566
|
</dd>
|
|
@@ -1591,8 +1576,8 @@ Returns a voice by ID.
|
|
|
1591
1576
|
|
|
1592
1577
|
```typescript
|
|
1593
1578
|
await client.voices.get("id");
|
|
1594
|
-
```
|
|
1595
1579
|
|
|
1580
|
+
```
|
|
1596
1581
|
</dd>
|
|
1597
1582
|
</dl>
|
|
1598
1583
|
</dd>
|
|
@@ -1607,26 +1592,26 @@ await client.voices.get("id");
|
|
|
1607
1592
|
<dd>
|
|
1608
1593
|
|
|
1609
1594
|
**id:** `string` — The ID of the voice to get.
|
|
1610
|
-
|
|
1595
|
+
|
|
1611
1596
|
</dd>
|
|
1612
1597
|
</dl>
|
|
1613
1598
|
|
|
1614
1599
|
<dl>
|
|
1615
1600
|
<dd>
|
|
1616
1601
|
|
|
1617
|
-
**requestOptions:** `
|
|
1618
|
-
|
|
1602
|
+
**requestOptions:** `VoicesClient.RequestOptions`
|
|
1603
|
+
|
|
1619
1604
|
</dd>
|
|
1620
1605
|
</dl>
|
|
1621
1606
|
</dd>
|
|
1622
1607
|
</dl>
|
|
1623
1608
|
|
|
1609
|
+
|
|
1624
1610
|
</dd>
|
|
1625
1611
|
</dl>
|
|
1626
1612
|
</details>
|
|
1627
1613
|
|
|
1628
1614
|
## Conversations
|
|
1629
|
-
|
|
1630
1615
|
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">list</a>({ ...params }) -> Phonic.ConversationsListResponse</code></summary>
|
|
1631
1616
|
<dl>
|
|
1632
1617
|
<dd>
|
|
@@ -1640,7 +1625,6 @@ await client.voices.get("id");
|
|
|
1640
1625
|
<dd>
|
|
1641
1626
|
|
|
1642
1627
|
Returns conversations with optional filtering.
|
|
1643
|
-
|
|
1644
1628
|
</dd>
|
|
1645
1629
|
</dl>
|
|
1646
1630
|
</dd>
|
|
@@ -1656,8 +1640,8 @@ Returns conversations with optional filtering.
|
|
|
1656
1640
|
|
|
1657
1641
|
```typescript
|
|
1658
1642
|
await client.conversations.list();
|
|
1659
|
-
```
|
|
1660
1643
|
|
|
1644
|
+
```
|
|
1661
1645
|
</dd>
|
|
1662
1646
|
</dl>
|
|
1663
1647
|
</dd>
|
|
@@ -1671,21 +1655,22 @@ await client.conversations.list();
|
|
|
1671
1655
|
<dl>
|
|
1672
1656
|
<dd>
|
|
1673
1657
|
|
|
1674
|
-
**request:** `Phonic.ConversationsListRequest`
|
|
1675
|
-
|
|
1658
|
+
**request:** `Phonic.ConversationsListRequest`
|
|
1659
|
+
|
|
1676
1660
|
</dd>
|
|
1677
1661
|
</dl>
|
|
1678
1662
|
|
|
1679
1663
|
<dl>
|
|
1680
1664
|
<dd>
|
|
1681
1665
|
|
|
1682
|
-
**requestOptions:** `
|
|
1683
|
-
|
|
1666
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1667
|
+
|
|
1684
1668
|
</dd>
|
|
1685
1669
|
</dl>
|
|
1686
1670
|
</dd>
|
|
1687
1671
|
</dl>
|
|
1688
1672
|
|
|
1673
|
+
|
|
1689
1674
|
</dd>
|
|
1690
1675
|
</dl>
|
|
1691
1676
|
</details>
|
|
@@ -1703,7 +1688,6 @@ await client.conversations.list();
|
|
|
1703
1688
|
<dd>
|
|
1704
1689
|
|
|
1705
1690
|
Returns a conversation by ID.
|
|
1706
|
-
|
|
1707
1691
|
</dd>
|
|
1708
1692
|
</dl>
|
|
1709
1693
|
</dd>
|
|
@@ -1719,8 +1703,8 @@ Returns a conversation by ID.
|
|
|
1719
1703
|
|
|
1720
1704
|
```typescript
|
|
1721
1705
|
await client.conversations.get("id");
|
|
1722
|
-
```
|
|
1723
1706
|
|
|
1707
|
+
```
|
|
1724
1708
|
</dd>
|
|
1725
1709
|
</dl>
|
|
1726
1710
|
</dd>
|
|
@@ -1735,20 +1719,21 @@ await client.conversations.get("id");
|
|
|
1735
1719
|
<dd>
|
|
1736
1720
|
|
|
1737
1721
|
**id:** `string` — The ID of the conversation to get.
|
|
1738
|
-
|
|
1722
|
+
|
|
1739
1723
|
</dd>
|
|
1740
1724
|
</dl>
|
|
1741
1725
|
|
|
1742
1726
|
<dl>
|
|
1743
1727
|
<dd>
|
|
1744
1728
|
|
|
1745
|
-
**requestOptions:** `
|
|
1746
|
-
|
|
1729
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1730
|
+
|
|
1747
1731
|
</dd>
|
|
1748
1732
|
</dl>
|
|
1749
1733
|
</dd>
|
|
1750
1734
|
</dl>
|
|
1751
1735
|
|
|
1736
|
+
|
|
1752
1737
|
</dd>
|
|
1753
1738
|
</dl>
|
|
1754
1739
|
</details>
|
|
@@ -1766,7 +1751,6 @@ await client.conversations.get("id");
|
|
|
1766
1751
|
<dd>
|
|
1767
1752
|
|
|
1768
1753
|
Cancels an active conversation.
|
|
1769
|
-
|
|
1770
1754
|
</dd>
|
|
1771
1755
|
</dl>
|
|
1772
1756
|
</dd>
|
|
@@ -1782,8 +1766,8 @@ Cancels an active conversation.
|
|
|
1782
1766
|
|
|
1783
1767
|
```typescript
|
|
1784
1768
|
await client.conversations.cancel("id");
|
|
1785
|
-
```
|
|
1786
1769
|
|
|
1770
|
+
```
|
|
1787
1771
|
</dd>
|
|
1788
1772
|
</dl>
|
|
1789
1773
|
</dd>
|
|
@@ -1798,20 +1782,21 @@ await client.conversations.cancel("id");
|
|
|
1798
1782
|
<dd>
|
|
1799
1783
|
|
|
1800
1784
|
**id:** `string` — The ID of the conversation to cancel.
|
|
1801
|
-
|
|
1785
|
+
|
|
1802
1786
|
</dd>
|
|
1803
1787
|
</dl>
|
|
1804
1788
|
|
|
1805
1789
|
<dl>
|
|
1806
1790
|
<dd>
|
|
1807
1791
|
|
|
1808
|
-
**requestOptions:** `
|
|
1809
|
-
|
|
1792
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1793
|
+
|
|
1810
1794
|
</dd>
|
|
1811
1795
|
</dl>
|
|
1812
1796
|
</dd>
|
|
1813
1797
|
</dl>
|
|
1814
1798
|
|
|
1799
|
+
|
|
1815
1800
|
</dd>
|
|
1816
1801
|
</dl>
|
|
1817
1802
|
</details>
|
|
@@ -1829,7 +1814,6 @@ await client.conversations.cancel("id");
|
|
|
1829
1814
|
<dd>
|
|
1830
1815
|
|
|
1831
1816
|
Returns an analysis of the specified conversation.
|
|
1832
|
-
|
|
1833
1817
|
</dd>
|
|
1834
1818
|
</dl>
|
|
1835
1819
|
</dd>
|
|
@@ -1845,8 +1829,8 @@ Returns an analysis of the specified conversation.
|
|
|
1845
1829
|
|
|
1846
1830
|
```typescript
|
|
1847
1831
|
await client.conversations.getAnalysis("id");
|
|
1848
|
-
```
|
|
1849
1832
|
|
|
1833
|
+
```
|
|
1850
1834
|
</dd>
|
|
1851
1835
|
</dl>
|
|
1852
1836
|
</dd>
|
|
@@ -1861,20 +1845,21 @@ await client.conversations.getAnalysis("id");
|
|
|
1861
1845
|
<dd>
|
|
1862
1846
|
|
|
1863
1847
|
**id:** `string` — The ID of the conversation to analyze.
|
|
1864
|
-
|
|
1848
|
+
|
|
1865
1849
|
</dd>
|
|
1866
1850
|
</dl>
|
|
1867
1851
|
|
|
1868
1852
|
<dl>
|
|
1869
1853
|
<dd>
|
|
1870
1854
|
|
|
1871
|
-
**requestOptions:** `
|
|
1872
|
-
|
|
1855
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1856
|
+
|
|
1873
1857
|
</dd>
|
|
1874
1858
|
</dl>
|
|
1875
1859
|
</dd>
|
|
1876
1860
|
</dl>
|
|
1877
1861
|
|
|
1862
|
+
|
|
1878
1863
|
</dd>
|
|
1879
1864
|
</dl>
|
|
1880
1865
|
</details>
|
|
@@ -1892,7 +1877,6 @@ await client.conversations.getAnalysis("id");
|
|
|
1892
1877
|
<dd>
|
|
1893
1878
|
|
|
1894
1879
|
Returns all extractions for a conversation.
|
|
1895
|
-
|
|
1896
1880
|
</dd>
|
|
1897
1881
|
</dl>
|
|
1898
1882
|
</dd>
|
|
@@ -1908,8 +1892,8 @@ Returns all extractions for a conversation.
|
|
|
1908
1892
|
|
|
1909
1893
|
```typescript
|
|
1910
1894
|
await client.conversations.listExtractions("id");
|
|
1911
|
-
```
|
|
1912
1895
|
|
|
1896
|
+
```
|
|
1913
1897
|
</dd>
|
|
1914
1898
|
</dl>
|
|
1915
1899
|
</dd>
|
|
@@ -1924,20 +1908,21 @@ await client.conversations.listExtractions("id");
|
|
|
1924
1908
|
<dd>
|
|
1925
1909
|
|
|
1926
1910
|
**id:** `string` — The ID of the conversation to get extractions for.
|
|
1927
|
-
|
|
1911
|
+
|
|
1928
1912
|
</dd>
|
|
1929
1913
|
</dl>
|
|
1930
1914
|
|
|
1931
1915
|
<dl>
|
|
1932
1916
|
<dd>
|
|
1933
1917
|
|
|
1934
|
-
**requestOptions:** `
|
|
1935
|
-
|
|
1918
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1919
|
+
|
|
1936
1920
|
</dd>
|
|
1937
1921
|
</dl>
|
|
1938
1922
|
</dd>
|
|
1939
1923
|
</dl>
|
|
1940
1924
|
|
|
1925
|
+
|
|
1941
1926
|
</dd>
|
|
1942
1927
|
</dl>
|
|
1943
1928
|
</details>
|
|
@@ -1955,7 +1940,6 @@ await client.conversations.listExtractions("id");
|
|
|
1955
1940
|
<dd>
|
|
1956
1941
|
|
|
1957
1942
|
Extracts data from a conversation using a schema.
|
|
1958
|
-
|
|
1959
1943
|
</dd>
|
|
1960
1944
|
</dl>
|
|
1961
1945
|
</dd>
|
|
@@ -1971,10 +1955,10 @@ Extracts data from a conversation using a schema.
|
|
|
1971
1955
|
|
|
1972
1956
|
```typescript
|
|
1973
1957
|
await client.conversations.extractData("id", {
|
|
1974
|
-
schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
|
|
1958
|
+
schema_id: "conv_extract_schema_6458e4ac-533c-4bdf-8e6d-c2f06f87fd5c"
|
|
1975
1959
|
});
|
|
1976
|
-
```
|
|
1977
1960
|
|
|
1961
|
+
```
|
|
1978
1962
|
</dd>
|
|
1979
1963
|
</dl>
|
|
1980
1964
|
</dd>
|
|
@@ -1989,28 +1973,29 @@ await client.conversations.extractData("id", {
|
|
|
1989
1973
|
<dd>
|
|
1990
1974
|
|
|
1991
1975
|
**id:** `string` — The ID of the conversation to extract data from.
|
|
1992
|
-
|
|
1976
|
+
|
|
1993
1977
|
</dd>
|
|
1994
1978
|
</dl>
|
|
1995
1979
|
|
|
1996
1980
|
<dl>
|
|
1997
1981
|
<dd>
|
|
1998
1982
|
|
|
1999
|
-
**request:** `Phonic.ExtractDataRequest`
|
|
2000
|
-
|
|
1983
|
+
**request:** `Phonic.ExtractDataRequest`
|
|
1984
|
+
|
|
2001
1985
|
</dd>
|
|
2002
1986
|
</dl>
|
|
2003
1987
|
|
|
2004
1988
|
<dl>
|
|
2005
1989
|
<dd>
|
|
2006
1990
|
|
|
2007
|
-
**requestOptions:** `
|
|
2008
|
-
|
|
1991
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
1992
|
+
|
|
2009
1993
|
</dd>
|
|
2010
1994
|
</dl>
|
|
2011
1995
|
</dd>
|
|
2012
1996
|
</dl>
|
|
2013
1997
|
|
|
1998
|
+
|
|
2014
1999
|
</dd>
|
|
2015
2000
|
</dl>
|
|
2016
2001
|
</details>
|
|
@@ -2028,7 +2013,6 @@ await client.conversations.extractData("id", {
|
|
|
2028
2013
|
<dd>
|
|
2029
2014
|
|
|
2030
2015
|
Returns all evaluations for a conversation.
|
|
2031
|
-
|
|
2032
2016
|
</dd>
|
|
2033
2017
|
</dl>
|
|
2034
2018
|
</dd>
|
|
@@ -2044,8 +2028,8 @@ Returns all evaluations for a conversation.
|
|
|
2044
2028
|
|
|
2045
2029
|
```typescript
|
|
2046
2030
|
await client.conversations.listEvaluations("id");
|
|
2047
|
-
```
|
|
2048
2031
|
|
|
2032
|
+
```
|
|
2049
2033
|
</dd>
|
|
2050
2034
|
</dl>
|
|
2051
2035
|
</dd>
|
|
@@ -2060,20 +2044,21 @@ await client.conversations.listEvaluations("id");
|
|
|
2060
2044
|
<dd>
|
|
2061
2045
|
|
|
2062
2046
|
**id:** `string` — The ID of the conversation to get evaluations for.
|
|
2063
|
-
|
|
2047
|
+
|
|
2064
2048
|
</dd>
|
|
2065
2049
|
</dl>
|
|
2066
2050
|
|
|
2067
2051
|
<dl>
|
|
2068
2052
|
<dd>
|
|
2069
2053
|
|
|
2070
|
-
**requestOptions:** `
|
|
2071
|
-
|
|
2054
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2055
|
+
|
|
2072
2056
|
</dd>
|
|
2073
2057
|
</dl>
|
|
2074
2058
|
</dd>
|
|
2075
2059
|
</dl>
|
|
2076
2060
|
|
|
2061
|
+
|
|
2077
2062
|
</dd>
|
|
2078
2063
|
</dl>
|
|
2079
2064
|
</details>
|
|
@@ -2091,7 +2076,6 @@ await client.conversations.listEvaluations("id");
|
|
|
2091
2076
|
<dd>
|
|
2092
2077
|
|
|
2093
2078
|
Evaluates a conversation using an evaluation prompt.
|
|
2094
|
-
|
|
2095
2079
|
</dd>
|
|
2096
2080
|
</dl>
|
|
2097
2081
|
</dd>
|
|
@@ -2107,10 +2091,10 @@ Evaluates a conversation using an evaluation prompt.
|
|
|
2107
2091
|
|
|
2108
2092
|
```typescript
|
|
2109
2093
|
await client.conversations.evaluate("id", {
|
|
2110
|
-
prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
|
|
2094
|
+
prompt_id: "conv_eval_prompt_d7cfe45d-35db-4ef6-a254-81ab1da76ce0"
|
|
2111
2095
|
});
|
|
2112
|
-
```
|
|
2113
2096
|
|
|
2097
|
+
```
|
|
2114
2098
|
</dd>
|
|
2115
2099
|
</dl>
|
|
2116
2100
|
</dd>
|
|
@@ -2125,28 +2109,29 @@ await client.conversations.evaluate("id", {
|
|
|
2125
2109
|
<dd>
|
|
2126
2110
|
|
|
2127
2111
|
**id:** `string` — The ID of the conversation to evaluate.
|
|
2128
|
-
|
|
2112
|
+
|
|
2129
2113
|
</dd>
|
|
2130
2114
|
</dl>
|
|
2131
2115
|
|
|
2132
2116
|
<dl>
|
|
2133
2117
|
<dd>
|
|
2134
2118
|
|
|
2135
|
-
**request:** `Phonic.EvaluateConversationRequest`
|
|
2136
|
-
|
|
2119
|
+
**request:** `Phonic.EvaluateConversationRequest`
|
|
2120
|
+
|
|
2137
2121
|
</dd>
|
|
2138
2122
|
</dl>
|
|
2139
2123
|
|
|
2140
2124
|
<dl>
|
|
2141
2125
|
<dd>
|
|
2142
2126
|
|
|
2143
|
-
**requestOptions:** `
|
|
2144
|
-
|
|
2127
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2128
|
+
|
|
2145
2129
|
</dd>
|
|
2146
2130
|
</dl>
|
|
2147
2131
|
</dd>
|
|
2148
2132
|
</dl>
|
|
2149
2133
|
|
|
2134
|
+
|
|
2150
2135
|
</dd>
|
|
2151
2136
|
</dl>
|
|
2152
2137
|
</details>
|
|
@@ -2164,7 +2149,6 @@ await client.conversations.evaluate("id", {
|
|
|
2164
2149
|
<dd>
|
|
2165
2150
|
|
|
2166
2151
|
Initiates a call to a given phone number using Phonic's Twilio account.
|
|
2167
|
-
|
|
2168
2152
|
</dd>
|
|
2169
2153
|
</dl>
|
|
2170
2154
|
</dd>
|
|
@@ -2186,8 +2170,8 @@ await client.conversations.outboundCall({
|
|
|
2186
2170
|
welcome_message: "Hi {{customer_name}}. How can I help you today?",
|
|
2187
2171
|
system_prompt: "You are an expert in {{subject}}. Be friendly, helpful and concise.",
|
|
2188
2172
|
template_variables: {
|
|
2189
|
-
customer_name: "David",
|
|
2190
|
-
subject: "Chess"
|
|
2173
|
+
"customer_name": "David",
|
|
2174
|
+
"subject": "Chess"
|
|
2191
2175
|
},
|
|
2192
2176
|
voice_id: "sabrina",
|
|
2193
2177
|
generate_no_input_poke_text: false,
|
|
@@ -2196,11 +2180,11 @@ await client.conversations.outboundCall({
|
|
|
2196
2180
|
no_input_end_conversation_sec: 180,
|
|
2197
2181
|
languages: ["en", "es"],
|
|
2198
2182
|
boosted_keywords: ["Load ID", "dispatch"],
|
|
2199
|
-
tools: ["keypad_input"]
|
|
2200
|
-
}
|
|
2183
|
+
tools: ["keypad_input"]
|
|
2184
|
+
}
|
|
2201
2185
|
});
|
|
2202
|
-
```
|
|
2203
2186
|
|
|
2187
|
+
```
|
|
2204
2188
|
</dd>
|
|
2205
2189
|
</dl>
|
|
2206
2190
|
</dd>
|
|
@@ -2214,21 +2198,22 @@ await client.conversations.outboundCall({
|
|
|
2214
2198
|
<dl>
|
|
2215
2199
|
<dd>
|
|
2216
2200
|
|
|
2217
|
-
**request:** `Phonic.OutboundCallRequest`
|
|
2218
|
-
|
|
2201
|
+
**request:** `Phonic.OutboundCallRequest`
|
|
2202
|
+
|
|
2219
2203
|
</dd>
|
|
2220
2204
|
</dl>
|
|
2221
2205
|
|
|
2222
2206
|
<dl>
|
|
2223
2207
|
<dd>
|
|
2224
2208
|
|
|
2225
|
-
**requestOptions:** `
|
|
2226
|
-
|
|
2209
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2210
|
+
|
|
2227
2211
|
</dd>
|
|
2228
2212
|
</dl>
|
|
2229
2213
|
</dd>
|
|
2230
2214
|
</dl>
|
|
2231
2215
|
|
|
2216
|
+
|
|
2232
2217
|
</dd>
|
|
2233
2218
|
</dl>
|
|
2234
2219
|
</details>
|
|
@@ -2246,7 +2231,6 @@ await client.conversations.outboundCall({
|
|
|
2246
2231
|
<dd>
|
|
2247
2232
|
|
|
2248
2233
|
Initiates a SIP outbound call using user-supplied SIP credentials in headers.
|
|
2249
|
-
|
|
2250
2234
|
</dd>
|
|
2251
2235
|
</dl>
|
|
2252
2236
|
</dd>
|
|
@@ -2264,10 +2248,10 @@ Initiates a SIP outbound call using user-supplied SIP credentials in headers.
|
|
|
2264
2248
|
await client.conversations.sipOutboundCall({
|
|
2265
2249
|
"X-Sip-Address": "X-Sip-Address",
|
|
2266
2250
|
from_phone_number: "from_phone_number",
|
|
2267
|
-
to_phone_number: "to_phone_number"
|
|
2251
|
+
to_phone_number: "to_phone_number"
|
|
2268
2252
|
});
|
|
2269
|
-
```
|
|
2270
2253
|
|
|
2254
|
+
```
|
|
2271
2255
|
</dd>
|
|
2272
2256
|
</dl>
|
|
2273
2257
|
</dd>
|
|
@@ -2281,27 +2265,27 @@ await client.conversations.sipOutboundCall({
|
|
|
2281
2265
|
<dl>
|
|
2282
2266
|
<dd>
|
|
2283
2267
|
|
|
2284
|
-
**request:** `Phonic.ConversationsSipOutboundCallRequest`
|
|
2285
|
-
|
|
2268
|
+
**request:** `Phonic.ConversationsSipOutboundCallRequest`
|
|
2269
|
+
|
|
2286
2270
|
</dd>
|
|
2287
2271
|
</dl>
|
|
2288
2272
|
|
|
2289
2273
|
<dl>
|
|
2290
2274
|
<dd>
|
|
2291
2275
|
|
|
2292
|
-
**requestOptions:** `
|
|
2293
|
-
|
|
2276
|
+
**requestOptions:** `ConversationsClient.RequestOptions`
|
|
2277
|
+
|
|
2294
2278
|
</dd>
|
|
2295
2279
|
</dl>
|
|
2296
2280
|
</dd>
|
|
2297
2281
|
</dl>
|
|
2298
2282
|
|
|
2283
|
+
|
|
2299
2284
|
</dd>
|
|
2300
2285
|
</dl>
|
|
2301
2286
|
</details>
|
|
2302
2287
|
|
|
2303
2288
|
## Auth
|
|
2304
|
-
|
|
2305
2289
|
<details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">createSessionToken</a>({ ...params }) -> Phonic.AuthCreateSessionTokenResponse</code></summary>
|
|
2306
2290
|
<dl>
|
|
2307
2291
|
<dd>
|
|
@@ -2315,7 +2299,6 @@ await client.conversations.sipOutboundCall({
|
|
|
2315
2299
|
<dd>
|
|
2316
2300
|
|
|
2317
2301
|
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
2302
|
</dd>
|
|
2320
2303
|
</dl>
|
|
2321
2304
|
</dd>
|
|
@@ -2331,10 +2314,10 @@ Creates a short-lived session token that can be used to authenticate WebSocket c
|
|
|
2331
2314
|
|
|
2332
2315
|
```typescript
|
|
2333
2316
|
await client.auth.createSessionToken({
|
|
2334
|
-
ttl_seconds: 300
|
|
2317
|
+
ttl_seconds: 300
|
|
2335
2318
|
});
|
|
2336
|
-
```
|
|
2337
2319
|
|
|
2320
|
+
```
|
|
2338
2321
|
</dd>
|
|
2339
2322
|
</dl>
|
|
2340
2323
|
</dd>
|
|
@@ -2348,27 +2331,27 @@ await client.auth.createSessionToken({
|
|
|
2348
2331
|
<dl>
|
|
2349
2332
|
<dd>
|
|
2350
2333
|
|
|
2351
|
-
**request:** `Phonic.CreateSessionTokenRequest`
|
|
2352
|
-
|
|
2334
|
+
**request:** `Phonic.CreateSessionTokenRequest`
|
|
2335
|
+
|
|
2353
2336
|
</dd>
|
|
2354
2337
|
</dl>
|
|
2355
2338
|
|
|
2356
2339
|
<dl>
|
|
2357
2340
|
<dd>
|
|
2358
2341
|
|
|
2359
|
-
**requestOptions:** `
|
|
2360
|
-
|
|
2342
|
+
**requestOptions:** `AuthClient.RequestOptions`
|
|
2343
|
+
|
|
2361
2344
|
</dd>
|
|
2362
2345
|
</dl>
|
|
2363
2346
|
</dd>
|
|
2364
2347
|
</dl>
|
|
2365
2348
|
|
|
2349
|
+
|
|
2366
2350
|
</dd>
|
|
2367
2351
|
</dl>
|
|
2368
2352
|
</details>
|
|
2369
2353
|
|
|
2370
2354
|
## Projects
|
|
2371
|
-
|
|
2372
2355
|
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">list</a>() -> Phonic.ProjectsListResponse</code></summary>
|
|
2373
2356
|
<dl>
|
|
2374
2357
|
<dd>
|
|
@@ -2382,7 +2365,6 @@ await client.auth.createSessionToken({
|
|
|
2382
2365
|
<dd>
|
|
2383
2366
|
|
|
2384
2367
|
Returns all projects in a workspace.
|
|
2385
|
-
|
|
2386
2368
|
</dd>
|
|
2387
2369
|
</dl>
|
|
2388
2370
|
</dd>
|
|
@@ -2398,8 +2380,8 @@ Returns all projects in a workspace.
|
|
|
2398
2380
|
|
|
2399
2381
|
```typescript
|
|
2400
2382
|
await client.projects.list();
|
|
2401
|
-
```
|
|
2402
2383
|
|
|
2384
|
+
```
|
|
2403
2385
|
</dd>
|
|
2404
2386
|
</dl>
|
|
2405
2387
|
</dd>
|
|
@@ -2413,13 +2395,14 @@ await client.projects.list();
|
|
|
2413
2395
|
<dl>
|
|
2414
2396
|
<dd>
|
|
2415
2397
|
|
|
2416
|
-
**requestOptions:** `
|
|
2417
|
-
|
|
2398
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2399
|
+
|
|
2418
2400
|
</dd>
|
|
2419
2401
|
</dl>
|
|
2420
2402
|
</dd>
|
|
2421
2403
|
</dl>
|
|
2422
2404
|
|
|
2405
|
+
|
|
2423
2406
|
</dd>
|
|
2424
2407
|
</dl>
|
|
2425
2408
|
</details>
|
|
@@ -2437,7 +2420,6 @@ await client.projects.list();
|
|
|
2437
2420
|
<dd>
|
|
2438
2421
|
|
|
2439
2422
|
Creates a new project in a workspace.
|
|
2440
|
-
|
|
2441
2423
|
</dd>
|
|
2442
2424
|
</dl>
|
|
2443
2425
|
</dd>
|
|
@@ -2453,10 +2435,10 @@ Creates a new project in a workspace.
|
|
|
2453
2435
|
|
|
2454
2436
|
```typescript
|
|
2455
2437
|
await client.projects.create({
|
|
2456
|
-
name: "customer-support"
|
|
2438
|
+
name: "customer-support"
|
|
2457
2439
|
});
|
|
2458
|
-
```
|
|
2459
2440
|
|
|
2441
|
+
```
|
|
2460
2442
|
</dd>
|
|
2461
2443
|
</dl>
|
|
2462
2444
|
</dd>
|
|
@@ -2470,21 +2452,22 @@ await client.projects.create({
|
|
|
2470
2452
|
<dl>
|
|
2471
2453
|
<dd>
|
|
2472
2454
|
|
|
2473
|
-
**request:** `Phonic.CreateProjectRequest`
|
|
2474
|
-
|
|
2455
|
+
**request:** `Phonic.CreateProjectRequest`
|
|
2456
|
+
|
|
2475
2457
|
</dd>
|
|
2476
2458
|
</dl>
|
|
2477
2459
|
|
|
2478
2460
|
<dl>
|
|
2479
2461
|
<dd>
|
|
2480
2462
|
|
|
2481
|
-
**requestOptions:** `
|
|
2482
|
-
|
|
2463
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2464
|
+
|
|
2483
2465
|
</dd>
|
|
2484
2466
|
</dl>
|
|
2485
2467
|
</dd>
|
|
2486
2468
|
</dl>
|
|
2487
2469
|
|
|
2470
|
+
|
|
2488
2471
|
</dd>
|
|
2489
2472
|
</dl>
|
|
2490
2473
|
</details>
|
|
@@ -2502,7 +2485,6 @@ await client.projects.create({
|
|
|
2502
2485
|
<dd>
|
|
2503
2486
|
|
|
2504
2487
|
Returns a project by name or ID.
|
|
2505
|
-
|
|
2506
2488
|
</dd>
|
|
2507
2489
|
</dl>
|
|
2508
2490
|
</dd>
|
|
@@ -2518,8 +2500,8 @@ Returns a project by name or ID.
|
|
|
2518
2500
|
|
|
2519
2501
|
```typescript
|
|
2520
2502
|
await client.projects.get("nameOrId");
|
|
2521
|
-
```
|
|
2522
2503
|
|
|
2504
|
+
```
|
|
2523
2505
|
</dd>
|
|
2524
2506
|
</dl>
|
|
2525
2507
|
</dd>
|
|
@@ -2534,20 +2516,21 @@ await client.projects.get("nameOrId");
|
|
|
2534
2516
|
<dd>
|
|
2535
2517
|
|
|
2536
2518
|
**nameOrId:** `string` — The name or the ID of the project to get.
|
|
2537
|
-
|
|
2519
|
+
|
|
2538
2520
|
</dd>
|
|
2539
2521
|
</dl>
|
|
2540
2522
|
|
|
2541
2523
|
<dl>
|
|
2542
2524
|
<dd>
|
|
2543
2525
|
|
|
2544
|
-
**requestOptions:** `
|
|
2545
|
-
|
|
2526
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2527
|
+
|
|
2546
2528
|
</dd>
|
|
2547
2529
|
</dl>
|
|
2548
2530
|
</dd>
|
|
2549
2531
|
</dl>
|
|
2550
2532
|
|
|
2533
|
+
|
|
2551
2534
|
</dd>
|
|
2552
2535
|
</dl>
|
|
2553
2536
|
</details>
|
|
@@ -2565,7 +2548,6 @@ await client.projects.get("nameOrId");
|
|
|
2565
2548
|
<dd>
|
|
2566
2549
|
|
|
2567
2550
|
Deletes a project by name or ID.
|
|
2568
|
-
|
|
2569
2551
|
</dd>
|
|
2570
2552
|
</dl>
|
|
2571
2553
|
</dd>
|
|
@@ -2581,8 +2563,8 @@ Deletes a project by name or ID.
|
|
|
2581
2563
|
|
|
2582
2564
|
```typescript
|
|
2583
2565
|
await client.projects.delete("nameOrId");
|
|
2584
|
-
```
|
|
2585
2566
|
|
|
2567
|
+
```
|
|
2586
2568
|
</dd>
|
|
2587
2569
|
</dl>
|
|
2588
2570
|
</dd>
|
|
@@ -2597,20 +2579,21 @@ await client.projects.delete("nameOrId");
|
|
|
2597
2579
|
<dd>
|
|
2598
2580
|
|
|
2599
2581
|
**nameOrId:** `string` — The name or the ID of the project to delete.
|
|
2600
|
-
|
|
2582
|
+
|
|
2601
2583
|
</dd>
|
|
2602
2584
|
</dl>
|
|
2603
2585
|
|
|
2604
2586
|
<dl>
|
|
2605
2587
|
<dd>
|
|
2606
2588
|
|
|
2607
|
-
**requestOptions:** `
|
|
2608
|
-
|
|
2589
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2590
|
+
|
|
2609
2591
|
</dd>
|
|
2610
2592
|
</dl>
|
|
2611
2593
|
</dd>
|
|
2612
2594
|
</dl>
|
|
2613
2595
|
|
|
2596
|
+
|
|
2614
2597
|
</dd>
|
|
2615
2598
|
</dl>
|
|
2616
2599
|
</details>
|
|
@@ -2628,7 +2611,6 @@ await client.projects.delete("nameOrId");
|
|
|
2628
2611
|
<dd>
|
|
2629
2612
|
|
|
2630
2613
|
Updates a project by name or ID.
|
|
2631
|
-
|
|
2632
2614
|
</dd>
|
|
2633
2615
|
</dl>
|
|
2634
2616
|
</dd>
|
|
@@ -2645,10 +2627,10 @@ Updates a project by name or ID.
|
|
|
2645
2627
|
```typescript
|
|
2646
2628
|
await client.projects.update("nameOrId", {
|
|
2647
2629
|
name: "updated-customer-support",
|
|
2648
|
-
default_agent: "another-agent"
|
|
2630
|
+
default_agent: "another-agent"
|
|
2649
2631
|
});
|
|
2650
|
-
```
|
|
2651
2632
|
|
|
2633
|
+
```
|
|
2652
2634
|
</dd>
|
|
2653
2635
|
</dl>
|
|
2654
2636
|
</dd>
|
|
@@ -2663,28 +2645,29 @@ await client.projects.update("nameOrId", {
|
|
|
2663
2645
|
<dd>
|
|
2664
2646
|
|
|
2665
2647
|
**nameOrId:** `string` — The name or the ID of the project to update.
|
|
2666
|
-
|
|
2648
|
+
|
|
2667
2649
|
</dd>
|
|
2668
2650
|
</dl>
|
|
2669
2651
|
|
|
2670
2652
|
<dl>
|
|
2671
2653
|
<dd>
|
|
2672
2654
|
|
|
2673
|
-
**request:** `Phonic.UpdateProjectRequest`
|
|
2674
|
-
|
|
2655
|
+
**request:** `Phonic.UpdateProjectRequest`
|
|
2656
|
+
|
|
2675
2657
|
</dd>
|
|
2676
2658
|
</dl>
|
|
2677
2659
|
|
|
2678
2660
|
<dl>
|
|
2679
2661
|
<dd>
|
|
2680
2662
|
|
|
2681
|
-
**requestOptions:** `
|
|
2682
|
-
|
|
2663
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2664
|
+
|
|
2683
2665
|
</dd>
|
|
2684
2666
|
</dl>
|
|
2685
2667
|
</dd>
|
|
2686
2668
|
</dl>
|
|
2687
2669
|
|
|
2670
|
+
|
|
2688
2671
|
</dd>
|
|
2689
2672
|
</dl>
|
|
2690
2673
|
</details>
|
|
@@ -2702,7 +2685,6 @@ await client.projects.update("nameOrId", {
|
|
|
2702
2685
|
<dd>
|
|
2703
2686
|
|
|
2704
2687
|
Returns all conversation evaluation prompts for a project.
|
|
2705
|
-
|
|
2706
2688
|
</dd>
|
|
2707
2689
|
</dl>
|
|
2708
2690
|
</dd>
|
|
@@ -2718,8 +2700,8 @@ Returns all conversation evaluation prompts for a project.
|
|
|
2718
2700
|
|
|
2719
2701
|
```typescript
|
|
2720
2702
|
await client.projects.listEvalPrompts("id");
|
|
2721
|
-
```
|
|
2722
2703
|
|
|
2704
|
+
```
|
|
2723
2705
|
</dd>
|
|
2724
2706
|
</dl>
|
|
2725
2707
|
</dd>
|
|
@@ -2734,20 +2716,21 @@ await client.projects.listEvalPrompts("id");
|
|
|
2734
2716
|
<dd>
|
|
2735
2717
|
|
|
2736
2718
|
**id:** `string` — The ID of the project.
|
|
2737
|
-
|
|
2719
|
+
|
|
2738
2720
|
</dd>
|
|
2739
2721
|
</dl>
|
|
2740
2722
|
|
|
2741
2723
|
<dl>
|
|
2742
2724
|
<dd>
|
|
2743
2725
|
|
|
2744
|
-
**requestOptions:** `
|
|
2745
|
-
|
|
2726
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2727
|
+
|
|
2746
2728
|
</dd>
|
|
2747
2729
|
</dl>
|
|
2748
2730
|
</dd>
|
|
2749
2731
|
</dl>
|
|
2750
2732
|
|
|
2733
|
+
|
|
2751
2734
|
</dd>
|
|
2752
2735
|
</dl>
|
|
2753
2736
|
</details>
|
|
@@ -2765,7 +2748,6 @@ await client.projects.listEvalPrompts("id");
|
|
|
2765
2748
|
<dd>
|
|
2766
2749
|
|
|
2767
2750
|
Creates a new conversation evaluation prompt for a project.
|
|
2768
|
-
|
|
2769
2751
|
</dd>
|
|
2770
2752
|
</dl>
|
|
2771
2753
|
</dd>
|
|
@@ -2782,10 +2764,10 @@ Creates a new conversation evaluation prompt for a project.
|
|
|
2782
2764
|
```typescript
|
|
2783
2765
|
await client.projects.createEvalPrompt("id", {
|
|
2784
2766
|
name: "test_prompt",
|
|
2785
|
-
prompt: "The assistant used the word chocolate in the conversation"
|
|
2767
|
+
prompt: "The assistant used the word chocolate in the conversation"
|
|
2786
2768
|
});
|
|
2787
|
-
```
|
|
2788
2769
|
|
|
2770
|
+
```
|
|
2789
2771
|
</dd>
|
|
2790
2772
|
</dl>
|
|
2791
2773
|
</dd>
|
|
@@ -2800,28 +2782,30 @@ await client.projects.createEvalPrompt("id", {
|
|
|
2800
2782
|
<dd>
|
|
2801
2783
|
|
|
2802
2784
|
**id:** `string` — The ID of the project.
|
|
2803
|
-
|
|
2785
|
+
|
|
2804
2786
|
</dd>
|
|
2805
2787
|
</dl>
|
|
2806
2788
|
|
|
2807
2789
|
<dl>
|
|
2808
2790
|
<dd>
|
|
2809
2791
|
|
|
2810
|
-
**request:** `Phonic.CreateConversationEvalPromptRequest`
|
|
2811
|
-
|
|
2792
|
+
**request:** `Phonic.CreateConversationEvalPromptRequest`
|
|
2793
|
+
|
|
2812
2794
|
</dd>
|
|
2813
2795
|
</dl>
|
|
2814
2796
|
|
|
2815
2797
|
<dl>
|
|
2816
2798
|
<dd>
|
|
2817
2799
|
|
|
2818
|
-
**requestOptions:** `
|
|
2819
|
-
|
|
2800
|
+
**requestOptions:** `ProjectsClient.RequestOptions`
|
|
2801
|
+
|
|
2820
2802
|
</dd>
|
|
2821
2803
|
</dl>
|
|
2822
2804
|
</dd>
|
|
2823
2805
|
</dl>
|
|
2824
2806
|
|
|
2807
|
+
|
|
2825
2808
|
</dd>
|
|
2826
2809
|
</dl>
|
|
2827
2810
|
</details>
|
|
2811
|
+
|