From 7ed7e5bc026a828c8cd991e0d68c3fb79bbaed9f Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 16:34:08 +0000 Subject: [PATCH 1/4] [fern-generated] Update SDK Generated by Fern CLI Version: unknown Generators: - fernapi/fern-typescript-sdk: 3.63.0 --- .fern/metadata.json | 6 +- .fern/replay.lock | 10 + .fernignore | 3 + .gitattributes | 1 + package.json | 2 +- pnpm-lock.yaml | 146 +-- reference.md | 984 +++++++++++++++++- src/BaseClient.ts | 4 +- src/api/resources/analytics/client/Client.ts | 2 + src/api/resources/assistants/client/Client.ts | 10 + .../client/requests/UpdateAssistantDto.ts | 3 + src/api/resources/calls/client/Client.ts | 10 + src/api/resources/campaigns/client/Client.ts | 10 + src/api/resources/eval/client/Client.ts | 18 + src/api/resources/files/client/Client.ts | 10 + src/api/resources/insight/client/Client.ts | 14 + .../insight/client/requests/InsightRunDto.ts | 1 + .../observabilityScorecard/client/Client.ts | 10 + .../resources/phoneNumbers/client/Client.ts | 12 + .../providerResources/client/Client.ts | 10 + src/api/resources/squads/client/Client.ts | 10 + .../structuredOutputs/client/Client.ts | 12 + src/api/resources/tools/client/Client.ts | 10 + src/api/types/AiEdgeCondition.ts | 4 + src/api/types/AiEdgeConditionType.ts | 1 + src/api/types/Analysis.ts | 3 + src/api/types/AnalysisCost.ts | 3 + src/api/types/AnalysisCostBreakdown.ts | 3 + src/api/types/AnalysisPlan.ts | 3 + src/api/types/AnalyticsOperation.ts | 3 + src/api/types/AnalyticsQuery.ts | 3 + src/api/types/AnalyticsQueryResult.ts | 3 + src/api/types/AnthropicBedrockModel.ts | 3 + src/api/types/AnthropicModel.ts | 3 + src/api/types/AnthropicThinkingConfig.ts | 4 + src/api/types/AnthropicThinkingConfigType.ts | 1 + src/api/types/AnyscaleModel.ts | 3 + src/api/types/ApiRequestTool.ts | 4 + src/api/types/ApiRequestToolMethod.ts | 1 + src/api/types/Artifact.ts | 3 + src/api/types/ArtifactPlan.ts | 3 + src/api/types/AssemblyAiTranscriber.ts | 3 + src/api/types/Assistant.ts | 6 + src/api/types/AssistantActivation.ts | 3 + .../types/AssistantCustomEndpointingRule.ts | 3 + src/api/types/AssistantMessage.ts | 3 + .../AssistantMessageEvaluationContinuePlan.ts | 3 + src/api/types/AssistantMessageJudgePlanAi.ts | 3 + .../types/AssistantMessageJudgePlanExact.ts | 3 + .../types/AssistantMessageJudgePlanRegex.ts | 3 + src/api/types/AssistantOverrides.ts | 7 + src/api/types/AwsStsAuthenticationPlan.ts | 3 + .../AwsiamCredentialsAuthenticationPlan.ts | 3 + src/api/types/AzureBlobStorageBucketPlan.ts | 3 + src/api/types/AzureSpeechTranscriber.ts | 3 + src/api/types/AzureVoice.ts | 3 + .../types/BackgroundSpeechDenoisingPlan.ts | 3 + src/api/types/BackoffPlan.ts | 10 +- src/api/types/BarInsight.ts | 4 + src/api/types/BarInsightMetadata.ts | 8 + src/api/types/BashTool.ts | 3 + src/api/types/BearerAuthenticationPlan.ts | 3 + src/api/types/BotMessage.ts | 3 + src/api/types/BothCustomEndpointingRule.ts | 4 + src/api/types/BucketPlan.ts | 3 + src/api/types/ByoPhoneNumber.ts | 3 + src/api/types/Call.ts | 4 + src/api/types/CallBatchError.ts | 5 + src/api/types/CallBatchResponse.ts | 3 + .../CallHookAssistantSpeechInterrupted.ts | 3 + src/api/types/CallHookCallEnding.ts | 3 + .../CallHookCustomerSpeechInterrupted.ts | 3 + .../types/CallHookCustomerSpeechTimeout.ts | 5 +- src/api/types/CallHookFilter.ts | 3 + src/api/types/CallHookModelResponseTimeout.ts | 3 + src/api/types/Campaign.ts | 3 + src/api/types/CampaignPaginatedResponse.ts | 5 + src/api/types/CartesiaExperimentalControls.ts | 5 + .../CartesiaExperimentalControlsEmotion.ts | 1 + src/api/types/CartesiaGenerationConfig.ts | 3 + .../CartesiaGenerationConfigExperimental.ts | 3 + src/api/types/CartesiaSpeedControl.ts | 3 + src/api/types/CartesiaTranscriber.ts | 5 + src/api/types/CartesiaTranscriberLanguage.ts | 1 + src/api/types/CartesiaTranscriberModel.ts | 1 + src/api/types/CartesiaVoice.ts | 3 + src/api/types/CerebrasModel.ts | 3 + .../ChatEvalAssistantMessageEvaluation.ts | 3 + src/api/types/ChatEvalAssistantMessageMock.ts | 3 + .../ChatEvalAssistantMessageMockToolCall.ts | 3 + src/api/types/ChatEvalSystemMessageMock.ts | 3 + .../ChatEvalToolResponseMessageEvaluation.ts | 3 + .../types/ChatEvalToolResponseMessageMock.ts | 3 + src/api/types/ChatEvalUserMessageMock.ts | 3 + src/api/types/ChunkPlan.ts | 3 + src/api/types/CloudflareR2BucketPlan.ts | 3 + src/api/types/CodeTool.ts | 3 + src/api/types/CodeToolEnvironmentVariable.ts | 3 + src/api/types/Compliance.ts | 3 + src/api/types/ComplianceOverride.ts | 3 + src/api/types/CompliancePlan.ts | 4 + .../CompliancePlanRecordingConsentPlan.ts | 3 + src/api/types/ComputerTool.ts | 3 + src/api/types/Condition.ts | 3 + src/api/types/ContextEngineeringPlanAll.ts | 3 + .../ContextEngineeringPlanLastNMessages.ts | 3 + src/api/types/ContextEngineeringPlanNone.ts | 3 + ...EngineeringPlanUserAndAssistantMessages.ts | 3 + src/api/types/ConversationNode.ts | 5 + src/api/types/CostBreakdown.ts | 3 + .../CreateAnthropicBedrockCredentialDto.ts | 3 + src/api/types/CreateAnthropicCredentialDto.ts | 3 + src/api/types/CreateAnyscaleCredentialDto.ts | 3 + src/api/types/CreateApiRequestToolDto.ts | 4 + .../types/CreateApiRequestToolDtoMethod.ts | 1 + .../types/CreateAssemblyAiCredentialDto.ts | 3 + src/api/types/CreateAssistantDto.ts | 6 + src/api/types/CreateAzureCredentialDto.ts | 3 + .../types/CreateAzureOpenAiCredentialDto.ts | 6 + .../CreateAzureOpenAiCredentialDtoRegion.ts | 1 + .../types/CreateBarInsightFromCallTableDto.ts | 4 + src/api/types/CreateBashToolDto.ts | 3 + src/api/types/CreateByoPhoneNumberDto.ts | 3 + .../types/CreateByoSipTrunkCredentialDto.ts | 3 + src/api/types/CreateCartesiaCredentialDto.ts | 3 + src/api/types/CreateCerebrasCredentialDto.ts | 3 + .../types/CreateCloudflareCredentialDto.ts | 3 + src/api/types/CreateCodeToolDto.ts | 3 + src/api/types/CreateComputerToolDto.ts | 3 + src/api/types/CreateCustomCredentialDto.ts | 3 + src/api/types/CreateCustomKnowledgeBaseDto.ts | 3 + src/api/types/CreateCustomLlmCredentialDto.ts | 3 + src/api/types/CreateCustomerDto.ts | 3 + src/api/types/CreateDeepInfraCredentialDto.ts | 3 + src/api/types/CreateDeepSeekCredentialDto.ts | 3 + src/api/types/CreateDeepgramCredentialDto.ts | 3 + src/api/types/CreateDtmfToolDto.ts | 3 + .../types/CreateElevenLabsCredentialDto.ts | 3 + src/api/types/CreateEmailCredentialDto.ts | 3 + src/api/types/CreateEndCallToolDto.ts | 3 + src/api/types/CreateEvalDto.ts | 3 + src/api/types/CreateFunctionToolDto.ts | 3 + src/api/types/CreateGcpCredentialDto.ts | 4 + src/api/types/CreateGladiaCredentialDto.ts | 3 + ...eGoHighLevelCalendarAvailabilityToolDto.ts | 3 + ...teGoHighLevelCalendarEventCreateToolDto.ts | 3 + .../CreateGoHighLevelContactCreateToolDto.ts | 3 + .../CreateGoHighLevelContactGetToolDto.ts | 3 + .../types/CreateGoHighLevelCredentialDto.ts | 3 + .../CreateGoHighLevelMcpCredentialDto.ts | 3 + ...eGoogleCalendarCheckAvailabilityToolDto.ts | 3 + .../CreateGoogleCalendarCreateEventToolDto.ts | 3 + ...alendarOAuth2AuthorizationCredentialDto.ts | 3 + ...GoogleCalendarOAuth2ClientCredentialDto.ts | 3 + src/api/types/CreateGoogleCredentialDto.ts | 3 + ...eSheetsOAuth2AuthorizationCredentialDto.ts | 3 + .../CreateGoogleSheetsRowAppendToolDto.ts | 3 + src/api/types/CreateGroqCredentialDto.ts | 3 + src/api/types/CreateHandoffToolDto.ts | 3 + src/api/types/CreateHumeCredentialDto.ts | 3 + .../types/CreateInflectionAiCredentialDto.ts | 3 + src/api/types/CreateInworldCredentialDto.ts | 3 + src/api/types/CreateLangfuseCredentialDto.ts | 3 + .../CreateLineInsightFromCallTableDto.ts | 4 + src/api/types/CreateLmntCredentialDto.ts | 3 + src/api/types/CreateMakeCredentialDto.ts | 3 + src/api/types/CreateMcpToolDto.ts | 4 + src/api/types/CreateMinimaxCredentialDto.ts | 3 + src/api/types/CreateMistralCredentialDto.ts | 3 + src/api/types/CreateNeuphonicCredentialDto.ts | 3 + src/api/types/CreateOpenAiCredentialDto.ts | 3 + .../types/CreateOpenRouterCredentialDto.ts | 3 + .../types/CreatePerplexityAiCredentialDto.ts | 3 + .../types/CreatePieInsightFromCallTableDto.ts | 4 + src/api/types/CreatePlayHtCredentialDto.ts | 4 + src/api/types/CreateQueryToolDto.ts | 3 + src/api/types/CreateRimeAiCredentialDto.ts | 3 + src/api/types/CreateRunpodCredentialDto.ts | 3 + src/api/types/CreateS3CredentialDto.ts | 3 + src/api/types/CreateScorecardDto.ts | 3 + src/api/types/CreateSipRequestToolDto.ts | 3 + ...teSlackOAuth2AuthorizationCredentialDto.ts | 3 + .../types/CreateSlackSendMessageToolDto.ts | 3 + .../types/CreateSlackWebhookCredentialDto.ts | 3 + .../types/CreateSmallestAiCredentialDto.ts | 3 + src/api/types/CreateSmsToolDto.ts | 3 + src/api/types/CreateSonioxCredentialDto.ts | 3 + .../types/CreateSpeechmaticsCredentialDto.ts | 3 + src/api/types/CreateSquadDto.ts | 3 + src/api/types/CreateStructuredOutputDto.ts | 3 + src/api/types/CreateSupabaseCredentialDto.ts | 4 + src/api/types/CreateTavusCredentialDto.ts | 3 + src/api/types/CreateTelnyxPhoneNumberDto.ts | 3 + src/api/types/CreateTextEditorToolDto.ts | 3 + .../CreateTextInsightFromCallTableDto.ts | 4 + .../types/CreateTogetherAiCredentialDto.ts | 3 + src/api/types/CreateTransferCallToolDto.ts | 3 + src/api/types/CreateTrieveCredentialDto.ts | 3 + src/api/types/CreateTwilioCredentialDto.ts | 4 + src/api/types/CreateTwilioPhoneNumberDto.ts | 3 + src/api/types/CreateVapiPhoneNumberDto.ts | 3 + src/api/types/CreateVoicemailToolDto.ts | 3 + src/api/types/CreateVonageCredentialDto.ts | 4 + src/api/types/CreateVonagePhoneNumberDto.ts | 3 + src/api/types/CreateWellSaidCredentialDto.ts | 3 + src/api/types/CreateWorkflowDto.ts | 7 + src/api/types/CreateXAiCredentialDto.ts | 3 + ...tomEndpointingModelSmartEndpointingPlan.ts | 3 + src/api/types/CustomLlmModel.ts | 3 + src/api/types/CustomMessage.ts | 3 + src/api/types/CustomTranscriber.ts | 3 + src/api/types/CustomVoice.ts | 3 + .../types/CustomerCustomEndpointingRule.ts | 3 + src/api/types/CustomerSpeechTimeoutOptions.ts | 9 +- src/api/types/DeepInfraModel.ts | 3 + src/api/types/DeepSeekModel.ts | 3 + src/api/types/DeepgramTranscriber.ts | 3 + src/api/types/DeepgramVoice.ts | 3 + src/api/types/DeveloperMessage.ts | 3 + src/api/types/DialPlanEntry.ts | 3 + src/api/types/DtmfTool.ts | 3 + src/api/types/Edge.ts | 6 + ...levenLabsPronunciationDictionaryLocator.ts | 3 + src/api/types/ElevenLabsTranscriber.ts | 3 + src/api/types/ElevenLabsVoice.ts | 3 + src/api/types/EndCallTool.ts | 3 + src/api/types/Eval.ts | 7 + src/api/types/EvalAnthropicModel.ts | 3 + src/api/types/EvalCustomModel.ts | 3 + src/api/types/EvalGoogleModel.ts | 3 + src/api/types/EvalOpenAiModel.ts | 3 + src/api/types/EvalPaginatedResponse.ts | 5 + src/api/types/EvalRun.ts | 8 + src/api/types/EvalRunPaginatedResponse.ts | 5 + src/api/types/EvalRunResult.ts | 3 + src/api/types/EvalRunTargetAssistant.ts | 3 + src/api/types/EvalRunTargetSquad.ts | 3 + src/api/types/EventsTableBooleanCondition.ts | 3 + src/api/types/EventsTableNumberCondition.ts | 3 + src/api/types/EventsTableStringCondition.ts | 3 + src/api/types/ExactReplacement.ts | 3 + .../types/FallbackAssemblyAiTranscriber.ts | 3 + .../types/FallbackAzureSpeechTranscriber.ts | 3 + src/api/types/FallbackAzureVoice.ts | 3 + src/api/types/FallbackCartesiaTranscriber.ts | 5 + .../FallbackCartesiaTranscriberLanguage.ts | 1 + .../types/FallbackCartesiaTranscriberModel.ts | 1 + src/api/types/FallbackCartesiaVoice.ts | 3 + src/api/types/FallbackCustomTranscriber.ts | 3 + src/api/types/FallbackCustomVoice.ts | 3 + src/api/types/FallbackDeepgramTranscriber.ts | 3 + src/api/types/FallbackDeepgramVoice.ts | 3 + .../types/FallbackElevenLabsTranscriber.ts | 3 + src/api/types/FallbackElevenLabsVoice.ts | 3 + src/api/types/FallbackGladiaTranscriber.ts | 3 + src/api/types/FallbackGoogleTranscriber.ts | 3 + src/api/types/FallbackHumeVoice.ts | 3 + src/api/types/FallbackInworldVoice.ts | 3 + src/api/types/FallbackLmntVoice.ts | 3 + src/api/types/FallbackNeuphonicVoice.ts | 3 + src/api/types/FallbackOpenAiTranscriber.ts | 3 + src/api/types/FallbackOpenAiVoice.ts | 3 + src/api/types/FallbackPlan.ts | 3 + src/api/types/FallbackPlayHtVoice.ts | 3 + src/api/types/FallbackRimeAiVoice.ts | 3 + src/api/types/FallbackSesameVoice.ts | 3 + src/api/types/FallbackSmallestAiVoice.ts | 3 + src/api/types/FallbackSonioxTranscriber.ts | 3 + .../types/FallbackSpeechmaticsTranscriber.ts | 5 + ...FallbackSpeechmaticsTranscriberLanguage.ts | 1 + .../types/FallbackTalkscriberTranscriber.ts | 3 + src/api/types/FallbackTavusVoice.ts | 3 + src/api/types/FallbackTranscriberPlan.ts | 4 + src/api/types/FallbackVapiVoice.ts | 3 + src/api/types/FallbackWellSaidVoice.ts | 3 + src/api/types/FileObject.ts | 1 + src/api/types/FileStatus.ts | 1 + src/api/types/File_.ts | 16 + .../types/FilterDateTypeColumnOnCallTable.ts | 3 + .../FilterNumberArrayTypeColumnOnCallTable.ts | 3 + .../FilterNumberTypeColumnOnCallTable.ts | 3 + .../FilterStringArrayTypeColumnOnCallTable.ts | 3 + .../FilterStringTypeColumnOnCallTable.ts | 3 + ...FilterStructuredOutputColumnOnCallTable.ts | 3 + src/api/types/FormatPlan.ts | 3 + src/api/types/FourierDenoisingPlan.ts | 3 + src/api/types/FunctionTool.ts | 3 + src/api/types/GcpKey.ts | 3 + ...GeminiMultimodalLivePrebuiltVoiceConfig.ts | 4 + ...timodalLivePrebuiltVoiceConfigVoiceName.ts | 1 + .../types/GeminiMultimodalLiveSpeechConfig.ts | 4 + .../types/GeminiMultimodalLiveVoiceConfig.ts | 4 + src/api/types/GhlToolMetadata.ts | 5 + .../types/GladiaCustomVocabularyConfigDto.ts | 3 + src/api/types/GladiaTranscriber.ts | 3 + src/api/types/GladiaVocabularyItemDto.ts | 3 + src/api/types/GlobalNodePlan.ts | 3 + .../GoHighLevelCalendarAvailabilityTool.ts | 3 + .../GoHighLevelCalendarEventCreateTool.ts | 3 + src/api/types/GoHighLevelContactCreateTool.ts | 3 + src/api/types/GoHighLevelContactGetTool.ts | 3 + .../GoogleCalendarCheckAvailabilityTool.ts | 3 + .../types/GoogleCalendarCreateEventTool.ts | 3 + src/api/types/GoogleModel.ts | 3 + src/api/types/GoogleRealtimeConfig.ts | 3 + src/api/types/GoogleSheetsRowAppendTool.ts | 3 + src/api/types/GoogleTranscriber.ts | 3 + src/api/types/GoogleVoicemailDetectionPlan.ts | 3 + src/api/types/GroqModel.ts | 3 + src/api/types/GroupCondition.ts | 3 + src/api/types/HandoffDestinationAssistant.ts | 4 + .../types/HandoffDestinationAssistantType.ts | 1 + src/api/types/HandoffDestinationDynamic.ts | 3 + src/api/types/HandoffDestinationSquad.ts | 3 + src/api/types/HandoffTool.ts | 3 + src/api/types/HmacAuthenticationPlan.ts | 3 + src/api/types/HumeVoice.ts | 3 + src/api/types/ImportTwilioPhoneNumberDto.ts | 3 + src/api/types/InflectionAiModel.ts | 3 + src/api/types/Insight.ts | 3 + src/api/types/InsightFormula.ts | 3 + src/api/types/InsightPaginatedResponse.ts | 5 + src/api/types/InsightRunFormatPlan.ts | 3 + src/api/types/InsightRunResponse.ts | 8 + src/api/types/InsightTimeRange.ts | 3 + src/api/types/InsightTimeRangeWithStep.ts | 3 + src/api/types/InworldVoice.ts | 3 + ...sonQueryOnCallTableWithNumberTypeColumn.ts | 3 + ...sonQueryOnCallTableWithStringTypeColumn.ts | 3 + ...ryOnCallTableWithStructuredOutputColumn.ts | 3 + src/api/types/JsonQueryOnEventsTable.ts | 3 + src/api/types/JsonSchema.ts | 3 + src/api/types/KeypadInputPlan.ts | 3 + src/api/types/KnowledgeBase.ts | 3 + src/api/types/KnowledgeBaseCost.ts | 3 + src/api/types/LangfuseObservabilityPlan.ts | 4 + .../LangfuseObservabilityPlanProvider.ts | 1 + src/api/types/LineInsight.ts | 4 + src/api/types/LineInsightMetadata.ts | 8 + src/api/types/LiquidCondition.ts | 3 + src/api/types/LivekitSmartEndpointingPlan.ts | 3 + src/api/types/LmntVoice.ts | 3 + src/api/types/McpTool.ts | 4 + src/api/types/McpToolMessages.ts | 3 + src/api/types/McpToolMetadata.ts | 3 + src/api/types/MessageAddHookAction.ts | 3 + src/api/types/MessageTarget.ts | 3 + src/api/types/MinimaxLlmModel.ts | 3 + src/api/types/MinimaxVoice.ts | 3 + src/api/types/ModelCost.ts | 3 + src/api/types/Monitor.ts | 4 + src/api/types/MonitorPlan.ts | 11 +- src/api/types/MonitorResult.ts | 5 + src/api/types/Mono.ts | 3 + src/api/types/NeuphonicVoice.ts | 3 + src/api/types/NodeArtifact.ts | 3 + src/api/types/OAuth2AuthenticationPlan.ts | 4 + src/api/types/OAuth2AuthenticationPlanType.ts | 1 + src/api/types/Oauth2AuthenticationSession.ts | 3 + src/api/types/OpenAiFunction.ts | 3 + src/api/types/OpenAiFunctionParameters.ts | 3 + src/api/types/OpenAiMessage.ts | 5 + src/api/types/OpenAiMessageRole.ts | 1 + src/api/types/OpenAiModel.ts | 3 + src/api/types/OpenAiTranscriber.ts | 3 + src/api/types/OpenAiVoice.ts | 3 + src/api/types/OpenAiVoicemailDetectionPlan.ts | 3 + src/api/types/OpenRouterModel.ts | 3 + src/api/types/PaginationMeta.ts | 9 + src/api/types/PerformanceMetrics.ts | 3 + src/api/types/PerplexityAiModel.ts | 3 + .../types/PhoneNumberCallEndingHookFilter.ts | 3 + .../types/PhoneNumberCallRingingHookFilter.ts | 3 + src/api/types/PhoneNumberHookCallEnding.ts | 3 + src/api/types/PhoneNumberHookCallRinging.ts | 3 + src/api/types/PhoneNumberPaginatedResponse.ts | 3 + src/api/types/PieInsight.ts | 4 + src/api/types/PlayHtVoice.ts | 3 + .../types/PromptInjectionSecurityFilter.ts | 3 + src/api/types/ProviderResource.ts | 3 + .../ProviderResourcePaginatedResponse.ts | 5 + src/api/types/PublicKeyEncryptionPlan.ts | 3 + src/api/types/QueryTool.ts | 3 + src/api/types/RceSecurityFilter.ts | 3 + src/api/types/Recording.ts | 3 + src/api/types/RecordingConsent.ts | 3 + .../types/RecordingConsentPlanStayOnLine.ts | 3 + src/api/types/RecordingConsentPlanVerbal.ts | 3 + src/api/types/RegexCondition.ts | 3 + src/api/types/RegexOption.ts | 3 + src/api/types/RegexReplacement.ts | 3 + src/api/types/RegexSecurityFilter.ts | 3 + src/api/types/RimeAiVoice.ts | 3 + src/api/types/SayHookAction.ts | 3 + src/api/types/SayPhoneNumberHookAction.ts | 3 + src/api/types/SbcConfiguration.ts | 3 + src/api/types/SchedulePlan.ts | 3 + src/api/types/Scorecard.ts | 3 + src/api/types/ScorecardMetric.ts | 3 + src/api/types/ScorecardPaginatedResponse.ts | 5 + src/api/types/SecurityFilterBase.ts | 3 + src/api/types/SecurityFilterPlan.ts | 3 + src/api/types/Server.ts | 3 + src/api/types/SesameVoice.ts | 3 + src/api/types/SipAuthentication.ts | 3 + src/api/types/SipRequestTool.ts | 3 + src/api/types/SipTrunkGateway.ts | 3 + .../SipTrunkOutboundAuthenticationPlan.ts | 4 + .../types/SipTrunkOutboundSipRegisterPlan.ts | 6 + src/api/types/SlackSendMessageTool.ts | 3 + src/api/types/SmallestAiVoice.ts | 3 + src/api/types/SmartDenoisingPlan.ts | 3 + src/api/types/SmsTool.ts | 3 + src/api/types/SonioxTranscriber.ts | 3 + .../types/SpeechmaticsCustomVocabularyItem.ts | 3 + src/api/types/SpeechmaticsTranscriber.ts | 5 + .../types/SpeechmaticsTranscriberLanguage.ts | 1 + src/api/types/SpkiPemPublicKeyConfig.ts | 3 + src/api/types/SqlInjectionSecurityFilter.ts | 3 + src/api/types/Squad.ts | 3 + src/api/types/SquadMemberDto.ts | 4 + src/api/types/SsrfSecurityFilter.ts | 3 + src/api/types/StartSpeakingPlan.ts | 3 + src/api/types/StopSpeakingPlan.ts | 3 + src/api/types/StructuredDataMultiPlan.ts | 3 + src/api/types/StructuredDataPlan.ts | 3 + src/api/types/StructuredOutput.ts | 3 + .../StructuredOutputPaginatedResponse.ts | 5 + src/api/types/SubscriptionLimits.ts | 3 + src/api/types/SuccessEvaluationPlan.ts | 3 + src/api/types/SummaryPlan.ts | 3 + src/api/types/SupabaseBucketPlan.ts | 3 + src/api/types/SystemMessage.ts | 3 + src/api/types/TalkscriberTranscriber.ts | 3 + src/api/types/TavusConversationProperties.ts | 3 + src/api/types/TavusVoice.ts | 3 + src/api/types/TelnyxPhoneNumber.ts | 3 + src/api/types/TextContent.ts | 6 + src/api/types/TextContentLanguage.ts | 1 + src/api/types/TextContentType.ts | 1 + src/api/types/TextEditorTool.ts | 3 + src/api/types/TextInsight.ts | 4 + src/api/types/TimeRange.ts | 3 + src/api/types/TogetherAiModel.ts | 3 + src/api/types/ToolCall.ts | 3 + src/api/types/ToolCallFunction.ts | 3 + src/api/types/ToolCallHookAction.ts | 3 + src/api/types/ToolCallMessage.ts | 3 + src/api/types/ToolCallResultMessage.ts | 3 + src/api/types/ToolMessage.ts | 3 + src/api/types/ToolMessageComplete.ts | 3 + src/api/types/ToolMessageDelayed.ts | 3 + src/api/types/ToolMessageFailed.ts | 3 + src/api/types/ToolMessageStart.ts | 3 + src/api/types/ToolNode.ts | 4 + src/api/types/ToolParameter.ts | 3 + src/api/types/ToolRejectionPlan.ts | 3 + src/api/types/TranscriberCost.ts | 3 + src/api/types/TranscriptPlan.ts | 3 + src/api/types/TranscriptionEndpointingPlan.ts | 3 + src/api/types/TransferCallTool.ts | 3 + src/api/types/TransferDestinationAssistant.ts | 4 + .../types/TransferDestinationAssistantType.ts | 1 + src/api/types/TransferDestinationNumber.ts | 3 + src/api/types/TransferDestinationSip.ts | 3 + src/api/types/TransferFallbackPlan.ts | 3 + .../types/TransferPhoneNumberHookAction.ts | 3 + src/api/types/TransferPlan.ts | 3 + src/api/types/TransportConfigurationTwilio.ts | 4 + .../TransportConfigurationTwilioProvider.ts | 1 + src/api/types/TransportCost.ts | 4 + src/api/types/TransportCostProvider.ts | 1 + src/api/types/TurnLatency.ts | 3 + src/api/types/TwilioPhoneNumber.ts | 3 + src/api/types/TwilioVoicemailDetectionPlan.ts | 3 + src/api/types/UpdateApiRequestToolDto.ts | 4 + .../types/UpdateApiRequestToolDtoMethod.ts | 1 + .../types/UpdateBarInsightFromCallTableDto.ts | 4 + src/api/types/UpdateBashToolDto.ts | 3 + src/api/types/UpdateByoPhoneNumberDto.ts | 3 + src/api/types/UpdateComputerToolDto.ts | 3 + src/api/types/UpdateDtmfToolDto.ts | 3 + src/api/types/UpdateEndCallToolDto.ts | 3 + src/api/types/UpdateFunctionToolDto.ts | 3 + ...eGoHighLevelCalendarAvailabilityToolDto.ts | 3 + ...teGoHighLevelCalendarEventCreateToolDto.ts | 3 + .../UpdateGoHighLevelContactCreateToolDto.ts | 3 + .../UpdateGoHighLevelContactGetToolDto.ts | 3 + ...eGoogleCalendarCheckAvailabilityToolDto.ts | 3 + .../UpdateGoogleCalendarCreateEventToolDto.ts | 3 + .../UpdateGoogleSheetsRowAppendToolDto.ts | 3 + src/api/types/UpdateHandoffToolDto.ts | 3 + .../UpdateLineInsightFromCallTableDto.ts | 4 + src/api/types/UpdateMcpToolDto.ts | 4 + .../types/UpdatePieInsightFromCallTableDto.ts | 4 + src/api/types/UpdateQueryToolDto.ts | 3 + src/api/types/UpdateSipRequestToolDto.ts | 3 + .../types/UpdateSlackSendMessageToolDto.ts | 3 + src/api/types/UpdateSmsToolDto.ts | 3 + src/api/types/UpdateTelnyxPhoneNumberDto.ts | 3 + src/api/types/UpdateTextEditorToolDto.ts | 3 + .../UpdateTextInsightFromCallTableDto.ts | 4 + src/api/types/UpdateTransferCallToolDto.ts | 3 + src/api/types/UpdateTwilioPhoneNumberDto.ts | 3 + src/api/types/UpdateVapiPhoneNumberDto.ts | 3 + src/api/types/UpdateVoicemailToolDto.ts | 3 + src/api/types/UpdateVonagePhoneNumberDto.ts | 3 + src/api/types/UserMessage.ts | 3 + src/api/types/VapiCost.ts | 3 + src/api/types/VapiPhoneNumber.ts | 3 + .../VapiPronunciationDictionaryLocator.ts | 3 + src/api/types/VapiSmartEndpointingPlan.ts | 3 + src/api/types/VapiVoice.ts | 3 + src/api/types/VapiVoicemailDetectionPlan.ts | 3 + src/api/types/VariableExtractionAlias.ts | 3 + src/api/types/VariableExtractionPlan.ts | 3 + src/api/types/VariableValueGroupBy.ts | 3 + src/api/types/VoiceCost.ts | 3 + .../types/VoicemailDetectionBackoffPlan.ts | 3 + src/api/types/VoicemailDetectionCost.ts | 3 + src/api/types/VoicemailTool.ts | 3 + src/api/types/VonagePhoneNumber.ts | 3 + src/api/types/WellSaidVoice.ts | 3 + .../types/WorkflowAnthropicBedrockModel.ts | 3 + src/api/types/WorkflowAnthropicModel.ts | 3 + src/api/types/WorkflowCustomModel.ts | 3 + src/api/types/WorkflowGoogleModel.ts | 3 + src/api/types/WorkflowOpenAiModel.ts | 3 + src/api/types/WorkflowOverrides.ts | 3 + src/api/types/XaiModel.ts | 3 + src/api/types/XssSecurityFilter.ts | 3 + src/version.ts | 2 +- 532 files changed, 2835 insertions(+), 107 deletions(-) create mode 100644 .fern/replay.lock create mode 100644 .gitattributes diff --git a/.fern/metadata.json b/.fern/metadata.json index fbb2dfd3..a5662825 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,5 +1,5 @@ { - "cliVersion": "5.51.2", + "cliVersion": "5.78.0", "generatorName": "fernapi/fern-typescript-sdk", "generatorVersion": "3.63.0", "generatorConfig": { @@ -11,10 +11,10 @@ "omitUndefined": true, "enableInlineTypes": false }, - "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5", + "originGitCommit": "ae8b82b8b9da5961d03b23c22c4a4457efe952d1", "originGitCommitIsDirty": true, "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "2.0.0" + "sdkVersion": "0.0.0-fern-placeholder" } diff --git a/.fern/replay.lock b/.fern/replay.lock new file mode 100644 index 00000000..216d1276 --- /dev/null +++ b/.fern/replay.lock @@ -0,0 +1,10 @@ +# DO NOT EDIT MANUALLY - Managed by Fern Replay +version: "1.0" +generations: + - commit_sha: a1c6092cc00dca56259110e7ad5d14b616d25ed5 + tree_hash: 15237b3bbb8dd236320fd291333325fa5deaa7c4 + timestamp: 2026-07-22T16:33:45.572Z + cli_version: unknown + generator_versions: {} +current_generation: a1c6092cc00dca56259110e7ad5d14b616d25ed5 +patches: [] diff --git a/.fernignore b/.fernignore index 82e7de06..fad339e2 100644 --- a/.fernignore +++ b/.fernignore @@ -3,3 +3,6 @@ .github/workflows/sdk-release-pr-notification.yml README.md changelog.md +.fern/replay.lock +.fern/replay.yml +.gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..74928d6a --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +.fern/replay.lock linguist-generated=true diff --git a/package.json b/package.json index a80436ca..3bb757ef 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vapi-ai/server-sdk", - "version": "2.0.0", + "version": "0.0.0-fern-placeholder", "private": false, "repository": { "type": "git", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 36c57bd2..29a69f22 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -25,7 +25,7 @@ importers: version: 5.9.3 vitest: specifier: ^4.1.1 - version: 4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)) + version: 4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1)) webpack: specifier: ^5.105.4 version: 5.105.4 @@ -95,11 +95,11 @@ packages: '@bundled-es-modules/statuses@1.0.1': resolution: {integrity: sha512-yn7BklA5acgcBr+7w064fGV+SGIFySjCKpqjcWgBAIfrAkY+4GQTJJHQMeT3V/sgz23VTEVV8TtOmkvJAhFVfg==} - '@emnapi/core@1.11.1': - resolution: {integrity: sha512-RSvbQmHzdKzNsLYa/wHrbc3KN4sYLKAdPZxqiM2HATqv/SBk2/ENSHpvXGaLOMcsAyz0poEGqkmmKYG3OWiJEQ==} + '@emnapi/core@1.11.2': + resolution: {integrity: sha512-TC8MkTuZUtcTSiFeuC0ksCh9QIJ5+F21MvZ4Wn4ORfYaFJ/0dsiudv5tVkejgwZlwQ39jL9WWDe2lz8x0WglOA==} - '@emnapi/runtime@1.11.1': - resolution: {integrity: sha512-vgj7R3y3Wgx24IQaGPA/R6YFXLHVMOZ0uVEyIQPaWs+rd1AzfEMXlAC22FYwO1XkKR6NPsq7mUandH8oIRdZFw==} + '@emnapi/runtime@1.11.2': + resolution: {integrity: sha512-kyOl3X0DuTiT1h2ft8r2fYO8JYtU9a9Xis/zBSiGArNaagCOWx90N1k2wxp18czFDH+OgcWGb5ZP/XMt3dcyPA==} '@emnapi/wasi-threads@1.2.2': resolution: {integrity: sha512-c95qOXkHdydNKhscBTebqEC1CVAZpyqOfVfBzQ1qgzyl3gfeldUjIggDbIZgDKsHLgnsM+igH7TJ/eAasaVuMA==} @@ -598,78 +598,78 @@ packages: json-schema-traverse@1.0.0: resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} - lightningcss-android-arm64@1.32.0: - resolution: {integrity: sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==} + lightningcss-android-arm64@1.33.0: + resolution: {integrity: sha512-gEpRTalKdosp4Bb8qWtc2iOgE5SeIHlpS1up9bFq2wAyYhl1UdTObYiHe98zEM9SQvSoqQZ1IQD0JNpg3Ml5pg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [android] - lightningcss-darwin-arm64@1.32.0: - resolution: {integrity: sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==} + lightningcss-darwin-arm64@1.33.0: + resolution: {integrity: sha512-Sciaz8eenNTKn9b3t7+xr0ipTp9YxKQY4npwQ3mrRuL0BAVHBLyZxofhaKBAVtzmtRZ/zTyo0/to4B1uWG/Djg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [darwin] - lightningcss-darwin-x64@1.32.0: - resolution: {integrity: sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==} + lightningcss-darwin-x64@1.33.0: + resolution: {integrity: sha512-Z5UPAxzrjlWNNyGy6i65cJzzvgJ5D3T6wMvs+gWpY9d7qRhANrxqAp6LhxIgZhWEw18RfJTGcRxjuLIBr+m8XQ==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [darwin] - lightningcss-freebsd-x64@1.32.0: - resolution: {integrity: sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==} + lightningcss-freebsd-x64@1.33.0: + resolution: {integrity: sha512-QQM/Ti/hQajJwCY+RiWuCZ9sdtI/XQk7nDK5vC8kkdwixezOlDgvDx7+RT+QjK6FcFT4MpsuoBnHIo/O3StRRg==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [freebsd] - lightningcss-linux-arm-gnueabihf@1.32.0: - resolution: {integrity: sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==} + lightningcss-linux-arm-gnueabihf@1.33.0: + resolution: {integrity: sha512-N7FVBe6iS24MlM6R/4RBTxGhQheZGs7tiQ9U32UtF75NzP5Q7xWPRqLBCKxlRQRk3rY1jCIPLzx7WzOhuUIRLQ==} engines: {node: '>= 12.0.0'} cpu: [arm] os: [linux] - lightningcss-linux-arm64-gnu@1.32.0: - resolution: {integrity: sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==} + lightningcss-linux-arm64-gnu@1.33.0: + resolution: {integrity: sha512-j2v/itmy4HlNxlc6voKXYgBqNi0Ng2LShg4z7GufpEgs05P+2suBVyi9I6YHq5uoVFx9ETin3eCEhLVyXGQnKg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] libc: [glibc] - lightningcss-linux-arm64-musl@1.32.0: - resolution: {integrity: sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==} + lightningcss-linux-arm64-musl@1.33.0: + resolution: {integrity: sha512-yiO5ROMuYQgXbC60yjZU5CYSFZGKXL0HFATXt9mHJn1+zW55oCtMI9NfcVhYLMFDL7gV7oBPon/EmMMGg2OvtQ==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] libc: [musl] - lightningcss-linux-x64-gnu@1.32.0: - resolution: {integrity: sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==} + lightningcss-linux-x64-gnu@1.33.0: + resolution: {integrity: sha512-ar+Ju7LmcN0Jo4FpL4hpFybwNG9/3A/Br5KW2n2jyODg3MEZXaDYADdemoNS+BDNfMgKvylJLj4S5tyRActuAg==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] libc: [glibc] - lightningcss-linux-x64-musl@1.32.0: - resolution: {integrity: sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==} + lightningcss-linux-x64-musl@1.33.0: + resolution: {integrity: sha512-RYiYbkokw0trfKqqzfF55lginwEPrD3OJDfTuJzFs1MK6iFnDenaz1fqLLtX4ITG3OktJQXOeTaw1awrBAlZPw==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] libc: [musl] - lightningcss-win32-arm64-msvc@1.32.0: - resolution: {integrity: sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==} + lightningcss-win32-arm64-msvc@1.33.0: + resolution: {integrity: sha512-1K+MPfLSFVpphzpdbfkhlWk6wBrTObBzS2T6db10PNOZgR9GoVsAWzwNyuhUYYbTp23j+4RrncfujZ4uAzXvwA==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [win32] - lightningcss-win32-x64-msvc@1.32.0: - resolution: {integrity: sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==} + lightningcss-win32-x64-msvc@1.33.0: + resolution: {integrity: sha512-OlEICDx/Xl0FqSp4bry8zFnCvGpig3Gl4gCquvYwHuqJKEC1+n9NgDniFvqHGmMv1ZkqDJrDqKKSykTDX+ehuA==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [win32] - lightningcss@1.32.0: - resolution: {integrity: sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==} + lightningcss@1.33.0: + resolution: {integrity: sha512-WkUDrojuJs0xkgGf2udWxa3yGBRxPtxUkB79i6aCZLRgc7PM8fZe9TosfPDcvEpQZbuFASnHYmRLBLUbmLOIIA==} engines: {node: '>= 12.0.0'} loader-runner@4.3.1: @@ -719,8 +719,8 @@ packages: node-releases@2.0.37: resolution: {integrity: sha512-1h5gKZCF+pO/o3Iqt5Jp7wc9rH3eJJ0+nh/CIoiRwjRxde/hAHyLPXYN4V3CqKAbiZPSeJFSWHmJsbkicta0Eg==} - obug@2.1.3: - resolution: {integrity: sha512-9miFgM2OFba7hB+pRgvtV84pYTBaoTHohvmIgiRt6dRIzbwEOIaNaP+dIlGs2fNFoB0SeISs0Jz5WFVRid6Xyg==} + obug@2.1.4: + resolution: {integrity: sha512-4a+OsYv9UktOJKE+l1A4OufDgdRF9PifWj+tJnHURo/P+WOxpG4GzUFL9qCalmWauao6ogiG+QvnCovwPoyAWA==} engines: {node: '>=12.20.0'} outvariant@1.4.3: @@ -1076,13 +1076,13 @@ snapshots: dependencies: statuses: 2.0.2 - '@emnapi/core@1.11.1': + '@emnapi/core@1.11.2': dependencies: '@emnapi/wasi-threads': 1.2.2 tslib: 2.8.1 optional: true - '@emnapi/runtime@1.11.1': + '@emnapi/runtime@1.11.2': dependencies: tslib: 2.8.1 optional: true @@ -1148,10 +1148,10 @@ snapshots: outvariant: 1.4.3 strict-event-emitter: 0.5.1 - '@napi-rs/wasm-runtime@1.1.6(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)': + '@napi-rs/wasm-runtime@1.1.6(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)': dependencies: - '@emnapi/core': 1.11.1 - '@emnapi/runtime': 1.11.1 + '@emnapi/core': 1.11.2 + '@emnapi/runtime': 1.11.2 '@tybys/wasm-util': 0.10.3 optional: true @@ -1202,9 +1202,9 @@ snapshots: '@rolldown/binding-openharmony-arm64@1.0.0-rc.12': optional: true - '@rolldown/binding-wasm32-wasi@1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)': + '@rolldown/binding-wasm32-wasi@1.0.0-rc.12(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)': dependencies: - '@napi-rs/wasm-runtime': 1.1.6(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + '@napi-rs/wasm-runtime': 1.1.6(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2) transitivePeerDependencies: - '@emnapi/core' - '@emnapi/runtime' @@ -1263,14 +1263,14 @@ snapshots: chai: 6.2.2 tinyrainbow: 3.1.0 - '@vitest/mocker@4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1))': + '@vitest/mocker@4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1))': dependencies: '@vitest/spy': 4.1.2 estree-walker: 3.0.3 magic-string: 0.30.21 optionalDependencies: msw: 2.11.2(@types/node@18.19.130)(typescript@5.9.3) - vite: 8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1) + vite: 8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1) '@vitest/pretty-format@4.1.2': dependencies: @@ -1532,54 +1532,54 @@ snapshots: json-schema-traverse@1.0.0: {} - lightningcss-android-arm64@1.32.0: + lightningcss-android-arm64@1.33.0: optional: true - lightningcss-darwin-arm64@1.32.0: + lightningcss-darwin-arm64@1.33.0: optional: true - lightningcss-darwin-x64@1.32.0: + lightningcss-darwin-x64@1.33.0: optional: true - lightningcss-freebsd-x64@1.32.0: + lightningcss-freebsd-x64@1.33.0: optional: true - lightningcss-linux-arm-gnueabihf@1.32.0: + lightningcss-linux-arm-gnueabihf@1.33.0: optional: true - lightningcss-linux-arm64-gnu@1.32.0: + lightningcss-linux-arm64-gnu@1.33.0: optional: true - lightningcss-linux-arm64-musl@1.32.0: + lightningcss-linux-arm64-musl@1.33.0: optional: true - lightningcss-linux-x64-gnu@1.32.0: + lightningcss-linux-x64-gnu@1.33.0: optional: true - lightningcss-linux-x64-musl@1.32.0: + lightningcss-linux-x64-musl@1.33.0: optional: true - lightningcss-win32-arm64-msvc@1.32.0: + lightningcss-win32-arm64-msvc@1.33.0: optional: true - lightningcss-win32-x64-msvc@1.32.0: + lightningcss-win32-x64-msvc@1.33.0: optional: true - lightningcss@1.32.0: + lightningcss@1.33.0: dependencies: detect-libc: 2.1.2 optionalDependencies: - lightningcss-android-arm64: 1.32.0 - lightningcss-darwin-arm64: 1.32.0 - lightningcss-darwin-x64: 1.32.0 - lightningcss-freebsd-x64: 1.32.0 - lightningcss-linux-arm-gnueabihf: 1.32.0 - lightningcss-linux-arm64-gnu: 1.32.0 - lightningcss-linux-arm64-musl: 1.32.0 - lightningcss-linux-x64-gnu: 1.32.0 - lightningcss-linux-x64-musl: 1.32.0 - lightningcss-win32-arm64-msvc: 1.32.0 - lightningcss-win32-x64-msvc: 1.32.0 + lightningcss-android-arm64: 1.33.0 + lightningcss-darwin-arm64: 1.33.0 + lightningcss-darwin-x64: 1.33.0 + lightningcss-freebsd-x64: 1.33.0 + lightningcss-linux-arm-gnueabihf: 1.33.0 + lightningcss-linux-arm64-gnu: 1.33.0 + lightningcss-linux-arm64-musl: 1.33.0 + lightningcss-linux-x64-gnu: 1.33.0 + lightningcss-linux-x64-musl: 1.33.0 + lightningcss-win32-arm64-msvc: 1.33.0 + lightningcss-win32-x64-msvc: 1.33.0 loader-runner@4.3.1: {} @@ -1634,7 +1634,7 @@ snapshots: node-releases@2.0.37: {} - obug@2.1.3: {} + obug@2.1.4: {} outvariant@1.4.3: {} @@ -1660,7 +1660,7 @@ snapshots: rettime@0.7.0: {} - rolldown@1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1): + rolldown@1.0.0-rc.12(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2): dependencies: '@oxc-project/types': 0.122.0 '@rolldown/pluginutils': 1.0.0-rc.12 @@ -1677,7 +1677,7 @@ snapshots: '@rolldown/binding-linux-x64-gnu': 1.0.0-rc.12 '@rolldown/binding-linux-x64-musl': 1.0.0-rc.12 '@rolldown/binding-openharmony-arm64': 1.0.0-rc.12 - '@rolldown/binding-wasm32-wasi': 1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + '@rolldown/binding-wasm32-wasi': 1.0.0-rc.12(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2) '@rolldown/binding-win32-arm64-msvc': 1.0.0-rc.12 '@rolldown/binding-win32-x64-msvc': 1.0.0-rc.12 transitivePeerDependencies: @@ -1801,12 +1801,12 @@ snapshots: escalade: 3.2.0 picocolors: 1.1.1 - vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1): + vite@8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1): dependencies: - lightningcss: 1.32.0 + lightningcss: 1.33.0 picomatch: 4.0.4 postcss: 8.5.8 - rolldown: 1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + rolldown: 1.0.0-rc.12(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2) tinyglobby: 0.2.15 optionalDependencies: '@types/node': 18.19.130 @@ -1816,10 +1816,10 @@ snapshots: - '@emnapi/core' - '@emnapi/runtime' - vitest@4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)): + vitest@4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1)): dependencies: '@vitest/expect': 4.1.2 - '@vitest/mocker': 4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)) + '@vitest/mocker': 4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1)) '@vitest/pretty-format': 4.1.2 '@vitest/runner': 4.1.2 '@vitest/snapshot': 4.1.2 @@ -1828,7 +1828,7 @@ snapshots: es-module-lexer: 2.0.0 expect-type: 1.3.0 magic-string: 0.30.21 - obug: 2.1.3 + obug: 2.1.4 pathe: 2.0.3 picomatch: 4.0.4 std-env: 4.0.0 @@ -1836,7 +1836,7 @@ snapshots: tinyexec: 1.0.4 tinyglobby: 0.2.15 tinyrainbow: 3.1.0 - vite: 8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1) + vite: 8.0.3(@emnapi/core@1.11.2)(@emnapi/runtime@1.11.2)(@types/node@18.19.130)(terser@5.46.1) why-is-node-running: 2.3.0 optionalDependencies: '@types/node': 18.19.130 diff --git a/reference.md b/reference.md index 962778e6..14723573 100644 --- a/reference.md +++ b/reference.md @@ -4,6 +4,20 @@
+#### 📝 Description + +
+
+ +
+
+ +Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -53,6 +67,20 @@ await client.assistants.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. +
+
+
+
+ #### 🔌 Usage
@@ -102,6 +130,20 @@ await client.assistants.create({});
+#### 📝 Description + +
+
+ +
+
+ +Returns the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -153,6 +195,20 @@ await client.assistants.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -204,6 +260,20 @@ await client.assistants.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -256,6 +326,20 @@ await client.assistants.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -305,6 +389,20 @@ await client.squads.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a squad that coordinates multiple assistants and their handoffs during a conversation. +
+
+
+
+ #### 🔌 Usage
@@ -356,6 +454,20 @@ await client.squads.create({
+#### 📝 Description + +
+
+ +
+
+ +Returns the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -407,6 +519,20 @@ await client.squads.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -458,6 +584,20 @@ await client.squads.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -511,6 +651,20 @@ await client.squads.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -560,6 +714,20 @@ await client.calls.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. +
+
+
+
+ #### 🔌 Usage
@@ -609,6 +777,20 @@ await client.calls.create();
+#### 📝 Description + +
+
+ +
+
+ +Returns the call identified by its ID, including its status, configuration, and available call data. +
+
+
+
+ #### 🔌 Usage
@@ -660,6 +842,20 @@ await client.calls.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -711,6 +907,20 @@ await client.calls.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1033,6 +1243,20 @@ await client.chats.createResponse({
+#### 📝 Description + +
+
+ +
+
+ +Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -1082,6 +1306,20 @@ await client.campaigns.campaignControllerFindAll();
+#### 📝 Description + +
+
+ +
+
+ +Creates an outbound calling campaign that calls a set of customers. +
+
+
+
+ #### 🔌 Usage
@@ -1133,6 +1371,20 @@ await client.campaigns.campaignControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1184,6 +1436,20 @@ await client.campaigns.campaignControllerFindOne({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1235,7 +1501,7 @@ await client.campaigns.campaignControllerRemove({
-#### 🔌 Usage +#### 📝 Description
@@ -1243,18 +1509,32 @@ await client.campaigns.campaignControllerRemove({
-```typescript -await client.campaigns.campaignControllerUpdate({ - id: "id" -}); - -``` +Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
-#### ⚙️ Parameters +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.campaigns.campaignControllerUpdate({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters
@@ -1542,6 +1822,20 @@ await client.sessions.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -1591,6 +1885,20 @@ await client.phoneNumbers.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. +
+
+
+
+ #### 🔌 Usage
@@ -1643,6 +1951,20 @@ await client.phoneNumbers.create({
+#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -1692,6 +2014,20 @@ await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Returns the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1743,6 +2079,20 @@ await client.phoneNumbers.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1794,6 +2144,20 @@ await client.phoneNumbers.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1849,6 +2213,20 @@ await client.phoneNumbers.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -1898,6 +2276,20 @@ await client.tools.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable tool that assistants can invoke during conversations. +
+
+
+
+ #### 🔌 Usage
@@ -1951,6 +2343,20 @@ await client.tools.create({
+#### 📝 Description + +
+
+ +
+
+ +Returns the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2002,6 +2408,20 @@ await client.tools.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2053,6 +2473,20 @@ await client.tools.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2108,6 +2542,20 @@ await client.tools.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns files uploaded to the authenticated organization. +
+
+
+
+ #### 🔌 Usage
@@ -2149,6 +2597,20 @@ await client.files.list();
+#### 📝 Description + +
+
+ +
+
+ +Uploads a file for use with a Vapi knowledge base. +
+
+
+
+ #### 🔌 Usage
@@ -2200,6 +2662,20 @@ await client.files.create({
+#### 📝 Description + +
+
+ +
+
+ +Returns the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2251,6 +2727,20 @@ await client.files.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2302,6 +2792,20 @@ await client.files.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the name of the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2354,6 +2858,20 @@ await client.files.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -2403,6 +2921,20 @@ await client.structuredOutputs.structuredOutputControllerFindAll();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. +
+
+
+
+ #### 🔌 Usage
@@ -2457,7 +2989,21 @@ await client.structuredOutputs.structuredOutputControllerCreate({
-#### 🔌 Usage +#### 📝 Description + +
+
+ +
+
+ +Returns the structured-output definition identified by its ID. +
+
+
+
+ +#### 🔌 Usage
@@ -2508,6 +3054,20 @@ await client.structuredOutputs.structuredOutputControllerFindOne({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the structured-output definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2559,6 +3119,20 @@ await client.structuredOutputs.structuredOutputControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the structured-output definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2611,6 +3185,20 @@ await client.structuredOutputs.structuredOutputControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. +
+
+
+
+ #### 🔌 Usage
@@ -2663,6 +3251,20 @@ await client.structuredOutputs.structuredOutputControllerRun({
+#### 📝 Description + +
+
+ +
+
+ +Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -2712,6 +3314,20 @@ await client.insight.insightControllerFindAll();
+#### 📝 Description + +
+
+ +
+
+ +Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. +
+
+
+
+ #### 🔌 Usage
@@ -2769,6 +3385,20 @@ await client.insight.insightControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2820,6 +3450,20 @@ await client.insight.insightControllerFindOne({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2871,6 +3515,20 @@ await client.insight.insightControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2925,6 +3583,20 @@ await client.insight.insightControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved reporting insight, optionally overriding its time range and response format. +
+
+
+
+ #### 🔌 Usage
@@ -2976,6 +3648,20 @@ await client.insight.insightControllerRun({
+#### 📝 Description + +
+
+ +
+
+ +Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. +
+
+
+
+ #### 🔌 Usage
@@ -3034,6 +3720,20 @@ await client.insight.insightControllerPreview({
+#### 📝 Description + +
+
+ +
+
+ +Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3083,6 +3783,20 @@ await client.eval.evalControllerGetPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. +
+
+
+
+ #### 🔌 Usage
@@ -3137,6 +3851,20 @@ await client.eval.evalControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3188,6 +3916,20 @@ await client.eval.evalControllerGet({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3239,6 +3981,20 @@ await client.eval.evalControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3290,6 +4046,20 @@ await client.eval.evalControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3341,6 +4111,20 @@ await client.eval.evalControllerGetRun({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3392,6 +4176,20 @@ await client.eval.evalControllerRemoveRun({
+#### 📝 Description + +
+
+ +
+
+ +Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3441,6 +4239,20 @@ await client.eval.evalControllerGetRunsPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. +
+
+
+
+ #### 🔌 Usage
@@ -3496,6 +4308,20 @@ await client.eval.evalControllerRun({
+#### 📝 Description + +
+
+ +
+
+ +Returns the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3547,6 +4373,20 @@ await client.observabilityScorecard.scorecardControllerGet({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3598,6 +4438,20 @@ await client.observabilityScorecard.scorecardControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3649,6 +4503,20 @@ await client.observabilityScorecard.scorecardControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3698,6 +4566,20 @@ await client.observabilityScorecard.scorecardControllerGetPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. +
+
+
+
+ #### 🔌 Usage
@@ -3755,6 +4637,20 @@ await client.observabilityScorecard.scorecardControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3807,6 +4703,20 @@ await client.providerResources.providerResourceControllerGetProviderResourcesPag
+#### 📝 Description + +
+
+ +
+
+ +Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. +
+
+
+
+ #### 🔌 Usage
@@ -3859,6 +4769,20 @@ await client.providerResources.providerResourceControllerCreateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Returns the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -3912,6 +4836,20 @@ await client.providerResources.providerResourceControllerGetProviderResource({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -3965,6 +4903,20 @@ await client.providerResources.providerResourceControllerDeleteProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Updates the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -4019,6 +4971,20 @@ await client.providerResources.providerResourceControllerUpdateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. +
+
+
+
+ #### 🔌 Usage
diff --git a/src/BaseClient.ts b/src/BaseClient.ts index 98a48b9f..0cbc606c 100644 --- a/src/BaseClient.ts +++ b/src/BaseClient.ts @@ -52,8 +52,8 @@ export function normalizeClientOptions; @@ -154,5 +156,6 @@ export interface UpdateAssistantDto { * 3. org.serverUrl */ server?: Vapi.Server; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan; } diff --git a/src/api/resources/calls/client/Client.ts b/src/api/resources/calls/client/Client.ts index 6c591af2..ffa48556 100644 --- a/src/api/resources/calls/client/Client.ts +++ b/src/api/resources/calls/client/Client.ts @@ -23,6 +23,8 @@ export class CallsClient { } /** + * Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. + * * @param {Vapi.ListCallsRequest} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -106,6 +108,8 @@ export class CallsClient { } /** + * Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. + * * @param {Vapi.CreateCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -164,6 +168,8 @@ export class CallsClient { } /** + * Returns the call identified by its ID, including its status, configuration, and available call data. + * * @param {Vapi.GetCallsRequest} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -222,6 +228,8 @@ export class CallsClient { } /** + * Deletes the call identified by its ID. + * * @param {Vapi.DeleteCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -283,6 +291,8 @@ export class CallsClient { } /** + * Updates the call identified by its ID. + * * @param {Vapi.UpdateCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/campaigns/client/Client.ts b/src/api/resources/campaigns/client/Client.ts index a1306e38..14e6640b 100644 --- a/src/api/resources/campaigns/client/Client.ts +++ b/src/api/resources/campaigns/client/Client.ts @@ -23,6 +23,8 @@ export class CampaignsClient { } /** + * Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. + * * @param {Vapi.CampaignControllerFindAllRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -108,6 +110,8 @@ export class CampaignsClient { } /** + * Creates an outbound calling campaign that calls a set of customers. + * * @param {Vapi.CreateCampaignDto} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -168,6 +172,8 @@ export class CampaignsClient { } /** + * Returns the outbound calling campaign identified by its ID. + * * @param {Vapi.CampaignControllerFindOneRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -226,6 +232,8 @@ export class CampaignsClient { } /** + * Deletes the outbound calling campaign identified by its ID. + * * @param {Vapi.CampaignControllerRemoveRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -284,6 +292,8 @@ export class CampaignsClient { } /** + * Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. + * * @param {Vapi.UpdateCampaignDto} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/eval/client/Client.ts b/src/api/resources/eval/client/Client.ts index b522c9f2..ab434b30 100644 --- a/src/api/resources/eval/client/Client.ts +++ b/src/api/resources/eval/client/Client.ts @@ -23,6 +23,8 @@ export class EvalClient { } /** + * Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.EvalControllerGetPaginatedRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -106,6 +108,8 @@ export class EvalClient { } /** + * Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. + * * @param {Vapi.CreateEvalDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -169,6 +173,8 @@ export class EvalClient { } /** + * Returns the eval definition identified by its ID. + * * @param {Vapi.EvalControllerGetRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -227,6 +233,8 @@ export class EvalClient { } /** + * Deletes the eval definition identified by its ID. + * * @param {Vapi.EvalControllerRemoveRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -285,6 +293,8 @@ export class EvalClient { } /** + * Updates the eval definition identified by its ID. + * * @param {Vapi.UpdateEvalDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -346,6 +356,8 @@ export class EvalClient { } /** + * Returns the eval run identified by its ID. + * * @param {Vapi.EvalControllerGetRunRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -404,6 +416,8 @@ export class EvalClient { } /** + * Deletes the eval run identified by its ID. + * * @param {Vapi.EvalControllerRemoveRunRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -462,6 +476,8 @@ export class EvalClient { } /** + * Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.EvalControllerGetRunsPaginatedRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -545,6 +561,8 @@ export class EvalClient { } /** + * Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. + * * @param {Vapi.CreateEvalRunDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/files/client/Client.ts b/src/api/resources/files/client/Client.ts index 2d45974e..0811ccdb 100644 --- a/src/api/resources/files/client/Client.ts +++ b/src/api/resources/files/client/Client.ts @@ -23,6 +23,8 @@ export class FilesClient { } /** + * Returns files uploaded to the authenticated organization. + * * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * * @example @@ -71,6 +73,8 @@ export class FilesClient { } /** + * Uploads a file for use with a Vapi knowledge base. + * * @param {Vapi.CreateFileDto} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -143,6 +147,8 @@ export class FilesClient { } /** + * Returns the uploaded file identified by its ID. + * * @param {Vapi.GetFilesRequest} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -201,6 +207,8 @@ export class FilesClient { } /** + * Deletes the uploaded file identified by its ID. + * * @param {Vapi.DeleteFilesRequest} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -259,6 +267,8 @@ export class FilesClient { } /** + * Updates the name of the uploaded file identified by its ID. + * * @param {Vapi.UpdateFileDto} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/insight/client/Client.ts b/src/api/resources/insight/client/Client.ts index 9238c4c3..b7b83caf 100644 --- a/src/api/resources/insight/client/Client.ts +++ b/src/api/resources/insight/client/Client.ts @@ -23,6 +23,8 @@ export class InsightClient { } /** + * Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.InsightControllerFindAllRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -106,6 +108,8 @@ export class InsightClient { } /** + * Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. + * * @param {Vapi.InsightControllerCreateRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -172,6 +176,8 @@ export class InsightClient { } /** + * Returns the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerFindOneRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -233,6 +239,8 @@ export class InsightClient { } /** + * Deletes the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerRemoveRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -291,6 +299,8 @@ export class InsightClient { } /** + * Updates the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerUpdateRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -355,6 +365,8 @@ export class InsightClient { } /** + * Runs a saved reporting insight, optionally overriding its time range and response format. + * * @param {Vapi.InsightRunDto} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -416,6 +428,8 @@ export class InsightClient { } /** + * Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + * * @param {Vapi.InsightControllerPreviewRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/insight/client/requests/InsightRunDto.ts b/src/api/resources/insight/client/requests/InsightRunDto.ts index 6693ba33..81dc2283 100644 --- a/src/api/resources/insight/client/requests/InsightRunDto.ts +++ b/src/api/resources/insight/client/requests/InsightRunDto.ts @@ -10,6 +10,7 @@ import type * as Vapi from "../../../../index.js"; */ export interface InsightRunDto { id: string; + /** Output-formatting instructions applied to the insight run. */ formatPlan?: Vapi.InsightRunFormatPlan; /** * This is the optional time range override for the insight. diff --git a/src/api/resources/observabilityScorecard/client/Client.ts b/src/api/resources/observabilityScorecard/client/Client.ts index 6035efa7..d31df6a3 100644 --- a/src/api/resources/observabilityScorecard/client/Client.ts +++ b/src/api/resources/observabilityScorecard/client/Client.ts @@ -23,6 +23,8 @@ export class ObservabilityScorecardClient { } /** + * Returns the scorecard identified by its ID. + * * @param {Vapi.ScorecardControllerGetRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -81,6 +83,8 @@ export class ObservabilityScorecardClient { } /** + * Deletes the scorecard identified by its ID. + * * @param {Vapi.ScorecardControllerRemoveRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -144,6 +148,8 @@ export class ObservabilityScorecardClient { } /** + * Updates the scorecard identified by its ID. + * * @param {Vapi.UpdateScorecardDto} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -210,6 +216,8 @@ export class ObservabilityScorecardClient { } /** + * Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.ScorecardControllerGetPaginatedRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -293,6 +301,8 @@ export class ObservabilityScorecardClient { } /** + * Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. + * * @param {Vapi.CreateScorecardDto} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/phoneNumbers/client/Client.ts b/src/api/resources/phoneNumbers/client/Client.ts index a64f47d2..488e0418 100644 --- a/src/api/resources/phoneNumbers/client/Client.ts +++ b/src/api/resources/phoneNumbers/client/Client.ts @@ -23,6 +23,8 @@ export class PhoneNumbersClient { } /** + * Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListPhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -100,6 +102,8 @@ export class PhoneNumbersClient { } /** + * Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. + * * @param {Vapi.CreatePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -161,6 +165,8 @@ export class PhoneNumbersClient { } /** + * Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. + * * @param {Vapi.PhoneNumberControllerFindAllPaginatedRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -246,6 +252,8 @@ export class PhoneNumbersClient { } /** + * Returns the phone number resource identified by its ID. + * * @param {Vapi.GetPhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -304,6 +312,8 @@ export class PhoneNumbersClient { } /** + * Deletes the phone number resource identified by its ID. + * * @param {Vapi.DeletePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -362,6 +372,8 @@ export class PhoneNumbersClient { } /** + * Updates the specified fields of the phone number resource identified by its ID. + * * @param {Vapi.UpdatePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/providerResources/client/Client.ts b/src/api/resources/providerResources/client/Client.ts index fa3b4af0..d6d15aca 100644 --- a/src/api/resources/providerResources/client/Client.ts +++ b/src/api/resources/providerResources/client/Client.ts @@ -23,6 +23,8 @@ export class ProviderResourcesClient { } /** + * Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. + * * @param {Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -123,6 +125,8 @@ export class ProviderResourcesClient { } /** + * Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + * * @param {Vapi.ProviderResourceControllerCreateProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -189,6 +193,8 @@ export class ProviderResourcesClient { } /** + * Returns the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerGetProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -263,6 +269,8 @@ export class ProviderResourcesClient { } /** + * Deletes the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerDeleteProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -337,6 +345,8 @@ export class ProviderResourcesClient { } /** + * Updates the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerUpdateProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/squads/client/Client.ts b/src/api/resources/squads/client/Client.ts index ebaed121..95a9808c 100644 --- a/src/api/resources/squads/client/Client.ts +++ b/src/api/resources/squads/client/Client.ts @@ -23,6 +23,8 @@ export class SquadsClient { } /** + * Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -100,6 +102,8 @@ export class SquadsClient { } /** + * Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + * * @param {Vapi.CreateSquadDto} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -160,6 +164,8 @@ export class SquadsClient { } /** + * Returns the squad identified by its ID. + * * @param {Vapi.GetSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -218,6 +224,8 @@ export class SquadsClient { } /** + * Deletes the squad identified by its ID. + * * @param {Vapi.DeleteSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -276,6 +284,8 @@ export class SquadsClient { } /** + * Updates the specified fields of the squad identified by its ID. + * * @param {Vapi.UpdateSquadDto} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/structuredOutputs/client/Client.ts b/src/api/resources/structuredOutputs/client/Client.ts index 2e0677a2..61c0c74a 100644 --- a/src/api/resources/structuredOutputs/client/Client.ts +++ b/src/api/resources/structuredOutputs/client/Client.ts @@ -23,6 +23,8 @@ export class StructuredOutputsClient { } /** + * Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. + * * @param {Vapi.StructuredOutputControllerFindAllRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -111,6 +113,8 @@ export class StructuredOutputsClient { } /** + * Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. + * * @param {Vapi.CreateStructuredOutputDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -174,6 +178,8 @@ export class StructuredOutputsClient { } /** + * Returns the structured-output definition identified by its ID. + * * @param {Vapi.StructuredOutputControllerFindOneRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -232,6 +238,8 @@ export class StructuredOutputsClient { } /** + * Deletes the structured-output definition identified by its ID. + * * @param {Vapi.StructuredOutputControllerRemoveRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -290,6 +298,8 @@ export class StructuredOutputsClient { } /** + * Updates the structured-output definition identified by its ID. + * * @param {Vapi.UpdateStructuredOutputDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -355,6 +365,8 @@ export class StructuredOutputsClient { } /** + * Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. + * * @param {Vapi.StructuredOutputRunDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/tools/client/Client.ts b/src/api/resources/tools/client/Client.ts index 8c20113a..3cc516f6 100644 --- a/src/api/resources/tools/client/Client.ts +++ b/src/api/resources/tools/client/Client.ts @@ -23,6 +23,8 @@ export class ToolsClient { } /** + * Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -100,6 +102,8 @@ export class ToolsClient { } /** + * Creates a reusable tool that assistants can invoke during conversations. + * * @param {Vapi.CreateToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -162,6 +166,8 @@ export class ToolsClient { } /** + * Returns the tool identified by its ID. + * * @param {Vapi.GetToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -220,6 +226,8 @@ export class ToolsClient { } /** + * Deletes the tool identified by its ID. + * * @param {Vapi.DeleteToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -278,6 +286,8 @@ export class ToolsClient { } /** + * Updates the specified fields of the tool identified by its ID. + * * @param {Vapi.UpdateToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/types/AiEdgeCondition.ts b/src/api/types/AiEdgeCondition.ts index 94a584f4..cf03796b 100644 --- a/src/api/types/AiEdgeCondition.ts +++ b/src/api/types/AiEdgeCondition.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * An AI-evaluated boolean condition that determines whether a workflow follows an edge. + */ export interface AiEdgeCondition { + /** Selects an AI-evaluated workflow edge condition. */ type: Vapi.AiEdgeConditionType; /** This is the prompt for the AI edge condition. It should evaluate to a boolean. */ prompt: string; diff --git a/src/api/types/AiEdgeConditionType.ts b/src/api/types/AiEdgeConditionType.ts index 1500e779..55ebb4c5 100644 --- a/src/api/types/AiEdgeConditionType.ts +++ b/src/api/types/AiEdgeConditionType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects an AI-evaluated workflow edge condition. */ export const AiEdgeConditionType = { Ai: "ai", } as const; diff --git a/src/api/types/Analysis.ts b/src/api/types/Analysis.ts index 787c6efb..aa34c0b0 100644 --- a/src/api/types/Analysis.ts +++ b/src/api/types/Analysis.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Post-call analysis results, including summary, structured data, and success evaluation outputs. + */ export interface Analysis { /** This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`. */ summary?: string | undefined; diff --git a/src/api/types/AnalysisCost.ts b/src/api/types/AnalysisCost.ts index 5bff038d..beaefbaf 100644 --- a/src/api/types/AnalysisCost.ts +++ b/src/api/types/AnalysisCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Cost for an individual analysis request, including analysis type, model, token usage, and amount. + */ export interface AnalysisCost { /** This is the type of analysis performed. */ analysisType: Vapi.AnalysisCostAnalysisType; diff --git a/src/api/types/AnalysisCostBreakdown.ts b/src/api/types/AnalysisCostBreakdown.ts index 1b219acd..b51a0d54 100644 --- a/src/api/types/AnalysisCostBreakdown.ts +++ b/src/api/types/AnalysisCostBreakdown.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output generation. + */ export interface AnalysisCostBreakdown { /** This is the cost to summarize the call. */ summary?: number | undefined; diff --git a/src/api/types/AnalysisPlan.ts b/src/api/types/AnalysisPlan.ts index 816c2384..ebed9015 100644 --- a/src/api/types/AnalysisPlan.ts +++ b/src/api/types/AnalysisPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes. + */ export interface AnalysisPlan { /** * The minimum number of messages required to run the analysis plan. diff --git a/src/api/types/AnalyticsOperation.ts b/src/api/types/AnalyticsOperation.ts index 2dd530d4..667cd9eb 100644 --- a/src/api/types/AnalyticsOperation.ts +++ b/src/api/types/AnalyticsOperation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An aggregation or history operation applied to an analytics column, with an optional response alias. + */ export interface AnalyticsOperation { /** This is the aggregation operation you want to perform. */ operation: Vapi.AnalyticsOperationOperation; diff --git a/src/api/types/AnalyticsQuery.ts b/src/api/types/AnalyticsQuery.ts index 200a48ea..3671b300 100644 --- a/src/api/types/AnalyticsQuery.ts +++ b/src/api/types/AnalyticsQuery.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A named analytics query against call or subscription data, including grouping, time range, and aggregation operations. + */ export interface AnalyticsQuery { /** This is the table you want to query. */ table: Vapi.AnalyticsQueryTable; diff --git a/src/api/types/AnalyticsQueryResult.ts b/src/api/types/AnalyticsQueryResult.ts index 8889fb3a..8e0163d2 100644 --- a/src/api/types/AnalyticsQueryResult.ts +++ b/src/api/types/AnalyticsQueryResult.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The result of a named analytics query, including the evaluated time range and returned metric data. + */ export interface AnalyticsQueryResult { /** This is the unique key for the query. */ name: string; diff --git a/src/api/types/AnthropicBedrockModel.ts b/src/api/types/AnthropicBedrockModel.ts index 4e6c2d03..4386123a 100644 --- a/src/api/types/AnthropicBedrockModel.ts +++ b/src/api/types/AnthropicBedrockModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ export interface AnthropicBedrockModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/AnthropicModel.ts b/src/api/types/AnthropicModel.ts index acc371a8..15d984f9 100644 --- a/src/api/types/AnthropicModel.ts +++ b/src/api/types/AnthropicModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ export interface AnthropicModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/AnthropicThinkingConfig.ts b/src/api/types/AnthropicThinkingConfig.ts index d8bebfad..58d7fc7d 100644 --- a/src/api/types/AnthropicThinkingConfig.ts +++ b/src/api/types/AnthropicThinkingConfig.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Enables Anthropic extended thinking with a maximum thinking-token budget. + */ export interface AnthropicThinkingConfig { + /** Enables Anthropic extended thinking. */ type: Vapi.AnthropicThinkingConfigType; /** * The maximum number of tokens to allocate for thinking. diff --git a/src/api/types/AnthropicThinkingConfigType.ts b/src/api/types/AnthropicThinkingConfigType.ts index 99b612f7..9c3ca10b 100644 --- a/src/api/types/AnthropicThinkingConfigType.ts +++ b/src/api/types/AnthropicThinkingConfigType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Enables Anthropic extended thinking. */ export const AnthropicThinkingConfigType = { Enabled: "enabled", } as const; diff --git a/src/api/types/AnyscaleModel.ts b/src/api/types/AnyscaleModel.ts index e681087f..d0d46279 100644 --- a/src/api/types/AnyscaleModel.ts +++ b/src/api/types/AnyscaleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface AnyscaleModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/ApiRequestTool.ts b/src/api/types/ApiRequestTool.ts index 1c8c03a8..7438772b 100644 --- a/src/api/types/ApiRequestTool.ts +++ b/src/api/types/ApiRequestTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ export interface ApiRequestTool { /** * These are the messages that will be spoken to the user as the tool is running. @@ -9,6 +12,7 @@ export interface ApiRequestTool { * For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured. */ messages?: Vapi.ApiRequestToolMessagesItem[] | undefined; + /** The HTTP method used for the API request. */ method: Vapi.ApiRequestToolMethod; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. diff --git a/src/api/types/ApiRequestToolMethod.ts b/src/api/types/ApiRequestToolMethod.ts index 6538f40b..e36cc4e5 100644 --- a/src/api/types/ApiRequestToolMethod.ts +++ b/src/api/types/ApiRequestToolMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const ApiRequestToolMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/Artifact.ts b/src/api/types/Artifact.ts index 18cd24f6..ca17b902 100644 --- a/src/api/types/Artifact.ts +++ b/src/api/types/Artifact.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Artifacts generated during a call, including messages, recordings, transcript, logs, packet capture, workflow-node data, variables, performance metrics, structured outputs, scorecards, and transfers. + */ export interface Artifact { /** These are the messages that were spoken during the call. */ messages?: Vapi.ArtifactMessagesItem[] | undefined; diff --git a/src/api/types/ArtifactPlan.ts b/src/api/types/ArtifactPlan.ts index bec58829..a3815930 100644 --- a/src/api/types/ArtifactPlan.ts +++ b/src/api/types/ArtifactPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, structured outputs, scorecards, and custom storage paths. + */ export interface ArtifactPlan { /** * This determines whether assistant's calls are recorded. Defaults to true. diff --git a/src/api/types/AssemblyAiTranscriber.ts b/src/api/types/AssemblyAiTranscriber.ts index 4447dfbb..412d374a 100644 --- a/src/api/types/AssemblyAiTranscriber.ts +++ b/src/api/types/AssemblyAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, streaming model, endpointing, vocabulary, and fallback settings. + */ export interface AssemblyAiTranscriber { /** This is the language that will be set for the transcription. */ language?: Vapi.AssemblyAiTranscriberLanguage | undefined; diff --git a/src/api/types/Assistant.ts b/src/api/types/Assistant.ts index 68b5f5ec..6a052155 100644 --- a/src/api/types/Assistant.ts +++ b/src/api/types/Assistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved assistant configuration returned by the Vapi API. It defines how the assistant listens, reasons, speaks, handles conversations, sends events, and produces artifacts and analysis. + */ export interface Assistant { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.AssistantTranscriber | undefined; @@ -15,6 +18,7 @@ export interface Assistant { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -85,6 +89,7 @@ export interface Assistant { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -147,6 +152,7 @@ export interface Assistant { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; /** This is the unique identifier for the assistant. */ id: string; diff --git a/src/api/types/AssistantActivation.ts b/src/api/types/AssistantActivation.ts index 1b8aaf5c..8308cad4 100644 --- a/src/api/types/AssistantActivation.ts +++ b/src/api/types/AssistantActivation.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Identifies an assistant that became active during a call. + */ export interface AssistantActivation { /** This is the name of the assistant that was active during the call. */ assistantName: string; diff --git a/src/api/types/AssistantCustomEndpointingRule.ts b/src/api/types/AssistantCustomEndpointingRule.ts index 34ee2d38..643d72f2 100644 --- a/src/api/types/AssistantCustomEndpointingRule.ts +++ b/src/api/types/AssistantCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches the assistant's last message and applies a configured timeout. + */ export interface AssistantCustomEndpointingRule { /** * This is the regex pattern to match. diff --git a/src/api/types/AssistantMessage.ts b/src/api/types/AssistantMessage.ts index afdc616a..f504ec8d 100644 --- a/src/api/types/AssistantMessage.ts +++ b/src/api/types/AssistantMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata. + */ export interface AssistantMessage { /** This is the role of the message author */ role: Vapi.AssistantMessageRole; diff --git a/src/api/types/AssistantMessageEvaluationContinuePlan.ts b/src/api/types/AssistantMessageEvaluationContinuePlan.ts index 229f7aea..e18caa0c 100644 --- a/src/api/types/AssistantMessageEvaluationContinuePlan.ts +++ b/src/api/types/AssistantMessageEvaluationContinuePlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional message overrides. + */ export interface AssistantMessageEvaluationContinuePlan { /** * This is whether the evaluation should exit if the assistant message evaluates to false. diff --git a/src/api/types/AssistantMessageJudgePlanAi.ts b/src/api/types/AssistantMessageJudgePlanAi.ts index 712a2bc0..8384e48a 100644 --- a/src/api/types/AssistantMessageJudgePlanAi.ts +++ b/src/api/types/AssistantMessageJudgePlanAi.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates an assistant message with an LLM judge and a configured evaluation model. + */ export interface AssistantMessageJudgePlanAi { /** * This is the model to use for the LLM-as-a-judge. diff --git a/src/api/types/AssistantMessageJudgePlanExact.ts b/src/api/types/AssistantMessageJudgePlanExact.ts index 0a1a19e8..1c450074 100644 --- a/src/api/types/AssistantMessageJudgePlanExact.ts +++ b/src/api/types/AssistantMessageJudgePlanExact.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates an assistant message using case-insensitive exact content matching and expected tool calls. + */ export interface AssistantMessageJudgePlanExact { /** * This is what that will be used to evaluate the model's message content. diff --git a/src/api/types/AssistantMessageJudgePlanRegex.ts b/src/api/types/AssistantMessageJudgePlanRegex.ts index c0e52e95..d5c28d32 100644 --- a/src/api/types/AssistantMessageJudgePlanRegex.ts +++ b/src/api/types/AssistantMessageJudgePlanRegex.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates assistant-message content and tool-call arguments using regular-expression patterns. + */ export interface AssistantMessageJudgePlanRegex { /** * This is what that will be used to evaluate the model's message content. diff --git a/src/api/types/AssistantOverrides.ts b/src/api/types/AssistantOverrides.ts index adce6309..7ad8d157 100644 --- a/src/api/types/AssistantOverrides.ts +++ b/src/api/types/AssistantOverrides.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and server configuration. + */ export interface AssistantOverrides { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.AssistantOverridesTranscriber | undefined; @@ -15,6 +18,7 @@ export interface AssistantOverrides { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -65,6 +69,7 @@ export interface AssistantOverrides { credentials?: Vapi.AssistantOverridesCredentialsItem[] | undefined; /** This is a set of actions that will be performed on certain events. */ hooks?: Vapi.AssistantOverridesHooksItem[] | undefined; + /** Tools to append to the assistant's existing tool configuration. */ "tools:append"?: Vapi.AssistantOverridesToolsAppendItem[] | undefined; /** * These are values that will be used to replace the template variables in the assistant messages and other text-based fields. @@ -96,6 +101,7 @@ export interface AssistantOverrides { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings to apply, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -158,5 +164,6 @@ export interface AssistantOverrides { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; } diff --git a/src/api/types/AwsStsAuthenticationPlan.ts b/src/api/types/AwsStsAuthenticationPlan.ts index 92265580..55bec9a6 100644 --- a/src/api/types/AwsStsAuthenticationPlan.ts +++ b/src/api/types/AwsStsAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * AWS Security Token Service role-assumption configuration used to authenticate requests. + */ export interface AwsStsAuthenticationPlan { /** This is the role ARN for the AWS credential */ roleArn: string; diff --git a/src/api/types/AwsiamCredentialsAuthenticationPlan.ts b/src/api/types/AwsiamCredentialsAuthenticationPlan.ts index cb7a2474..713e5a4e 100644 --- a/src/api/types/AwsiamCredentialsAuthenticationPlan.ts +++ b/src/api/types/AwsiamCredentialsAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Direct AWS IAM credentials used to authenticate requests. + */ export interface AwsiamCredentialsAuthenticationPlan { /** AWS Access Key ID. This is not returned in the API. */ awsAccessKeyId: string; diff --git a/src/api/types/AzureBlobStorageBucketPlan.ts b/src/api/types/AzureBlobStorageBucketPlan.ts index 387d857f..d9f62c49 100644 --- a/src/api/types/AzureBlobStorageBucketPlan.ts +++ b/src/api/types/AzureBlobStorageBucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Azure Blob Storage container configuration for call artifacts, including its connection string, container name, and storage path. + */ export interface AzureBlobStorageBucketPlan { /** This is the blob storage connection string for the Azure resource. */ connectionString: string; diff --git a/src/api/types/AzureSpeechTranscriber.ts b/src/api/types/AzureSpeechTranscriber.ts index 87868250..e7e00a7f 100644 --- a/src/api/types/AzureSpeechTranscriber.ts +++ b/src/api/types/AzureSpeechTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Azure Speech, including language, segmentation, and fallback settings. + */ export interface AzureSpeechTranscriber { /** This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt */ language?: Vapi.AzureSpeechTranscriberLanguage | undefined; diff --git a/src/api/types/AzureVoice.ts b/src/api/types/AzureVoice.ts index f28e516b..3fc4b156 100644 --- a/src/api/types/AzureVoice.ts +++ b/src/api/types/AzureVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, and fallback settings. + */ export interface AzureVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/BackgroundSpeechDenoisingPlan.ts b/src/api/types/BackgroundSpeechDenoisingPlan.ts index fbfbca1a..f0b37f08 100644 --- a/src/api/types/BackgroundSpeechDenoisingPlan.ts +++ b/src/api/types/BackgroundSpeechDenoisingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls smart and Fourier denoising applied to customer audio before transcription. + */ export interface BackgroundSpeechDenoisingPlan { /** Whether smart denoising using Krisp is enabled. */ smartDenoisingPlan?: Vapi.SmartDenoisingPlan | undefined; diff --git a/src/api/types/BackoffPlan.ts b/src/api/types/BackoffPlan.ts index ae617e1d..2d951867 100644 --- a/src/api/types/BackoffPlan.ts +++ b/src/api/types/BackoffPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status codes excluded from retries. + */ export interface BackoffPlan { /** * This is the type of backoff plan to use. Defaults to fixed. @@ -13,11 +16,8 @@ export interface BackoffPlan { * @default 0 */ maxRetries: number; - /** This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay. */ + /** Base delay in seconds. For fixed backoff, this is the delay between retries. For exponential backoff, this is the initial delay. */ baseDelaySeconds: number; - /** - * This is the excluded status codes. If the response status code is in this list, the request will not be retried. - * By default, the request will be retried for any non-2xx status code. - */ + /** HTTP status codes that should not trigger a retry. By default, any non-2xx status code not listed here can be retried. */ excludedStatusCodes?: Record[] | undefined; } diff --git a/src/api/types/BarInsight.ts b/src/api/types/BarInsight.ts index 6d2cb765..23a6b76e 100644 --- a/src/api/types/BarInsight.ts +++ b/src/api/types/BarInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ export interface BarInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface BarInsight { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/BarInsightMetadata.ts b/src/api/types/BarInsightMetadata.ts index 9b44b3d6..228e661b 100644 --- a/src/api/types/BarInsightMetadata.ts +++ b/src/api/types/BarInsightMetadata.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds. + */ export interface BarInsightMetadata { + /** Label displayed on the chart's x-axis. */ xAxisLabel?: string | undefined; + /** Label displayed on the chart's y-axis. */ yAxisLabel?: string | undefined; + /** Minimum value displayed on the chart's y-axis. */ yAxisMin?: number | undefined; + /** Maximum value displayed on the chart's y-axis. */ yAxisMax?: number | undefined; + /** Display name for the insight chart. */ name?: string | undefined; } diff --git a/src/api/types/BashTool.ts b/src/api/types/BashTool.ts index 5c1044ba..947c1dff 100644 --- a/src/api/types/BashTool.ts +++ b/src/api/types/BashTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that executes shell commands in a configured environment. + */ export interface BashTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/BearerAuthenticationPlan.ts b/src/api/types/BearerAuthenticationPlan.ts index 48a069ff..15f8e8ef 100644 --- a/src/api/types/BearerAuthenticationPlan.ts +++ b/src/api/types/BearerAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Configuration for authenticating outbound requests with a bearer token, including header name and optional `Bearer` prefix. + */ export interface BearerAuthenticationPlan { /** This is the bearer token value. */ token: string; diff --git a/src/api/types/BotMessage.ts b/src/api/types/BotMessage.ts index b7f4a632..4c4c2b5b 100644 --- a/src/api/types/BotMessage.ts +++ b/src/api/types/BotMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An assistant-authored entry in the call message history, including content, timing, source, and duration. + */ export interface BotMessage { /** The role of the bot in the conversation. */ role: string; diff --git a/src/api/types/BothCustomEndpointingRule.ts b/src/api/types/BothCustomEndpointingRule.ts index 32bca870..a7aa48b1 100644 --- a/src/api/types/BothCustomEndpointingRule.ts +++ b/src/api/types/BothCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches both the assistant's last message and the customer's current speech before applying a configured timeout. + */ export interface BothCustomEndpointingRule { /** * This is the regex pattern to match the assistant's message. @@ -20,6 +23,7 @@ export interface BothCustomEndpointingRule { * @default [] */ assistantRegexOptions?: Vapi.RegexOption[] | undefined; + /** The regular expression pattern matched against the customer's speech. */ customerRegex: string; /** * These are the options for the customer's message regex match. Defaults to all disabled. diff --git a/src/api/types/BucketPlan.ts b/src/api/types/BucketPlan.ts index 7b3e5406..65ace125 100644 --- a/src/api/types/BucketPlan.ts +++ b/src/api/types/BucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional HMAC credentials. + */ export interface BucketPlan { /** This is the name of the bucket. */ name: string; diff --git a/src/api/types/ByoPhoneNumber.ts b/src/api/types/ByoPhoneNumber.ts index e0d5f314..7c48d283 100644 --- a/src/api/types/ByoPhoneNumber.ts +++ b/src/api/types/ByoPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface ByoPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/Call.ts b/src/api/types/Call.ts index e30089e6..6dfcf6ed 100644 --- a/src/api/types/Call.ts +++ b/src/api/types/Call.ts @@ -2,11 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A call record returned by Vapi. It contains the configuration and resources used for the call, its lifecycle status and timestamps, conversation messages, artifacts, analysis, and costs. + */ export interface Call { /** This is the type of call. */ type?: Vapi.CallType | undefined; /** These are the costs of individual components of the call in USD. */ costs?: Vapi.CallCostsItem[] | undefined; + /** Messages exchanged during the call, including user, assistant, system, tool-call, and tool-result messages. */ messages?: Vapi.CallMessagesItem[] | undefined; /** * This is the provider of the call. diff --git a/src/api/types/CallBatchError.ts b/src/api/types/CallBatchError.ts index 7a1021bd..6356ef2f 100644 --- a/src/api/types/CallBatchError.ts +++ b/src/api/types/CallBatchError.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Error returned for one customer entry in a batch call request. + */ export interface CallBatchError { + /** Customer configuration associated with the failed call. */ customer: Vapi.CreateCustomerDto; + /** Error message explaining why the call could not be created. */ error: string; } diff --git a/src/api/types/CallBatchResponse.ts b/src/api/types/CallBatchResponse.ts index bd746dd1..27dc63fc 100644 --- a/src/api/types/CallBatchResponse.ts +++ b/src/api/types/CallBatchResponse.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The result of a batch call creation request, containing successfully created calls, per-call failures, and subscription limits recorded at the end of the batch. + */ export interface CallBatchResponse { /** Subscription limits at the end of this batch */ subscriptionLimits?: Vapi.SubscriptionLimits | undefined; diff --git a/src/api/types/CallHookAssistantSpeechInterrupted.ts b/src/api/types/CallHookAssistantSpeechInterrupted.ts index 5798c755..74814f39 100644 --- a/src/api/types/CallHookAssistantSpeechInterrupted.ts +++ b/src/api/types/CallHookAssistantSpeechInterrupted.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the customer's speech interrupts the assistant. + */ export interface CallHookAssistantSpeechInterrupted { /** This is the event that triggers this hook */ on: Vapi.CallHookAssistantSpeechInterruptedOn; diff --git a/src/api/types/CallHookCallEnding.ts b/src/api/types/CallHookCallEnding.ts index aae89795..e968fa34 100644 --- a/src/api/types/CallHookCallEnding.ts +++ b/src/api/types/CallHookCallEnding.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when a call is ending, optionally only when its filters match. + */ export interface CallHookCallEnding { /** This is the event that triggers this hook */ on: Vapi.CallHookCallEndingOn; diff --git a/src/api/types/CallHookCustomerSpeechInterrupted.ts b/src/api/types/CallHookCustomerSpeechInterrupted.ts index 1a821565..9c237116 100644 --- a/src/api/types/CallHookCustomerSpeechInterrupted.ts +++ b/src/api/types/CallHookCustomerSpeechInterrupted.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the assistant interrupts the customer's speech. + */ export interface CallHookCustomerSpeechInterrupted { /** This is the event that triggers this hook */ on: Vapi.CallHookCustomerSpeechInterruptedOn; diff --git a/src/api/types/CallHookCustomerSpeechTimeout.ts b/src/api/types/CallHookCustomerSpeechTimeout.ts index 1a625aa6..22bceaf9 100644 --- a/src/api/types/CallHookCustomerSpeechTimeout.ts +++ b/src/api/types/CallHookCustomerSpeechTimeout.ts @@ -2,12 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the customer does not speak before the configured timeout, with support for trigger limits and named instances. + */ export interface CallHookCustomerSpeechTimeout { /** Must be either "customer.speech.timeout" or match the pattern "customer.speech.timeout[property=value]" */ on: string; /** This is the set of actions to perform when the hook triggers */ do: Vapi.CallHookCustomerSpeechTimeoutDoItem[]; - /** This is the set of filters that must match for the hook to trigger */ + /** Controls the speech timeout, maximum trigger count, and counter reset behavior for this hook. */ options?: Vapi.CustomerSpeechTimeoutOptions | undefined; /** * This is the name of the hook, it can be set by the user to identify the hook. diff --git a/src/api/types/CallHookFilter.ts b/src/api/types/CallHookFilter.ts index c89c5bbb..27e6bb9e 100644 --- a/src/api/types/CallHookFilter.ts +++ b/src/api/types/CallHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches a call field against one or more allowed values to determine whether a hook runs. + */ export interface CallHookFilter { /** This is the type of filter - currently only "oneOf" is supported */ type: Vapi.CallHookFilterType; diff --git a/src/api/types/CallHookModelResponseTimeout.ts b/src/api/types/CallHookModelResponseTimeout.ts index 69c400c8..60c6d2c0 100644 --- a/src/api/types/CallHookModelResponseTimeout.ts +++ b/src/api/types/CallHookModelResponseTimeout.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the language model does not respond before its timeout. + */ export interface CallHookModelResponseTimeout { /** This is the event that triggers this hook */ on: Vapi.CallHookModelResponseTimeoutOn; diff --git a/src/api/types/Campaign.ts b/src/api/types/Campaign.ts index c7d1aa6a..48cedf99 100644 --- a/src/api/types/Campaign.ts +++ b/src/api/types/Campaign.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and call-progress counters. + */ export interface Campaign { /** This is the status of the campaign. */ status: Vapi.CampaignStatus; diff --git a/src/api/types/CampaignPaginatedResponse.ts b/src/api/types/CampaignPaginatedResponse.ts index 316e3c75..51a2d4cd 100644 --- a/src/api/types/CampaignPaginatedResponse.ts +++ b/src/api/types/CampaignPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of outbound calling campaigns and metadata describing the result set. + */ export interface CampaignPaginatedResponse { + /** The campaigns returned for the current page. */ results: Vapi.Campaign[]; + /** Pagination metadata for the campaign result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/CartesiaExperimentalControls.ts b/src/api/types/CartesiaExperimentalControls.ts index 90cdef79..a43f8b64 100644 --- a/src/api/types/CartesiaExperimentalControls.ts +++ b/src/api/types/CartesiaExperimentalControls.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Cartesia voice controls for speed and emotion. + */ export interface CartesiaExperimentalControls { + /** Speaking-speed control expressed as a preset or a value from -1 to 1. */ speed?: Vapi.CartesiaSpeedControl | undefined; + /** Emotion and intensity applied to the Cartesia voice. */ emotion?: Vapi.CartesiaExperimentalControlsEmotion | undefined; } diff --git a/src/api/types/CartesiaExperimentalControlsEmotion.ts b/src/api/types/CartesiaExperimentalControlsEmotion.ts index 50e0ecd3..74c62d28 100644 --- a/src/api/types/CartesiaExperimentalControlsEmotion.ts +++ b/src/api/types/CartesiaExperimentalControlsEmotion.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Emotion and intensity applied to the Cartesia voice. */ export const CartesiaExperimentalControlsEmotion = { AngerLowest: "anger:lowest", AngerLow: "anger:low", diff --git a/src/api/types/CartesiaGenerationConfig.ts b/src/api/types/CartesiaGenerationConfig.ts index ed93001a..01b66a8b 100644 --- a/src/api/types/CartesiaGenerationConfig.ts +++ b/src/api/types/CartesiaGenerationConfig.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization. + */ export interface CartesiaGenerationConfig { /** Fine-grained speed control for sonic-3. Only available for sonic-3 model. */ speed?: number | undefined; diff --git a/src/api/types/CartesiaGenerationConfigExperimental.ts b/src/api/types/CartesiaGenerationConfigExperimental.ts index 4d1a4a3f..304eb00f 100644 --- a/src/api/types/CartesiaGenerationConfigExperimental.ts +++ b/src/api/types/CartesiaGenerationConfigExperimental.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Cartesia Sonic 3 generation controls, including accent localization. + */ export interface CartesiaGenerationConfigExperimental { /** Toggle accent localization for sonic-3: 0 (disabled, default) or 1 (enabled). When enabled, the voice adapts to match the transcript language accent while preserving vocal characteristics. */ accentLocalization?: number | undefined; diff --git a/src/api/types/CartesiaSpeedControl.ts b/src/api/types/CartesiaSpeedControl.ts index acaee582..7857983b 100644 --- a/src/api/types/CartesiaSpeedControl.ts +++ b/src/api/types/CartesiaSpeedControl.ts @@ -2,4 +2,7 @@ import type * as Vapi from "../index.js"; +/** + * Speaking-speed control expressed as a preset or a value from -1 to 1. + */ export type CartesiaSpeedControl = Vapi.CartesiaSpeedControlZero | number; diff --git a/src/api/types/CartesiaTranscriber.ts b/src/api/types/CartesiaTranscriber.ts index f95def21..09a08b04 100644 --- a/src/api/types/CartesiaTranscriber.ts +++ b/src/api/types/CartesiaTranscriber.ts @@ -2,8 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and fallback settings. + */ export interface CartesiaTranscriber { + /** The Cartesia speech-to-text model used for transcription. */ model?: Vapi.CartesiaTranscriberModel | undefined; + /** The language code used for transcription. */ language?: Vapi.CartesiaTranscriberLanguage | undefined; /** This is the plan for transcriber provider fallbacks in the event that the primary transcriber provider fails. */ fallbackPlan?: Vapi.FallbackTranscriberPlan | undefined; diff --git a/src/api/types/CartesiaTranscriberLanguage.ts b/src/api/types/CartesiaTranscriberLanguage.ts index 439cc84e..cbb85d59 100644 --- a/src/api/types/CartesiaTranscriberLanguage.ts +++ b/src/api/types/CartesiaTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The language code used for transcription. */ export const CartesiaTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/CartesiaTranscriberModel.ts b/src/api/types/CartesiaTranscriberModel.ts index 031175c5..031c3974 100644 --- a/src/api/types/CartesiaTranscriberModel.ts +++ b/src/api/types/CartesiaTranscriberModel.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The Cartesia speech-to-text model used for transcription. */ export const CartesiaTranscriberModel = { InkWhisper: "ink-whisper", } as const; diff --git a/src/api/types/CartesiaVoice.ts b/src/api/types/CartesiaVoice.ts index 0c31ea83..2ab9abfa 100644 --- a/src/api/types/CartesiaVoice.ts +++ b/src/api/types/CartesiaVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, caching, and fallback settings. + */ export interface CartesiaVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/CerebrasModel.ts b/src/api/types/CerebrasModel.ts index cb48fbcd..4d879a4b 100644 --- a/src/api/types/CerebrasModel.ts +++ b/src/api/types/CerebrasModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface CerebrasModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/ChatEvalAssistantMessageEvaluation.ts b/src/api/types/ChatEvalAssistantMessageEvaluation.ts index 7251f430..2e9db6f1 100644 --- a/src/api/types/ChatEvalAssistantMessageEvaluation.ts +++ b/src/api/types/ChatEvalAssistantMessageEvaluation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue afterward. + */ export interface ChatEvalAssistantMessageEvaluation { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalAssistantMessageMock.ts b/src/api/types/ChatEvalAssistantMessageMock.ts index 65aae701..6e96c11e 100644 --- a/src/api/types/ChatEvalAssistantMessageMock.ts +++ b/src/api/types/ChatEvalAssistantMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated assistant turn in an evaluation conversation, with optional message content and tool calls. + */ export interface ChatEvalAssistantMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalAssistantMessageMockToolCall.ts b/src/api/types/ChatEvalAssistantMessageMockToolCall.ts index 247946c3..875435ed 100644 --- a/src/api/types/ChatEvalAssistantMessageMockToolCall.ts +++ b/src/api/types/ChatEvalAssistantMessageMockToolCall.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A simulated assistant tool call with the tool name and optional arguments. + */ export interface ChatEvalAssistantMessageMockToolCall { /** * This is the name of the tool that will be called. diff --git a/src/api/types/ChatEvalSystemMessageMock.ts b/src/api/types/ChatEvalSystemMessageMock.ts index 4af1e411..ded983ac 100644 --- a/src/api/types/ChatEvalSystemMessageMock.ts +++ b/src/api/types/ChatEvalSystemMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated system message in an evaluation conversation. + */ export interface ChatEvalSystemMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalToolResponseMessageEvaluation.ts b/src/api/types/ChatEvalToolResponseMessageEvaluation.ts index cdbfead3..74b1beac 100644 --- a/src/api/types/ChatEvalToolResponseMessageEvaluation.ts +++ b/src/api/types/ChatEvalToolResponseMessageEvaluation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An expected tool-response turn evaluated by a configured LLM judge. + */ export interface ChatEvalToolResponseMessageEvaluation { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalToolResponseMessageMock.ts b/src/api/types/ChatEvalToolResponseMessageMock.ts index 9f998645..feeeed9a 100644 --- a/src/api/types/ChatEvalToolResponseMessageMock.ts +++ b/src/api/types/ChatEvalToolResponseMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated tool response in an evaluation conversation. + */ export interface ChatEvalToolResponseMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalUserMessageMock.ts b/src/api/types/ChatEvalUserMessageMock.ts index 5639fc6c..896f52b8 100644 --- a/src/api/types/ChatEvalUserMessageMock.ts +++ b/src/api/types/ChatEvalUserMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated user message in an evaluation conversation. + */ export interface ChatEvalUserMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChunkPlan.ts b/src/api/types/ChunkPlan.ts index 9ec75b8f..e5fac399 100644 --- a/src/api/types/ChunkPlan.ts +++ b/src/api/types/ChunkPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation boundaries, and formatting. + */ export interface ChunkPlan { /** * This determines whether the model output is chunked before being sent to the voice provider. Default `true`. diff --git a/src/api/types/CloudflareR2BucketPlan.ts b/src/api/types/CloudflareR2BucketPlan.ts index 72dfada2..1f276a2d 100644 --- a/src/api/types/CloudflareR2BucketPlan.ts +++ b/src/api/types/CloudflareR2BucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and path. + */ export interface CloudflareR2BucketPlan { /** Cloudflare R2 Access key ID. */ accessKeyId?: string | undefined; diff --git a/src/api/types/CodeTool.ts b/src/api/types/CodeTool.ts index 8736f172..390611f2 100644 --- a/src/api/types/CodeTool.ts +++ b/src/api/types/CodeTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ export interface CodeTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CodeToolEnvironmentVariable.ts b/src/api/types/CodeToolEnvironmentVariable.ts index 75f78883..ccfd862b 100644 --- a/src/api/types/CodeToolEnvironmentVariable.ts +++ b/src/api/types/CodeToolEnvironmentVariable.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An environment variable supplied to code-tool execution, with support for Liquid templates in its value. + */ export interface CodeToolEnvironmentVariable { /** Name of the environment variable */ name: string; diff --git a/src/api/types/Compliance.ts b/src/api/types/Compliance.ts index ae8ea4ed..bcef4ba6 100644 --- a/src/api/types/Compliance.ts +++ b/src/api/types/Compliance.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Compliance information captured for a call, including recording consent. + */ export interface Compliance { /** This is the recording consent of the call. Configure in `assistant.compliancePlan.recordingConsentPlan`. */ recordingConsent?: Vapi.RecordingConsent | undefined; diff --git a/src/api/types/ComplianceOverride.ts b/src/api/types/ComplianceOverride.ts index 941b3635..e800dd0e 100644 --- a/src/api/types/ComplianceOverride.ts +++ b/src/api/types/ComplianceOverride.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Overrides storage behavior for an output when HIPAA compliance is enabled. + */ export interface ComplianceOverride { /** Force storage for this output under HIPAA. Only enable if output contains no sensitive data. */ forceStoreOnHipaaEnabled?: boolean | undefined; diff --git a/src/api/types/CompliancePlan.ts b/src/api/types/CompliancePlan.ts index aff989ce..3d0eff1d 100644 --- a/src/api/types/CompliancePlan.ts +++ b/src/api/types/CompliancePlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant calls. + */ export interface CompliancePlan { /** When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false. Only HIPAA-compliant providers will be available for LLM, Voice, and Transcriber respectively. This setting is only honored if the organization is on an Enterprise subscription or has purchased the HIPAA add-on. */ hipaaEnabled?: boolean | undefined; @@ -12,5 +15,6 @@ export interface CompliancePlan { pciEnabled?: boolean | undefined; /** This is the security filter plan for the assistant. It allows filtering of transcripts for security threats before sending to LLM. */ securityFilterPlan?: Vapi.SecurityFilterPlan | undefined; + /** Controls how recording consent is requested before the assistant joins the call. */ recordingConsentPlan?: Vapi.CompliancePlanRecordingConsentPlan | undefined; } diff --git a/src/api/types/CompliancePlanRecordingConsentPlan.ts b/src/api/types/CompliancePlanRecordingConsentPlan.ts index b186b48a..a8195fe8 100644 --- a/src/api/types/CompliancePlanRecordingConsentPlan.ts +++ b/src/api/types/CompliancePlanRecordingConsentPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how recording consent is requested before the assistant joins the call. + */ export type CompliancePlanRecordingConsentPlan = | Vapi.CompliancePlanRecordingConsentPlan.StayOnLine | Vapi.CompliancePlanRecordingConsentPlan.Verbal; diff --git a/src/api/types/ComputerTool.ts b/src/api/types/ComputerTool.ts index 19f18a15..ad1158a8 100644 --- a/src/api/types/ComputerTool.ts +++ b/src/api/types/ComputerTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ export interface ComputerTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/Condition.ts b/src/api/types/Condition.ts index 66d1d180..5312322c 100644 --- a/src/api/types/Condition.ts +++ b/src/api/types/Condition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Compares a named parameter with a value using the selected comparison operator. + */ export interface Condition { /** This is the operator you want to use to compare the parameter and value. */ operator: Vapi.ConditionOperator; diff --git a/src/api/types/ContextEngineeringPlanAll.ts b/src/api/types/ContextEngineeringPlanAll.ts index 7ed31385..682818b6 100644 --- a/src/api/types/ContextEngineeringPlanAll.ts +++ b/src/api/types/ContextEngineeringPlanAll.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes all available messages when constructing context for a handoff. + */ export type ContextEngineeringPlanAll = {}; diff --git a/src/api/types/ContextEngineeringPlanLastNMessages.ts b/src/api/types/ContextEngineeringPlanLastNMessages.ts index d03df6bf..71ac3e14 100644 --- a/src/api/types/ContextEngineeringPlanLastNMessages.ts +++ b/src/api/types/ContextEngineeringPlanLastNMessages.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes a configured number of the most recent messages when constructing context for a handoff. + */ export interface ContextEngineeringPlanLastNMessages { /** This is the maximum number of messages to include in the context engineering plan. */ maxMessages: number; diff --git a/src/api/types/ContextEngineeringPlanNone.ts b/src/api/types/ContextEngineeringPlanNone.ts index efd7c1f4..88e23076 100644 --- a/src/api/types/ContextEngineeringPlanNone.ts +++ b/src/api/types/ContextEngineeringPlanNone.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Excludes prior conversation messages when constructing context for a handoff. + */ export type ContextEngineeringPlanNone = {}; diff --git a/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts b/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts index bc4cddbc..1343b439 100644 --- a/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts +++ b/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes only user and assistant messages when constructing context for a handoff. + */ export type ContextEngineeringPlanUserAndAssistantMessages = {}; diff --git a/src/api/types/ConversationNode.ts b/src/api/types/ConversationNode.ts index 1bc05e74..c8bd3926 100644 --- a/src/api/types/ConversationNode.ts +++ b/src/api/types/ConversationNode.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, and variable extraction. + */ export interface ConversationNode { /** * This is the model for the node. @@ -33,6 +36,7 @@ export interface ConversationNode { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** Prompt that guides the assistant while this node is active. */ prompt?: string | undefined; /** This is the plan for the global node. */ globalNodePlan?: Vapi.GlobalNodePlan | undefined; @@ -86,6 +90,7 @@ export interface ConversationNode { * Note: The `schema` field is required for Conversation nodes if you want to extract variables from the user's responses. `aliases` is just a convenience. */ variableExtractionPlan?: Vapi.VariableExtractionPlan | undefined; + /** Unique name used to identify this workflow node. */ name: string; /** This is whether or not the node is the start of the workflow. */ isStart?: boolean | undefined; diff --git a/src/api/types/CostBreakdown.ts b/src/api/types/CostBreakdown.ts index 9f9e469b..586813d4 100644 --- a/src/api/types/CostBreakdown.ts +++ b/src/api/types/CostBreakdown.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and character totals. + */ export interface CostBreakdown { /** This is the cost of the transport provider, like Twilio or Vonage. */ transport?: number | undefined; diff --git a/src/api/types/CreateAnthropicBedrockCredentialDto.ts b/src/api/types/CreateAnthropicBedrockCredentialDto.ts index 47cb1b3e..42e886e1 100644 --- a/src/api/types/CreateAnthropicBedrockCredentialDto.ts +++ b/src/api/types/CreateAnthropicBedrockCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and authentication method. + */ export interface CreateAnthropicBedrockCredentialDto { /** AWS region where Bedrock is configured. */ region: Vapi.CreateAnthropicBedrockCredentialDtoRegion; diff --git a/src/api/types/CreateAnthropicCredentialDto.ts b/src/api/types/CreateAnthropicCredentialDto.ts index f2f7c470..5c377968 100644 --- a/src/api/types/CreateAnthropicCredentialDto.ts +++ b/src/api/types/CreateAnthropicCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Anthropic. + */ export interface CreateAnthropicCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateAnyscaleCredentialDto.ts b/src/api/types/CreateAnyscaleCredentialDto.ts index af1d780d..ce630bd3 100644 --- a/src/api/types/CreateAnyscaleCredentialDto.ts +++ b/src/api/types/CreateAnyscaleCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Anyscale. + */ export interface CreateAnyscaleCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateApiRequestToolDto.ts b/src/api/types/CreateApiRequestToolDto.ts index 1e524283..958333fc 100644 --- a/src/api/types/CreateApiRequestToolDto.ts +++ b/src/api/types/CreateApiRequestToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ export interface CreateApiRequestToolDto { /** * These are the messages that will be spoken to the user as the tool is running. @@ -9,6 +12,7 @@ export interface CreateApiRequestToolDto { * For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured. */ messages?: Vapi.CreateApiRequestToolDtoMessagesItem[] | undefined; + /** The HTTP method used for the API request. */ method: Vapi.CreateApiRequestToolDtoMethod; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. diff --git a/src/api/types/CreateApiRequestToolDtoMethod.ts b/src/api/types/CreateApiRequestToolDtoMethod.ts index f9a682c5..15c52325 100644 --- a/src/api/types/CreateApiRequestToolDtoMethod.ts +++ b/src/api/types/CreateApiRequestToolDtoMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const CreateApiRequestToolDtoMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/CreateAssemblyAiCredentialDto.ts b/src/api/types/CreateAssemblyAiCredentialDto.ts index e03c9866..ef25dcb7 100644 --- a/src/api/types/CreateAssemblyAiCredentialDto.ts +++ b/src/api/types/CreateAssemblyAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with AssemblyAI. + */ export interface CreateAssemblyAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateAssistantDto.ts b/src/api/types/CreateAssistantDto.ts index d9c9a164..5f0285a2 100644 --- a/src/api/types/CreateAssistantDto.ts +++ b/src/api/types/CreateAssistantDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and conversation behavior. + */ export interface CreateAssistantDto { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.CreateAssistantDtoTranscriber | undefined; @@ -15,6 +18,7 @@ export interface CreateAssistantDto { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -85,6 +89,7 @@ export interface CreateAssistantDto { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -147,5 +152,6 @@ export interface CreateAssistantDto { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; } diff --git a/src/api/types/CreateAzureCredentialDto.ts b/src/api/types/CreateAzureCredentialDto.ts index b13e23f6..0fe9943d 100644 --- a/src/api/types/CreateAzureCredentialDto.ts +++ b/src/api/types/CreateAzureCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings. + */ export interface CreateAzureCredentialDto { /** This is the service being used in Azure. */ service: Vapi.CreateAzureCredentialDtoService; diff --git a/src/api/types/CreateAzureOpenAiCredentialDto.ts b/src/api/types/CreateAzureOpenAiCredentialDto.ts index 212bb821..b5b7f14f 100644 --- a/src/api/types/CreateAzureOpenAiCredentialDto.ts +++ b/src/api/types/CreateAzureOpenAiCredentialDto.ts @@ -2,13 +2,19 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and available models. + */ export interface CreateAzureOpenAiCredentialDto { + /** Azure region that hosts the OpenAI resource. */ region: Vapi.CreateAzureOpenAiCredentialDtoRegion; + /** Azure OpenAI models available through this credential. */ models: Vapi.CreateAzureOpenAiCredentialDtoModelsItem[]; /** This is not returned in the API. */ openAIKey: string; /** This is not returned in the API. */ ocpApimSubscriptionKey?: string | undefined; + /** Endpoint URL for the Azure OpenAI resource. */ openAIEndpoint: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts b/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts index 9f81bf63..0fb3b17f 100644 --- a/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts +++ b/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Azure region that hosts the OpenAI resource. */ export const CreateAzureOpenAiCredentialDtoRegion = { Australiaeast: "australiaeast", Canadaeast: "canadaeast", diff --git a/src/api/types/CreateBarInsightFromCallTableDto.ts b/src/api/types/CreateBarInsightFromCallTableDto.ts index bafb40a5..c18d0d7b 100644 --- a/src/api/types/CreateBarInsightFromCallTableDto.ts +++ b/src/api/types/CreateBarInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ export interface CreateBarInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface CreateBarInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreateBashToolDto.ts b/src/api/types/CreateBashToolDto.ts index 5eeedf9b..cb72e53a 100644 --- a/src/api/types/CreateBashToolDto.ts +++ b/src/api/types/CreateBashToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that executes shell commands in a configured environment. + */ export interface CreateBashToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateByoPhoneNumberDto.ts b/src/api/types/CreateByoPhoneNumberDto.ts index a5574e69..268ec064 100644 --- a/src/api/types/CreateByoPhoneNumberDto.ts +++ b/src/api/types/CreateByoPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing settings. + */ export interface CreateByoPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateByoSipTrunkCredentialDto.ts b/src/api/types/CreateByoSipTrunkCredentialDto.ts index 4dba7308..e6d7a78a 100644 --- a/src/api/types/CreateByoSipTrunkCredentialDto.ts +++ b/src/api/types/CreateByoSipTrunkCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for connecting Vapi to a bring-your-own SIP trunk or carrier, including gateways, outbound authentication, number handling, and optional session border controller routing. + */ export interface CreateByoSipTrunkCredentialDto { /** This is the list of SIP trunk's gateways. */ gateways: Vapi.SipTrunkGateway[]; diff --git a/src/api/types/CreateCartesiaCredentialDto.ts b/src/api/types/CreateCartesiaCredentialDto.ts index dedf1fd5..125679bc 100644 --- a/src/api/types/CreateCartesiaCredentialDto.ts +++ b/src/api/types/CreateCartesiaCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Cartesia. + */ export interface CreateCartesiaCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateCerebrasCredentialDto.ts b/src/api/types/CreateCerebrasCredentialDto.ts index c9f400ab..4fa66a5f 100644 --- a/src/api/types/CreateCerebrasCredentialDto.ts +++ b/src/api/types/CreateCerebrasCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Cerebras. + */ export interface CreateCerebrasCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateCloudflareCredentialDto.ts b/src/api/types/CreateCloudflareCredentialDto.ts index fb7e0497..f7e958a9 100644 --- a/src/api/types/CreateCloudflareCredentialDto.ts +++ b/src/api/types/CreateCloudflareCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and upload fallback order. + */ export interface CreateCloudflareCredentialDto { /** Cloudflare Account Id. */ accountId?: string | undefined; diff --git a/src/api/types/CreateCodeToolDto.ts b/src/api/types/CreateCodeToolDto.ts index dee3d932..38024b3a 100644 --- a/src/api/types/CreateCodeToolDto.ts +++ b/src/api/types/CreateCodeToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ export interface CreateCodeToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateComputerToolDto.ts b/src/api/types/CreateComputerToolDto.ts index 1ea1bd82..4f5ce3c1 100644 --- a/src/api/types/CreateComputerToolDto.ts +++ b/src/api/types/CreateComputerToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ export interface CreateComputerToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateCustomCredentialDto.ts b/src/api/types/CreateCustomCredentialDto.ts index d3706986..07bd36cc 100644 --- a/src/api/types/CreateCustomCredentialDto.ts +++ b/src/api/types/CreateCustomCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for sensitive request data. + */ export interface CreateCustomCredentialDto { /** This is the authentication plan. Supports OAuth2 RFC 6749, HMAC signing, and Bearer authentication. */ authenticationPlan: Vapi.CreateCustomCredentialDtoAuthenticationPlan; diff --git a/src/api/types/CreateCustomKnowledgeBaseDto.ts b/src/api/types/CreateCustomKnowledgeBaseDto.ts index e15a604c..25205440 100644 --- a/src/api/types/CreateCustomKnowledgeBaseDto.ts +++ b/src/api/types/CreateCustomKnowledgeBaseDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for connecting a custom knowledge-base implementation through a customer-hosted server. + */ export interface CreateCustomKnowledgeBaseDto { /** This knowledge base is bring your own knowledge base implementation. */ provider: Vapi.CreateCustomKnowledgeBaseDtoProvider; diff --git a/src/api/types/CreateCustomLlmCredentialDto.ts b/src/api/types/CreateCustomLlmCredentialDto.ts index 311fb9c6..25372219 100644 --- a/src/api/types/CreateCustomLlmCredentialDto.ts +++ b/src/api/types/CreateCustomLlmCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication plan. + */ export interface CreateCustomLlmCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateCustomerDto.ts b/src/api/types/CreateCustomerDto.ts index 35052af2..31e85f70 100644 --- a/src/api/types/CreateCustomerDto.ts +++ b/src/api/types/CreateCustomerDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact identifiers, extension, and assistant overrides. + */ export interface CreateCustomerDto { /** * This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it. diff --git a/src/api/types/CreateDeepInfraCredentialDto.ts b/src/api/types/CreateDeepInfraCredentialDto.ts index fd64ca77..d23cf93f 100644 --- a/src/api/types/CreateDeepInfraCredentialDto.ts +++ b/src/api/types/CreateDeepInfraCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with DeepInfra. + */ export interface CreateDeepInfraCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDeepSeekCredentialDto.ts b/src/api/types/CreateDeepSeekCredentialDto.ts index e6c093b3..558a98ea 100644 --- a/src/api/types/CreateDeepSeekCredentialDto.ts +++ b/src/api/types/CreateDeepSeekCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with DeepSeek. + */ export interface CreateDeepSeekCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDeepgramCredentialDto.ts b/src/api/types/CreateDeepgramCredentialDto.ts index 75732212..a66374f7 100644 --- a/src/api/types/CreateDeepgramCredentialDto.ts +++ b/src/api/types/CreateDeepgramCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API URL for an on-premises instance. + */ export interface CreateDeepgramCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDtmfToolDto.ts b/src/api/types/CreateDtmfToolDto.ts index edce636c..3a672e5c 100644 --- a/src/api/types/CreateDtmfToolDto.ts +++ b/src/api/types/CreateDtmfToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call. + */ export interface CreateDtmfToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateElevenLabsCredentialDto.ts b/src/api/types/CreateElevenLabsCredentialDto.ts index 43996126..bc4eea7f 100644 --- a/src/api/types/CreateElevenLabsCredentialDto.ts +++ b/src/api/types/CreateElevenLabsCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs. + */ export interface CreateElevenLabsCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateEmailCredentialDto.ts b/src/api/types/CreateEmailCredentialDto.ts index 8c5218c7..e51ec2ae 100644 --- a/src/api/types/CreateEmailCredentialDto.ts +++ b/src/api/types/CreateEmailCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Destination configuration for sending Vapi alerts to an email address. + */ export interface CreateEmailCredentialDto { /** The recipient email address for alerts */ email: string; diff --git a/src/api/types/CreateEndCallToolDto.ts b/src/api/types/CreateEndCallToolDto.ts index 9fafa84f..8867fd8e 100644 --- a/src/api/types/CreateEndCallToolDto.ts +++ b/src/api/types/CreateEndCallToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant end the active call. + */ export interface CreateEndCallToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateEvalDto.ts b/src/api/types/CreateEvalDto.ts index 97ecdccc..edd15bd9 100644 --- a/src/api/types/CreateEvalDto.ts +++ b/src/api/types/CreateEvalDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing assistant responses and tool calls. + */ export interface CreateEvalDto { /** * This is the mock conversation that will be used to evaluate the flow of the conversation. diff --git a/src/api/types/CreateFunctionToolDto.ts b/src/api/types/CreateFunctionToolDto.ts index 52a6940d..5d8e860c 100644 --- a/src/api/types/CreateFunctionToolDto.ts +++ b/src/api/types/CreateFunctionToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a custom function tool that sends model-generated arguments to a server and returns the result to the assistant. + */ export interface CreateFunctionToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGcpCredentialDto.ts b/src/api/types/CreateGcpCredentialDto.ts index 3a985a2a..f9a226ef 100644 --- a/src/api/types/CreateGcpCredentialDto.ts +++ b/src/api/types/CreateGcpCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, bucket configuration, and upload fallback order. + */ export interface CreateGcpCredentialDto { /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ fallbackIndex?: number | undefined; @@ -13,6 +16,7 @@ export interface CreateGcpCredentialDto { gcpKey: Vapi.GcpKey; /** This is the region of the GCP resource. */ region?: string | undefined; + /** Bucket configuration used to store call artifacts in Google Cloud Storage. */ bucketPlan?: Vapi.BucketPlan | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateGladiaCredentialDto.ts b/src/api/types/CreateGladiaCredentialDto.ts index fe700ced..10e61358 100644 --- a/src/api/types/CreateGladiaCredentialDto.ts +++ b/src/api/types/CreateGladiaCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Gladia. + */ export interface CreateGladiaCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts b/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts index 94e2e933..998cef4e 100644 --- a/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts +++ b/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account. + */ export interface CreateGoHighLevelCalendarAvailabilityToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts b/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts index 8979aadd..3e38acf7 100644 --- a/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts +++ b/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds calendar events to a connected GoHighLevel account. + */ export interface CreateGoHighLevelCalendarEventCreateToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoHighLevelContactCreateToolDto.ts b/src/api/types/CreateGoHighLevelContactCreateToolDto.ts index 1772bd6b..ea661b6b 100644 --- a/src/api/types/CreateGoHighLevelContactCreateToolDto.ts +++ b/src/api/types/CreateGoHighLevelContactCreateToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds contacts to a connected GoHighLevel account. + */ export interface CreateGoHighLevelContactCreateToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoHighLevelContactGetToolDto.ts b/src/api/types/CreateGoHighLevelContactGetToolDto.ts index 46168341..33ef3e7c 100644 --- a/src/api/types/CreateGoHighLevelContactGetToolDto.ts +++ b/src/api/types/CreateGoHighLevelContactGetToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account. + */ export interface CreateGoHighLevelContactGetToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoHighLevelCredentialDto.ts b/src/api/types/CreateGoHighLevelCredentialDto.ts index a3050f8d..e0198641 100644 --- a/src/api/types/CreateGoHighLevelCredentialDto.ts +++ b/src/api/types/CreateGoHighLevelCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating Vapi integrations with GoHighLevel. + */ export interface CreateGoHighLevelCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoHighLevelMcpCredentialDto.ts b/src/api/types/CreateGoHighLevelMcpCredentialDto.ts index b4ab62c8..bcd5e055 100644 --- a/src/api/types/CreateGoHighLevelMcpCredentialDto.ts +++ b/src/api/types/CreateGoHighLevelMcpCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests. + */ export interface CreateGoHighLevelMcpCredentialDto { /** This is the authentication session for the credential. */ authenticationSession: Vapi.Oauth2AuthenticationSession; diff --git a/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts b/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts index 5129f2b8..b38178dd 100644 --- a/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts +++ b/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that checks availability in a connected Google Calendar. + */ export interface CreateGoogleCalendarCheckAvailabilityToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts b/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts index 406a9073..325c8c29 100644 --- a/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts +++ b/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds events to a connected Google Calendar. + */ export interface CreateGoogleCalendarCreateEventToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts index e2c5b21c..af21dd43 100644 --- a/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Google Calendar operations. + */ export interface CreateGoogleCalendarOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts b/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts index 7d275e65..555ba8af 100644 --- a/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts +++ b/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OAuth 2.0 client credential for Google Calendar integrations. + */ export interface CreateGoogleCalendarOAuth2ClientCredentialDto { /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateGoogleCredentialDto.ts b/src/api/types/CreateGoogleCredentialDto.ts index 5bf8c267..4df88d1a 100644 --- a/src/api/types/CreateGoogleCredentialDto.ts +++ b/src/api/types/CreateGoogleCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Google AI. + */ export interface CreateGoogleCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts index 0db16a6c..6e7f4187 100644 --- a/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Google Sheets operations. + */ export interface CreateGoogleSheetsOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts b/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts index 729ef215..2ccd4a90 100644 --- a/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts +++ b/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that appends rows to a connected Google Sheet. + */ export interface CreateGoogleSheetsRowAppendToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateGroqCredentialDto.ts b/src/api/types/CreateGroqCredentialDto.ts index bb99cbae..9652d407 100644 --- a/src/api/types/CreateGroqCredentialDto.ts +++ b/src/api/types/CreateGroqCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Groq. + */ export interface CreateGroqCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateHandoffToolDto.ts b/src/api/types/CreateHandoffToolDto.ts index 2ca788df..1be37bb2 100644 --- a/src/api/types/CreateHandoffToolDto.ts +++ b/src/api/types/CreateHandoffToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ export interface CreateHandoffToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateHumeCredentialDto.ts b/src/api/types/CreateHumeCredentialDto.ts index f2894b24..c6c9afce 100644 --- a/src/api/types/CreateHumeCredentialDto.ts +++ b/src/api/types/CreateHumeCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Hume. + */ export interface CreateHumeCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateInflectionAiCredentialDto.ts b/src/api/types/CreateInflectionAiCredentialDto.ts index 18e0ebe2..1ddbc3a9 100644 --- a/src/api/types/CreateInflectionAiCredentialDto.ts +++ b/src/api/types/CreateInflectionAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Inflection AI. + */ export interface CreateInflectionAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateInworldCredentialDto.ts b/src/api/types/CreateInworldCredentialDto.ts index 941b8e35..69bb5e43 100644 --- a/src/api/types/CreateInworldCredentialDto.ts +++ b/src/api/types/CreateInworldCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Inworld. + */ export interface CreateInworldCredentialDto { /** This is the Inworld Basic (Base64) authentication token. This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateLangfuseCredentialDto.ts b/src/api/types/CreateLangfuseCredentialDto.ts index 57ff7adc..70fe35f4 100644 --- a/src/api/types/CreateLangfuseCredentialDto.ts +++ b/src/api/types/CreateLangfuseCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and host URL. + */ export interface CreateLangfuseCredentialDto { /** The public key for Langfuse project. Eg: pk-lf-... */ publicKey: string; diff --git a/src/api/types/CreateLineInsightFromCallTableDto.ts b/src/api/types/CreateLineInsightFromCallTableDto.ts index e62f9b5c..a87bc9ab 100644 --- a/src/api/types/CreateLineInsightFromCallTableDto.ts +++ b/src/api/types/CreateLineInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ export interface CreateLineInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface CreateLineInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreateLmntCredentialDto.ts b/src/api/types/CreateLmntCredentialDto.ts index 508156fb..344bf31f 100644 --- a/src/api/types/CreateLmntCredentialDto.ts +++ b/src/api/types/CreateLmntCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with LMNT. + */ export interface CreateLmntCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateMakeCredentialDto.ts b/src/api/types/CreateMakeCredentialDto.ts index b6f1a642..412d3106 100644 --- a/src/api/types/CreateMakeCredentialDto.ts +++ b/src/api/types/CreateMakeCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating Vapi integrations with Make, including team, region, and API key. + */ export interface CreateMakeCredentialDto { /** Team ID */ teamId: string; diff --git a/src/api/types/CreateMcpToolDto.ts b/src/api/types/CreateMcpToolDto.ts index 1b73a2e6..2bb3a0a7 100644 --- a/src/api/types/CreateMcpToolDto.ts +++ b/src/api/types/CreateMcpToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ export interface CreateMcpToolDto { /** * These are the messages that will be spoken to the user as the tool is running. @@ -22,6 +25,7 @@ export interface CreateMcpToolDto { server?: Vapi.Server | undefined; /** Per-tool message overrides for individual tools loaded from the MCP server. Set messages to an empty array to suppress messages for a specific tool. Tools not listed here will use the default messages from the parent tool. */ toolMessages?: Vapi.McpToolMessages[] | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateMinimaxCredentialDto.ts b/src/api/types/CreateMinimaxCredentialDto.ts index 0a157271..456e6631 100644 --- a/src/api/types/CreateMinimaxCredentialDto.ts +++ b/src/api/types/CreateMinimaxCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax group identifier. + */ export interface CreateMinimaxCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateMistralCredentialDto.ts b/src/api/types/CreateMistralCredentialDto.ts index 604584cc..0a790217 100644 --- a/src/api/types/CreateMistralCredentialDto.ts +++ b/src/api/types/CreateMistralCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Mistral. + */ export interface CreateMistralCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateNeuphonicCredentialDto.ts b/src/api/types/CreateNeuphonicCredentialDto.ts index 5d379eb7..18c19304 100644 --- a/src/api/types/CreateNeuphonicCredentialDto.ts +++ b/src/api/types/CreateNeuphonicCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Neuphonic. + */ export interface CreateNeuphonicCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateOpenAiCredentialDto.ts b/src/api/types/CreateOpenAiCredentialDto.ts index 26638593..0912a522 100644 --- a/src/api/types/CreateOpenAiCredentialDto.ts +++ b/src/api/types/CreateOpenAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI. + */ export interface CreateOpenAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateOpenRouterCredentialDto.ts b/src/api/types/CreateOpenRouterCredentialDto.ts index cab67cbd..ccbe813a 100644 --- a/src/api/types/CreateOpenRouterCredentialDto.ts +++ b/src/api/types/CreateOpenRouterCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with OpenRouter. + */ export interface CreateOpenRouterCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreatePerplexityAiCredentialDto.ts b/src/api/types/CreatePerplexityAiCredentialDto.ts index 06eb35da..ccac2624 100644 --- a/src/api/types/CreatePerplexityAiCredentialDto.ts +++ b/src/api/types/CreatePerplexityAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Perplexity AI. + */ export interface CreatePerplexityAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreatePieInsightFromCallTableDto.ts b/src/api/types/CreatePieInsightFromCallTableDto.ts index 7255a861..2298b13d 100644 --- a/src/api/types/CreatePieInsightFromCallTableDto.ts +++ b/src/api/types/CreatePieInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range. + */ export interface CreatePieInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface CreatePieInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreatePlayHtCredentialDto.ts b/src/api/types/CreatePlayHtCredentialDto.ts index ab081ed7..16b90bf9 100644 --- a/src/api/types/CreatePlayHtCredentialDto.ts +++ b/src/api/types/CreatePlayHtCredentialDto.ts @@ -1,8 +1,12 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier. + */ export interface CreatePlayHtCredentialDto { /** This is not returned in the API. */ apiKey: string; + /** PlayHT user identifier associated with the API key. */ userId: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateQueryToolDto.ts b/src/api/types/CreateQueryToolDto.ts index ef9f31d3..58c68f75 100644 --- a/src/api/types/CreateQueryToolDto.ts +++ b/src/api/types/CreateQueryToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the assistant. + */ export interface CreateQueryToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateRimeAiCredentialDto.ts b/src/api/types/CreateRimeAiCredentialDto.ts index 87ea6a9a..0f42e2bd 100644 --- a/src/api/types/CreateRimeAiCredentialDto.ts +++ b/src/api/types/CreateRimeAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Rime AI. + */ export interface CreateRimeAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateRunpodCredentialDto.ts b/src/api/types/CreateRunpodCredentialDto.ts index ec9cb195..4431d77e 100644 --- a/src/api/types/CreateRunpodCredentialDto.ts +++ b/src/api/types/CreateRunpodCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests through Runpod. + */ export interface CreateRunpodCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateS3CredentialDto.ts b/src/api/types/CreateS3CredentialDto.ts index 5abc471d..96afb752 100644 --- a/src/api/types/CreateS3CredentialDto.ts +++ b/src/api/types/CreateS3CredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and upload fallback order. + */ export interface CreateS3CredentialDto { /** AWS access key ID. */ awsAccessKeyId: string; diff --git a/src/api/types/CreateScorecardDto.ts b/src/api/types/CreateScorecardDto.ts index 9327befe..ad576340 100644 --- a/src/api/types/CreateScorecardDto.ts +++ b/src/api/types/CreateScorecardDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant associations. + */ export interface CreateScorecardDto { /** This is the name of the scorecard. It is only for user reference and will not be used for any evaluation. */ name?: string | undefined; diff --git a/src/api/types/CreateSipRequestToolDto.ts b/src/api/types/CreateSipRequestToolDto.ts index 36f3c4b3..2b697bd8 100644 --- a/src/api/types/CreateSipRequestToolDto.ts +++ b/src/api/types/CreateSipRequestToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ export interface CreateSipRequestToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts index 653f9634..da1eecd4 100644 --- a/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Slack operations. + */ export interface CreateSlackOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateSlackSendMessageToolDto.ts b/src/api/types/CreateSlackSendMessageToolDto.ts index 213ac064..d8e9feaa 100644 --- a/src/api/types/CreateSlackSendMessageToolDto.ts +++ b/src/api/types/CreateSlackSendMessageToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send a message to Slack. + */ export interface CreateSlackSendMessageToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateSlackWebhookCredentialDto.ts b/src/api/types/CreateSlackWebhookCredentialDto.ts index 776e00e9..2a689516 100644 --- a/src/api/types/CreateSlackWebhookCredentialDto.ts +++ b/src/api/types/CreateSlackWebhookCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for sending Vapi alerts through a Slack incoming webhook. + */ export interface CreateSlackWebhookCredentialDto { /** Slack incoming webhook URL. See https://api.slack.com/messaging/webhooks for setup instructions. This is not returned in the API. */ webhookUrl: string; diff --git a/src/api/types/CreateSmallestAiCredentialDto.ts b/src/api/types/CreateSmallestAiCredentialDto.ts index f855651f..d8ce7b91 100644 --- a/src/api/types/CreateSmallestAiCredentialDto.ts +++ b/src/api/types/CreateSmallestAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Smallest AI. + */ export interface CreateSmallestAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateSmsToolDto.ts b/src/api/types/CreateSmsToolDto.ts index 4c480d95..f698fb16 100644 --- a/src/api/types/CreateSmsToolDto.ts +++ b/src/api/types/CreateSmsToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send an SMS message during a call. + */ export interface CreateSmsToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateSonioxCredentialDto.ts b/src/api/types/CreateSonioxCredentialDto.ts index cfdc5df6..5ffc97b6 100644 --- a/src/api/types/CreateSonioxCredentialDto.ts +++ b/src/api/types/CreateSonioxCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Soniox. + */ export interface CreateSonioxCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateSpeechmaticsCredentialDto.ts b/src/api/types/CreateSpeechmaticsCredentialDto.ts index 272c3030..5a908464 100644 --- a/src/api/types/CreateSpeechmaticsCredentialDto.ts +++ b/src/api/types/CreateSpeechmaticsCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Speechmatics. + */ export interface CreateSpeechmaticsCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateSquadDto.ts b/src/api/types/CreateSquadDto.ts index c4d802aa..d849851d 100644 --- a/src/api/types/CreateSquadDto.ts +++ b/src/api/types/CreateSquadDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a squad. Provide an ordered list of assistant members and optional overrides that control how the squad handles a conversation and transfers between assistants. + */ export interface CreateSquadDto { /** This is the name of the squad. */ name?: string | undefined; diff --git a/src/api/types/CreateStructuredOutputDto.ts b/src/api/types/CreateStructuredOutputDto.ts index 208950d7..04775196 100644 --- a/src/api/types/CreateStructuredOutputDto.ts +++ b/src/api/types/CreateStructuredOutputDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a structured-output definition that extracts validated data from calls using an AI model or regular expression. + */ export interface CreateStructuredOutputDto { /** * This is the type of structured output. diff --git a/src/api/types/CreateSupabaseCredentialDto.ts b/src/api/types/CreateSupabaseCredentialDto.ts index 2681e657..7a8a53ca 100644 --- a/src/api/types/CreateSupabaseCredentialDto.ts +++ b/src/api/types/CreateSupabaseCredentialDto.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and upload fallback order. + */ export interface CreateSupabaseCredentialDto { /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ fallbackIndex?: number | undefined; + /** Supabase S3-compatible bucket configuration used to store call artifacts. */ bucketPlan?: Vapi.SupabaseBucketPlan | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateTavusCredentialDto.ts b/src/api/types/CreateTavusCredentialDto.ts index 37168ac4..239412ae 100644 --- a/src/api/types/CreateTavusCredentialDto.ts +++ b/src/api/types/CreateTavusCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Tavus. + */ export interface CreateTavusCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateTelnyxPhoneNumberDto.ts b/src/api/types/CreateTelnyxPhoneNumberDto.ts index ec71d389..3e5c1de8 100644 --- a/src/api/types/CreateTelnyxPhoneNumberDto.ts +++ b/src/api/types/CreateTelnyxPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings. + */ export interface CreateTelnyxPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateTextEditorToolDto.ts b/src/api/types/CreateTextEditorToolDto.ts index 441bd0cc..163e1e9b 100644 --- a/src/api/types/CreateTextEditorToolDto.ts +++ b/src/api/types/CreateTextEditorToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that reads and edits text files in a configured environment. + */ export interface CreateTextEditorToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateTextInsightFromCallTableDto.ts b/src/api/types/CreateTextInsightFromCallTableDto.ts index 1bdd029c..f9dae153 100644 --- a/src/api/types/CreateTextInsightFromCallTableDto.ts +++ b/src/api/types/CreateTextInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range. + */ export interface CreateTextInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface CreateTextInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. diff --git a/src/api/types/CreateTogetherAiCredentialDto.ts b/src/api/types/CreateTogetherAiCredentialDto.ts index ec46e6fd..569be28c 100644 --- a/src/api/types/CreateTogetherAiCredentialDto.ts +++ b/src/api/types/CreateTogetherAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Together AI. + */ export interface CreateTogetherAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateTransferCallToolDto.ts b/src/api/types/CreateTransferCallToolDto.ts index 810db8ef..4dd139df 100644 --- a/src/api/types/CreateTransferCallToolDto.ts +++ b/src/api/types/CreateTransferCallToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that transfers the active call to one of its configured destinations. + */ export interface CreateTransferCallToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateTrieveCredentialDto.ts b/src/api/types/CreateTrieveCredentialDto.ts index 00760cb6..1e47f1b3 100644 --- a/src/api/types/CreateTrieveCredentialDto.ts +++ b/src/api/types/CreateTrieveCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating knowledge-base requests with Trieve. + */ export interface CreateTrieveCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateTwilioCredentialDto.ts b/src/api/types/CreateTwilioCredentialDto.ts index 7bb46111..dbf86f61 100644 --- a/src/api/types/CreateTwilioCredentialDto.ts +++ b/src/api/types/CreateTwilioCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API key credentials. + */ export interface CreateTwilioCredentialDto { /** This is not returned in the API. */ authToken?: string | undefined; @@ -7,6 +10,7 @@ export interface CreateTwilioCredentialDto { apiKey?: string | undefined; /** This is not returned in the API. */ apiSecret?: string | undefined; + /** Twilio Account SID associated with the credential. */ accountSid: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateTwilioPhoneNumberDto.ts b/src/api/types/CreateTwilioPhoneNumberDto.ts index 32790e71..b8f4d0e2 100644 --- a/src/api/types/CreateTwilioPhoneNumberDto.ts +++ b/src/api/types/CreateTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings. + */ export interface CreateTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateVapiPhoneNumberDto.ts b/src/api/types/CreateVapiPhoneNumberDto.ts index 5cb40bb9..8e5542e4 100644 --- a/src/api/types/CreateVapiPhoneNumberDto.ts +++ b/src/api/types/CreateVapiPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and authentication settings. + */ export interface CreateVapiPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateVoicemailToolDto.ts b/src/api/types/CreateVoicemailToolDto.ts index 1e5e3959..f8be8c20 100644 --- a/src/api/types/CreateVoicemailToolDto.ts +++ b/src/api/types/CreateVoicemailToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a voicemail-detection tool with optional beep detection for supported calls. + */ export interface CreateVoicemailToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/CreateVonageCredentialDto.ts b/src/api/types/CreateVonageCredentialDto.ts index 7f69272b..605cd49c 100644 --- a/src/api/types/CreateVonageCredentialDto.ts +++ b/src/api/types/CreateVonageCredentialDto.ts @@ -1,8 +1,12 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating telephony requests with Vonage. + */ export interface CreateVonageCredentialDto { /** This is not returned in the API. */ apiSecret: string; + /** Vonage API key associated with the credential. */ apiKey: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateVonagePhoneNumberDto.ts b/src/api/types/CreateVonagePhoneNumberDto.ts index 9cf8016d..4caee3b6 100644 --- a/src/api/types/CreateVonagePhoneNumberDto.ts +++ b/src/api/types/CreateVonagePhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings. + */ export interface CreateVonagePhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateWellSaidCredentialDto.ts b/src/api/types/CreateWellSaidCredentialDto.ts index e994f1e8..57f664bc 100644 --- a/src/api/types/CreateWellSaidCredentialDto.ts +++ b/src/api/types/CreateWellSaidCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with WellSaid. + */ export interface CreateWellSaidCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateWorkflowDto.ts b/src/api/types/CreateWorkflowDto.ts index f3cb459f..3ce3d645 100644 --- a/src/api/types/CreateWorkflowDto.ts +++ b/src/api/types/CreateWorkflowDto.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for creating a graph-based workflow, including conversation and tool nodes, directed edges, global prompts, shared providers, hooks, credentials, and call behavior. + */ export interface CreateWorkflowDto { + /** Nodes that make up the workflow graph. Conversation nodes interact with the customer, while tool nodes invoke configured tools. */ nodes: Vapi.CreateWorkflowDtoNodesItem[]; /** * This is the model for the workflow. @@ -47,8 +51,11 @@ export interface CreateWorkflowDto { * Default is 1800 (30 minutes), max is 43200 (12 hours), and min is 10 seconds. */ maxDurationSeconds?: number | undefined; + /** Name used to identify the workflow. */ name: string; + /** Directed connections that determine transitions between nodes. */ edges: Vapi.Edge[]; + /** Prompt applied across the workflow's conversation nodes. */ globalPrompt?: string | undefined; /** * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. diff --git a/src/api/types/CreateXAiCredentialDto.ts b/src/api/types/CreateXAiCredentialDto.ts index 83c372af..9bc3fafe 100644 --- a/src/api/types/CreateXAiCredentialDto.ts +++ b/src/api/types/CreateXAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with xAI. + */ export interface CreateXAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts b/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts index 5fd31689..36cb519d 100644 --- a/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts +++ b/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using a custom endpointing model, including its provider identifier and server connection. + */ export interface CustomEndpointingModelSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. Use `custom-endpointing-model` for custom endpointing providers that are not natively supported. */ provider: Vapi.CustomEndpointingModelSmartEndpointingPlanProvider; diff --git a/src/api/types/CustomLlmModel.ts b/src/api/types/CustomLlmModel.ts index 7fb421a0..3c8c90bb 100644 --- a/src/api/types/CustomLlmModel.ts +++ b/src/api/types/CustomLlmModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses through a custom language model endpoint, including server URL, headers, metadata, prompts, tools, and generation settings. + */ export interface CustomLlmModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/CustomMessage.ts b/src/api/types/CustomMessage.ts index 01ed175e..a32072c1 100644 --- a/src/api/types/CustomMessage.ts +++ b/src/api/types/CustomMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A message spoken by the assistant with optional language-specific content variants. + */ export interface CustomMessage { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/CustomTranscriber.ts b/src/api/types/CustomTranscriber.ts index 44b77b9e..479a76c7 100644 --- a/src/api/types/CustomTranscriber.ts +++ b/src/api/types/CustomTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for sending conversation audio to a custom WebSocket transcription server. + */ export interface CustomTranscriber { /** * This is where the transcription request will be sent. diff --git a/src/api/types/CustomVoice.ts b/src/api/types/CustomVoice.ts index 54db4240..06ef0ec4 100644 --- a/src/api/types/CustomVoice.ts +++ b/src/api/types/CustomVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, caching, and fallback settings. + */ export interface CustomVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/CustomerCustomEndpointingRule.ts b/src/api/types/CustomerCustomEndpointingRule.ts index c80a6c7b..fe96cc06 100644 --- a/src/api/types/CustomerCustomEndpointingRule.ts +++ b/src/api/types/CustomerCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches the customer's current speech and applies a configured timeout. + */ export interface CustomerCustomEndpointingRule { /** * This is the regex pattern to match. diff --git a/src/api/types/CustomerSpeechTimeoutOptions.ts b/src/api/types/CustomerSpeechTimeoutOptions.ts index bf959975..1d24758b 100644 --- a/src/api/types/CustomerSpeechTimeoutOptions.ts +++ b/src/api/types/CustomerSpeechTimeoutOptions.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets. + */ export interface CustomerSpeechTimeoutOptions { /** * This is the timeout in seconds before action is triggered. @@ -14,10 +17,6 @@ export interface CustomerSpeechTimeoutOptions { * @default 3 */ triggerMaxCount?: number | undefined; - /** - * This is whether the counter for hook trigger resets the user speaks. - * - * @default never - */ + /** Controls whether the hook's trigger counter resets after the customer speaks. Defaults to `never`. */ triggerResetMode?: Record | undefined; } diff --git a/src/api/types/DeepInfraModel.ts b/src/api/types/DeepInfraModel.ts index 46b48b0f..86bf3b1b 100644 --- a/src/api/types/DeepInfraModel.ts +++ b/src/api/types/DeepInfraModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface DeepInfraModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/DeepSeekModel.ts b/src/api/types/DeepSeekModel.ts index 1852108d..8c42bad9 100644 --- a/src/api/types/DeepSeekModel.ts +++ b/src/api/types/DeepSeekModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface DeepSeekModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/DeepgramTranscriber.ts b/src/api/types/DeepgramTranscriber.ts index 48d46995..9c30d66b 100644 --- a/src/api/types/DeepgramTranscriber.ts +++ b/src/api/types/DeepgramTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, formatting, endpointing, vocabulary, and fallback settings. + */ export interface DeepgramTranscriber { /** This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview */ model?: Vapi.DeepgramTranscriberModel | undefined; diff --git a/src/api/types/DeepgramVoice.ts b/src/api/types/DeepgramVoice.ts index 77c39858..db48fd8d 100644 --- a/src/api/types/DeepgramVoice.ts +++ b/src/api/types/DeepgramVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, caching, and fallback settings. + */ export interface DeepgramVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/DeveloperMessage.ts b/src/api/types/DeveloperMessage.ts index 9b248909..9ea236a7 100644 --- a/src/api/types/DeveloperMessage.ts +++ b/src/api/types/DeveloperMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A developer-authored instruction message supplied to the language model. + */ export interface DeveloperMessage { /** This is the role of the message author */ role: Vapi.DeveloperMessageRole; diff --git a/src/api/types/DialPlanEntry.ts b/src/api/types/DialPlanEntry.ts index c1557164..4a3462c9 100644 --- a/src/api/types/DialPlanEntry.ts +++ b/src/api/types/DialPlanEntry.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Associates a phone number with the customers to dial through that number in a batch call plan. + */ export interface DialPlanEntry { /** The phone number ID to use for calling the customers in this entry. */ phoneNumberId: string; diff --git a/src/api/types/DtmfTool.ts b/src/api/types/DtmfTool.ts index 60393a7e..0704680c 100644 --- a/src/api/types/DtmfTool.ts +++ b/src/api/types/DtmfTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send DTMF keypad tones during a call. + */ export interface DtmfTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/Edge.ts b/src/api/types/Edge.ts index 3a3a65f5..3136f5a1 100644 --- a/src/api/types/Edge.ts +++ b/src/api/types/Edge.ts @@ -2,9 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A directed connection between two workflow nodes, with an optional AI-evaluated transition condition. + */ export interface Edge { + /** Condition that must evaluate to true to follow this edge. */ condition?: Vapi.AiEdgeCondition | undefined; + /** Name of the source workflow node. */ from: string; + /** Name of the destination workflow node. */ to: string; /** This is for metadata you want to store on the edge. */ metadata?: Record | undefined; diff --git a/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts b/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts index 7cb431fa..2dd545b0 100644 --- a/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts +++ b/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Identifies a specific version of an ElevenLabs pronunciation dictionary. + */ export interface ElevenLabsPronunciationDictionaryLocator { /** This is the ID of the pronunciation dictionary to use. */ pronunciationDictionaryId: string; diff --git a/src/api/types/ElevenLabsTranscriber.ts b/src/api/types/ElevenLabsTranscriber.ts index c377e99c..10d22dbe 100644 --- a/src/api/types/ElevenLabsTranscriber.ts +++ b/src/api/types/ElevenLabsTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, speech thresholds, and fallback settings. + */ export interface ElevenLabsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.ElevenLabsTranscriberModel | undefined; diff --git a/src/api/types/ElevenLabsVoice.ts b/src/api/types/ElevenLabsVoice.ts index b116e8cb..65904663 100644 --- a/src/api/types/ElevenLabsVoice.ts +++ b/src/api/types/ElevenLabsVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, caching, and fallback settings. + */ export interface ElevenLabsVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/EndCallTool.ts b/src/api/types/EndCallTool.ts index 03a61d4b..8315284e 100644 --- a/src/api/types/EndCallTool.ts +++ b/src/api/types/EndCallTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant end the active call. + */ export interface EndCallTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/Eval.ts b/src/api/types/Eval.ts index d1b7f795..45527ae6 100644 --- a/src/api/types/Eval.ts +++ b/src/api/types/Eval.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle information. + */ export interface Eval { /** * This is the mock conversation that will be used to evaluate the flow of the conversation. @@ -11,9 +14,13 @@ export interface Eval { * Evaluation Messages are used as checkpoints in the flow where the model's response to previous conversation needs to be evaluated to check the content and tool calls */ messages: Vapi.EvalMessagesItem[]; + /** The unique identifier for the eval. */ id: string; + /** The unique identifier for the organization that owns the eval. */ orgId: string; + /** The ISO 8601 timestamp when the eval was created. */ createdAt: string; + /** The ISO 8601 timestamp when the eval was last updated. */ updatedAt: string; /** * This is the name of the eval. diff --git a/src/api/types/EvalAnthropicModel.ts b/src/api/types/EvalAnthropicModel.ts index 72f8a322..3d30c6aa 100644 --- a/src/api/types/EvalAnthropicModel.ts +++ b/src/api/types/EvalAnthropicModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended thinking. + */ export interface EvalAnthropicModel { /** This is the specific model that will be used. */ model: Vapi.EvalAnthropicModelModel; diff --git a/src/api/types/EvalCustomModel.ts b/src/api/types/EvalCustomModel.ts index 53e31047..3e043058 100644 --- a/src/api/types/EvalCustomModel.ts +++ b/src/api/types/EvalCustomModel.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and generation settings. + */ export interface EvalCustomModel { /** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */ url: string; diff --git a/src/api/types/EvalGoogleModel.ts b/src/api/types/EvalGoogleModel.ts index fd0d5148..20b28f3a 100644 --- a/src/api/types/EvalGoogleModel.ts +++ b/src/api/types/EvalGoogleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Google model configuration for an LLM judge, including its messages and generation settings. + */ export interface EvalGoogleModel { /** This is the name of the model. Ex. gpt-4o */ model: Vapi.EvalGoogleModelModel; diff --git a/src/api/types/EvalOpenAiModel.ts b/src/api/types/EvalOpenAiModel.ts index 1c6121b2..d0a8f7f6 100644 --- a/src/api/types/EvalOpenAiModel.ts +++ b/src/api/types/EvalOpenAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * OpenAI model configuration for an LLM judge, including its messages and generation settings. + */ export interface EvalOpenAiModel { /** * This is the OpenAI model that will be used. diff --git a/src/api/types/EvalPaginatedResponse.ts b/src/api/types/EvalPaginatedResponse.ts index 7795aece..d30b65b9 100644 --- a/src/api/types/EvalPaginatedResponse.ts +++ b/src/api/types/EvalPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of saved eval definitions and metadata describing the result set. + */ export interface EvalPaginatedResponse { + /** The eval definitions returned for the current page. */ results: Vapi.Eval[]; + /** Pagination metadata for the eval result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/EvalRun.ts b/src/api/types/EvalRun.ts index e86cc063..3c62654a 100644 --- a/src/api/types/EvalRun.ts +++ b/src/api/types/EvalRun.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle timestamps. + */ export interface EvalRun { /** * This is the status of the eval run. When an eval run is created, the status is 'running'. @@ -21,10 +24,15 @@ export interface EvalRun { eval?: Vapi.CreateEvalDto | undefined; /** This is the target that will be run against the eval */ target: Vapi.EvalRunTarget; + /** The unique identifier for the eval run. */ id: string; + /** The unique identifier for the organization that owns the run. */ orgId: string; + /** The ISO 8601 timestamp when the eval run was created. */ createdAt: string; + /** The ISO 8601 timestamp when the eval run started. */ startedAt: string; + /** The ISO 8601 timestamp when the eval run ended. */ endedAt: string; /** This is the ended message when the eval run ended for any reason apart from mockConversation.done */ endedMessage?: string | undefined; diff --git a/src/api/types/EvalRunPaginatedResponse.ts b/src/api/types/EvalRunPaginatedResponse.ts index 0bf7ef2e..c11bde35 100644 --- a/src/api/types/EvalRunPaginatedResponse.ts +++ b/src/api/types/EvalRunPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of eval runs and metadata describing the result set. + */ export interface EvalRunPaginatedResponse { + /** The eval runs returned for the current page. */ results: Vapi.EvalRun[]; + /** Pagination metadata for the eval-run result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/EvalRunResult.ts b/src/api/types/EvalRunResult.ts index 28f16977..778d0286 100644 --- a/src/api/types/EvalRunResult.ts +++ b/src/api/types/EvalRunResult.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The pass or fail result of an evaluation run, including its conversation messages and timing. + */ export interface EvalRunResult { /** * This is the status of the eval run result. diff --git a/src/api/types/EvalRunTargetAssistant.ts b/src/api/types/EvalRunTargetAssistant.ts index 3877dc76..049eb50a 100644 --- a/src/api/types/EvalRunTargetAssistant.ts +++ b/src/api/types/EvalRunTargetAssistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant overrides. + */ export interface EvalRunTargetAssistant { /** This is the transient assistant that will be run against the eval */ assistant?: Vapi.CreateAssistantDto | undefined; diff --git a/src/api/types/EvalRunTargetSquad.ts b/src/api/types/EvalRunTargetSquad.ts index 098d3748..ebcb852f 100644 --- a/src/api/types/EvalRunTargetSquad.ts +++ b/src/api/types/EvalRunTargetSquad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides. + */ export interface EvalRunTargetSquad { /** This is the transient squad that will be run against the eval */ squad?: Vapi.CreateSquadDto | undefined; diff --git a/src/api/types/EventsTableBooleanCondition.ts b/src/api/types/EventsTableBooleanCondition.ts index c6b9bce2..71e35286 100644 --- a/src/api/types/EventsTableBooleanCondition.ts +++ b/src/api/types/EventsTableBooleanCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing a boolean field with an expected value. + */ export interface EventsTableBooleanCondition { /** The boolean field name from the event data */ column: string; diff --git a/src/api/types/EventsTableNumberCondition.ts b/src/api/types/EventsTableNumberCondition.ts index 7b93fef3..5f54d738 100644 --- a/src/api/types/EventsTableNumberCondition.ts +++ b/src/api/types/EventsTableNumberCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing a numeric field with a value. + */ export interface EventsTableNumberCondition { /** The number field name from the event data */ column: string; diff --git a/src/api/types/EventsTableStringCondition.ts b/src/api/types/EventsTableStringCondition.ts index 870330cd..d65fd720 100644 --- a/src/api/types/EventsTableStringCondition.ts +++ b/src/api/types/EventsTableStringCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing or searching a string field. + */ export interface EventsTableStringCondition { /** The string field name from the event data */ column: string; diff --git a/src/api/types/ExactReplacement.ts b/src/api/types/ExactReplacement.ts index d1ad5e87..aec57620 100644 --- a/src/api/types/ExactReplacement.ts +++ b/src/api/types/ExactReplacement.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Replaces an exact word or phrase before text is sent to a voice provider. + */ export interface ExactReplacement { /** * This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance. diff --git a/src/api/types/FallbackAssemblyAiTranscriber.ts b/src/api/types/FallbackAssemblyAiTranscriber.ts index 54825824..ff0e57a0 100644 --- a/src/api/types/FallbackAssemblyAiTranscriber.ts +++ b/src/api/types/FallbackAssemblyAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, and vocabulary. + */ export interface FallbackAssemblyAiTranscriber { /** This is the language that will be set for the transcription. */ language?: Vapi.FallbackAssemblyAiTranscriberLanguage | undefined; diff --git a/src/api/types/FallbackAzureSpeechTranscriber.ts b/src/api/types/FallbackAzureSpeechTranscriber.ts index 16103bb9..96571dd7 100644 --- a/src/api/types/FallbackAzureSpeechTranscriber.ts +++ b/src/api/types/FallbackAzureSpeechTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Azure Speech, including language and segmentation. + */ export interface FallbackAzureSpeechTranscriber { /** This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt */ language?: Vapi.FallbackAzureSpeechTranscriberLanguage | undefined; diff --git a/src/api/types/FallbackAzureVoice.ts b/src/api/types/FallbackAzureVoice.ts index 796ae403..1e63ef27 100644 --- a/src/api/types/FallbackAzureVoice.ts +++ b/src/api/types/FallbackAzureVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, and caching. + */ export interface FallbackAzureVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackCartesiaTranscriber.ts b/src/api/types/FallbackCartesiaTranscriber.ts index 2ed07955..c86ed000 100644 --- a/src/api/types/FallbackCartesiaTranscriber.ts +++ b/src/api/types/FallbackCartesiaTranscriber.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Cartesia, including model and language. + */ export interface FallbackCartesiaTranscriber { + /** The Cartesia speech-to-text model used for transcription. */ model?: Vapi.FallbackCartesiaTranscriberModel | undefined; + /** The language code used for transcription. */ language?: Vapi.FallbackCartesiaTranscriberLanguage | undefined; } diff --git a/src/api/types/FallbackCartesiaTranscriberLanguage.ts b/src/api/types/FallbackCartesiaTranscriberLanguage.ts index 058e3259..cb2c1cb2 100644 --- a/src/api/types/FallbackCartesiaTranscriberLanguage.ts +++ b/src/api/types/FallbackCartesiaTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The language code used for transcription. */ export const FallbackCartesiaTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/FallbackCartesiaTranscriberModel.ts b/src/api/types/FallbackCartesiaTranscriberModel.ts index f6b08d86..3396d8b9 100644 --- a/src/api/types/FallbackCartesiaTranscriberModel.ts +++ b/src/api/types/FallbackCartesiaTranscriberModel.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The Cartesia speech-to-text model used for transcription. */ export const FallbackCartesiaTranscriberModel = { InkWhisper: "ink-whisper", } as const; diff --git a/src/api/types/FallbackCartesiaVoice.ts b/src/api/types/FallbackCartesiaVoice.ts index f54b9783..fb102192 100644 --- a/src/api/types/FallbackCartesiaVoice.ts +++ b/src/api/types/FallbackCartesiaVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, and caching. + */ export interface FallbackCartesiaVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackCustomTranscriber.ts b/src/api/types/FallbackCustomTranscriber.ts index 3273ca22..5a7b7e81 100644 --- a/src/api/types/FallbackCustomTranscriber.ts +++ b/src/api/types/FallbackCustomTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for sending conversation audio to a custom WebSocket transcription server. + */ export interface FallbackCustomTranscriber { /** * This is where the transcription request will be sent. diff --git a/src/api/types/FallbackCustomVoice.ts b/src/api/types/FallbackCustomVoice.ts index 3caa3e8f..27dc9512 100644 --- a/src/api/types/FallbackCustomVoice.ts +++ b/src/api/types/FallbackCustomVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, and caching. + */ export interface FallbackCustomVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackDeepgramTranscriber.ts b/src/api/types/FallbackDeepgramTranscriber.ts index 61b2d9c2..1a64eb33 100644 --- a/src/api/types/FallbackDeepgramTranscriber.ts +++ b/src/api/types/FallbackDeepgramTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, and vocabulary. + */ export interface FallbackDeepgramTranscriber { /** This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview */ model?: Vapi.DeepgramTranscriberModel | undefined; diff --git a/src/api/types/FallbackDeepgramVoice.ts b/src/api/types/FallbackDeepgramVoice.ts index a20d91f9..63c9b903 100644 --- a/src/api/types/FallbackDeepgramVoice.ts +++ b/src/api/types/FallbackDeepgramVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, and caching. + */ export interface FallbackDeepgramVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackElevenLabsTranscriber.ts b/src/api/types/FallbackElevenLabsTranscriber.ts index a3244172..e2a33efd 100644 --- a/src/api/types/FallbackElevenLabsTranscriber.ts +++ b/src/api/types/FallbackElevenLabsTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds. + */ export interface FallbackElevenLabsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackElevenLabsTranscriberModel | undefined; diff --git a/src/api/types/FallbackElevenLabsVoice.ts b/src/api/types/FallbackElevenLabsVoice.ts index ea106d21..b6a93bbd 100644 --- a/src/api/types/FallbackElevenLabsVoice.ts +++ b/src/api/types/FallbackElevenLabsVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, and caching. + */ export interface FallbackElevenLabsVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackGladiaTranscriber.ts b/src/api/types/FallbackGladiaTranscriber.ts index 036cc335..106f879c 100644 --- a/src/api/types/FallbackGladiaTranscriber.ts +++ b/src/api/types/FallbackGladiaTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, endpointing, vocabulary, and region. + */ export interface FallbackGladiaTranscriber { /** This is the Gladia model that will be used. Default is 'fast' */ model?: Vapi.FallbackGladiaTranscriberModel | undefined; diff --git a/src/api/types/FallbackGoogleTranscriber.ts b/src/api/types/FallbackGoogleTranscriber.ts index 89a2cb67..30b3102d 100644 --- a/src/api/types/FallbackGoogleTranscriber.ts +++ b/src/api/types/FallbackGoogleTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Google, including model and language. + */ export interface FallbackGoogleTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackGoogleTranscriberModel | undefined; diff --git a/src/api/types/FallbackHumeVoice.ts b/src/api/types/FallbackHumeVoice.ts index 155db82c..bc20d6cb 100644 --- a/src/api/types/FallbackHumeVoice.ts +++ b/src/api/types/FallbackHumeVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, and caching. + */ export interface FallbackHumeVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackInworldVoice.ts b/src/api/types/FallbackInworldVoice.ts index 7ff3fefc..98f86a30 100644 --- a/src/api/types/FallbackInworldVoice.ts +++ b/src/api/types/FallbackInworldVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, and caching. + */ export interface FallbackInworldVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackLmntVoice.ts b/src/api/types/FallbackLmntVoice.ts index 08bb6e26..f98123d4 100644 --- a/src/api/types/FallbackLmntVoice.ts +++ b/src/api/types/FallbackLmntVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, and caching. + */ export interface FallbackLmntVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackNeuphonicVoice.ts b/src/api/types/FallbackNeuphonicVoice.ts index ef6ad94f..20017da8 100644 --- a/src/api/types/FallbackNeuphonicVoice.ts +++ b/src/api/types/FallbackNeuphonicVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, and caching. + */ export interface FallbackNeuphonicVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackOpenAiTranscriber.ts b/src/api/types/FallbackOpenAiTranscriber.ts index 2c791109..26030986 100644 --- a/src/api/types/FallbackOpenAiTranscriber.ts +++ b/src/api/types/FallbackOpenAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with OpenAI, including model and language. + */ export interface FallbackOpenAiTranscriber { /** This is the model that will be used for the transcription. */ model: Vapi.FallbackOpenAiTranscriberModel; diff --git a/src/api/types/FallbackOpenAiVoice.ts b/src/api/types/FallbackOpenAiVoice.ts index 3a582107..c826f01d 100644 --- a/src/api/types/FallbackOpenAiVoice.ts +++ b/src/api/types/FallbackOpenAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, and caching. + */ export interface FallbackOpenAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackPlan.ts b/src/api/types/FallbackPlan.ts index 0797b4a0..cc266826 100644 --- a/src/api/types/FallbackPlan.ts +++ b/src/api/types/FallbackPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Lists backup voice configurations that can be used if the primary voice provider fails. + */ export interface FallbackPlan { /** This is the list of voices to fallback to in the event that the primary voice provider fails. */ voices: Vapi.FallbackPlanVoicesItem[]; diff --git a/src/api/types/FallbackPlayHtVoice.ts b/src/api/types/FallbackPlayHtVoice.ts index 83053ac3..24942ea7 100644 --- a/src/api/types/FallbackPlayHtVoice.ts +++ b/src/api/types/FallbackPlayHtVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, and caching. + */ export interface FallbackPlayHtVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackRimeAiVoice.ts b/src/api/types/FallbackRimeAiVoice.ts index 6ac1567c..8451b1f4 100644 --- a/src/api/types/FallbackRimeAiVoice.ts +++ b/src/api/types/FallbackRimeAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, and caching. + */ export interface FallbackRimeAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSesameVoice.ts b/src/api/types/FallbackSesameVoice.ts index 7e816a76..062878f1 100644 --- a/src/api/types/FallbackSesameVoice.ts +++ b/src/api/types/FallbackSesameVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, and caching. + */ export interface FallbackSesameVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSmallestAiVoice.ts b/src/api/types/FallbackSmallestAiVoice.ts index e7c4563c..dc6475f8 100644 --- a/src/api/types/FallbackSmallestAiVoice.ts +++ b/src/api/types/FallbackSmallestAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, and caching. + */ export interface FallbackSmallestAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSonioxTranscriber.ts b/src/api/types/FallbackSonioxTranscriber.ts index 6faab381..04480a04 100644 --- a/src/api/types/FallbackSonioxTranscriber.ts +++ b/src/api/types/FallbackSonioxTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and vocabulary. + */ export interface FallbackSonioxTranscriber { /** The Soniox model to use for transcription. */ model?: Vapi.FallbackSonioxTranscriberModel | undefined; diff --git a/src/api/types/FallbackSpeechmaticsTranscriber.ts b/src/api/types/FallbackSpeechmaticsTranscriber.ts index 31a7c0f3..f161e45f 100644 --- a/src/api/types/FallbackSpeechmaticsTranscriber.ts +++ b/src/api/types/FallbackSpeechmaticsTranscriber.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, vocabulary, endpointing, and formatting. + */ export interface FallbackSpeechmaticsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackSpeechmaticsTranscriberModel | undefined; + /** Language used for transcription. Set to `auto` to detect the language automatically. */ language?: Vapi.FallbackSpeechmaticsTranscriberLanguage | undefined; /** * This is the operating point for the transcription. Choose between `standard` for faster turnaround with strong accuracy or `enhanced` for highest accuracy when precision is critical. @@ -30,6 +34,7 @@ export interface FallbackSpeechmaticsTranscriber { * @default 3000 */ maxDelay?: number | undefined; + /** Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ customVocabulary: Vapi.SpeechmaticsCustomVocabularyItem[]; /** * This controls how numbers, dates, currencies, and other entities are formatted in the transcription output. diff --git a/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts b/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts index 4f8d9326..f84d3d71 100644 --- a/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts +++ b/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language used for transcription. Set to `auto` to detect the language automatically. */ export const FallbackSpeechmaticsTranscriberLanguage = { Auto: "auto", Ar: "ar", diff --git a/src/api/types/FallbackTalkscriberTranscriber.ts b/src/api/types/FallbackTalkscriberTranscriber.ts index e4a1e287..04c19812 100644 --- a/src/api/types/FallbackTalkscriberTranscriber.ts +++ b/src/api/types/FallbackTalkscriberTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Talkscriber, including model and language. + */ export interface FallbackTalkscriberTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackTalkscriberTranscriberModel | undefined; diff --git a/src/api/types/FallbackTavusVoice.ts b/src/api/types/FallbackTavusVoice.ts index 7791ae86..ef67f9d5 100644 --- a/src/api/types/FallbackTavusVoice.ts +++ b/src/api/types/FallbackTavusVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, and caching. + */ export interface FallbackTavusVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackTranscriberPlan.ts b/src/api/types/FallbackTranscriberPlan.ts index 3eeeff5a..47c5fa5a 100644 --- a/src/api/types/FallbackTranscriberPlan.ts +++ b/src/api/types/FallbackTranscriberPlan.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Lists backup transcriber configurations that can be used if the primary transcriber fails. + */ export interface FallbackTranscriberPlan { + /** Transcriber configurations available when the primary transcriber fails. */ transcribers: Vapi.FallbackTranscriberPlanTranscribersItem[]; } diff --git a/src/api/types/FallbackVapiVoice.ts b/src/api/types/FallbackVapiVoice.ts index 59392438..757c6c24 100644 --- a/src/api/types/FallbackVapiVoice.ts +++ b/src/api/types/FallbackVapiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, and caching. + */ export interface FallbackVapiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackWellSaidVoice.ts b/src/api/types/FallbackWellSaidVoice.ts index 141ef0e9..d8a2d5b2 100644 --- a/src/api/types/FallbackWellSaidVoice.ts +++ b/src/api/types/FallbackWellSaidVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, and caching. + */ export interface FallbackWellSaidVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FileObject.ts b/src/api/types/FileObject.ts index b4aa566a..cb37ac84 100644 --- a/src/api/types/FileObject.ts +++ b/src/api/types/FileObject.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The object type. This is always `file`. */ export const FileObject = { File: "file", } as const; diff --git a/src/api/types/FileStatus.ts b/src/api/types/FileStatus.ts index a6a168cf..c8a5285e 100644 --- a/src/api/types/FileStatus.ts +++ b/src/api/types/FileStatus.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The current processing status of the uploaded file. */ export const FileStatus = { Processing: "processing", Done: "done", diff --git a/src/api/types/File_.ts b/src/api/types/File_.ts index 1e5228d7..e2d2d74c 100644 --- a/src/api/types/File_.ts +++ b/src/api/types/File_.ts @@ -2,21 +2,37 @@ import type * as Vapi from "../index.js"; +/** + * An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and lifecycle timestamps. + */ export interface File_ { + /** The object type. This is always `file`. */ object?: Vapi.FileObject | undefined; + /** The current processing status of the uploaded file. */ status?: Vapi.FileStatus | undefined; /** This is the name of the file. This is just for your own reference. */ name?: string | undefined; + /** The original name of the uploaded file. */ originalName?: string | undefined; + /** The size of the uploaded file in bytes. */ bytes?: number | undefined; + /** The intended use assigned to the uploaded file. */ purpose?: string | undefined; + /** The MIME type of the uploaded file. */ mimetype?: string | undefined; + /** The object-storage key for the uploaded file. */ key?: string | undefined; + /** The object-storage path for the uploaded file. */ path?: string | undefined; + /** The object-storage bucket containing the uploaded file. */ bucket?: string | undefined; + /** The URL used to access the uploaded file. */ url?: string | undefined; + /** The URL used to access text extracted from the file. */ parsedTextUrl?: string | undefined; + /** The size of the extracted text in bytes. */ parsedTextBytes?: number | undefined; + /** Additional metadata associated with the uploaded file. */ metadata?: Record | undefined; /** This is the unique identifier for the file. */ id: string; diff --git a/src/api/types/FilterDateTypeColumnOnCallTable.ts b/src/api/types/FilterDateTypeColumnOnCallTable.ts index c3b58c8b..4e134861 100644 --- a/src/api/types/FilterDateTypeColumnOnCallTable.ts +++ b/src/api/types/FilterDateTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing a start or end timestamp with a date. + */ export interface FilterDateTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts b/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts index a6ee7e63..3390d3fc 100644 --- a/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts +++ b/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters numeric call fields using a list of values or an emptiness test. + */ export interface FilterNumberArrayTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterNumberTypeColumnOnCallTable.ts b/src/api/types/FilterNumberTypeColumnOnCallTable.ts index d9337120..3f9aa4e1 100644 --- a/src/api/types/FilterNumberTypeColumnOnCallTable.ts +++ b/src/api/types/FilterNumberTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing a numeric field with a value. + */ export interface FilterNumberTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts b/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts index 235000b8..e803a97e 100644 --- a/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts +++ b/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters string-valued call fields using a list of values or an emptiness test. + */ export interface FilterStringArrayTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStringTypeColumnOnCallTable.ts b/src/api/types/FilterStringTypeColumnOnCallTable.ts index 5e7d0dc9..534a862f 100644 --- a/src/api/types/FilterStringTypeColumnOnCallTable.ts +++ b/src/api/types/FilterStringTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing or searching a string-valued field. + */ export interface FilterStringTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStructuredOutputColumnOnCallTable.ts b/src/api/types/FilterStructuredOutputColumnOnCallTable.ts index e6b8a1bc..6fab5dfc 100644 --- a/src/api/types/FilterStructuredOutputColumnOnCallTable.ts +++ b/src/api/types/FilterStructuredOutputColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness operators. + */ export interface FilterStructuredOutputColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FormatPlan.ts b/src/api/types/FormatPlan.ts index b929ddf5..87b18a56 100644 --- a/src/api/types/FormatPlan.ts +++ b/src/api/types/FormatPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom replacements. + */ export interface FormatPlan { /** * This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. diff --git a/src/api/types/FourierDenoisingPlan.ts b/src/api/types/FourierDenoisingPlan.ts index e25f739a..d5609771 100644 --- a/src/api/types/FourierDenoisingPlan.ts +++ b/src/api/types/FourierDenoisingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis window. + */ export interface FourierDenoisingPlan { /** Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected. */ enabled?: boolean | undefined; diff --git a/src/api/types/FunctionTool.ts b/src/api/types/FunctionTool.ts index 40fce552..801d64ec 100644 --- a/src/api/types/FunctionTool.ts +++ b/src/api/types/FunctionTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant. + */ export interface FunctionTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GcpKey.ts b/src/api/types/GcpKey.ts index bc65d9bf..af2469e4 100644 --- a/src/api/types/GcpKey.ts +++ b/src/api/types/GcpKey.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Google Cloud service-account key used to authenticate access to Google Cloud resources. + */ export interface GcpKey { /** This is the type of the key. Most likely, this is "service_account". */ type: string; diff --git a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts index c8072496..3746a0f9 100644 --- a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts +++ b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Selects a prebuilt voice for Gemini Multimodal Live audio output. + */ export interface GeminiMultimodalLivePrebuiltVoiceConfig { + /** Prebuilt Gemini voice used for audio output. */ voiceName: Vapi.GeminiMultimodalLivePrebuiltVoiceConfigVoiceName; } diff --git a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts index 69367fdf..68b6984a 100644 --- a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts +++ b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Prebuilt Gemini voice used for audio output. */ export const GeminiMultimodalLivePrebuiltVoiceConfigVoiceName = { Puck: "Puck", Charon: "Charon", diff --git a/src/api/types/GeminiMultimodalLiveSpeechConfig.ts b/src/api/types/GeminiMultimodalLiveSpeechConfig.ts index 4a04e9df..4d946c4a 100644 --- a/src/api/types/GeminiMultimodalLiveSpeechConfig.ts +++ b/src/api/types/GeminiMultimodalLiveSpeechConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Speech-output configuration for Gemini Multimodal Live. + */ export interface GeminiMultimodalLiveSpeechConfig { + /** Voice configuration used for Gemini Multimodal Live speech output. */ voiceConfig: Vapi.GeminiMultimodalLiveVoiceConfig; } diff --git a/src/api/types/GeminiMultimodalLiveVoiceConfig.ts b/src/api/types/GeminiMultimodalLiveVoiceConfig.ts index 66873c91..07631452 100644 --- a/src/api/types/GeminiMultimodalLiveVoiceConfig.ts +++ b/src/api/types/GeminiMultimodalLiveVoiceConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Voice selection configuration for Gemini Multimodal Live. + */ export interface GeminiMultimodalLiveVoiceConfig { + /** Prebuilt voice used for Gemini Multimodal Live speech output. */ prebuiltVoiceConfig: Vapi.GeminiMultimodalLivePrebuiltVoiceConfig; } diff --git a/src/api/types/GhlToolMetadata.ts b/src/api/types/GhlToolMetadata.ts index 402db52d..7dd4abaa 100644 --- a/src/api/types/GhlToolMetadata.ts +++ b/src/api/types/GhlToolMetadata.ts @@ -1,6 +1,11 @@ // This file was auto-generated by Fern from our API Definition. +/** + * GHL workflow and location identifiers attached to a tool. + */ export interface GhlToolMetadata { + /** GHL workflow identifier associated with the tool. */ workflowId?: string | undefined; + /** GHL location identifier associated with the tool. */ locationId?: string | undefined; } diff --git a/src/api/types/GladiaCustomVocabularyConfigDto.ts b/src/api/types/GladiaCustomVocabularyConfigDto.ts index 043937e6..2d134a3d 100644 --- a/src/api/types/GladiaCustomVocabularyConfigDto.ts +++ b/src/api/types/GladiaCustomVocabularyConfigDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition intensity. + */ export interface GladiaCustomVocabularyConfigDto { /** Array of vocabulary items (strings or objects with value, pronunciations, intensity, language) */ vocabulary: Vapi.GladiaCustomVocabularyConfigDtoVocabularyItem[]; diff --git a/src/api/types/GladiaTranscriber.ts b/src/api/types/GladiaTranscriber.ts index 364713e9..cd348662 100644 --- a/src/api/types/GladiaTranscriber.ts +++ b/src/api/types/GladiaTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, audio processing, endpointing, vocabulary, region, and fallback settings. + */ export interface GladiaTranscriber { /** This is the Gladia model that will be used. Default is 'fast' */ model?: Vapi.GladiaTranscriberModel | undefined; diff --git a/src/api/types/GladiaVocabularyItemDto.ts b/src/api/types/GladiaVocabularyItemDto.ts index 1b8e07bc..b64422af 100644 --- a/src/api/types/GladiaVocabularyItemDto.ts +++ b/src/api/types/GladiaVocabularyItemDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language. + */ export interface GladiaVocabularyItemDto { /** The vocabulary word or phrase */ value: string; diff --git a/src/api/types/GlobalNodePlan.ts b/src/api/types/GlobalNodePlan.ts index d03f57b6..bdd73f0b 100644 --- a/src/api/types/GlobalNodePlan.ts +++ b/src/api/types/GlobalNodePlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether a conversation node can be entered globally and the condition evaluated before that node runs. + */ export interface GlobalNodePlan { /** * This is the flag to determine if this node is a global node diff --git a/src/api/types/GoHighLevelCalendarAvailabilityTool.ts b/src/api/types/GoHighLevelCalendarAvailabilityTool.ts index 0c361ae0..0fa3571c 100644 --- a/src/api/types/GoHighLevelCalendarAvailabilityTool.ts +++ b/src/api/types/GoHighLevelCalendarAvailabilityTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that checks calendar availability in a connected GoHighLevel account. + */ export interface GoHighLevelCalendarAvailabilityTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoHighLevelCalendarEventCreateTool.ts b/src/api/types/GoHighLevelCalendarEventCreateTool.ts index 3c927271..75f27516 100644 --- a/src/api/types/GoHighLevelCalendarEventCreateTool.ts +++ b/src/api/types/GoHighLevelCalendarEventCreateTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds calendar events to a connected GoHighLevel account. + */ export interface GoHighLevelCalendarEventCreateTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoHighLevelContactCreateTool.ts b/src/api/types/GoHighLevelContactCreateTool.ts index 378ec1ef..e984a25b 100644 --- a/src/api/types/GoHighLevelContactCreateTool.ts +++ b/src/api/types/GoHighLevelContactCreateTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds contacts to a connected GoHighLevel account. + */ export interface GoHighLevelContactCreateTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoHighLevelContactGetTool.ts b/src/api/types/GoHighLevelContactGetTool.ts index a00261b7..8fe9fdf8 100644 --- a/src/api/types/GoHighLevelContactGetTool.ts +++ b/src/api/types/GoHighLevelContactGetTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that retrieves contacts from a connected GoHighLevel account. + */ export interface GoHighLevelContactGetTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoogleCalendarCheckAvailabilityTool.ts b/src/api/types/GoogleCalendarCheckAvailabilityTool.ts index 5f2ea106..23b29c1c 100644 --- a/src/api/types/GoogleCalendarCheckAvailabilityTool.ts +++ b/src/api/types/GoogleCalendarCheckAvailabilityTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that checks availability in a connected Google Calendar. + */ export interface GoogleCalendarCheckAvailabilityTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoogleCalendarCreateEventTool.ts b/src/api/types/GoogleCalendarCreateEventTool.ts index d13b6394..cb48f717 100644 --- a/src/api/types/GoogleCalendarCreateEventTool.ts +++ b/src/api/types/GoogleCalendarCreateEventTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds events to a connected Google Calendar. + */ export interface GoogleCalendarCreateEventTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoogleModel.ts b/src/api/types/GoogleModel.ts index 65f789eb..0e1e74a5 100644 --- a/src/api/types/GoogleModel.ts +++ b/src/api/types/GoogleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base access, realtime settings, and generation settings. + */ export interface GoogleModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/GoogleRealtimeConfig.ts b/src/api/types/GoogleRealtimeConfig.ts index ded46199..ae24d85b 100644 --- a/src/api/types/GoogleRealtimeConfig.ts +++ b/src/api/types/GoogleRealtimeConfig.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice configuration. + */ export interface GoogleRealtimeConfig { /** * This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation. diff --git a/src/api/types/GoogleSheetsRowAppendTool.ts b/src/api/types/GoogleSheetsRowAppendTool.ts index b1ee489f..776cc2e1 100644 --- a/src/api/types/GoogleSheetsRowAppendTool.ts +++ b/src/api/types/GoogleSheetsRowAppendTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that appends rows to a connected Google Sheet. + */ export interface GoogleSheetsRowAppendTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/GoogleTranscriber.ts b/src/api/types/GoogleTranscriber.ts index e11438d9..b38799c4 100644 --- a/src/api/types/GoogleTranscriber.ts +++ b/src/api/types/GoogleTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Google, including model, language, and fallback settings. + */ export interface GoogleTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.GoogleTranscriberModel | undefined; diff --git a/src/api/types/GoogleVoicemailDetectionPlan.ts b/src/api/types/GoogleVoicemailDetectionPlan.ts index cb958d65..52049314 100644 --- a/src/api/types/GoogleVoicemailDetectionPlan.ts +++ b/src/api/types/GoogleVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff. + */ export interface GoogleVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/GroqModel.ts b/src/api/types/GroqModel.ts index 6111679c..4fee058b 100644 --- a/src/api/types/GroqModel.ts +++ b/src/api/types/GroqModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface GroqModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/GroupCondition.ts b/src/api/types/GroupCondition.ts index 74807bc4..7e337a76 100644 --- a/src/api/types/GroupCondition.ts +++ b/src/api/types/GroupCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator. + */ export interface GroupCondition { /** This is the logical operator for combining conditions in this group */ operator: Vapi.GroupConditionOperator; diff --git a/src/api/types/HandoffDestinationAssistant.ts b/src/api/types/HandoffDestinationAssistant.ts index 8c702267..5d86eb0e 100644 --- a/src/api/types/HandoffDestinationAssistant.ts +++ b/src/api/types/HandoffDestinationAssistant.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and assistant overrides. + */ export interface HandoffDestinationAssistant { + /** Selects an assistant as the handoff destination. */ type: Vapi.HandoffDestinationAssistantType; /** This is the plan for manipulating the message context before handing off the call to the next assistant. */ contextEngineeringPlan?: Vapi.HandoffDestinationAssistantContextEngineeringPlan | undefined; diff --git a/src/api/types/HandoffDestinationAssistantType.ts b/src/api/types/HandoffDestinationAssistantType.ts index 0ed6fd24..74de23ae 100644 --- a/src/api/types/HandoffDestinationAssistantType.ts +++ b/src/api/types/HandoffDestinationAssistantType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects an assistant as the handoff destination. */ export const HandoffDestinationAssistantType = { Assistant: "assistant", } as const; diff --git a/src/api/types/HandoffDestinationDynamic.ts b/src/api/types/HandoffDestinationDynamic.ts index 07bdfe8c..2c14fc69 100644 --- a/src/api/types/HandoffDestinationDynamic.ts +++ b/src/api/types/HandoffDestinationDynamic.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Uses a webhook response to select the handoff destination at runtime. + */ export interface HandoffDestinationDynamic { /** * This is where Vapi will send the handoff-destination-request webhook in a dynamic handoff. diff --git a/src/api/types/HandoffDestinationSquad.ts b/src/api/types/HandoffDestinationSquad.ts index cf6d630b..f9d71ebd 100644 --- a/src/api/types/HandoffDestinationSquad.ts +++ b/src/api/types/HandoffDestinationSquad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable extraction, and overrides. + */ export interface HandoffDestinationSquad { /** This is the plan for manipulating the message context before handing off the call to the squad. */ contextEngineeringPlan?: Vapi.HandoffDestinationSquadContextEngineeringPlan | undefined; diff --git a/src/api/types/HandoffTool.ts b/src/api/types/HandoffTool.ts index 4673c363..324e2bc7 100644 --- a/src/api/types/HandoffTool.ts +++ b/src/api/types/HandoffTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ export interface HandoffTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/HmacAuthenticationPlan.ts b/src/api/types/HmacAuthenticationPlan.ts index 0657f66a..d38cdd8e 100644 --- a/src/api/types/HmacAuthenticationPlan.ts +++ b/src/api/types/HmacAuthenticationPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and signature encoding. + */ export interface HmacAuthenticationPlan { /** This is the HMAC secret key used to sign requests. */ secretKey: string; diff --git a/src/api/types/HumeVoice.ts b/src/api/types/HumeVoice.ts index f9b6c7f4..78613e07 100644 --- a/src/api/types/HumeVoice.ts +++ b/src/api/types/HumeVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, caching, and fallback settings. + */ export interface HumeVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/ImportTwilioPhoneNumberDto.ts b/src/api/types/ImportTwilioPhoneNumberDto.ts index bc3b52b1..2ab92953 100644 --- a/src/api/types/ImportTwilioPhoneNumberDto.ts +++ b/src/api/types/ImportTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, fallback destination, hooks, SMS, and server settings. + */ export interface ImportTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/InflectionAiModel.ts b/src/api/types/InflectionAiModel.ts index 350d4485..cb8f649c 100644 --- a/src/api/types/InflectionAiModel.ts +++ b/src/api/types/InflectionAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface InflectionAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/Insight.ts b/src/api/types/Insight.ts index 6d0d9e48..a1ed7115 100644 --- a/src/api/types/Insight.ts +++ b/src/api/types/Insight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle timestamps. + */ export interface Insight { /** This is the name of the Insight. */ name?: string | undefined; diff --git a/src/api/types/InsightFormula.ts b/src/api/types/InsightFormula.ts index 12b9550e..521981c9 100644 --- a/src/api/types/InsightFormula.ts +++ b/src/api/types/InsightFormula.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A formula used to calculate an insight from its query results, with an optional display name. + */ export interface InsightFormula { /** * This is the name of the formula. diff --git a/src/api/types/InsightPaginatedResponse.ts b/src/api/types/InsightPaginatedResponse.ts index 66bb4c8a..4870e860 100644 --- a/src/api/types/InsightPaginatedResponse.ts +++ b/src/api/types/InsightPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of saved reporting insights and metadata describing the result set. + */ export interface InsightPaginatedResponse { + /** The reporting insights returned for the current page. */ results: Vapi.Insight[]; + /** Pagination metadata for the insight result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/InsightRunFormatPlan.ts b/src/api/types/InsightRunFormatPlan.ts index 89a4dd5b..88b5eb44 100644 --- a/src/api/types/InsightRunFormatPlan.ts +++ b/src/api/types/InsightRunFormatPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects whether an insight run returns raw data or Recharts-formatted data. + */ export interface InsightRunFormatPlan { /** * This is the format of the data to return. diff --git a/src/api/types/InsightRunResponse.ts b/src/api/types/InsightRunResponse.ts index f87c3ab9..0fd9c465 100644 --- a/src/api/types/InsightRunResponse.ts +++ b/src/api/types/InsightRunResponse.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Metadata identifying a saved insight run and its lifecycle timestamps. + */ export interface InsightRunResponse { + /** The unique identifier for the insight run. */ id: string; + /** The unique identifier for the insight that was run. */ insightId: string; + /** The unique identifier for the organization that owns the run. */ orgId: string; + /** The ISO 8601 timestamp when the insight run was created. */ createdAt: string; + /** The ISO 8601 timestamp when the insight run was last updated. */ updatedAt: string; } diff --git a/src/api/types/InsightTimeRange.ts b/src/api/types/InsightTimeRange.ts index 152c08ae..ae7bf1f7 100644 --- a/src/api/types/InsightTimeRange.ts +++ b/src/api/types/InsightTimeRange.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Start, end, and timezone used to limit an insight query by time. + */ export interface InsightTimeRange { /** * This is the start date for the time range. diff --git a/src/api/types/InsightTimeRangeWithStep.ts b/src/api/types/InsightTimeRangeWithStep.ts index 582e74c8..1aabda09 100644 --- a/src/api/types/InsightTimeRangeWithStep.ts +++ b/src/api/types/InsightTimeRangeWithStep.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Start, end, timezone, and aggregation step used for a time-series insight query. + */ export interface InsightTimeRangeWithStep { /** * This is the group by step for aggregation. diff --git a/src/api/types/InworldVoice.ts b/src/api/types/InworldVoice.ts index a220ce56..c5341ac8 100644 --- a/src/api/types/InworldVoice.ts +++ b/src/api/types/InworldVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, caching, and fallback settings. + */ export interface InworldVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts b/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts index cb0bb7a1..0ae0feed 100644 --- a/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that aggregates a numeric call-table column with optional call filters. + */ export interface JsonQueryOnCallTableWithNumberTypeColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithNumberTypeColumnType; diff --git a/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts b/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts index ccd45824..dbcd7461 100644 --- a/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that counts values from a string-valued call-table column with optional call filters. + */ export interface JsonQueryOnCallTableWithStringTypeColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithStringTypeColumnType; diff --git a/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts b/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts index d24a8092..6e1432e1 100644 --- a/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that aggregates or counts a structured-output value stored on call records. + */ export interface JsonQueryOnCallTableWithStructuredOutputColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithStructuredOutputColumnType; diff --git a/src/api/types/JsonQueryOnEventsTable.ts b/src/api/types/JsonQueryOnEventsTable.ts index 4394532e..a060dfc6 100644 --- a/src/api/types/JsonQueryOnEventsTable.ts +++ b/src/api/types/JsonQueryOnEventsTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data filters. + */ export interface JsonQueryOnEventsTable { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnEventsTableType; diff --git a/src/api/types/JsonSchema.ts b/src/api/types/JsonSchema.ts index a25fa920..5cf1516c 100644 --- a/src/api/types/JsonSchema.ts +++ b/src/api/types/JsonSchema.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * JSON Schema definition used to describe structured data for extraction, validation, or model output. + */ export interface JsonSchema { /** * This is the type of output you'd like. diff --git a/src/api/types/KeypadInputPlan.ts b/src/api/types/KeypadInputPlan.ts index c458d652..95d046fe 100644 --- a/src/api/types/KeypadInputPlan.ts +++ b/src/api/types/KeypadInputPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, and delimiters. + */ export interface KeypadInputPlan { /** * This keeps track of whether the user has enabled keypad input. diff --git a/src/api/types/KnowledgeBase.ts b/src/api/types/KnowledgeBase.ts index 843d77f0..19bdf467 100644 --- a/src/api/types/KnowledgeBase.ts +++ b/src/api/types/KnowledgeBase.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A knowledge-base configuration, including its provider, model, description, and associated files. + */ export interface KnowledgeBase { /** The name of the knowledge base */ name: string; diff --git a/src/api/types/KnowledgeBaseCost.ts b/src/api/types/KnowledgeBaseCost.ts index fa99b82d..191fb4f5 100644 --- a/src/api/types/KnowledgeBaseCost.ts +++ b/src/api/types/KnowledgeBaseCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Knowledge-base model cost, including model, token usage, and amount. + */ export interface KnowledgeBaseCost { /** This is the model that was used for processing the knowledge base. */ model: Record; diff --git a/src/api/types/LangfuseObservabilityPlan.ts b/src/api/types/LangfuseObservabilityPlan.ts index e77f2a33..76d8e6b3 100644 --- a/src/api/types/LangfuseObservabilityPlan.ts +++ b/src/api/types/LangfuseObservabilityPlan.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, and metadata. + */ export interface LangfuseObservabilityPlan { + /** Routes assistant call observability data to Langfuse. */ provider: Vapi.LangfuseObservabilityPlanProvider; /** The name of a Langfuse prompt to link generations to. This enables tracking which prompt version was used for each generation. https://langfuse.com/docs/prompt-management/features/link-to-traces */ promptName?: string | undefined; diff --git a/src/api/types/LangfuseObservabilityPlanProvider.ts b/src/api/types/LangfuseObservabilityPlanProvider.ts index c91acc30..67b2c7aa 100644 --- a/src/api/types/LangfuseObservabilityPlanProvider.ts +++ b/src/api/types/LangfuseObservabilityPlanProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Routes assistant call observability data to Langfuse. */ export const LangfuseObservabilityPlanProvider = { Langfuse: "langfuse", } as const; diff --git a/src/api/types/LineInsight.ts b/src/api/types/LineInsight.ts index 848d6219..223b73c5 100644 --- a/src/api/types/LineInsight.ts +++ b/src/api/types/LineInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ export interface LineInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface LineInsight { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/LineInsightMetadata.ts b/src/api/types/LineInsightMetadata.ts index 6d2a9328..89bb12ca 100644 --- a/src/api/types/LineInsightMetadata.ts +++ b/src/api/types/LineInsightMetadata.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds. + */ export interface LineInsightMetadata { + /** Label displayed on the chart's x-axis. */ xAxisLabel?: string | undefined; + /** Label displayed on the chart's y-axis. */ yAxisLabel?: string | undefined; + /** Minimum value displayed on the chart's y-axis. */ yAxisMin?: number | undefined; + /** Maximum value displayed on the chart's y-axis. */ yAxisMax?: number | undefined; + /** Display name for the insight chart. */ name?: string | undefined; } diff --git a/src/api/types/LiquidCondition.ts b/src/api/types/LiquidCondition.ts index e4abd6ec..9bf2a2e1 100644 --- a/src/api/types/LiquidCondition.ts +++ b/src/api/types/LiquidCondition.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Evaluates a Liquid template that must return `true` or `false`. + */ export interface LiquidCondition { /** * This is the Liquid template that must return exactly "true" or "false" as a string. diff --git a/src/api/types/LivekitSmartEndpointingPlan.ts b/src/api/types/LivekitSmartEndpointingPlan.ts index 16edcfa1..cd20d297 100644 --- a/src/api/types/LivekitSmartEndpointingPlan.ts +++ b/src/api/types/LivekitSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior. + */ export interface LivekitSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. */ provider: Vapi.LivekitSmartEndpointingPlanProvider; diff --git a/src/api/types/LmntVoice.ts b/src/api/types/LmntVoice.ts index b75400db..b638c26c 100644 --- a/src/api/types/LmntVoice.ts +++ b/src/api/types/LmntVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, caching, and fallback settings. + */ export interface LmntVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/McpTool.ts b/src/api/types/McpTool.ts index 11837ca2..b8d141b8 100644 --- a/src/api/types/McpTool.ts +++ b/src/api/types/McpTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ export interface McpTool { /** * These are the messages that will be spoken to the user as the tool is running. @@ -111,5 +114,6 @@ export interface McpTool { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; } diff --git a/src/api/types/McpToolMessages.ts b/src/api/types/McpToolMessages.ts index 9d4c5be8..3d2d3dad 100644 --- a/src/api/types/McpToolMessages.ts +++ b/src/api/types/McpToolMessages.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Per-tool message overrides for a tool discovered through an MCP server. + */ export interface McpToolMessages { /** The name of the tool from the MCP server. */ name: string; diff --git a/src/api/types/McpToolMetadata.ts b/src/api/types/McpToolMetadata.ts index c43e0fdc..6f9c1b08 100644 --- a/src/api/types/McpToolMetadata.ts +++ b/src/api/types/McpToolMetadata.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Protocol metadata used to communicate with an MCP server. + */ export interface McpToolMetadata { /** This is the protocol used for MCP communication. Defaults to Streamable HTTP. */ protocol?: Vapi.McpToolMetadataProtocol | undefined; diff --git a/src/api/types/MessageAddHookAction.ts b/src/api/types/MessageAddHookAction.ts index 59c5e278..12618768 100644 --- a/src/api/types/MessageAddHookAction.ts +++ b/src/api/types/MessageAddHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response. + */ export interface MessageAddHookAction { /** The message to add to the conversation in OpenAI format */ message: Vapi.OpenAiMessage; diff --git a/src/api/types/MessageTarget.ts b/src/api/types/MessageTarget.ts index efd696f2..ad016769 100644 --- a/src/api/types/MessageTarget.ts +++ b/src/api/types/MessageTarget.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects a conversation message by participant role and position for condition evaluation. + */ export interface MessageTarget { /** * This is the role of the message to target. diff --git a/src/api/types/MinimaxLlmModel.ts b/src/api/types/MinimaxLlmModel.ts index b4359102..f81bcf93 100644 --- a/src/api/types/MinimaxLlmModel.ts +++ b/src/api/types/MinimaxLlmModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface MinimaxLlmModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/MinimaxVoice.ts b/src/api/types/MinimaxVoice.ts index 8c778b89..a6f7bddb 100644 --- a/src/api/types/MinimaxVoice.ts +++ b/src/api/types/MinimaxVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with MiniMax, including voice and model selection, emotion, pitch, speed, volume, region, language, text normalization, chunking, caching, and fallback settings. + */ export interface MinimaxVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/ModelCost.ts b/src/api/types/ModelCost.ts index edddb80f..1545df08 100644 --- a/src/api/types/ModelCost.ts +++ b/src/api/types/ModelCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Language-model cost for a call, including model, token usage, and amount. + */ export interface ModelCost { /** * This is the model that was used during the call. diff --git a/src/api/types/Monitor.ts b/src/api/types/Monitor.ts index 457935c0..766b8cbe 100644 --- a/src/api/types/Monitor.ts +++ b/src/api/types/Monitor.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Live monitoring data for a call, including attached monitor results and listening and control URLs. + */ export interface Monitor { + /** Results produced by monitors attached to the call. */ monitors?: Vapi.MonitorResult[] | undefined; /** This is the URL where the assistant's calls can be listened to in real-time. To enable, set `assistant.monitorPlan.listenEnabled` to `true`. */ listenUrl?: string | undefined; diff --git a/src/api/types/MonitorPlan.ts b/src/api/types/MonitorPlan.ts index f727b08a..8c4c09c5 100644 --- a/src/api/types/MonitorPlan.ts +++ b/src/api/types/MonitorPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and attached monitors. + */ export interface MonitorPlan { /** * This determines whether the assistant's calls allow live listening. Defaults to true. @@ -35,12 +38,6 @@ export interface MonitorPlan { * @default false */ controlAuthenticationEnabled?: boolean | undefined; - /** - * This the set of monitor ids that are attached to the assistant. - * The source of truth for the monitor ids is the assistant_monitor join table. - * This field can be used for transient assistants and to update assistants with new monitor ids. - * - * @default [] - */ + /** IDs of the monitors attached to the assistant. Use this field for transient assistants or to update the monitors attached to an existing assistant. Defaults to an empty array. */ monitorIds?: string[] | undefined; } diff --git a/src/api/types/MonitorResult.ts b/src/api/types/MonitorResult.ts index 0f41afff..485357db 100644 --- a/src/api/types/MonitorResult.ts +++ b/src/api/types/MonitorResult.ts @@ -1,6 +1,11 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Result of evaluating an attached monitor's filter for a call. + */ export interface MonitorResult { + /** Unique identifier of the monitor that produced this result. */ monitorId: string; + /** Whether the monitor's filter matched the call. */ filterPassed: boolean; } diff --git a/src/api/types/Mono.ts b/src/api/types/Mono.ts index 68a1ef15..39c8d482 100644 --- a/src/api/types/Mono.ts +++ b/src/api/types/Mono.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Mono recording URLs for the combined call and isolated assistant and customer audio. + */ export interface Mono { /** This is the combined recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ combinedUrl?: string | undefined; diff --git a/src/api/types/NeuphonicVoice.ts b/src/api/types/NeuphonicVoice.ts index 6e699ddf..4f05813e 100644 --- a/src/api/types/NeuphonicVoice.ts +++ b/src/api/types/NeuphonicVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, caching, and fallback settings. + */ export interface NeuphonicVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/NodeArtifact.ts b/src/api/types/NodeArtifact.ts index 7788f476..183d8c85 100644 --- a/src/api/types/NodeArtifact.ts +++ b/src/api/types/NodeArtifact.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Messages and variable values captured while a workflow node was active. + */ export interface NodeArtifact { /** These are the messages that were spoken during the node. */ messages?: Vapi.NodeArtifactMessagesItem[] | undefined; diff --git a/src/api/types/OAuth2AuthenticationPlan.ts b/src/api/types/OAuth2AuthenticationPlan.ts index 54f1b1cf..cab2e47a 100644 --- a/src/api/types/OAuth2AuthenticationPlan.ts +++ b/src/api/types/OAuth2AuthenticationPlan.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests. + */ export interface OAuth2AuthenticationPlan { + /** Selects OAuth 2.0 authentication. */ type: Vapi.OAuth2AuthenticationPlanType; /** This is the OAuth2 URL. */ url: string; diff --git a/src/api/types/OAuth2AuthenticationPlanType.ts b/src/api/types/OAuth2AuthenticationPlanType.ts index 00741965..e20d34de 100644 --- a/src/api/types/OAuth2AuthenticationPlanType.ts +++ b/src/api/types/OAuth2AuthenticationPlanType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects OAuth 2.0 authentication. */ export const OAuth2AuthenticationPlanType = { Oauth2: "oauth2", } as const; diff --git a/src/api/types/Oauth2AuthenticationSession.ts b/src/api/types/Oauth2AuthenticationSession.ts index 7b65ef67..b90fe39e 100644 --- a/src/api/types/Oauth2AuthenticationSession.ts +++ b/src/api/types/Oauth2AuthenticationSession.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OAuth 2.0 session tokens and expiration used to authenticate integration requests. + */ export interface Oauth2AuthenticationSession { /** This is the OAuth2 access token. */ accessToken?: string | undefined; diff --git a/src/api/types/OpenAiFunction.ts b/src/api/types/OpenAiFunction.ts index 176c33d1..a760db7f 100644 --- a/src/api/types/OpenAiFunction.ts +++ b/src/api/types/OpenAiFunction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema behavior. + */ export interface OpenAiFunction { /** * This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/). diff --git a/src/api/types/OpenAiFunctionParameters.ts b/src/api/types/OpenAiFunctionParameters.ts index 2a036bc7..b0058485 100644 --- a/src/api/types/OpenAiFunctionParameters.ts +++ b/src/api/types/OpenAiFunctionParameters.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * JSON object schema defining the properties accepted by a function and which properties are required. + */ export interface OpenAiFunctionParameters { /** This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties. */ type: Vapi.OpenAiFunctionParametersType; diff --git a/src/api/types/OpenAiMessage.ts b/src/api/types/OpenAiMessage.ts index 6183a777..c6e2f524 100644 --- a/src/api/types/OpenAiMessage.ts +++ b/src/api/types/OpenAiMessage.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A conversation message represented in OpenAI chat format. + */ export interface OpenAiMessage { + /** Content of the conversation message. */ content: string | null; + /** Role associated with the conversation message. */ role: Vapi.OpenAiMessageRole; } diff --git a/src/api/types/OpenAiMessageRole.ts b/src/api/types/OpenAiMessageRole.ts index a5b26da8..d4fdae0b 100644 --- a/src/api/types/OpenAiMessageRole.ts +++ b/src/api/types/OpenAiMessageRole.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Role associated with the conversation message. */ export const OpenAiMessageRole = { Assistant: "assistant", Function: "function", diff --git a/src/api/types/OpenAiModel.ts b/src/api/types/OpenAiModel.ts index e53272ac..94bf9eda 100644 --- a/src/api/types/OpenAiModel.ts +++ b/src/api/types/OpenAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, tools, prompt caching, and generation settings. + */ export interface OpenAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/OpenAiTranscriber.ts b/src/api/types/OpenAiTranscriber.ts index 257e2070..5e7c8de5 100644 --- a/src/api/types/OpenAiTranscriber.ts +++ b/src/api/types/OpenAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and fallback settings. + */ export interface OpenAiTranscriber { /** This is the model that will be used for the transcription. */ model: Vapi.OpenAiTranscriberModel; diff --git a/src/api/types/OpenAiVoice.ts b/src/api/types/OpenAiVoice.ts index 45bf026c..0dfd1422 100644 --- a/src/api/types/OpenAiVoice.ts +++ b/src/api/types/OpenAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, caching, and fallback settings. + */ export interface OpenAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/OpenAiVoicemailDetectionPlan.ts b/src/api/types/OpenAiVoicemailDetectionPlan.ts index a2210187..2fd0336b 100644 --- a/src/api/types/OpenAiVoicemailDetectionPlan.ts +++ b/src/api/types/OpenAiVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff. + */ export interface OpenAiVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/OpenRouterModel.ts b/src/api/types/OpenRouterModel.ts index 861b7c9e..b1e487be 100644 --- a/src/api/types/OpenRouterModel.ts +++ b/src/api/types/OpenRouterModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, tools, knowledge-base access, and generation settings. + */ export interface OpenRouterModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/PaginationMeta.ts b/src/api/types/PaginationMeta.ts index 2eaafb43..a57d0e13 100644 --- a/src/api/types/PaginationMeta.ts +++ b/src/api/types/PaginationMeta.ts @@ -1,10 +1,19 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Pagination and retention metadata returned with a paginated list of phone numbers. + */ export interface PaginationMeta { + /** The number of phone numbers returned per page. */ itemsPerPage: number; + /** The total number of phone numbers matching the request. */ totalItems: number; + /** The current page number. */ currentPage: number; + /** Whether additional matching phone numbers exist beyond the organization's data-retention window. */ itemsBeyondRetention?: boolean | undefined; + /** The inclusive upper creation-time boundary applied to the result set. */ createdAtLe?: string | undefined; + /** The inclusive lower creation-time boundary applied to the result set. */ createdAtGe?: string | undefined; } diff --git a/src/api/types/PerformanceMetrics.ts b/src/api/types/PerformanceMetrics.ts index bf9d08a5..618c467f 100644 --- a/src/api/types/PerformanceMetrics.ts +++ b/src/api/types/PerformanceMetrics.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption metrics. + */ export interface PerformanceMetrics { /** These are the individual latencies for each turn. */ turnLatencies?: Vapi.TurnLatency[] | undefined; diff --git a/src/api/types/PerplexityAiModel.ts b/src/api/types/PerplexityAiModel.ts index 35339dc2..b904e3e7 100644 --- a/src/api/types/PerplexityAiModel.ts +++ b/src/api/types/PerplexityAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface PerplexityAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/PhoneNumberCallEndingHookFilter.ts b/src/api/types/PhoneNumberCallEndingHookFilter.ts index a993a39f..922ebf13 100644 --- a/src/api/types/PhoneNumberCallEndingHookFilter.ts +++ b/src/api/types/PhoneNumberCallEndingHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs. + */ export interface PhoneNumberCallEndingHookFilter { /** This is the type of filter - currently only "oneOf" is supported */ type: Vapi.PhoneNumberCallEndingHookFilterType; diff --git a/src/api/types/PhoneNumberCallRingingHookFilter.ts b/src/api/types/PhoneNumberCallRingingHookFilter.ts index c6beb9d5..cde446c3 100644 --- a/src/api/types/PhoneNumberCallRingingHookFilter.ts +++ b/src/api/types/PhoneNumberCallRingingHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs. + */ export interface PhoneNumberCallRingingHookFilter { /** This is the type of filter - matches when the specified field starts with any of the given prefixes */ type: Vapi.PhoneNumberCallRingingHookFilterType; diff --git a/src/api/types/PhoneNumberHookCallEnding.ts b/src/api/types/PhoneNumberHookCallEnding.ts index efa6cbcf..561219b9 100644 --- a/src/api/types/PhoneNumberHookCallEnding.ts +++ b/src/api/types/PhoneNumberHookCallEnding.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason. + */ export interface PhoneNumberHookCallEnding { /** Optional filters to decide when to trigger - restricted to assistant-request related ended reasons */ filters?: Vapi.PhoneNumberCallEndingHookFilter[] | undefined; diff --git a/src/api/types/PhoneNumberHookCallRinging.ts b/src/api/types/PhoneNumberHookCallRinging.ts index 57c70dba..a1357f59 100644 --- a/src/api/types/PhoneNumberHookCallRinging.ts +++ b/src/api/types/PhoneNumberHookCallRinging.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters match. + */ export interface PhoneNumberHookCallRinging { /** Optional filters to decide when to trigger the hook. Currently supports filtering by caller country code. */ filters?: Vapi.PhoneNumberCallRingingHookFilter[] | undefined; diff --git a/src/api/types/PhoneNumberPaginatedResponse.ts b/src/api/types/PhoneNumberPaginatedResponse.ts index 94d13d64..94056d9a 100644 --- a/src/api/types/PhoneNumberPaginatedResponse.ts +++ b/src/api/types/PhoneNumberPaginatedResponse.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of phone numbers and metadata describing the result set. + */ export interface PhoneNumberPaginatedResponse { /** A list of phone numbers, which can be of any provider type. */ results: Vapi.PhoneNumberPaginatedResponseResultsItem[]; diff --git a/src/api/types/PieInsight.ts b/src/api/types/PieInsight.ts index 95645181..43651f76 100644 --- a/src/api/types/PieInsight.ts +++ b/src/api/types/PieInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information. + */ export interface PieInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface PieInsight { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/PlayHtVoice.ts b/src/api/types/PlayHtVoice.ts index 04ac51f2..1df72025 100644 --- a/src/api/types/PlayHtVoice.ts +++ b/src/api/types/PlayHtVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, caching, and fallback settings. + */ export interface PlayHtVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/PromptInjectionSecurityFilter.ts b/src/api/types/PromptInjectionSecurityFilter.ts index 8b08c5e7..11a46a35 100644 --- a/src/api/types/PromptInjectionSecurityFilter.ts +++ b/src/api/types/PromptInjectionSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential prompt-injection patterns from transcripts. + */ export interface PromptInjectionSecurityFilter { /** The type of security threat to filter. */ type: Vapi.PromptInjectionSecurityFilterType; diff --git a/src/api/types/ProviderResource.ts b/src/api/types/ProviderResource.ts index adc8f565..11c37334 100644 --- a/src/api/types/ProviderResource.ts +++ b/src/api/types/ProviderResource.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, resource data, and lifecycle information. + */ export interface ProviderResource { /** This is the unique identifier for the provider resource. */ id: string; diff --git a/src/api/types/ProviderResourcePaginatedResponse.ts b/src/api/types/ProviderResourcePaginatedResponse.ts index a2e9165a..7c145fe7 100644 --- a/src/api/types/ProviderResourcePaginatedResponse.ts +++ b/src/api/types/ProviderResourcePaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of provider resources and metadata describing the result set. + */ export interface ProviderResourcePaginatedResponse { + /** The provider resources returned for the current page. */ results: Vapi.ProviderResource[]; + /** Pagination metadata for the provider-resource result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/PublicKeyEncryptionPlan.ts b/src/api/types/PublicKeyEncryptionPlan.ts index 0aace0a6..3fa63cbe 100644 --- a/src/api/types/PublicKeyEncryptionPlan.ts +++ b/src/api/types/PublicKeyEncryptionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for encrypting sensitive outbound request data with a public key. + */ export interface PublicKeyEncryptionPlan { /** The encryption algorithm to use. */ algorithm: Vapi.PublicKeyEncryptionPlanAlgorithm; diff --git a/src/api/types/QueryTool.ts b/src/api/types/QueryTool.ts index e16cd7fe..5adf5696 100644 --- a/src/api/types/QueryTool.ts +++ b/src/api/types/QueryTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that searches configured knowledge bases and returns relevant content to the assistant. + */ export interface QueryTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/RceSecurityFilter.ts b/src/api/types/RceSecurityFilter.ts index b21970e6..1e475fc7 100644 --- a/src/api/types/RceSecurityFilter.ts +++ b/src/api/types/RceSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential remote code execution (RCE) patterns from transcripts. + */ export interface RceSecurityFilter { /** The type of security threat to filter. */ type: Vapi.RceSecurityFilterType; diff --git a/src/api/types/Recording.ts b/src/api/types/Recording.ts index 853a9ed4..0d346618 100644 --- a/src/api/types/Recording.ts +++ b/src/api/types/Recording.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Call recording locations, including stereo, video, and separated mono recording URLs. + */ export interface Recording { /** This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ stereoUrl?: string | undefined; diff --git a/src/api/types/RecordingConsent.ts b/src/api/types/RecordingConsent.ts index 5cabcda6..b6ffcdc5 100644 --- a/src/api/types/RecordingConsent.ts +++ b/src/api/types/RecordingConsent.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Result of the recording-consent flow, including consent type and the time consent was granted. + */ export interface RecordingConsent { /** This is the type of recording consent. */ type: Record; diff --git a/src/api/types/RecordingConsentPlanStayOnLine.ts b/src/api/types/RecordingConsentPlanStayOnLine.ts index 5137786d..08286fef 100644 --- a/src/api/types/RecordingConsentPlanStayOnLine.ts +++ b/src/api/types/RecordingConsentPlanStayOnLine.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requesting recording consent by treating continued presence on the call as consent, including the announcement voice and wait time. + */ export interface RecordingConsentPlanStayOnLine { /** * This is the message asking for consent to record the call. diff --git a/src/api/types/RecordingConsentPlanVerbal.ts b/src/api/types/RecordingConsentPlanVerbal.ts index b23459dd..b5f64a26 100644 --- a/src/api/types/RecordingConsentPlanVerbal.ts +++ b/src/api/types/RecordingConsentPlanVerbal.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requesting explicit verbal recording consent, including the announcement voice and action to take when the customer declines. + */ export interface RecordingConsentPlanVerbal { /** * This is the message asking for consent to record the call. diff --git a/src/api/types/RegexCondition.ts b/src/api/types/RegexCondition.ts index f8bd41e8..345f2094 100644 --- a/src/api/types/RegexCondition.ts +++ b/src/api/types/RegexCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates whether targeted conversation-message content matches a regular expression. + */ export interface RegexCondition { /** * This is the regular expression pattern to match against message content. diff --git a/src/api/types/RegexOption.ts b/src/api/types/RegexOption.ts index 5dca3a7d..c3f6963f 100644 --- a/src/api/types/RegexOption.ts +++ b/src/api/types/RegexOption.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Enables or disables one regular-expression matching option for a text replacement. + */ export interface RegexOption { /** * This is the type of the regex option. Options are: diff --git a/src/api/types/RegexReplacement.ts b/src/api/types/RegexReplacement.ts index 92afdb21..33304eca 100644 --- a/src/api/types/RegexReplacement.ts +++ b/src/api/types/RegexReplacement.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Replaces text matching a regular expression before it is sent to a voice provider. + */ export interface RegexReplacement { /** * This is the regex pattern to replace. diff --git a/src/api/types/RegexSecurityFilter.ts b/src/api/types/RegexSecurityFilter.ts index 66805170..1ad256e9 100644 --- a/src/api/types/RegexSecurityFilter.ts +++ b/src/api/types/RegexSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters transcript content that matches a custom regular expression. + */ export interface RegexSecurityFilter { /** The type of security threat to filter. */ type: Vapi.RegexSecurityFilterType; diff --git a/src/api/types/RimeAiVoice.ts b/src/api/types/RimeAiVoice.ts index 1ed66a79..4d956c91 100644 --- a/src/api/types/RimeAiVoice.ts +++ b/src/api/types/RimeAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, caching, and fallback settings. + */ export interface RimeAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/SayHookAction.ts b/src/api/types/SayHookAction.ts index c5273d21..5cab3cac 100644 --- a/src/api/types/SayHookAction.ts +++ b/src/api/types/SayHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that makes the assistant speak exact text or generate a response from a prompt. + */ export interface SayHookAction { /** * This is the prompt for the assistant to generate a response based on existing conversation. diff --git a/src/api/types/SayPhoneNumberHookAction.ts b/src/api/types/SayPhoneNumberHookAction.ts index 5f0c9c37..95c812d1 100644 --- a/src/api/types/SayPhoneNumberHookAction.ts +++ b/src/api/types/SayPhoneNumberHookAction.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A phone-number hook action that speaks an exact message to the caller. + */ export interface SayPhoneNumberHookAction { /** This is the message to say */ exact: string; diff --git a/src/api/types/SbcConfiguration.ts b/src/api/types/SbcConfiguration.ts index e16bc574..a01221ba 100644 --- a/src/api/types/SbcConfiguration.ts +++ b/src/api/types/SbcConfiguration.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed controller. + */ export type SbcConfiguration = {}; diff --git a/src/api/types/SchedulePlan.ts b/src/api/types/SchedulePlan.ts index 3654c3bd..a9203327 100644 --- a/src/api/types/SchedulePlan.ts +++ b/src/api/types/SchedulePlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Time window that controls the earliest and latest time a call may begin. + */ export interface SchedulePlan { /** This is the ISO 8601 date-time string of the earliest time the call can be scheduled. */ earliestAt: string; diff --git a/src/api/types/Scorecard.ts b/src/api/types/Scorecard.ts index d5215c2a..9c3e905d 100644 --- a/src/api/types/Scorecard.ts +++ b/src/api/types/Scorecard.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive metadata, and lifecycle information. + */ export interface Scorecard { /** This is the unique identifier for the scorecard. */ id: string; diff --git a/src/api/types/ScorecardMetric.ts b/src/api/types/ScorecardMetric.ts index 1a96c31f..294ecb31 100644 --- a/src/api/types/ScorecardMetric.ts +++ b/src/api/types/ScorecardMetric.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A scorecard metric that awards points when a structured output meets its configured conditions. + */ export interface ScorecardMetric { /** * This is the unique identifier for the structured output that will be used to evaluate the scorecard. diff --git a/src/api/types/ScorecardPaginatedResponse.ts b/src/api/types/ScorecardPaginatedResponse.ts index dcf4b9be..de3ab05a 100644 --- a/src/api/types/ScorecardPaginatedResponse.ts +++ b/src/api/types/ScorecardPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of scorecards and metadata describing the result set. + */ export interface ScorecardPaginatedResponse { + /** The scorecards returned for the current page. */ results: Vapi.Scorecard[]; + /** Pagination metadata for the scorecard result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/SecurityFilterBase.ts b/src/api/types/SecurityFilterBase.ts index eb2e46d0..cd0564fe 100644 --- a/src/api/types/SecurityFilterBase.ts +++ b/src/api/types/SecurityFilterBase.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Base configuration for a security filter applied to transcripts before model processing. + */ export type SecurityFilterBase = {}; diff --git a/src/api/types/SecurityFilterPlan.ts b/src/api/types/SecurityFilterPlan.ts index 5458e337..b83fe075 100644 --- a/src/api/types/SecurityFilterPlan.ts +++ b/src/api/types/SecurityFilterPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls filtering of transcripts for security threats before content is sent to the assistant's language model, including filter selection, handling mode, and replacement text. + */ export interface SecurityFilterPlan { /** * Whether the security filter is enabled. diff --git a/src/api/types/Server.ts b/src/api/types/Server.ts index 3c60454c..f7e99a97 100644 --- a/src/api/types/Server.ts +++ b/src/api/types/Server.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, encryption, static IP addresses, and retry behavior. + */ export interface Server { /** * This is the timeout in seconds for the request. Defaults to 20 seconds. diff --git a/src/api/types/SesameVoice.ts b/src/api/types/SesameVoice.ts index d577279e..5ce52306 100644 --- a/src/api/types/SesameVoice.ts +++ b/src/api/types/SesameVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, caching, and fallback settings. + */ export interface SesameVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/SipAuthentication.ts b/src/api/types/SipAuthentication.ts index 545f75e0..fbdadd1a 100644 --- a/src/api/types/SipAuthentication.ts +++ b/src/api/types/SipAuthentication.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Realm, username, and password used to authenticate SIP requests. + */ export interface SipAuthentication { /** This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.vapi.ai. */ realm?: string | undefined; diff --git a/src/api/types/SipRequestTool.ts b/src/api/types/SipRequestTool.ts index 7e57dacf..a53e7b09 100644 --- a/src/api/types/SipRequestTool.ts +++ b/src/api/types/SipRequestTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ export interface SipRequestTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/SipTrunkGateway.ts b/src/api/types/SipTrunkGateway.ts index 4059859c..83a25811 100644 --- a/src/api/types/SipTrunkGateway.ts +++ b/src/api/types/SipTrunkGateway.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Network and routing settings for a SIP trunk gateway, including address, port, netmask, inbound and outbound use, signaling protocol, and OPTIONS health checks. + */ export interface SipTrunkGateway { /** This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com. */ ip: string; diff --git a/src/api/types/SipTrunkOutboundAuthenticationPlan.ts b/src/api/types/SipTrunkOutboundAuthenticationPlan.ts index 4eeb6bfd..931c1107 100644 --- a/src/api/types/SipTrunkOutboundAuthenticationPlan.ts +++ b/src/api/types/SipTrunkOutboundAuthenticationPlan.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk. + */ export interface SipTrunkOutboundAuthenticationPlan { /** This is not returned in the API. */ authPassword?: string | undefined; + /** Username used to authenticate outbound SIP requests. */ authUsername?: string | undefined; /** This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted. */ sipRegisterPlan?: Vapi.SipTrunkOutboundSipRegisterPlan | undefined; diff --git a/src/api/types/SipTrunkOutboundSipRegisterPlan.ts b/src/api/types/SipTrunkOutboundSipRegisterPlan.ts index a72e2f90..23f35481 100644 --- a/src/api/types/SipTrunkOutboundSipRegisterPlan.ts +++ b/src/api/types/SipTrunkOutboundSipRegisterPlan.ts @@ -1,7 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Registration settings used when the SIP trunk requires SIP REGISTER. + */ export interface SipTrunkOutboundSipRegisterPlan { + /** SIP registrar domain used for registration. */ domain?: string | undefined; + /** Username sent with the SIP REGISTER request. */ username?: string | undefined; + /** Authentication realm used for SIP registration. */ realm?: string | undefined; } diff --git a/src/api/types/SlackSendMessageTool.ts b/src/api/types/SlackSendMessageTool.ts index 42476133..5aedf375 100644 --- a/src/api/types/SlackSendMessageTool.ts +++ b/src/api/types/SlackSendMessageTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send a message to Slack. + */ export interface SlackSendMessageTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/SmallestAiVoice.ts b/src/api/types/SmallestAiVoice.ts index 81ae1495..274d6ec7 100644 --- a/src/api/types/SmallestAiVoice.ts +++ b/src/api/types/SmallestAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, caching, and fallback settings. + */ export interface SmallestAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/SmartDenoisingPlan.ts b/src/api/types/SmartDenoisingPlan.ts index 3a0cfa4d..4f32740e 100644 --- a/src/api/types/SmartDenoisingPlan.ts +++ b/src/api/types/SmartDenoisingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether Krisp smart denoising filters background speech and noise. + */ export interface SmartDenoisingPlan { /** Whether smart denoising using Krisp is enabled. */ enabled?: boolean | undefined; diff --git a/src/api/types/SmsTool.ts b/src/api/types/SmsTool.ts index b07e3039..9eb295a4 100644 --- a/src/api/types/SmsTool.ts +++ b/src/api/types/SmsTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send an SMS message during a call. + */ export interface SmsTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/SonioxTranscriber.ts b/src/api/types/SonioxTranscriber.ts index 464b6e49..d7990e6a 100644 --- a/src/api/types/SonioxTranscriber.ts +++ b/src/api/types/SonioxTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Soniox, including model, language detection, endpointing, vocabulary, and fallback settings. + */ export interface SonioxTranscriber { /** The Soniox model to use for transcription. */ model?: Vapi.SonioxTranscriberModel | undefined; diff --git a/src/api/types/SpeechmaticsCustomVocabularyItem.ts b/src/api/types/SpeechmaticsCustomVocabularyItem.ts index f132f331..f1e98032 100644 --- a/src/api/types/SpeechmaticsCustomVocabularyItem.ts +++ b/src/api/types/SpeechmaticsCustomVocabularyItem.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives. + */ export interface SpeechmaticsCustomVocabularyItem { /** The word or phrase to add to the custom vocabulary. */ content: string; diff --git a/src/api/types/SpeechmaticsTranscriber.ts b/src/api/types/SpeechmaticsTranscriber.ts index d7d1da9d..9c906cd0 100644 --- a/src/api/types/SpeechmaticsTranscriber.ts +++ b/src/api/types/SpeechmaticsTranscriber.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Speechmatics, including language, region, diarization, vocabulary, endpointing, formatting, and fallback settings. + */ export interface SpeechmaticsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.SpeechmaticsTranscriberModel | undefined; + /** Language used for transcription. Set to `auto` to detect the language automatically. */ language?: Vapi.SpeechmaticsTranscriberLanguage | undefined; /** * This is the operating point for the transcription. Choose between `standard` for faster turnaround with strong accuracy or `enhanced` for highest accuracy when precision is critical. @@ -30,6 +34,7 @@ export interface SpeechmaticsTranscriber { * @default 3000 */ maxDelay?: number | undefined; + /** Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ customVocabulary: Vapi.SpeechmaticsCustomVocabularyItem[]; /** * This controls how numbers, dates, currencies, and other entities are formatted in the transcription output. diff --git a/src/api/types/SpeechmaticsTranscriberLanguage.ts b/src/api/types/SpeechmaticsTranscriberLanguage.ts index 63fc6621..0f0e071d 100644 --- a/src/api/types/SpeechmaticsTranscriberLanguage.ts +++ b/src/api/types/SpeechmaticsTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language used for transcription. Set to `auto` to detect the language automatically. */ export const SpeechmaticsTranscriberLanguage = { Auto: "auto", Ar: "ar", diff --git a/src/api/types/SpkiPemPublicKeyConfig.ts b/src/api/types/SpkiPemPublicKeyConfig.ts index 02fa9e30..31021b71 100644 --- a/src/api/types/SpkiPemPublicKeyConfig.ts +++ b/src/api/types/SpkiPemPublicKeyConfig.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An SPKI public key in PEM format used to encrypt sensitive request data. + */ export interface SpkiPemPublicKeyConfig { /** Optional name of the key for identification purposes. */ name?: string | undefined; diff --git a/src/api/types/SqlInjectionSecurityFilter.ts b/src/api/types/SqlInjectionSecurityFilter.ts index ea36522d..ff250ffa 100644 --- a/src/api/types/SqlInjectionSecurityFilter.ts +++ b/src/api/types/SqlInjectionSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential SQL injection patterns from transcripts. + */ export interface SqlInjectionSecurityFilter { /** The type of security threat to filter. */ type: Vapi.SqlInjectionSecurityFilterType; diff --git a/src/api/types/Squad.ts b/src/api/types/Squad.ts index 7f8c7ae3..0df83e44 100644 --- a/src/api/types/Squad.ts +++ b/src/api/types/Squad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved squad configuration that coordinates a group of assistants during a conversation. The first member starts the call, and member destinations control transfers between assistants. + */ export interface Squad { /** This is the name of the squad. */ name?: string | undefined; diff --git a/src/api/types/SquadMemberDto.ts b/src/api/types/SquadMemberDto.ts index 4052e063..f3af3930 100644 --- a/src/api/types/SquadMemberDto.ts +++ b/src/api/types/SquadMemberDto.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * An assistant member of a squad. Reference a saved assistant or provide a transient assistant, then configure member-specific overrides and destinations for transfers. + */ export interface SquadMemberDto { + /** Assistants this squad member can route the conversation to through a transfer or handoff. */ assistantDestinations?: Vapi.SquadMemberDtoAssistantDestinationsItem[] | undefined; /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */ assistantId?: (string | null) | undefined; diff --git a/src/api/types/SsrfSecurityFilter.ts b/src/api/types/SsrfSecurityFilter.ts index bb371911..38d85c33 100644 --- a/src/api/types/SsrfSecurityFilter.ts +++ b/src/api/types/SsrfSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential server-side request forgery (SSRF) patterns from transcripts. + */ export interface SsrfSecurityFilter { /** The type of security threat to filter. */ type: Vapi.SsrfSecurityFilterType; diff --git a/src/api/types/StartSpeakingPlan.ts b/src/api/types/StartSpeakingPlan.ts index 99a80253..170b4770 100644 --- a/src/api/types/StartSpeakingPlan.ts +++ b/src/api/types/StartSpeakingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing strategy, and custom endpointing rules. + */ export interface StartSpeakingPlan { /** * This is how long assistant waits before speaking. Defaults to 0.4. diff --git a/src/api/types/StopSpeakingPlan.ts b/src/api/types/StopSpeakingPlan.ts index 32984c52..8ee193f7 100644 --- a/src/api/types/StopSpeakingPlan.ts +++ b/src/api/types/StopSpeakingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, restart delay, and phrase exceptions. + */ export interface StopSpeakingPlan { /** * This is the number of words that the customer has to say before the assistant will stop talking. diff --git a/src/api/types/StructuredDataMultiPlan.ts b/src/api/types/StructuredDataMultiPlan.ts index 213da004..196ebbad 100644 --- a/src/api/types/StructuredDataMultiPlan.ts +++ b/src/api/types/StructuredDataMultiPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Associates a catalog key with a structured data extraction plan. + */ export interface StructuredDataMultiPlan { /** This is the key of the structured data plan in the catalog. */ key: string; diff --git a/src/api/types/StructuredDataPlan.ts b/src/api/types/StructuredDataPlan.ts index 35a304a5..572b12e6 100644 --- a/src/api/types/StructuredDataPlan.ts +++ b/src/api/types/StructuredDataPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request timeout. + */ export interface StructuredDataPlan { /** * These are the messages used to generate the structured data. diff --git a/src/api/types/StructuredOutput.ts b/src/api/types/StructuredOutput.ts index 7b38a604..5d238b29 100644 --- a/src/api/types/StructuredOutput.ts +++ b/src/api/types/StructuredOutput.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved structured-output definition containing its extraction schema, execution method, model or regular expression, linked resources, and lifecycle metadata. + */ export interface StructuredOutput { /** * This is the type of structured output. diff --git a/src/api/types/StructuredOutputPaginatedResponse.ts b/src/api/types/StructuredOutputPaginatedResponse.ts index 7ac44137..a3afd70d 100644 --- a/src/api/types/StructuredOutputPaginatedResponse.ts +++ b/src/api/types/StructuredOutputPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of structured-output definitions and metadata describing the result set. + */ export interface StructuredOutputPaginatedResponse { + /** The structured-output definitions returned for the current page. */ results: Vapi.StructuredOutput[]; + /** Pagination metadata for the structured-output result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/SubscriptionLimits.ts b/src/api/types/SubscriptionLimits.ts index 4198f818..fecc8a04 100644 --- a/src/api/types/SubscriptionLimits.ts +++ b/src/api/types/SubscriptionLimits.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Organization concurrency limits and remaining concurrent call capacity. + */ export interface SubscriptionLimits { /** True if this call was blocked by the Call Concurrency limit */ concurrencyBlocked?: boolean | undefined; diff --git a/src/api/types/SuccessEvaluationPlan.ts b/src/api/types/SuccessEvaluationPlan.ts index 49f5bea2..f752966e 100644 --- a/src/api/types/SuccessEvaluationPlan.ts +++ b/src/api/types/SuccessEvaluationPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout. + */ export interface SuccessEvaluationPlan { /** * This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`. diff --git a/src/api/types/SummaryPlan.ts b/src/api/types/SummaryPlan.ts index 7572f558..19698ff8 100644 --- a/src/api/types/SummaryPlan.ts +++ b/src/api/types/SummaryPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls generation of a post-call summary, including prompt messages, enablement, and request timeout. + */ export interface SummaryPlan { /** * These are the messages used to generate the summary. diff --git a/src/api/types/SupabaseBucketPlan.ts b/src/api/types/SupabaseBucketPlan.ts index e53f8345..55e847fa 100644 --- a/src/api/types/SupabaseBucketPlan.ts +++ b/src/api/types/SupabaseBucketPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket name, and path. + */ export interface SupabaseBucketPlan { /** * This is the S3 Region. It should look like us-east-1 diff --git a/src/api/types/SystemMessage.ts b/src/api/types/SystemMessage.ts index 08903393..cc5acb78 100644 --- a/src/api/types/SystemMessage.ts +++ b/src/api/types/SystemMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A system-authored entry in the call message history, including its content and timing. + */ export interface SystemMessage { /** The role of the system in the conversation. */ role: string; diff --git a/src/api/types/TalkscriberTranscriber.ts b/src/api/types/TalkscriberTranscriber.ts index d7f7c629..5897c46e 100644 --- a/src/api/types/TalkscriberTranscriber.ts +++ b/src/api/types/TalkscriberTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, and fallback settings. + */ export interface TalkscriberTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.TalkscriberTranscriberModel | undefined; diff --git a/src/api/types/TavusConversationProperties.ts b/src/api/types/TavusConversationProperties.ts index 22d50bc3..03ad8c9e 100644 --- a/src/api/types/TavusConversationProperties.ts +++ b/src/api/types/TavusConversationProperties.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Tavus conversation behavior and media settings, including duration, participant timeouts, recording, transcription, background, language, and recording storage. + */ export interface TavusConversationProperties { /** * The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour). diff --git a/src/api/types/TavusVoice.ts b/src/api/types/TavusVoice.ts index 32f5ae37..0a1d99d2 100644 --- a/src/api/types/TavusVoice.ts +++ b/src/api/types/TavusVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, caching, and fallback settings. + */ export interface TavusVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/TelnyxPhoneNumber.ts b/src/api/types/TelnyxPhoneNumber.ts index bc347fed..d442e4b3 100644 --- a/src/api/types/TelnyxPhoneNumber.ts +++ b/src/api/types/TelnyxPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface TelnyxPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/TextContent.ts b/src/api/types/TextContent.ts index 6a4f7bc1..8ddc3dd0 100644 --- a/src/api/types/TextContent.ts +++ b/src/api/types/TextContent.ts @@ -2,8 +2,14 @@ import type * as Vapi from "../index.js"; +/** + * Localized text content used as a language-specific message variant. + */ export interface TextContent { + /** Selects text as the content type. */ type: Vapi.TextContentType; + /** Text spoken or displayed for this content variant. */ text: string; + /** Language code associated with this text variant. */ language: Vapi.TextContentLanguage; } diff --git a/src/api/types/TextContentLanguage.ts b/src/api/types/TextContentLanguage.ts index 51352c70..07c23945 100644 --- a/src/api/types/TextContentLanguage.ts +++ b/src/api/types/TextContentLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language code associated with this text variant. */ export const TextContentLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/TextContentType.ts b/src/api/types/TextContentType.ts index 55c03733..1366072b 100644 --- a/src/api/types/TextContentType.ts +++ b/src/api/types/TextContentType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects text as the content type. */ export const TextContentType = { Text: "text", } as const; diff --git a/src/api/types/TextEditorTool.ts b/src/api/types/TextEditorTool.ts index 383b77f9..8e9d5c8f 100644 --- a/src/api/types/TextEditorTool.ts +++ b/src/api/types/TextEditorTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that reads and edits text files in a configured environment. + */ export interface TextEditorTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/TextInsight.ts b/src/api/types/TextInsight.ts index deddceee..a45166ee 100644 --- a/src/api/types/TextInsight.ts +++ b/src/api/types/TextInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information. + */ export interface TextInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface TextInsight { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. diff --git a/src/api/types/TimeRange.ts b/src/api/types/TimeRange.ts index 21646bc4..0746d953 100644 --- a/src/api/types/TimeRange.ts +++ b/src/api/types/TimeRange.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Start, end, timezone, and time step used for analytics aggregation. + */ export interface TimeRange { /** * This is the time step for aggregations. diff --git a/src/api/types/TogetherAiModel.ts b/src/api/types/TogetherAiModel.ts index b3062449..4dda418b 100644 --- a/src/api/types/TogetherAiModel.ts +++ b/src/api/types/TogetherAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface TogetherAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/ToolCall.ts b/src/api/types/ToolCall.ts index e12999c6..f56b9aad 100644 --- a/src/api/types/ToolCall.ts +++ b/src/api/types/ToolCall.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A tool invocation requested by the assistant, including its identifier, type, and function details. + */ export interface ToolCall { /** This is the ID of the tool call */ id: string; diff --git a/src/api/types/ToolCallFunction.ts b/src/api/types/ToolCallFunction.ts index e1ef5e1f..b0faf2dc 100644 --- a/src/api/types/ToolCallFunction.ts +++ b/src/api/types/ToolCallFunction.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * The function name and serialized arguments associated with a tool call. + */ export interface ToolCallFunction { /** This is the arguments to call the function with */ arguments: string; diff --git a/src/api/types/ToolCallHookAction.ts b/src/api/types/ToolCallHookAction.ts index c6e345d3..e400b8be 100644 --- a/src/api/types/ToolCallHookAction.ts +++ b/src/api/types/ToolCallHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that invokes an inline tool or an existing tool when the hook triggers. + */ export interface ToolCallHookAction { /** This is the type of action - must be "tool" */ type: Vapi.ToolCallHookActionType; diff --git a/src/api/types/ToolCallMessage.ts b/src/api/types/ToolCallMessage.ts index 1675f26c..5680dc99 100644 --- a/src/api/types/ToolCallMessage.ts +++ b/src/api/types/ToolCallMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An entry in the call message history that records one or more tool calls requested during the conversation. + */ export interface ToolCallMessage { /** The role of the tool call in the conversation. */ role: string; diff --git a/src/api/types/ToolCallResultMessage.ts b/src/api/types/ToolCallResultMessage.ts index 2d25c063..aa754ac4 100644 --- a/src/api/types/ToolCallResultMessage.ts +++ b/src/api/types/ToolCallResultMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An entry in the call message history that records the result and metadata for a completed tool call. + */ export interface ToolCallResultMessage { /** The role of the tool call result in the conversation. */ role: string; diff --git a/src/api/types/ToolMessage.ts b/src/api/types/ToolMessage.ts index 12a79dd9..fa7cff68 100644 --- a/src/api/types/ToolMessage.ts +++ b/src/api/types/ToolMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A tool-result message associated with a specific tool call. + */ export interface ToolMessage { /** This is the role of the message author */ role: Vapi.ToolMessageRole; diff --git a/src/api/types/ToolMessageComplete.ts b/src/api/types/ToolMessageComplete.ts index b703487b..abfcee8f 100644 --- a/src/api/types/ToolMessageComplete.ts +++ b/src/api/types/ToolMessageComplete.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call completes, with optional language variants, argument conditions, role, and end-call behavior. + */ export interface ToolMessageComplete { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolMessageDelayed.ts b/src/api/types/ToolMessageDelayed.ts index fc133e4f..be20b896 100644 --- a/src/api/types/ToolMessageDelayed.ts +++ b/src/api/types/ToolMessageDelayed.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument conditions. + */ export interface ToolMessageDelayed { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolMessageFailed.ts b/src/api/types/ToolMessageFailed.ts index 40e696ec..b185bbc0 100644 --- a/src/api/types/ToolMessageFailed.ts +++ b/src/api/types/ToolMessageFailed.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call behavior. + */ export interface ToolMessageFailed { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolMessageStart.ts b/src/api/types/ToolMessageStart.ts index e00978c7..9693dd5a 100644 --- a/src/api/types/ToolMessageStart.ts +++ b/src/api/types/ToolMessageStart.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking behavior. + */ export interface ToolMessageStart { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolNode.ts b/src/api/types/ToolNode.ts index 8c474c5d..cab7be24 100644 --- a/src/api/types/ToolNode.ts +++ b/src/api/types/ToolNode.ts @@ -2,11 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A workflow node that invokes an inline tool or an existing saved tool. + */ export interface ToolNode { /** This is the tool to call. To use an existing tool, send `toolId` instead. */ tool?: Vapi.ToolNodeTool | undefined; /** This is the tool to call. To use a transient tool, send `tool` instead. */ toolId?: string | undefined; + /** Unique name used to identify this workflow node. */ name: string; /** This is whether or not the node is the start of the workflow. */ isStart?: boolean | undefined; diff --git a/src/api/types/ToolParameter.ts b/src/api/types/ToolParameter.ts index e0fa717f..059172b3 100644 --- a/src/api/types/ToolParameter.ts +++ b/src/api/types/ToolParameter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Static key-value parameter added to a tool request, with Liquid template support for string values. + */ export interface ToolParameter { /** This is the key of the parameter. */ key: string; diff --git a/src/api/types/ToolRejectionPlan.ts b/src/api/types/ToolRejectionPlan.ts index 6be37e56..8017d132 100644 --- a/src/api/types/ToolRejectionPlan.ts +++ b/src/api/types/ToolRejectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Conditions evaluated to determine whether a requested tool call should be rejected. + */ export interface ToolRejectionPlan { /** * This is the list of conditions that must be evaluated. diff --git a/src/api/types/TranscriberCost.ts b/src/api/types/TranscriberCost.ts index fcaef650..8d07548d 100644 --- a/src/api/types/TranscriberCost.ts +++ b/src/api/types/TranscriberCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Speech-to-text cost for a call, including transcriber, billable minutes, and amount. + */ export interface TranscriberCost { /** * This is the transcriber that was used during the call. diff --git a/src/api/types/TranscriptPlan.ts b/src/api/types/TranscriptPlan.ts index fe931527..f3a9c190 100644 --- a/src/api/types/TranscriptPlan.ts +++ b/src/api/types/TranscriptPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether the call transcript is stored and the speaker names used in the transcript. + */ export interface TranscriptPlan { /** * This determines whether the transcript is stored in `call.artifact.transcript`. Defaults to true. diff --git a/src/api/types/TranscriptionEndpointingPlan.ts b/src/api/types/TranscriptionEndpointingPlan.ts index 3f781af1..e0ec03c5 100644 --- a/src/api/types/TranscriptionEndpointingPlan.ts +++ b/src/api/types/TranscriptionEndpointingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a number. + */ export interface TranscriptionEndpointingPlan { /** * The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. Defaults to 0.1. diff --git a/src/api/types/TransferCallTool.ts b/src/api/types/TransferCallTool.ts index bac596b6..0f054ff4 100644 --- a/src/api/types/TransferCallTool.ts +++ b/src/api/types/TransferCallTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that transfers the active call to one of its configured destinations. + */ export interface TransferCallTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/TransferDestinationAssistant.ts b/src/api/types/TransferDestinationAssistant.ts index 15c2c333..b4fce0c8 100644 --- a/src/api/types/TransferDestinationAssistant.ts +++ b/src/api/types/TransferDestinationAssistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to another assistant by name, with an optional message and assistant-transfer mode. + */ export interface TransferDestinationAssistant { /** * This is spoken to the customer before connecting them to the destination. @@ -13,6 +16,7 @@ export interface TransferDestinationAssistant { * This accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field. */ message?: Vapi.TransferDestinationAssistantMessage | undefined; + /** Selects another assistant as the transfer destination. */ type: Vapi.TransferDestinationAssistantType; /** * This is the mode to use for the transfer. Defaults to `rolling-history`. diff --git a/src/api/types/TransferDestinationAssistantType.ts b/src/api/types/TransferDestinationAssistantType.ts index cb7910c1..72f003a7 100644 --- a/src/api/types/TransferDestinationAssistantType.ts +++ b/src/api/types/TransferDestinationAssistantType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects another assistant as the transfer destination. */ export const TransferDestinationAssistantType = { Assistant: "assistant", } as const; diff --git a/src/api/types/TransferDestinationNumber.ts b/src/api/types/TransferDestinationNumber.ts index 1f941e7e..a911b243 100644 --- a/src/api/types/TransferDestinationNumber.ts +++ b/src/api/types/TransferDestinationNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number validation. + */ export interface TransferDestinationNumber { /** * This is spoken to the customer before connecting them to the destination. diff --git a/src/api/types/TransferDestinationSip.ts b/src/api/types/TransferDestinationSip.ts index 852512b9..ce00508e 100644 --- a/src/api/types/TransferDestinationSip.ts +++ b/src/api/types/TransferDestinationSip.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan. + */ export interface TransferDestinationSip { /** * This is spoken to the customer before connecting them to the destination. diff --git a/src/api/types/TransferFallbackPlan.ts b/src/api/types/TransferFallbackPlan.ts index 46be634b..d4f59759 100644 --- a/src/api/types/TransferFallbackPlan.ts +++ b/src/api/types/TransferFallbackPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls the message and end-call behavior used when a call transfer fails. + */ export interface TransferFallbackPlan { /** This is the message the assistant will deliver to the customer if the transfer fails. */ message: Vapi.TransferFallbackPlanMessage; diff --git a/src/api/types/TransferPhoneNumberHookAction.ts b/src/api/types/TransferPhoneNumberHookAction.ts index 5cb3e0c6..91f7c23e 100644 --- a/src/api/types/TransferPhoneNumberHookAction.ts +++ b/src/api/types/TransferPhoneNumberHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A phone-number hook action that transfers the call to a phone number or SIP destination. + */ export interface TransferPhoneNumberHookAction { /** This is the destination details for the transfer - can be a phone number or SIP URI */ destination?: Vapi.TransferPhoneNumberHookActionDestination | undefined; diff --git a/src/api/types/TransferPlan.ts b/src/api/types/TransferPlan.ts index dde3a1f5..093dd1f5 100644 --- a/src/api/types/TransferPlan.ts +++ b/src/api/types/TransferPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how a call transfer is executed, including blind and warm transfer modes, dialing and SIP behavior, hold audio, context, summary, and failure handling. + */ export interface TransferPlan { /** * This configures how transfer is executed and the experience of the destination party receiving the call. diff --git a/src/api/types/TransportConfigurationTwilio.ts b/src/api/types/TransportConfigurationTwilio.ts index a97bc4c3..6b57b8e2 100644 --- a/src/api/types/TransportConfigurationTwilio.ts +++ b/src/api/types/TransportConfigurationTwilio.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior. + */ export interface TransportConfigurationTwilio { + /** Selects Twilio as the call transport provider. */ provider: Vapi.TransportConfigurationTwilioProvider; /** * The integer number of seconds that we should allow the phone to ring before assuming there is no answer. diff --git a/src/api/types/TransportConfigurationTwilioProvider.ts b/src/api/types/TransportConfigurationTwilioProvider.ts index f5cdd277..f7ca50cc 100644 --- a/src/api/types/TransportConfigurationTwilioProvider.ts +++ b/src/api/types/TransportConfigurationTwilioProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects Twilio as the call transport provider. */ export const TransportConfigurationTwilioProvider = { Twilio: "twilio", } as const; diff --git a/src/api/types/TransportCost.ts b/src/api/types/TransportCost.ts index e40bed6b..bf840299 100644 --- a/src/api/types/TransportCost.ts +++ b/src/api/types/TransportCost.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Telephony transport cost for a call, including provider, billable minutes, and amount. + */ export interface TransportCost { + /** Telephony or transport provider that generated the cost. */ provider?: Vapi.TransportCostProvider | undefined; /** This is the minutes of `transport` usage. This should match `call.endedAt` - `call.startedAt`. */ minutes: number; diff --git a/src/api/types/TransportCostProvider.ts b/src/api/types/TransportCostProvider.ts index 8295a535..8d0c28c7 100644 --- a/src/api/types/TransportCostProvider.ts +++ b/src/api/types/TransportCostProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Telephony or transport provider that generated the cost. */ export const TransportCostProvider = { Daily: "daily", VapiWebsocket: "vapi.websocket", diff --git a/src/api/types/TurnLatency.ts b/src/api/types/TurnLatency.ts index b87e65a4..05299d3a 100644 --- a/src/api/types/TurnLatency.ts +++ b/src/api/types/TurnLatency.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Model, voice, transcription, endpointing, and total latency measurements for a conversation turn. + */ export interface TurnLatency { /** This is the model latency for the first token. */ modelLatency?: number | undefined; diff --git a/src/api/types/TwilioPhoneNumber.ts b/src/api/types/TwilioPhoneNumber.ts index d37b1c1d..8bb6343f 100644 --- a/src/api/types/TwilioPhoneNumber.ts +++ b/src/api/types/TwilioPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata. + */ export interface TwilioPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/TwilioVoicemailDetectionPlan.ts b/src/api/types/TwilioVoicemailDetectionPlan.ts index b0cdbf89..24717207 100644 --- a/src/api/types/TwilioVoicemailDetectionPlan.ts +++ b/src/api/types/TwilioVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech thresholds, and silence timeout. + */ export interface TwilioVoicemailDetectionPlan { /** This is the provider to use for voicemail detection. */ provider: Vapi.TwilioVoicemailDetectionPlanProvider; diff --git a/src/api/types/UpdateApiRequestToolDto.ts b/src/api/types/UpdateApiRequestToolDto.ts index 868b8a45..5bc48341 100644 --- a/src/api/types/UpdateApiRequestToolDto.ts +++ b/src/api/types/UpdateApiRequestToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, and response handling. + */ export interface UpdateApiRequestToolDto { /** * These are the messages that will be spoken to the user as the tool is running. @@ -9,6 +12,7 @@ export interface UpdateApiRequestToolDto { * For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured. */ messages?: Vapi.UpdateApiRequestToolDtoMessagesItem[] | undefined; + /** The HTTP method used for the API request. */ method?: Vapi.UpdateApiRequestToolDtoMethod | undefined; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. diff --git a/src/api/types/UpdateApiRequestToolDtoMethod.ts b/src/api/types/UpdateApiRequestToolDtoMethod.ts index eb76c8ea..3b832638 100644 --- a/src/api/types/UpdateApiRequestToolDtoMethod.ts +++ b/src/api/types/UpdateApiRequestToolDtoMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const UpdateApiRequestToolDtoMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/UpdateBarInsightFromCallTableDto.ts b/src/api/types/UpdateBarInsightFromCallTableDto.ts index a0cc7baa..3b002ad7 100644 --- a/src/api/types/UpdateBarInsightFromCallTableDto.ts +++ b/src/api/types/UpdateBarInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ export interface UpdateBarInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface UpdateBarInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdateBashToolDto.ts b/src/api/types/UpdateBashToolDto.ts index 8aa76fae..804fa9b1 100644 --- a/src/api/types/UpdateBashToolDto.ts +++ b/src/api/types/UpdateBashToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan. + */ export interface UpdateBashToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateByoPhoneNumberDto.ts b/src/api/types/UpdateByoPhoneNumberDto.ts index fbdaef7b..ae6d13e5 100644 --- a/src/api/types/UpdateByoPhoneNumberDto.ts +++ b/src/api/types/UpdateByoPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateByoPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateComputerToolDto.ts b/src/api/types/UpdateComputerToolDto.ts index 3f116acb..22c182df 100644 --- a/src/api/types/UpdateComputerToolDto.ts +++ b/src/api/types/UpdateComputerToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan. + */ export interface UpdateComputerToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateDtmfToolDto.ts b/src/api/types/UpdateDtmfToolDto.ts index 6d5d0aa9..18fc7e81 100644 --- a/src/api/types/UpdateDtmfToolDto.ts +++ b/src/api/types/UpdateDtmfToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior. + */ export interface UpdateDtmfToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateEndCallToolDto.ts b/src/api/types/UpdateEndCallToolDto.ts index fae27240..1f8fd250 100644 --- a/src/api/types/UpdateEndCallToolDto.ts +++ b/src/api/types/UpdateEndCallToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an end-call tool, including its spoken messages and rejection plan. + */ export interface UpdateEndCallToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateFunctionToolDto.ts b/src/api/types/UpdateFunctionToolDto.ts index a3fe5909..b69e3c30 100644 --- a/src/api/types/UpdateFunctionToolDto.ts +++ b/src/api/types/UpdateFunctionToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior. + */ export interface UpdateFunctionToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts b/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts index 5036ecf3..d9dda5b3 100644 --- a/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts +++ b/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelCalendarAvailabilityToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts b/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts index f7a8120f..7faf2923 100644 --- a/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts +++ b/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelCalendarEventCreateToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts b/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts index 2321d337..58f66ce8 100644 --- a/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts +++ b/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelContactCreateToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoHighLevelContactGetToolDto.ts b/src/api/types/UpdateGoHighLevelContactGetToolDto.ts index 2e1acbf7..727b3b25 100644 --- a/src/api/types/UpdateGoHighLevelContactGetToolDto.ts +++ b/src/api/types/UpdateGoHighLevelContactGetToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelContactGetToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts b/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts index a4b725eb..c3b2cc0b 100644 --- a/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts +++ b/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleCalendarCheckAvailabilityToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts b/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts index a30f4c18..c50a3351 100644 --- a/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts +++ b/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleCalendarCreateEventToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts b/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts index 634f674f..abe4de29 100644 --- a/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts +++ b/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleSheetsRowAppendToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateHandoffToolDto.ts b/src/api/types/UpdateHandoffToolDto.ts index 4a114c6e..4a589024 100644 --- a/src/api/types/UpdateHandoffToolDto.ts +++ b/src/api/types/UpdateHandoffToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan. + */ export interface UpdateHandoffToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateLineInsightFromCallTableDto.ts b/src/api/types/UpdateLineInsightFromCallTableDto.ts index 88ec4d5b..4689a71c 100644 --- a/src/api/types/UpdateLineInsightFromCallTableDto.ts +++ b/src/api/types/UpdateLineInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ export interface UpdateLineInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface UpdateLineInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdateMcpToolDto.ts b/src/api/types/UpdateMcpToolDto.ts index 8f8d05fa..743d08fb 100644 --- a/src/api/types/UpdateMcpToolDto.ts +++ b/src/api/types/UpdateMcpToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan. + */ export interface UpdateMcpToolDto { /** * These are the messages that will be spoken to the user as the tool is running. @@ -103,5 +106,6 @@ export interface UpdateMcpToolDto { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; } diff --git a/src/api/types/UpdatePieInsightFromCallTableDto.ts b/src/api/types/UpdatePieInsightFromCallTableDto.ts index b34cacb0..eac95df4 100644 --- a/src/api/types/UpdatePieInsightFromCallTableDto.ts +++ b/src/api/types/UpdatePieInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name. + */ export interface UpdatePieInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface UpdatePieInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdateQueryToolDto.ts b/src/api/types/UpdateQueryToolDto.ts index 09f56462..647d206a 100644 --- a/src/api/types/UpdateQueryToolDto.ts +++ b/src/api/types/UpdateQueryToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan. + */ export interface UpdateQueryToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateSipRequestToolDto.ts b/src/api/types/UpdateSipRequestToolDto.ts index f62db805..4969e999 100644 --- a/src/api/types/UpdateSipRequestToolDto.ts +++ b/src/api/types/UpdateSipRequestToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan. + */ export interface UpdateSipRequestToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateSlackSendMessageToolDto.ts b/src/api/types/UpdateSlackSendMessageToolDto.ts index e5d9fda2..2e06ec14 100644 --- a/src/api/types/UpdateSlackSendMessageToolDto.ts +++ b/src/api/types/UpdateSlackSendMessageToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Slack message tool, including its spoken messages and rejection plan. + */ export interface UpdateSlackSendMessageToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateSmsToolDto.ts b/src/api/types/UpdateSmsToolDto.ts index 5f1db8d9..717dfae0 100644 --- a/src/api/types/UpdateSmsToolDto.ts +++ b/src/api/types/UpdateSmsToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an SMS tool, including its spoken messages and rejection plan. + */ export interface UpdateSmsToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateTelnyxPhoneNumberDto.ts b/src/api/types/UpdateTelnyxPhoneNumberDto.ts index a15de859..4d01888d 100644 --- a/src/api/types/UpdateTelnyxPhoneNumberDto.ts +++ b/src/api/types/UpdateTelnyxPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateTelnyxPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateTextEditorToolDto.ts b/src/api/types/UpdateTextEditorToolDto.ts index ab8b1036..1d226e3b 100644 --- a/src/api/types/UpdateTextEditorToolDto.ts +++ b/src/api/types/UpdateTextEditorToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan. + */ export interface UpdateTextEditorToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateTextInsightFromCallTableDto.ts b/src/api/types/UpdateTextInsightFromCallTableDto.ts index 57f45b7c..a8b97d99 100644 --- a/src/api/types/UpdateTextInsightFromCallTableDto.ts +++ b/src/api/types/UpdateTextInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a text-value insight, including its queries, formula, time range, and name. + */ export interface UpdateTextInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface UpdateTextInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. diff --git a/src/api/types/UpdateTransferCallToolDto.ts b/src/api/types/UpdateTransferCallToolDto.ts index a70e45a9..47c92dcc 100644 --- a/src/api/types/UpdateTransferCallToolDto.ts +++ b/src/api/types/UpdateTransferCallToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan. + */ export interface UpdateTransferCallToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateTwilioPhoneNumberDto.ts b/src/api/types/UpdateTwilioPhoneNumberDto.ts index e1f0ccdc..ca802412 100644 --- a/src/api/types/UpdateTwilioPhoneNumberDto.ts +++ b/src/api/types/UpdateTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings. + */ export interface UpdateTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateVapiPhoneNumberDto.ts b/src/api/types/UpdateVapiPhoneNumberDto.ts index 65fdce29..adbcceee 100644 --- a/src/api/types/UpdateVapiPhoneNumberDto.ts +++ b/src/api/types/UpdateVapiPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings. + */ export interface UpdateVapiPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateVoicemailToolDto.ts b/src/api/types/UpdateVoicemailToolDto.ts index cce6fd97..39f05a52 100644 --- a/src/api/types/UpdateVoicemailToolDto.ts +++ b/src/api/types/UpdateVoicemailToolDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan. + */ export interface UpdateVoicemailToolDto { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/UpdateVonagePhoneNumberDto.ts b/src/api/types/UpdateVonagePhoneNumberDto.ts index e913675e..cadc42c9 100644 --- a/src/api/types/UpdateVonagePhoneNumberDto.ts +++ b/src/api/types/UpdateVonagePhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateVonagePhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UserMessage.ts b/src/api/types/UserMessage.ts index bf2b2a67..d6a7bf3e 100644 --- a/src/api/types/UserMessage.ts +++ b/src/api/types/UserMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A user-authored entry in the call message history, including content, timing, security-filter results, and optional speaker metadata. + */ export interface UserMessage { /** The role of the user in the conversation. */ role: string; diff --git a/src/api/types/VapiCost.ts b/src/api/types/VapiCost.ts index 9c08b1f2..9c8565c1 100644 --- a/src/api/types/VapiCost.ts +++ b/src/api/types/VapiCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Vapi platform cost for a call, including cost subtype, billable minutes, and amount. + */ export interface VapiCost { /** This is the sub type of the cost. */ subType: Vapi.VapiCostSubType; diff --git a/src/api/types/VapiPhoneNumber.ts b/src/api/types/VapiPhoneNumber.ts index 2046233e..bcb0a328 100644 --- a/src/api/types/VapiPhoneNumber.ts +++ b/src/api/types/VapiPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata. + */ export interface VapiPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/VapiPronunciationDictionaryLocator.ts b/src/api/types/VapiPronunciationDictionaryLocator.ts index 89ae4b33..f5e641e0 100644 --- a/src/api/types/VapiPronunciationDictionaryLocator.ts +++ b/src/api/types/VapiPronunciationDictionaryLocator.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Identifies a pronunciation dictionary and optional version used for voice synthesis. + */ export interface VapiPronunciationDictionaryLocator { /** The pronunciation dictionary ID */ pronunciationDictId: string; diff --git a/src/api/types/VapiSmartEndpointingPlan.ts b/src/api/types/VapiSmartEndpointingPlan.ts index f8e2cdcc..94fe1763 100644 --- a/src/api/types/VapiSmartEndpointingPlan.ts +++ b/src/api/types/VapiSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects Vapi smart endpointing to determine when customer speech is complete. + */ export interface VapiSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. */ provider: Vapi.VapiSmartEndpointingPlanProvider; diff --git a/src/api/types/VapiVoice.ts b/src/api/types/VapiVoice.ts index 3da0134b..8ad72ede 100644 --- a/src/api/types/VapiVoice.ts +++ b/src/api/types/VapiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, caching, and fallback settings. + */ export interface VapiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/VapiVoicemailDetectionPlan.ts b/src/api/types/VapiVoicemailDetectionPlan.ts index e36604c3..9ca27d1c 100644 --- a/src/api/types/VapiVoicemailDetectionPlan.ts +++ b/src/api/types/VapiVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff. + */ export interface VapiVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/VariableExtractionAlias.ts b/src/api/types/VariableExtractionAlias.ts index c78571ee..bbaa121c 100644 --- a/src/api/types/VariableExtractionAlias.ts +++ b/src/api/types/VariableExtractionAlias.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Defines an additional Liquid-based variable from values extracted during a call. + */ export interface VariableExtractionAlias { /** * This is the key of the variable. diff --git a/src/api/types/VariableExtractionPlan.ts b/src/api/types/VariableExtractionPlan.ts index c859c28c..c95c9f7d 100644 --- a/src/api/types/VariableExtractionPlan.ts +++ b/src/api/types/VariableExtractionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Defines structured variables to extract and optional aliases made available during and after a call. + */ export interface VariableExtractionPlan { /** * This is the schema to extract. diff --git a/src/api/types/VariableValueGroupBy.ts b/src/api/types/VariableValueGroupBy.ts index f03c5aa2..9cc96320 100644 --- a/src/api/types/VariableValueGroupBy.ts +++ b/src/api/types/VariableValueGroupBy.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Groups analytics results by a selected assistant variable-value key. + */ export interface VariableValueGroupBy { /** This is the key of the variable value to group by. */ key: string; diff --git a/src/api/types/VoiceCost.ts b/src/api/types/VoiceCost.ts index 8021d3b0..c2a75a94 100644 --- a/src/api/types/VoiceCost.ts +++ b/src/api/types/VoiceCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Voice-synthesis cost for a call, including voice, character usage, and amount. + */ export interface VoiceCost { /** * This is the voice that was used during the call. diff --git a/src/api/types/VoicemailDetectionBackoffPlan.ts b/src/api/types/VoicemailDetectionBackoffPlan.ts index 80858217..61bf9d69 100644 --- a/src/api/types/VoicemailDetectionBackoffPlan.ts +++ b/src/api/types/VoicemailDetectionBackoffPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts. + */ export interface VoicemailDetectionBackoffPlan { /** This is the number of seconds to wait before starting the first retry attempt. */ startAtSeconds?: number | undefined; diff --git a/src/api/types/VoicemailDetectionCost.ts b/src/api/types/VoicemailDetectionCost.ts index 52aabc09..0acde3af 100644 --- a/src/api/types/VoicemailDetectionCost.ts +++ b/src/api/types/VoicemailDetectionCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Voicemail-detection model cost, including provider, model, multimodal token usage, and amount. + */ export interface VoicemailDetectionCost { /** This is the model that was used to perform the analysis. */ model: Record; diff --git a/src/api/types/VoicemailTool.ts b/src/api/types/VoicemailTool.ts index 9ecbc7dd..d5fed235 100644 --- a/src/api/types/VoicemailTool.ts +++ b/src/api/types/VoicemailTool.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A reusable voicemail-detection tool with optional beep detection for supported calls. + */ export interface VoicemailTool { /** * These are the messages that will be spoken to the user as the tool is running. diff --git a/src/api/types/VonagePhoneNumber.ts b/src/api/types/VonagePhoneNumber.ts index c555996f..77cea813 100644 --- a/src/api/types/VonagePhoneNumber.ts +++ b/src/api/types/VonagePhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface VonagePhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/WellSaidVoice.ts b/src/api/types/WellSaidVoice.ts index 45a584d4..6421a743 100644 --- a/src/api/types/WellSaidVoice.ts +++ b/src/api/types/WellSaidVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, caching, and fallback settings. + */ export interface WellSaidVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/WorkflowAnthropicBedrockModel.ts b/src/api/types/WorkflowAnthropicBedrockModel.ts index 592c0f45..5fc117e2 100644 --- a/src/api/types/WorkflowAnthropicBedrockModel.ts +++ b/src/api/types/WorkflowAnthropicBedrockModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, temperature, and maximum output tokens. + */ export interface WorkflowAnthropicBedrockModel { /** This is the specific model that will be used. */ model: Vapi.WorkflowAnthropicBedrockModelModel; diff --git a/src/api/types/WorkflowAnthropicModel.ts b/src/api/types/WorkflowAnthropicModel.ts index 6f4437f2..fa8fbcb5 100644 --- a/src/api/types/WorkflowAnthropicModel.ts +++ b/src/api/types/WorkflowAnthropicModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output tokens. + */ export interface WorkflowAnthropicModel { /** This is the specific model that will be used. */ model: Vapi.WorkflowAnthropicModelModel; diff --git a/src/api/types/WorkflowCustomModel.ts b/src/api/types/WorkflowCustomModel.ts index 7daaf2c9..d0127e69 100644 --- a/src/api/types/WorkflowCustomModel.ts +++ b/src/api/types/WorkflowCustomModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, timeout, model, temperature, and maximum output tokens. + */ export interface WorkflowCustomModel { /** * This determines whether metadata is sent in requests to the custom provider. diff --git a/src/api/types/WorkflowGoogleModel.ts b/src/api/types/WorkflowGoogleModel.ts index dccd5350..77a9ff1f 100644 --- a/src/api/types/WorkflowGoogleModel.ts +++ b/src/api/types/WorkflowGoogleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Google, including model selection, temperature, and maximum output tokens. + */ export interface WorkflowGoogleModel { /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.WorkflowGoogleModelModel; diff --git a/src/api/types/WorkflowOpenAiModel.ts b/src/api/types/WorkflowOpenAiModel.ts index e7c46422..d96f6e55 100644 --- a/src/api/types/WorkflowOpenAiModel.ts +++ b/src/api/types/WorkflowOpenAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens. + */ export interface WorkflowOpenAiModel { /** * This is the OpenAI model that will be used. diff --git a/src/api/types/WorkflowOverrides.ts b/src/api/types/WorkflowOverrides.ts index c627b7b5..2f335ca3 100644 --- a/src/api/types/WorkflowOverrides.ts +++ b/src/api/types/WorkflowOverrides.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Per-call overrides for values used in workflow template variables. + */ export interface WorkflowOverrides { /** * These are values that will be used to replace the template variables in the workflow messages and other text-based fields. diff --git a/src/api/types/XaiModel.ts b/src/api/types/XaiModel.ts index 0b11639f..9cf908a1 100644 --- a/src/api/types/XaiModel.ts +++ b/src/api/types/XaiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface XaiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; diff --git a/src/api/types/XssSecurityFilter.ts b/src/api/types/XssSecurityFilter.ts index 4e98e6bb..374b1013 100644 --- a/src/api/types/XssSecurityFilter.ts +++ b/src/api/types/XssSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential cross-site scripting (XSS) patterns from transcripts. + */ export interface XssSecurityFilter { /** The type of security threat to filter. */ type: Vapi.XssSecurityFilterType; diff --git a/src/version.ts b/src/version.ts index 478f50d1..02d1eb13 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.0.0"; +export const SDK_VERSION = "0.0.0-fern-placeholder"; From a045cb26dc1cf1863721f64dcdae6cc2931932bb Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 16:34:09 +0000 Subject: [PATCH 2/4] [fern-autoversion] chore: add JSDoc descriptions across API types and client methods MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds descriptive JSDoc comments to all major API types and resource client methods throughout the SDK. This improves IDE hover documentation and makes the SDK easier to explore without consulting external docs. Also adds new optional field documentation for `UpdateAssistantDto` and `InsightRunDto`, and updates `.fernignore` with additional ignored files. Key changes: - Added interface-level JSDoc summaries to types including `BackoffPlan`, `MonitorPlan`, `AnalysisPlan`, `AnthropicModel`, `AnthropicBedrockModel`, and many more - Added method-level JSDoc descriptions to all CRUD operations across every resource client (assistants, calls, campaigns, eval, files, insight, phone numbers, squads, tools, etc.) - Added inline field documentation for `firstMessageInterruptionsEnabled`, `compliancePlan`, and `keypadInputPlan` in `UpdateAssistantDto`, and `formatPlan` in `InsightRunDto` 🌿 Generated with Fern --- .fern/metadata.json | 2 +- package.json | 2 +- src/BaseClient.ts | 4 ++-- src/version.ts | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.fern/metadata.json b/.fern/metadata.json index a5662825..9489ee3f 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -16,5 +16,5 @@ "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "0.0.0-fern-placeholder" + "sdkVersion": "2.0.1" } diff --git a/package.json b/package.json index 3bb757ef..912595a2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vapi-ai/server-sdk", - "version": "0.0.0-fern-placeholder", + "version": "2.0.1", "private": false, "repository": { "type": "git", diff --git a/src/BaseClient.ts b/src/BaseClient.ts index 0cbc606c..57a9cccf 100644 --- a/src/BaseClient.ts +++ b/src/BaseClient.ts @@ -52,8 +52,8 @@ export function normalizeClientOptions Date: Wed, 22 Jul 2026 16:34:09 +0000 Subject: [PATCH 3/4] [fern-replay] advance lockfile --- .fern/replay.lock | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.fern/replay.lock b/.fern/replay.lock index 216d1276..16daab09 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -6,5 +6,11 @@ generations: timestamp: 2026-07-22T16:33:45.572Z cli_version: unknown generator_versions: {} -current_generation: a1c6092cc00dca56259110e7ad5d14b616d25ed5 + - commit_sha: 9614e930778e21f4f73cf8fcdac8b730f9d2187f + tree_hash: de9bb72ea3ce63d849749a4c6ee0100edff7dab3 + timestamp: 2026-07-22T16:33:46.171Z + cli_version: unknown + generator_versions: + fernapi/fern-typescript-sdk: 3.63.0 +current_generation: 9614e930778e21f4f73cf8fcdac8b730f9d2187f patches: [] From 0f922ae3dd3fdee9f10ef9eda7d577021f0f8dce Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 16:34:10 +0000 Subject: [PATCH 4/4] chore: add JSDoc descriptions across API types and client methods MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds descriptive JSDoc comments to all major API types and resource client methods throughout the SDK. This improves IDE hover documentation and makes the SDK easier to explore without consulting external docs. Also adds new optional field documentation for `UpdateAssistantDto` and `InsightRunDto`, and updates `.fernignore` with additional ignored files. Key changes: - Added interface-level JSDoc summaries to types including `BackoffPlan`, `MonitorPlan`, `AnalysisPlan`, `AnthropicModel`, `AnthropicBedrockModel`, and many more - Added method-level JSDoc descriptions to all CRUD operations across every resource client (assistants, calls, campaigns, eval, files, insight, phone numbers, squads, tools, etc.) - Added inline field documentation for `firstMessageInterruptionsEnabled`, `compliancePlan`, and `keypadInputPlan` in `UpdateAssistantDto`, and `formatPlan` in `InsightRunDto` 🌿 Generated with Fern --- changelog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/changelog.md b/changelog.md index 1813cfb9..5a4fc7d3 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,5 @@ +## [2.0.1] - 2026-07-22 + ## 2.0.0 - 2026-06-24 ### Breaking Changes * **`CartesiaExperimentalControlsSpeedZero`** has been removed and replaced by **`CartesiaSpeedControlZero`**, which carries the same `"slowest" | "slow" | "normal" | "fast" | "fastest"` values. Update any imports or references from `CartesiaExperimentalControlsSpeedZero` to `CartesiaSpeedControlZero`.