From fd64a81b5880f19401cd2ac2f9e3d48103a841f8 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:33:55 +0000 Subject: [PATCH 1/4] [fern-generated] Update SDK Generated by Fern CLI Version: unknown Generators: - fernapi/fern-csharp-sdk: 2.58.0 --- .fern/metadata.json | 6 +-- .fern/replay.lock | 10 +++++ .fernignore | 3 ++ .gitattributes | 1 + src/Vapi.Net/Analytics/AnalyticsClient.cs | 3 ++ src/Vapi.Net/Analytics/IAnalyticsClient.cs | 3 ++ src/Vapi.Net/Assistants/AssistantsClient.cs | 15 +++++++ src/Vapi.Net/Assistants/IAssistantsClient.cs | 15 +++++++ .../Assistants/Requests/UpdateAssistantDto.cs | 9 ++++ src/Vapi.Net/Calls/CallsClient.cs | 15 +++++++ src/Vapi.Net/Calls/ICallsClient.cs | 15 +++++++ src/Vapi.Net/Campaigns/CampaignsClient.cs | 15 +++++++ src/Vapi.Net/Campaigns/ICampaignsClient.cs | 15 +++++++ src/Vapi.Net/Core/Public/Version.cs | 2 +- src/Vapi.Net/Eval/EvalClient.cs | 27 ++++++++++++ src/Vapi.Net/Eval/IEvalClient.cs | 27 ++++++++++++ src/Vapi.Net/Files/FilesClient.cs | 15 +++++++ src/Vapi.Net/Files/IFilesClient.cs | 15 +++++++ src/Vapi.Net/Insight/IInsightClient.cs | 21 ++++++++++ src/Vapi.Net/Insight/InsightClient.cs | 21 ++++++++++ .../Insight/Requests/InsightRunDto.cs | 3 ++ .../IObservabilityScorecardClient.cs | 15 +++++++ .../ObservabilityScorecardClient.cs | 15 +++++++ .../PhoneNumbers/IPhoneNumbersClient.cs | 18 ++++++++ .../PhoneNumbers/PhoneNumbersClient.cs | 18 ++++++++ .../IProviderResourcesClient.cs | 15 +++++++ .../ProviderResourcesClient.cs | 15 +++++++ src/Vapi.Net/Squads/ISquadsClient.cs | 15 +++++++ src/Vapi.Net/Squads/SquadsClient.cs | 15 +++++++ .../IStructuredOutputsClient.cs | 18 ++++++++ .../StructuredOutputsClient.cs | 18 ++++++++ src/Vapi.Net/Tools/IToolsClient.cs | 15 +++++++ src/Vapi.Net/Tools/ToolsClient.cs | 15 +++++++ src/Vapi.Net/Types/AiEdgeCondition.cs | 6 +++ src/Vapi.Net/Types/Analysis.cs | 3 ++ src/Vapi.Net/Types/AnalysisCost.cs | 3 ++ src/Vapi.Net/Types/AnalysisCostBreakdown.cs | 3 ++ src/Vapi.Net/Types/AnalysisPlan.cs | 3 ++ src/Vapi.Net/Types/AnalyticsOperation.cs | 3 ++ src/Vapi.Net/Types/AnalyticsQuery.cs | 3 ++ src/Vapi.Net/Types/AnalyticsQueryResult.cs | 3 ++ src/Vapi.Net/Types/AnthropicBedrockModel.cs | 3 ++ src/Vapi.Net/Types/AnthropicModel.cs | 3 ++ src/Vapi.Net/Types/AnthropicThinkingConfig.cs | 6 +++ src/Vapi.Net/Types/AnyscaleModel.cs | 3 ++ src/Vapi.Net/Types/ApiRequestTool.cs | 6 +++ src/Vapi.Net/Types/Artifact.cs | 3 ++ src/Vapi.Net/Types/ArtifactPlan.cs | 3 ++ src/Vapi.Net/Types/AssemblyAiTranscriber.cs | 3 ++ src/Vapi.Net/Types/Assistant.cs | 12 ++++++ src/Vapi.Net/Types/AssistantActivation.cs | 3 ++ .../Types/AssistantCustomEndpointingRule.cs | 3 ++ src/Vapi.Net/Types/AssistantMessage.cs | 3 ++ .../AssistantMessageEvaluationContinuePlan.cs | 3 ++ .../Types/AssistantMessageJudgePlanAi.cs | 3 ++ .../Types/AssistantMessageJudgePlanExact.cs | 3 ++ .../Types/AssistantMessageJudgePlanRegex.cs | 3 ++ src/Vapi.Net/Types/AssistantOverrides.cs | 15 +++++++ .../Types/AwsStsAuthenticationPlan.cs | 3 ++ .../AwsiamCredentialsAuthenticationPlan.cs | 3 ++ .../Types/AzureBlobStorageBucketPlan.cs | 3 ++ src/Vapi.Net/Types/AzureSpeechTranscriber.cs | 3 ++ src/Vapi.Net/Types/AzureVoice.cs | 3 ++ .../Types/BackgroundSpeechDenoisingPlan.cs | 3 ++ src/Vapi.Net/Types/BackoffPlan.cs | 8 ++-- src/Vapi.Net/Types/BarInsight.cs | 6 +++ src/Vapi.Net/Types/BarInsightMetadata.cs | 18 ++++++++ src/Vapi.Net/Types/BashTool.cs | 3 ++ .../Types/BearerAuthenticationPlan.cs | 3 ++ src/Vapi.Net/Types/BotMessage.cs | 3 ++ .../Types/BothCustomEndpointingRule.cs | 6 +++ src/Vapi.Net/Types/BucketPlan.cs | 3 ++ src/Vapi.Net/Types/ByoPhoneNumber.cs | 3 ++ src/Vapi.Net/Types/Call.cs | 6 +++ src/Vapi.Net/Types/CallBatchError.cs | 9 ++++ src/Vapi.Net/Types/CallBatchResponse.cs | 3 ++ .../CallHookAssistantSpeechInterrupted.cs | 3 ++ src/Vapi.Net/Types/CallHookCallEnding.cs | 3 ++ .../CallHookCustomerSpeechInterrupted.cs | 3 ++ .../Types/CallHookCustomerSpeechTimeout.cs | 5 ++- src/Vapi.Net/Types/CallHookFilter.cs | 3 ++ .../Types/CallHookModelResponseTimeout.cs | 3 ++ src/Vapi.Net/Types/Campaign.cs | 3 ++ .../Types/CampaignPaginatedResponse.cs | 9 ++++ .../Types/CartesiaExperimentalControls.cs | 9 ++++ .../Types/CartesiaGenerationConfig.cs | 3 ++ .../CartesiaGenerationConfigExperimental.cs | 3 ++ src/Vapi.Net/Types/CartesiaTranscriber.cs | 9 ++++ src/Vapi.Net/Types/CartesiaVoice.cs | 3 ++ src/Vapi.Net/Types/CerebrasModel.cs | 3 ++ .../ChatEvalAssistantMessageEvaluation.cs | 3 ++ .../Types/ChatEvalAssistantMessageMock.cs | 3 ++ .../ChatEvalAssistantMessageMockToolCall.cs | 3 ++ .../Types/ChatEvalSystemMessageMock.cs | 3 ++ .../ChatEvalToolResponseMessageEvaluation.cs | 3 ++ .../Types/ChatEvalToolResponseMessageMock.cs | 3 ++ src/Vapi.Net/Types/ChatEvalUserMessageMock.cs | 3 ++ src/Vapi.Net/Types/ChunkPlan.cs | 3 ++ src/Vapi.Net/Types/CloudflareR2BucketPlan.cs | 3 ++ src/Vapi.Net/Types/CodeTool.cs | 3 ++ .../Types/CodeToolEnvironmentVariable.cs | 3 ++ src/Vapi.Net/Types/Compliance.cs | 3 ++ src/Vapi.Net/Types/ComplianceOverride.cs | 3 ++ src/Vapi.Net/Types/CompliancePlan.cs | 6 +++ src/Vapi.Net/Types/ComputerTool.cs | 3 ++ src/Vapi.Net/Types/Condition.cs | 3 ++ .../Types/ContextEngineeringPlanAll.cs | 3 ++ .../ContextEngineeringPlanLastNMessages.cs | 3 ++ .../Types/ContextEngineeringPlanNone.cs | 3 ++ ...EngineeringPlanUserAndAssistantMessages.cs | 3 ++ src/Vapi.Net/Types/ConversationNode.cs | 9 ++++ src/Vapi.Net/Types/CostBreakdown.cs | 3 ++ .../CreateAnthropicBedrockCredentialDto.cs | 3 ++ .../Types/CreateAnthropicCredentialDto.cs | 3 ++ .../Types/CreateAnyscaleCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateApiRequestToolDto.cs | 6 +++ .../Types/CreateAssemblyAiCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateAssistantDto.cs | 12 ++++++ .../Types/CreateAzureCredentialDto.cs | 3 ++ .../Types/CreateAzureOpenAiCredentialDto.cs | 12 ++++++ .../Types/CreateBarInsightFromCallTableDto.cs | 6 +++ src/Vapi.Net/Types/CreateBashToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateByoPhoneNumberDto.cs | 3 ++ .../Types/CreateByoSipTrunkCredentialDto.cs | 3 ++ .../Types/CreateCartesiaCredentialDto.cs | 3 ++ .../Types/CreateCerebrasCredentialDto.cs | 3 ++ .../Types/CreateCloudflareCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateCodeToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateComputerToolDto.cs | 3 ++ .../Types/CreateCustomCredentialDto.cs | 3 ++ .../Types/CreateCustomKnowledgeBaseDto.cs | 3 ++ .../Types/CreateCustomLlmCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateCustomerDto.cs | 3 ++ .../Types/CreateDeepInfraCredentialDto.cs | 3 ++ .../Types/CreateDeepSeekCredentialDto.cs | 3 ++ .../Types/CreateDeepgramCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateDtmfToolDto.cs | 3 ++ .../Types/CreateElevenLabsCredentialDto.cs | 3 ++ .../Types/CreateEmailCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateEndCallToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateEvalDto.cs | 3 ++ src/Vapi.Net/Types/CreateFunctionToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateGcpCredentialDto.cs | 6 +++ .../Types/CreateGladiaCredentialDto.cs | 3 ++ ...eGoHighLevelCalendarAvailabilityToolDto.cs | 3 ++ ...teGoHighLevelCalendarEventCreateToolDto.cs | 3 ++ .../CreateGoHighLevelContactCreateToolDto.cs | 3 ++ .../CreateGoHighLevelContactGetToolDto.cs | 3 ++ .../Types/CreateGoHighLevelCredentialDto.cs | 3 ++ .../CreateGoHighLevelMcpCredentialDto.cs | 3 ++ ...eGoogleCalendarCheckAvailabilityToolDto.cs | 3 ++ .../CreateGoogleCalendarCreateEventToolDto.cs | 3 ++ ...alendarOAuth2AuthorizationCredentialDto.cs | 3 ++ ...GoogleCalendarOAuth2ClientCredentialDto.cs | 3 ++ .../Types/CreateGoogleCredentialDto.cs | 3 ++ ...eSheetsOAuth2AuthorizationCredentialDto.cs | 3 ++ .../CreateGoogleSheetsRowAppendToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateGroqCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateHandoffToolDto.cs | 3 ++ src/Vapi.Net/Types/CreateHumeCredentialDto.cs | 3 ++ .../Types/CreateInflectionAiCredentialDto.cs | 3 ++ .../Types/CreateInworldCredentialDto.cs | 3 ++ .../Types/CreateLangfuseCredentialDto.cs | 3 ++ .../CreateLineInsightFromCallTableDto.cs | 6 +++ src/Vapi.Net/Types/CreateLmntCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateMakeCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateMcpToolDto.cs | 6 +++ .../Types/CreateMinimaxCredentialDto.cs | 3 ++ .../Types/CreateMistralCredentialDto.cs | 3 ++ .../Types/CreateNeuphonicCredentialDto.cs | 3 ++ .../Types/CreateOpenAiCredentialDto.cs | 3 ++ .../Types/CreateOpenRouterCredentialDto.cs | 3 ++ .../Types/CreatePerplexityAiCredentialDto.cs | 3 ++ .../Types/CreatePieInsightFromCallTableDto.cs | 6 +++ .../Types/CreatePlayHtCredentialDto.cs | 6 +++ src/Vapi.Net/Types/CreateQueryToolDto.cs | 3 ++ .../Types/CreateRimeAiCredentialDto.cs | 3 ++ .../Types/CreateRunpodCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateS3CredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateScorecardDto.cs | 3 ++ src/Vapi.Net/Types/CreateSipRequestToolDto.cs | 3 ++ ...teSlackOAuth2AuthorizationCredentialDto.cs | 3 ++ .../Types/CreateSlackSendMessageToolDto.cs | 3 ++ .../Types/CreateSlackWebhookCredentialDto.cs | 3 ++ .../Types/CreateSmallestAiCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateSmsToolDto.cs | 3 ++ .../Types/CreateSonioxCredentialDto.cs | 3 ++ .../Types/CreateSpeechmaticsCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateSquadDto.cs | 3 ++ .../Types/CreateStructuredOutputDto.cs | 3 ++ .../Types/CreateSupabaseCredentialDto.cs | 6 +++ .../Types/CreateTavusCredentialDto.cs | 3 ++ .../Types/CreateTelnyxPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/CreateTextEditorToolDto.cs | 3 ++ .../CreateTextInsightFromCallTableDto.cs | 6 +++ .../Types/CreateTogetherAiCredentialDto.cs | 3 ++ .../Types/CreateTransferCallToolDto.cs | 3 ++ .../Types/CreateTrieveCredentialDto.cs | 3 ++ .../Types/CreateTwilioCredentialDto.cs | 6 +++ .../Types/CreateTwilioPhoneNumberDto.cs | 3 ++ .../Types/CreateVapiPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/CreateVoicemailToolDto.cs | 3 ++ .../Types/CreateVonageCredentialDto.cs | 6 +++ .../Types/CreateVonagePhoneNumberDto.cs | 3 ++ .../Types/CreateWellSaidCredentialDto.cs | 3 ++ src/Vapi.Net/Types/CreateWorkflowDto.cs | 15 +++++++ src/Vapi.Net/Types/CreateXAiCredentialDto.cs | 3 ++ ...tomEndpointingModelSmartEndpointingPlan.cs | 3 ++ src/Vapi.Net/Types/CustomLlmModel.cs | 3 ++ src/Vapi.Net/Types/CustomMessage.cs | 3 ++ src/Vapi.Net/Types/CustomTranscriber.cs | 3 ++ src/Vapi.Net/Types/CustomVoice.cs | 3 ++ .../Types/CustomerCustomEndpointingRule.cs | 3 ++ .../Types/CustomerSpeechTimeoutOptions.cs | 7 ++-- src/Vapi.Net/Types/DeepInfraModel.cs | 3 ++ src/Vapi.Net/Types/DeepSeekModel.cs | 3 ++ src/Vapi.Net/Types/DeepgramTranscriber.cs | 3 ++ src/Vapi.Net/Types/DeepgramVoice.cs | 3 ++ src/Vapi.Net/Types/DeveloperMessage.cs | 3 ++ src/Vapi.Net/Types/DialPlanEntry.cs | 3 ++ src/Vapi.Net/Types/DtmfTool.cs | 3 ++ src/Vapi.Net/Types/Edge.cs | 12 ++++++ ...levenLabsPronunciationDictionaryLocator.cs | 3 ++ src/Vapi.Net/Types/ElevenLabsTranscriber.cs | 3 ++ src/Vapi.Net/Types/ElevenLabsVoice.cs | 3 ++ src/Vapi.Net/Types/EndCallTool.cs | 3 ++ src/Vapi.Net/Types/Eval.cs | 15 +++++++ src/Vapi.Net/Types/EvalAnthropicModel.cs | 3 ++ src/Vapi.Net/Types/EvalCustomModel.cs | 3 ++ src/Vapi.Net/Types/EvalGoogleModel.cs | 3 ++ src/Vapi.Net/Types/EvalOpenAiModel.cs | 3 ++ src/Vapi.Net/Types/EvalPaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/EvalRun.cs | 18 ++++++++ .../Types/EvalRunPaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/EvalRunResult.cs | 3 ++ src/Vapi.Net/Types/EvalRunTargetAssistant.cs | 3 ++ src/Vapi.Net/Types/EvalRunTargetSquad.cs | 3 ++ .../Types/EventsTableBooleanCondition.cs | 3 ++ .../Types/EventsTableNumberCondition.cs | 3 ++ .../Types/EventsTableStringCondition.cs | 3 ++ src/Vapi.Net/Types/ExactReplacement.cs | 3 ++ .../Types/FallbackAssemblyAiTranscriber.cs | 3 ++ .../Types/FallbackAzureSpeechTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackAzureVoice.cs | 3 ++ .../Types/FallbackCartesiaTranscriber.cs | 9 ++++ src/Vapi.Net/Types/FallbackCartesiaVoice.cs | 3 ++ .../Types/FallbackCustomTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackCustomVoice.cs | 3 ++ .../Types/FallbackDeepgramTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackDeepgramVoice.cs | 3 ++ .../Types/FallbackElevenLabsTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackElevenLabsVoice.cs | 3 ++ .../Types/FallbackGladiaTranscriber.cs | 3 ++ .../Types/FallbackGoogleTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackHumeVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackInworldVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackLmntVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackNeuphonicVoice.cs | 3 ++ .../Types/FallbackOpenAiTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackOpenAiVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackPlan.cs | 3 ++ src/Vapi.Net/Types/FallbackPlayHtVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackRimeAiVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackSesameVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackSmallestAiVoice.cs | 3 ++ .../Types/FallbackSonioxTranscriber.cs | 3 ++ .../Types/FallbackSpeechmaticsTranscriber.cs | 9 ++++ .../Types/FallbackTalkscriberTranscriber.cs | 3 ++ src/Vapi.Net/Types/FallbackTavusVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackTranscriberPlan.cs | 6 +++ src/Vapi.Net/Types/FallbackVapiVoice.cs | 3 ++ src/Vapi.Net/Types/FallbackWellSaidVoice.cs | 3 ++ src/Vapi.Net/Types/File.cs | 42 +++++++++++++++++++ .../Types/FilterDateTypeColumnOnCallTable.cs | 3 ++ .../FilterNumberArrayTypeColumnOnCallTable.cs | 3 ++ .../FilterNumberTypeColumnOnCallTable.cs | 3 ++ .../FilterStringArrayTypeColumnOnCallTable.cs | 3 ++ .../FilterStringTypeColumnOnCallTable.cs | 3 ++ ...FilterStructuredOutputColumnOnCallTable.cs | 3 ++ src/Vapi.Net/Types/FormatPlan.cs | 3 ++ src/Vapi.Net/Types/FourierDenoisingPlan.cs | 3 ++ src/Vapi.Net/Types/FunctionTool.cs | 3 ++ src/Vapi.Net/Types/GcpKey.cs | 3 ++ ...GeminiMultimodalLivePrebuiltVoiceConfig.cs | 6 +++ .../Types/GeminiMultimodalLiveSpeechConfig.cs | 6 +++ .../Types/GeminiMultimodalLiveVoiceConfig.cs | 6 +++ src/Vapi.Net/Types/GhlToolMetadata.cs | 9 ++++ .../Types/GladiaCustomVocabularyConfigDto.cs | 3 ++ src/Vapi.Net/Types/GladiaTranscriber.cs | 3 ++ src/Vapi.Net/Types/GladiaVocabularyItemDto.cs | 3 ++ src/Vapi.Net/Types/GlobalNodePlan.cs | 3 ++ .../GoHighLevelCalendarAvailabilityTool.cs | 3 ++ .../GoHighLevelCalendarEventCreateTool.cs | 3 ++ .../Types/GoHighLevelContactCreateTool.cs | 3 ++ .../Types/GoHighLevelContactGetTool.cs | 3 ++ .../GoogleCalendarCheckAvailabilityTool.cs | 3 ++ .../Types/GoogleCalendarCreateEventTool.cs | 3 ++ src/Vapi.Net/Types/GoogleModel.cs | 3 ++ src/Vapi.Net/Types/GoogleRealtimeConfig.cs | 3 ++ .../Types/GoogleSheetsRowAppendTool.cs | 3 ++ src/Vapi.Net/Types/GoogleTranscriber.cs | 3 ++ .../Types/GoogleVoicemailDetectionPlan.cs | 3 ++ src/Vapi.Net/Types/GroqModel.cs | 3 ++ src/Vapi.Net/Types/GroupCondition.cs | 3 ++ .../Types/HandoffDestinationAssistant.cs | 6 +++ .../Types/HandoffDestinationDynamic.cs | 3 ++ src/Vapi.Net/Types/HandoffDestinationSquad.cs | 3 ++ src/Vapi.Net/Types/HandoffTool.cs | 3 ++ src/Vapi.Net/Types/HmacAuthenticationPlan.cs | 3 ++ src/Vapi.Net/Types/HumeVoice.cs | 3 ++ .../Types/ImportTwilioPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/InflectionAiModel.cs | 3 ++ src/Vapi.Net/Types/Insight.cs | 3 ++ src/Vapi.Net/Types/InsightFormula.cs | 3 ++ .../Types/InsightPaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/InsightRunFormatPlan.cs | 3 ++ src/Vapi.Net/Types/InsightRunResponse.cs | 18 ++++++++ src/Vapi.Net/Types/InsightTimeRange.cs | 3 ++ .../Types/InsightTimeRangeWithStep.cs | 3 ++ src/Vapi.Net/Types/InworldVoice.cs | 3 ++ ...sonQueryOnCallTableWithNumberTypeColumn.cs | 3 ++ ...sonQueryOnCallTableWithStringTypeColumn.cs | 3 ++ ...ryOnCallTableWithStructuredOutputColumn.cs | 3 ++ src/Vapi.Net/Types/JsonQueryOnEventsTable.cs | 3 ++ src/Vapi.Net/Types/JsonSchema.cs | 3 ++ src/Vapi.Net/Types/KeypadInputPlan.cs | 3 ++ src/Vapi.Net/Types/KnowledgeBase.cs | 3 ++ src/Vapi.Net/Types/KnowledgeBaseCost.cs | 3 ++ .../Types/LangfuseObservabilityPlan.cs | 6 +++ src/Vapi.Net/Types/LineInsight.cs | 6 +++ src/Vapi.Net/Types/LineInsightMetadata.cs | 18 ++++++++ src/Vapi.Net/Types/LiquidCondition.cs | 3 ++ .../Types/LivekitSmartEndpointingPlan.cs | 3 ++ src/Vapi.Net/Types/LmntVoice.cs | 3 ++ src/Vapi.Net/Types/McpTool.cs | 6 +++ src/Vapi.Net/Types/McpToolMessages.cs | 3 ++ src/Vapi.Net/Types/McpToolMetadata.cs | 3 ++ src/Vapi.Net/Types/MessageAddHookAction.cs | 3 ++ src/Vapi.Net/Types/MessageTarget.cs | 3 ++ src/Vapi.Net/Types/MinimaxLlmModel.cs | 3 ++ src/Vapi.Net/Types/MinimaxVoice.cs | 3 ++ src/Vapi.Net/Types/ModelCost.cs | 3 ++ src/Vapi.Net/Types/Monitor.cs | 6 +++ src/Vapi.Net/Types/MonitorPlan.cs | 9 ++-- src/Vapi.Net/Types/MonitorResult.cs | 9 ++++ src/Vapi.Net/Types/Mono.cs | 3 ++ src/Vapi.Net/Types/NeuphonicVoice.cs | 3 ++ src/Vapi.Net/Types/NodeArtifact.cs | 3 ++ .../Types/OAuth2AuthenticationPlan.cs | 6 +++ .../Types/Oauth2AuthenticationSession.cs | 3 ++ src/Vapi.Net/Types/OpenAiFunction.cs | 3 ++ .../Types/OpenAiFunctionParameters.cs | 3 ++ src/Vapi.Net/Types/OpenAiMessage.cs | 9 ++++ src/Vapi.Net/Types/OpenAiModel.cs | 3 ++ src/Vapi.Net/Types/OpenAiTranscriber.cs | 3 ++ src/Vapi.Net/Types/OpenAiVoice.cs | 3 ++ .../Types/OpenAiVoicemailDetectionPlan.cs | 3 ++ src/Vapi.Net/Types/OpenRouterModel.cs | 3 ++ src/Vapi.Net/Types/PaginationMeta.cs | 21 ++++++++++ src/Vapi.Net/Types/PerformanceMetrics.cs | 3 ++ src/Vapi.Net/Types/PerplexityAiModel.cs | 3 ++ .../Types/PhoneNumberCallEndingHookFilter.cs | 3 ++ .../Types/PhoneNumberCallRingingHookFilter.cs | 3 ++ .../Types/PhoneNumberHookCallEnding.cs | 3 ++ .../Types/PhoneNumberHookCallRinging.cs | 3 ++ .../Types/PhoneNumberPaginatedResponse.cs | 3 ++ src/Vapi.Net/Types/PieInsight.cs | 6 +++ src/Vapi.Net/Types/PlayHtVoice.cs | 3 ++ .../Types/PromptInjectionSecurityFilter.cs | 3 ++ src/Vapi.Net/Types/ProviderResource.cs | 3 ++ .../ProviderResourcePaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/PublicKeyEncryptionPlan.cs | 3 ++ src/Vapi.Net/Types/QueryTool.cs | 3 ++ src/Vapi.Net/Types/RceSecurityFilter.cs | 3 ++ src/Vapi.Net/Types/Recording.cs | 3 ++ src/Vapi.Net/Types/RecordingConsent.cs | 3 ++ .../Types/RecordingConsentPlanStayOnLine.cs | 3 ++ .../Types/RecordingConsentPlanVerbal.cs | 3 ++ src/Vapi.Net/Types/RegexCondition.cs | 3 ++ src/Vapi.Net/Types/RegexOption.cs | 3 ++ src/Vapi.Net/Types/RegexReplacement.cs | 3 ++ src/Vapi.Net/Types/RegexSecurityFilter.cs | 3 ++ src/Vapi.Net/Types/RimeAiVoice.cs | 3 ++ src/Vapi.Net/Types/SayHookAction.cs | 3 ++ .../Types/SayPhoneNumberHookAction.cs | 3 ++ src/Vapi.Net/Types/SbcConfiguration.cs | 3 ++ src/Vapi.Net/Types/SchedulePlan.cs | 3 ++ src/Vapi.Net/Types/Scorecard.cs | 3 ++ src/Vapi.Net/Types/ScorecardMetric.cs | 3 ++ .../Types/ScorecardPaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/SecurityFilterBase.cs | 3 ++ src/Vapi.Net/Types/SecurityFilterPlan.cs | 3 ++ src/Vapi.Net/Types/Server.cs | 3 ++ src/Vapi.Net/Types/SesameVoice.cs | 3 ++ src/Vapi.Net/Types/SipAuthentication.cs | 3 ++ src/Vapi.Net/Types/SipRequestTool.cs | 3 ++ src/Vapi.Net/Types/SipTrunkGateway.cs | 3 ++ .../SipTrunkOutboundAuthenticationPlan.cs | 6 +++ .../Types/SipTrunkOutboundSipRegisterPlan.cs | 12 ++++++ src/Vapi.Net/Types/SlackSendMessageTool.cs | 3 ++ src/Vapi.Net/Types/SmallestAiVoice.cs | 3 ++ src/Vapi.Net/Types/SmartDenoisingPlan.cs | 3 ++ src/Vapi.Net/Types/SmsTool.cs | 3 ++ src/Vapi.Net/Types/SonioxTranscriber.cs | 3 ++ .../Types/SpeechmaticsCustomVocabularyItem.cs | 3 ++ src/Vapi.Net/Types/SpeechmaticsTranscriber.cs | 9 ++++ src/Vapi.Net/Types/SpkiPemPublicKeyConfig.cs | 3 ++ .../Types/SqlInjectionSecurityFilter.cs | 3 ++ src/Vapi.Net/Types/Squad.cs | 3 ++ src/Vapi.Net/Types/SquadMemberDto.cs | 6 +++ src/Vapi.Net/Types/SsrfSecurityFilter.cs | 3 ++ src/Vapi.Net/Types/StartSpeakingPlan.cs | 3 ++ src/Vapi.Net/Types/StopSpeakingPlan.cs | 3 ++ src/Vapi.Net/Types/StructuredDataMultiPlan.cs | 3 ++ src/Vapi.Net/Types/StructuredDataPlan.cs | 3 ++ src/Vapi.Net/Types/StructuredOutput.cs | 3 ++ .../StructuredOutputPaginatedResponse.cs | 9 ++++ src/Vapi.Net/Types/SubscriptionLimits.cs | 3 ++ src/Vapi.Net/Types/SuccessEvaluationPlan.cs | 3 ++ src/Vapi.Net/Types/SummaryPlan.cs | 3 ++ src/Vapi.Net/Types/SupabaseBucketPlan.cs | 3 ++ src/Vapi.Net/Types/SystemMessage.cs | 3 ++ src/Vapi.Net/Types/TalkscriberTranscriber.cs | 3 ++ .../Types/TavusConversationProperties.cs | 3 ++ src/Vapi.Net/Types/TavusVoice.cs | 3 ++ src/Vapi.Net/Types/TelnyxPhoneNumber.cs | 3 ++ src/Vapi.Net/Types/TextContent.cs | 12 ++++++ src/Vapi.Net/Types/TextEditorTool.cs | 3 ++ src/Vapi.Net/Types/TextInsight.cs | 6 +++ src/Vapi.Net/Types/TimeRange.cs | 3 ++ src/Vapi.Net/Types/TogetherAiModel.cs | 3 ++ src/Vapi.Net/Types/ToolCall.cs | 3 ++ src/Vapi.Net/Types/ToolCallFunction.cs | 3 ++ src/Vapi.Net/Types/ToolCallHookAction.cs | 3 ++ src/Vapi.Net/Types/ToolCallMessage.cs | 3 ++ src/Vapi.Net/Types/ToolCallResultMessage.cs | 3 ++ src/Vapi.Net/Types/ToolMessage.cs | 3 ++ src/Vapi.Net/Types/ToolMessageComplete.cs | 3 ++ src/Vapi.Net/Types/ToolMessageDelayed.cs | 3 ++ src/Vapi.Net/Types/ToolMessageFailed.cs | 3 ++ src/Vapi.Net/Types/ToolMessageStart.cs | 3 ++ src/Vapi.Net/Types/ToolNode.cs | 6 +++ src/Vapi.Net/Types/ToolParameter.cs | 3 ++ src/Vapi.Net/Types/ToolRejectionPlan.cs | 3 ++ src/Vapi.Net/Types/TranscriberCost.cs | 3 ++ src/Vapi.Net/Types/TranscriptPlan.cs | 3 ++ .../Types/TranscriptionEndpointingPlan.cs | 3 ++ src/Vapi.Net/Types/TransferCallTool.cs | 3 ++ .../Types/TransferDestinationAssistant.cs | 6 +++ .../Types/TransferDestinationNumber.cs | 3 ++ src/Vapi.Net/Types/TransferDestinationSip.cs | 3 ++ src/Vapi.Net/Types/TransferFallbackPlan.cs | 3 ++ .../Types/TransferPhoneNumberHookAction.cs | 3 ++ src/Vapi.Net/Types/TransferPlan.cs | 3 ++ .../Types/TransportConfigurationTwilio.cs | 6 +++ src/Vapi.Net/Types/TransportCost.cs | 6 +++ src/Vapi.Net/Types/TurnLatency.cs | 3 ++ src/Vapi.Net/Types/TwilioPhoneNumber.cs | 3 ++ .../Types/TwilioVoicemailDetectionPlan.cs | 3 ++ src/Vapi.Net/Types/UpdateApiRequestToolDto.cs | 6 +++ .../Types/UpdateBarInsightFromCallTableDto.cs | 6 +++ src/Vapi.Net/Types/UpdateBashToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateByoPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/UpdateComputerToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateDtmfToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateEndCallToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateFunctionToolDto.cs | 3 ++ ...eGoHighLevelCalendarAvailabilityToolDto.cs | 3 ++ ...teGoHighLevelCalendarEventCreateToolDto.cs | 3 ++ .../UpdateGoHighLevelContactCreateToolDto.cs | 3 ++ .../UpdateGoHighLevelContactGetToolDto.cs | 3 ++ ...eGoogleCalendarCheckAvailabilityToolDto.cs | 3 ++ .../UpdateGoogleCalendarCreateEventToolDto.cs | 3 ++ .../UpdateGoogleSheetsRowAppendToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateHandoffToolDto.cs | 3 ++ .../UpdateLineInsightFromCallTableDto.cs | 6 +++ src/Vapi.Net/Types/UpdateMcpToolDto.cs | 6 +++ .../Types/UpdatePieInsightFromCallTableDto.cs | 6 +++ src/Vapi.Net/Types/UpdateQueryToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateSipRequestToolDto.cs | 3 ++ .../Types/UpdateSlackSendMessageToolDto.cs | 3 ++ src/Vapi.Net/Types/UpdateSmsToolDto.cs | 3 ++ .../Types/UpdateTelnyxPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/UpdateTextEditorToolDto.cs | 3 ++ .../UpdateTextInsightFromCallTableDto.cs | 6 +++ .../Types/UpdateTransferCallToolDto.cs | 3 ++ .../Types/UpdateTwilioPhoneNumberDto.cs | 3 ++ .../Types/UpdateVapiPhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/UpdateVoicemailToolDto.cs | 3 ++ .../Types/UpdateVonagePhoneNumberDto.cs | 3 ++ src/Vapi.Net/Types/UserMessage.cs | 3 ++ src/Vapi.Net/Types/VapiCost.cs | 3 ++ src/Vapi.Net/Types/VapiPhoneNumber.cs | 3 ++ .../VapiPronunciationDictionaryLocator.cs | 3 ++ .../Types/VapiSmartEndpointingPlan.cs | 3 ++ src/Vapi.Net/Types/VapiVoice.cs | 3 ++ .../Types/VapiVoicemailDetectionPlan.cs | 3 ++ src/Vapi.Net/Types/VariableExtractionAlias.cs | 3 ++ src/Vapi.Net/Types/VariableExtractionPlan.cs | 3 ++ src/Vapi.Net/Types/VariableValueGroupBy.cs | 3 ++ src/Vapi.Net/Types/VoiceCost.cs | 3 ++ .../Types/VoicemailDetectionBackoffPlan.cs | 3 ++ src/Vapi.Net/Types/VoicemailDetectionCost.cs | 3 ++ src/Vapi.Net/Types/VoicemailTool.cs | 3 ++ src/Vapi.Net/Types/VonagePhoneNumber.cs | 3 ++ src/Vapi.Net/Types/WellSaidVoice.cs | 3 ++ .../Types/WorkflowAnthropicBedrockModel.cs | 3 ++ src/Vapi.Net/Types/WorkflowAnthropicModel.cs | 3 ++ src/Vapi.Net/Types/WorkflowCustomModel.cs | 3 ++ src/Vapi.Net/Types/WorkflowGoogleModel.cs | 3 ++ src/Vapi.Net/Types/WorkflowOpenAiModel.cs | 3 ++ src/Vapi.Net/Types/WorkflowOverrides.cs | 3 ++ src/Vapi.Net/Types/XaiModel.cs | 3 ++ src/Vapi.Net/Types/XssSecurityFilter.cs | 3 ++ src/Vapi.Net/Vapi.Net.csproj | 2 +- src/Vapi.Net/VapiClient.cs | 2 +- 516 files changed, 2329 insertions(+), 18 deletions(-) create mode 100644 .fern/replay.lock create mode 100644 .gitattributes diff --git a/.fern/metadata.json b/.fern/metadata.json index 7a55a5fc..8f07f130 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,5 +1,5 @@ { - "cliVersion": "5.51.2", + "cliVersion": "5.78.0", "generatorName": "fernapi/fern-csharp-sdk", "generatorVersion": "2.58.0", "generatorConfig": { @@ -12,10 +12,10 @@ "simplify-object-dictionaries": true, "use-discriminated-unions": false }, - "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5", + "originGitCommit": "ae8b82b8b9da5961d03b23c22c4a4457efe952d1", "originGitCommitIsDirty": true, "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "2.0.0" + "sdkVersion": "0.0.0-fern-placeholder" } \ No newline at end of file diff --git a/.fern/replay.lock b/.fern/replay.lock new file mode 100644 index 00000000..7faf974b --- /dev/null +++ b/.fern/replay.lock @@ -0,0 +1,10 @@ +# DO NOT EDIT MANUALLY - Managed by Fern Replay +version: "1.0" +generations: + - commit_sha: 6ee2f1cc74dd9f71a5250dc543072a20fe241e05 + tree_hash: b3aa526a34c3de7f3c7c338cd2e7525f57496081 + timestamp: 2026-07-22T16:33:32.410Z + cli_version: unknown + generator_versions: {} +current_generation: 6ee2f1cc74dd9f71a5250dc543072a20fe241e05 +patches: [] diff --git a/.fernignore b/.fernignore index 5cb78eeb..a7e71969 100644 --- a/.fernignore +++ b/.fernignore @@ -3,3 +3,6 @@ .gitignore 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/src/Vapi.Net/Analytics/AnalyticsClient.cs b/src/Vapi.Net/Analytics/AnalyticsClient.cs index 55fafff5..18f7b190 100644 --- a/src/Vapi.Net/Analytics/AnalyticsClient.cs +++ b/src/Vapi.Net/Analytics/AnalyticsClient.cs @@ -81,6 +81,9 @@ private async Task>> GetAsyncC } } + /// + /// Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. + /// public WithRawResponseTask> GetAsync( AnalyticsQueryDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Analytics/IAnalyticsClient.cs b/src/Vapi.Net/Analytics/IAnalyticsClient.cs index ee580002..0f40fd8d 100644 --- a/src/Vapi.Net/Analytics/IAnalyticsClient.cs +++ b/src/Vapi.Net/Analytics/IAnalyticsClient.cs @@ -2,6 +2,9 @@ namespace Vapi.Net; public partial interface IAnalyticsClient { + /// + /// Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. + /// WithRawResponseTask> GetAsync( AnalyticsQueryDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Assistants/AssistantsClient.cs b/src/Vapi.Net/Assistants/AssistantsClient.cs index 34d9fcb8..0f27896c 100644 --- a/src/Vapi.Net/Assistants/AssistantsClient.cs +++ b/src/Vapi.Net/Assistants/AssistantsClient.cs @@ -356,6 +356,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// public WithRawResponseTask> ListAsync( ListAssistantsRequest request, RequestOptions? options = null, @@ -367,6 +370,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. + /// public WithRawResponseTask CreateAsync( CreateAssistantDto request, RequestOptions? options = null, @@ -378,6 +384,9 @@ public WithRawResponseTask CreateAsync( ); } + /// + /// Returns the assistant identified by its ID. + /// public WithRawResponseTask GetAsync( string id, GetAssistantsRequest request, @@ -390,6 +399,9 @@ public WithRawResponseTask GetAsync( ); } + /// + /// Deletes the assistant identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeleteAssistantsRequest request, @@ -402,6 +414,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the specified fields of the assistant identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdateAssistantDto request, diff --git a/src/Vapi.Net/Assistants/IAssistantsClient.cs b/src/Vapi.Net/Assistants/IAssistantsClient.cs index d910d90e..d800bccc 100644 --- a/src/Vapi.Net/Assistants/IAssistantsClient.cs +++ b/src/Vapi.Net/Assistants/IAssistantsClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface IAssistantsClient { + /// + /// Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// WithRawResponseTask> ListAsync( ListAssistantsRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. + /// WithRawResponseTask CreateAsync( CreateAssistantDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the assistant identified by its ID. + /// WithRawResponseTask GetAsync( string id, GetAssistantsRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the assistant identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeleteAssistantsRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the specified fields of the assistant identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdateAssistantDto request, diff --git a/src/Vapi.Net/Assistants/Requests/UpdateAssistantDto.cs b/src/Vapi.Net/Assistants/Requests/UpdateAssistantDto.cs index 14717536..1382d15d 100644 --- a/src/Vapi.Net/Assistants/Requests/UpdateAssistantDto.cs +++ b/src/Vapi.Net/Assistants/Requests/UpdateAssistantDto.cs @@ -33,6 +33,9 @@ public record UpdateAssistantDto [JsonPropertyName("firstMessage")] public string? FirstMessage { get; set; } + /// + /// Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. + /// [JsonPropertyName("firstMessageInterruptionsEnabled")] public bool? FirstMessageInterruptionsEnabled { get; set; } @@ -161,6 +164,9 @@ public IEnumerable< [JsonPropertyName("endCallPhrases")] public IEnumerable? EndCallPhrases { get; set; } + /// + /// Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. + /// [JsonPropertyName("compliancePlan")] public CompliancePlan? CompliancePlan { get; set; } @@ -251,6 +257,9 @@ public IEnumerable< [JsonPropertyName("server")] public Server? Server { get; set; } + /// + /// Configuration for collecting and processing DTMF keypad input during calls. + /// [JsonPropertyName("keypadInputPlan")] public KeypadInputPlan? KeypadInputPlan { get; set; } diff --git a/src/Vapi.Net/Calls/CallsClient.cs b/src/Vapi.Net/Calls/CallsClient.cs index 17ea408b..ba745c6b 100644 --- a/src/Vapi.Net/Calls/CallsClient.cs +++ b/src/Vapi.Net/Calls/CallsClient.cs @@ -365,6 +365,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. + /// public WithRawResponseTask> ListAsync( ListCallsRequest request, RequestOptions? options = null, @@ -376,6 +379,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. + /// public WithRawResponseTask> CreateAsync( CreateCallDto request, RequestOptions? options = null, @@ -387,6 +393,9 @@ public WithRawResponseTask> CreateAsync( ); } + /// + /// Returns the call identified by its ID, including its status, configuration, and available call data. + /// public WithRawResponseTask GetAsync( string id, GetCallsRequest request, @@ -397,6 +406,9 @@ public WithRawResponseTask GetAsync( return new WithRawResponseTask(GetAsyncCore(id, request, options, cancellationToken)); } + /// + /// Deletes the call identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeleteCallDto request, @@ -409,6 +421,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the call identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdateCallDto request, diff --git a/src/Vapi.Net/Calls/ICallsClient.cs b/src/Vapi.Net/Calls/ICallsClient.cs index 9e56929b..202595a3 100644 --- a/src/Vapi.Net/Calls/ICallsClient.cs +++ b/src/Vapi.Net/Calls/ICallsClient.cs @@ -4,18 +4,27 @@ namespace Vapi.Net; public partial interface ICallsClient { + /// + /// Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. + /// WithRawResponseTask> ListAsync( ListCallsRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. + /// WithRawResponseTask> CreateAsync( CreateCallDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the call identified by its ID, including its status, configuration, and available call data. + /// WithRawResponseTask GetAsync( string id, GetCallsRequest request, @@ -23,6 +32,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the call identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeleteCallDto request, @@ -30,6 +42,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the call identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdateCallDto request, diff --git a/src/Vapi.Net/Campaigns/CampaignsClient.cs b/src/Vapi.Net/Campaigns/CampaignsClient.cs index 64f632f3..1d95cff5 100644 --- a/src/Vapi.Net/Campaigns/CampaignsClient.cs +++ b/src/Vapi.Net/Campaigns/CampaignsClient.cs @@ -363,6 +363,9 @@ private async Task> CampaignControllerUpdateAsyncCore( } } + /// + /// Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. + /// public WithRawResponseTask CampaignControllerFindAllAsync( CampaignControllerFindAllRequest request, RequestOptions? options = null, @@ -374,6 +377,9 @@ public WithRawResponseTask CampaignControllerFindAllA ); } + /// + /// Creates an outbound calling campaign that calls a set of customers. + /// public WithRawResponseTask CampaignControllerCreateAsync( CreateCampaignDto request, RequestOptions? options = null, @@ -385,6 +391,9 @@ public WithRawResponseTask CampaignControllerCreateAsync( ); } + /// + /// Returns the outbound calling campaign identified by its ID. + /// public WithRawResponseTask CampaignControllerFindOneAsync( string id, CampaignControllerFindOneRequest request, @@ -397,6 +406,9 @@ public WithRawResponseTask CampaignControllerFindOneAsync( ); } + /// + /// Deletes the outbound calling campaign identified by its ID. + /// public WithRawResponseTask CampaignControllerRemoveAsync( string id, CampaignControllerRemoveRequest request, @@ -409,6 +421,9 @@ public WithRawResponseTask CampaignControllerRemoveAsync( ); } + /// + /// Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. + /// public WithRawResponseTask CampaignControllerUpdateAsync( string id, UpdateCampaignDto request, diff --git a/src/Vapi.Net/Campaigns/ICampaignsClient.cs b/src/Vapi.Net/Campaigns/ICampaignsClient.cs index 8b40bb4f..ef5e2716 100644 --- a/src/Vapi.Net/Campaigns/ICampaignsClient.cs +++ b/src/Vapi.Net/Campaigns/ICampaignsClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface ICampaignsClient { + /// + /// Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. + /// WithRawResponseTask CampaignControllerFindAllAsync( CampaignControllerFindAllRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates an outbound calling campaign that calls a set of customers. + /// WithRawResponseTask CampaignControllerCreateAsync( CreateCampaignDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the outbound calling campaign identified by its ID. + /// WithRawResponseTask CampaignControllerFindOneAsync( string id, CampaignControllerFindOneRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask CampaignControllerFindOneAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the outbound calling campaign identified by its ID. + /// WithRawResponseTask CampaignControllerRemoveAsync( string id, CampaignControllerRemoveRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask CampaignControllerRemoveAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. + /// WithRawResponseTask CampaignControllerUpdateAsync( string id, UpdateCampaignDto request, diff --git a/src/Vapi.Net/Core/Public/Version.cs b/src/Vapi.Net/Core/Public/Version.cs index 641bf59d..38406f35 100644 --- a/src/Vapi.Net/Core/Public/Version.cs +++ b/src/Vapi.Net/Core/Public/Version.cs @@ -3,5 +3,5 @@ namespace Vapi.Net; [Serializable] internal class Version { - public const string Current = "2.0.0"; + public const string Current = "0.0.0-fern-placeholder"; } diff --git a/src/Vapi.Net/Eval/EvalClient.cs b/src/Vapi.Net/Eval/EvalClient.cs index 740e5a1a..6a8e97e7 100644 --- a/src/Vapi.Net/Eval/EvalClient.cs +++ b/src/Vapi.Net/Eval/EvalClient.cs @@ -641,6 +641,9 @@ private async Task> EvalControllerRunAsyncCore( } } + /// + /// Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. + /// public WithRawResponseTask EvalControllerGetPaginatedAsync( EvalControllerGetPaginatedRequest request, RequestOptions? options = null, @@ -652,6 +655,9 @@ public WithRawResponseTask EvalControllerGetPaginatedAsyn ); } + /// + /// Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. + /// public WithRawResponseTask EvalControllerCreateAsync( CreateEvalDto request, RequestOptions? options = null, @@ -663,6 +669,9 @@ public WithRawResponseTask EvalControllerCreateAsync( ); } + /// + /// Returns the eval definition identified by its ID. + /// public WithRawResponseTask EvalControllerGetAsync( string id, EvalControllerGetRequest request, @@ -675,6 +684,9 @@ public WithRawResponseTask EvalControllerGetAsync( ); } + /// + /// Deletes the eval definition identified by its ID. + /// public WithRawResponseTask EvalControllerRemoveAsync( string id, EvalControllerRemoveRequest request, @@ -687,6 +699,9 @@ public WithRawResponseTask EvalControllerRemoveAsync( ); } + /// + /// Updates the eval definition identified by its ID. + /// public WithRawResponseTask EvalControllerUpdateAsync( string id, UpdateEvalDto request, @@ -699,6 +714,9 @@ public WithRawResponseTask EvalControllerUpdateAsync( ); } + /// + /// Returns the eval run identified by its ID. + /// public WithRawResponseTask EvalControllerGetRunAsync( string id, EvalControllerGetRunRequest request, @@ -711,6 +729,9 @@ public WithRawResponseTask EvalControllerGetRunAsync( ); } + /// + /// Deletes the eval run identified by its ID. + /// public WithRawResponseTask EvalControllerRemoveRunAsync( string id, EvalControllerRemoveRunRequest request, @@ -723,6 +744,9 @@ public WithRawResponseTask EvalControllerRemoveRunAsync( ); } + /// + /// Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + /// public WithRawResponseTask EvalControllerGetRunsPaginatedAsync( EvalControllerGetRunsPaginatedRequest request, RequestOptions? options = null, @@ -734,6 +758,9 @@ public WithRawResponseTask EvalControllerGetRunsPagina ); } + /// + /// Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. + /// public WithRawResponseTask EvalControllerRunAsync( CreateEvalRunDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Eval/IEvalClient.cs b/src/Vapi.Net/Eval/IEvalClient.cs index 6b5cf2ec..c20dda0c 100644 --- a/src/Vapi.Net/Eval/IEvalClient.cs +++ b/src/Vapi.Net/Eval/IEvalClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface IEvalClient { + /// + /// Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. + /// WithRawResponseTask EvalControllerGetPaginatedAsync( EvalControllerGetPaginatedRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. + /// WithRawResponseTask EvalControllerCreateAsync( CreateEvalDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the eval definition identified by its ID. + /// WithRawResponseTask EvalControllerGetAsync( string id, EvalControllerGetRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask EvalControllerGetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the eval definition identified by its ID. + /// WithRawResponseTask EvalControllerRemoveAsync( string id, EvalControllerRemoveRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask EvalControllerRemoveAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the eval definition identified by its ID. + /// WithRawResponseTask EvalControllerUpdateAsync( string id, UpdateEvalDto request, @@ -35,6 +50,9 @@ WithRawResponseTask EvalControllerUpdateAsync( CancellationToken cancellationToken = default ); + /// + /// Returns the eval run identified by its ID. + /// WithRawResponseTask EvalControllerGetRunAsync( string id, EvalControllerGetRunRequest request, @@ -42,6 +60,9 @@ WithRawResponseTask EvalControllerGetRunAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the eval run identified by its ID. + /// WithRawResponseTask EvalControllerRemoveRunAsync( string id, EvalControllerRemoveRunRequest request, @@ -49,12 +70,18 @@ WithRawResponseTask EvalControllerRemoveRunAsync( CancellationToken cancellationToken = default ); + /// + /// Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + /// WithRawResponseTask EvalControllerGetRunsPaginatedAsync( EvalControllerGetRunsPaginatedRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. + /// WithRawResponseTask EvalControllerRunAsync( CreateEvalRunDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Files/FilesClient.cs b/src/Vapi.Net/Files/FilesClient.cs index f4735751..1bfe87ed 100644 --- a/src/Vapi.Net/Files/FilesClient.cs +++ b/src/Vapi.Net/Files/FilesClient.cs @@ -352,6 +352,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns files uploaded to the authenticated organization. + /// public WithRawResponseTask> ListAsync( RequestOptions? options = null, CancellationToken cancellationToken = default @@ -362,6 +365,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Uploads a file for use with a Vapi knowledge base. + /// public WithRawResponseTask CreateAsync( CreateFileDto request, RequestOptions? options = null, @@ -371,6 +377,9 @@ public WithRawResponseTask CreateAsync( return new WithRawResponseTask(CreateAsyncCore(request, options, cancellationToken)); } + /// + /// Returns the uploaded file identified by its ID. + /// public WithRawResponseTask GetAsync( string id, GetFilesRequest request, @@ -381,6 +390,9 @@ public WithRawResponseTask GetAsync( return new WithRawResponseTask(GetAsyncCore(id, request, options, cancellationToken)); } + /// + /// Deletes the uploaded file identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeleteFilesRequest request, @@ -393,6 +405,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the name of the uploaded file identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdateFileDto request, diff --git a/src/Vapi.Net/Files/IFilesClient.cs b/src/Vapi.Net/Files/IFilesClient.cs index 66dff31c..1167d90b 100644 --- a/src/Vapi.Net/Files/IFilesClient.cs +++ b/src/Vapi.Net/Files/IFilesClient.cs @@ -2,17 +2,26 @@ namespace Vapi.Net; public partial interface IFilesClient { + /// + /// Returns files uploaded to the authenticated organization. + /// WithRawResponseTask> ListAsync( RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Uploads a file for use with a Vapi knowledge base. + /// WithRawResponseTask CreateAsync( CreateFileDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the uploaded file identified by its ID. + /// WithRawResponseTask GetAsync( string id, GetFilesRequest request, @@ -20,6 +29,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the uploaded file identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeleteFilesRequest request, @@ -27,6 +39,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the name of the uploaded file identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdateFileDto request, diff --git a/src/Vapi.Net/Insight/IInsightClient.cs b/src/Vapi.Net/Insight/IInsightClient.cs index 802475f3..18d29b67 100644 --- a/src/Vapi.Net/Insight/IInsightClient.cs +++ b/src/Vapi.Net/Insight/IInsightClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface IInsightClient { + /// + /// Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. + /// WithRawResponseTask InsightControllerFindAllAsync( InsightControllerFindAllRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. + /// WithRawResponseTask InsightControllerCreateAsync( object request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the reporting insight identified by its ID. + /// WithRawResponseTask InsightControllerFindOneAsync( string id, InsightControllerFindOneRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask InsightControllerFindOneAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the reporting insight identified by its ID. + /// WithRawResponseTask InsightControllerRemoveAsync( string id, InsightControllerRemoveRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask InsightControllerRemoveAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the reporting insight identified by its ID. + /// WithRawResponseTask InsightControllerUpdateAsync( string id, InsightControllerUpdateRequest request, @@ -35,6 +50,9 @@ WithRawResponseTask InsightControllerUpdateAsync( CancellationToken cancellationToken = default ); + /// + /// Runs a saved reporting insight, optionally overriding its time range and response format. + /// WithRawResponseTask InsightControllerRunAsync( string id, InsightRunDto request, @@ -42,6 +60,9 @@ WithRawResponseTask InsightControllerRunAsync( CancellationToken cancellationToken = default ); + /// + /// Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + /// WithRawResponseTask InsightControllerPreviewAsync( object request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Insight/InsightClient.cs b/src/Vapi.Net/Insight/InsightClient.cs index 3ce566df..176a3646 100644 --- a/src/Vapi.Net/Insight/InsightClient.cs +++ b/src/Vapi.Net/Insight/InsightClient.cs @@ -505,6 +505,9 @@ private async Task> InsightControllerPreview } } + /// + /// Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. + /// public WithRawResponseTask InsightControllerFindAllAsync( InsightControllerFindAllRequest request, RequestOptions? options = null, @@ -516,6 +519,9 @@ public WithRawResponseTask InsightControllerFindAllAsy ); } + /// + /// Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. + /// public WithRawResponseTask InsightControllerCreateAsync( object request, RequestOptions? options = null, @@ -527,6 +533,9 @@ public WithRawResponseTask InsightControllerCreateAsync( ); } + /// + /// Returns the reporting insight identified by its ID. + /// public WithRawResponseTask InsightControllerFindOneAsync( string id, InsightControllerFindOneRequest request, @@ -539,6 +548,9 @@ public WithRawResponseTask InsightControllerFindOneAsync( ); } + /// + /// Deletes the reporting insight identified by its ID. + /// public WithRawResponseTask InsightControllerRemoveAsync( string id, InsightControllerRemoveRequest request, @@ -551,6 +563,9 @@ public WithRawResponseTask InsightControllerRemoveAsync( ); } + /// + /// Updates the reporting insight identified by its ID. + /// public WithRawResponseTask InsightControllerUpdateAsync( string id, InsightControllerUpdateRequest request, @@ -563,6 +578,9 @@ public WithRawResponseTask InsightControllerUpdateAsync( ); } + /// + /// Runs a saved reporting insight, optionally overriding its time range and response format. + /// public WithRawResponseTask InsightControllerRunAsync( string id, InsightRunDto request, @@ -575,6 +593,9 @@ public WithRawResponseTask InsightControllerRunAsync( ); } + /// + /// Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + /// public WithRawResponseTask InsightControllerPreviewAsync( object request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Insight/Requests/InsightRunDto.cs b/src/Vapi.Net/Insight/Requests/InsightRunDto.cs index cd18d6a1..982d818e 100644 --- a/src/Vapi.Net/Insight/Requests/InsightRunDto.cs +++ b/src/Vapi.Net/Insight/Requests/InsightRunDto.cs @@ -6,6 +6,9 @@ namespace Vapi.Net; [Serializable] public record InsightRunDto { + /// + /// Output-formatting instructions applied to the insight run. + /// [JsonPropertyName("formatPlan")] public InsightRunFormatPlan? FormatPlan { get; set; } diff --git a/src/Vapi.Net/ObservabilityScorecard/IObservabilityScorecardClient.cs b/src/Vapi.Net/ObservabilityScorecard/IObservabilityScorecardClient.cs index a75ca484..1fff4aab 100644 --- a/src/Vapi.Net/ObservabilityScorecard/IObservabilityScorecardClient.cs +++ b/src/Vapi.Net/ObservabilityScorecard/IObservabilityScorecardClient.cs @@ -2,6 +2,9 @@ namespace Vapi.Net; public partial interface IObservabilityScorecardClient { + /// + /// Returns the scorecard identified by its ID. + /// WithRawResponseTask ScorecardControllerGetAsync( string id, ScorecardControllerGetRequest request, @@ -9,6 +12,9 @@ WithRawResponseTask ScorecardControllerGetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the scorecard identified by its ID. + /// WithRawResponseTask ScorecardControllerRemoveAsync( string id, ScorecardControllerRemoveRequest request, @@ -16,6 +22,9 @@ WithRawResponseTask ScorecardControllerRemoveAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the scorecard identified by its ID. + /// WithRawResponseTask ScorecardControllerUpdateAsync( string id, UpdateScorecardDto request, @@ -23,12 +32,18 @@ WithRawResponseTask ScorecardControllerUpdateAsync( CancellationToken cancellationToken = default ); + /// + /// Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + /// WithRawResponseTask ScorecardControllerGetPaginatedAsync( ScorecardControllerGetPaginatedRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. + /// WithRawResponseTask ScorecardControllerCreateAsync( CreateScorecardDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/ObservabilityScorecard/ObservabilityScorecardClient.cs b/src/Vapi.Net/ObservabilityScorecard/ObservabilityScorecardClient.cs index 981cdadb..fe93a183 100644 --- a/src/Vapi.Net/ObservabilityScorecard/ObservabilityScorecardClient.cs +++ b/src/Vapi.Net/ObservabilityScorecard/ObservabilityScorecardClient.cs @@ -370,6 +370,9 @@ private async Task> ScorecardControllerCreateAsyncCor } } + /// + /// Returns the scorecard identified by its ID. + /// public WithRawResponseTask ScorecardControllerGetAsync( string id, ScorecardControllerGetRequest request, @@ -382,6 +385,9 @@ public WithRawResponseTask ScorecardControllerGetAsync( ); } + /// + /// Deletes the scorecard identified by its ID. + /// public WithRawResponseTask ScorecardControllerRemoveAsync( string id, ScorecardControllerRemoveRequest request, @@ -394,6 +400,9 @@ public WithRawResponseTask ScorecardControllerRemoveAsync( ); } + /// + /// Updates the scorecard identified by its ID. + /// public WithRawResponseTask ScorecardControllerUpdateAsync( string id, UpdateScorecardDto request, @@ -406,6 +415,9 @@ public WithRawResponseTask ScorecardControllerUpdateAsync( ); } + /// + /// Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + /// public WithRawResponseTask ScorecardControllerGetPaginatedAsync( ScorecardControllerGetPaginatedRequest request, RequestOptions? options = null, @@ -417,6 +429,9 @@ public WithRawResponseTask ScorecardControllerGetPag ); } + /// + /// Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. + /// public WithRawResponseTask ScorecardControllerCreateAsync( CreateScorecardDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/PhoneNumbers/IPhoneNumbersClient.cs b/src/Vapi.Net/PhoneNumbers/IPhoneNumbersClient.cs index 85c66158..3fab79ca 100644 --- a/src/Vapi.Net/PhoneNumbers/IPhoneNumbersClient.cs +++ b/src/Vapi.Net/PhoneNumbers/IPhoneNumbersClient.cs @@ -2,24 +2,36 @@ namespace Vapi.Net; public partial interface IPhoneNumbersClient { + /// + /// Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// WithRawResponseTask> ListAsync( ListPhoneNumbersRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. + /// WithRawResponseTask CreateAsync( object request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// 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. + /// WithRawResponseTask PhoneNumberControllerFindAllPaginatedAsync( PhoneNumberControllerFindAllPaginatedRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the phone number resource identified by its ID. + /// WithRawResponseTask GetAsync( string id, GetPhoneNumbersRequest request, @@ -27,6 +39,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the phone number resource identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeletePhoneNumbersRequest request, @@ -34,6 +49,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the specified fields of the phone number resource identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdatePhoneNumbersRequest request, diff --git a/src/Vapi.Net/PhoneNumbers/PhoneNumbersClient.cs b/src/Vapi.Net/PhoneNumbers/PhoneNumbersClient.cs index 4d465220..44b5e1aa 100644 --- a/src/Vapi.Net/PhoneNumbers/PhoneNumbersClient.cs +++ b/src/Vapi.Net/PhoneNumbers/PhoneNumbersClient.cs @@ -450,6 +450,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// public WithRawResponseTask> ListAsync( ListPhoneNumbersRequest request, RequestOptions? options = null, @@ -461,6 +464,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. + /// public WithRawResponseTask CreateAsync( object request, RequestOptions? options = null, @@ -472,6 +478,9 @@ public WithRawResponseTask CreateAsync( ); } + /// + /// 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. + /// public WithRawResponseTask PhoneNumberControllerFindAllPaginatedAsync( PhoneNumberControllerFindAllPaginatedRequest request, RequestOptions? options = null, @@ -483,6 +492,9 @@ public WithRawResponseTask PhoneNumberControllerFi ); } + /// + /// Returns the phone number resource identified by its ID. + /// public WithRawResponseTask GetAsync( string id, GetPhoneNumbersRequest request, @@ -495,6 +507,9 @@ public WithRawResponseTask GetAsync( ); } + /// + /// Deletes the phone number resource identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeletePhoneNumbersRequest request, @@ -507,6 +522,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the specified fields of the phone number resource identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdatePhoneNumbersRequest request, diff --git a/src/Vapi.Net/ProviderResources/IProviderResourcesClient.cs b/src/Vapi.Net/ProviderResources/IProviderResourcesClient.cs index d7e5faf2..8d80f585 100644 --- a/src/Vapi.Net/ProviderResources/IProviderResourcesClient.cs +++ b/src/Vapi.Net/ProviderResources/IProviderResourcesClient.cs @@ -2,6 +2,9 @@ namespace Vapi.Net; public partial interface IProviderResourcesClient { + /// + /// Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. + /// WithRawResponseTask ProviderResourceControllerGetProviderResourcesPaginatedAsync( ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider provider, ProviderResourceControllerGetProviderResourcesPaginatedRequestResourceName resourceName, @@ -10,6 +13,9 @@ WithRawResponseTask ProviderResourceControlle CancellationToken cancellationToken = default ); + /// + /// Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + /// WithRawResponseTask ProviderResourceControllerCreateProviderResourceAsync( ProviderResourceControllerCreateProviderResourceRequestProvider provider, ProviderResourceControllerCreateProviderResourceRequestResourceName resourceName, @@ -18,6 +24,9 @@ WithRawResponseTask ProviderResourceControllerCreateProviderRe CancellationToken cancellationToken = default ); + /// + /// Returns the provider resource identified by its Vapi resource ID. + /// WithRawResponseTask ProviderResourceControllerGetProviderResourceAsync( ProviderResourceControllerGetProviderResourceRequestProvider provider, ProviderResourceControllerGetProviderResourceRequestResourceName resourceName, @@ -27,6 +36,9 @@ WithRawResponseTask ProviderResourceControllerGetProviderResou CancellationToken cancellationToken = default ); + /// + /// Deletes the provider resource identified by its Vapi resource ID. + /// WithRawResponseTask ProviderResourceControllerDeleteProviderResourceAsync( ProviderResourceControllerDeleteProviderResourceRequestProvider provider, ProviderResourceControllerDeleteProviderResourceRequestResourceName resourceName, @@ -36,6 +48,9 @@ WithRawResponseTask ProviderResourceControllerDeleteProviderRe CancellationToken cancellationToken = default ); + /// + /// Updates the provider resource identified by its Vapi resource ID. + /// WithRawResponseTask ProviderResourceControllerUpdateProviderResourceAsync( ProviderResourceControllerUpdateProviderResourceRequestProvider provider, ProviderResourceControllerUpdateProviderResourceRequestResourceName resourceName, diff --git a/src/Vapi.Net/ProviderResources/ProviderResourcesClient.cs b/src/Vapi.Net/ProviderResources/ProviderResourcesClient.cs index 96bca57d..e59e70a9 100644 --- a/src/Vapi.Net/ProviderResources/ProviderResourcesClient.cs +++ b/src/Vapi.Net/ProviderResources/ProviderResourcesClient.cs @@ -438,6 +438,9 @@ private async Task< } } + /// + /// Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. + /// public WithRawResponseTask ProviderResourceControllerGetProviderResourcesPaginatedAsync( ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider provider, ProviderResourceControllerGetProviderResourcesPaginatedRequestResourceName resourceName, @@ -457,6 +460,9 @@ public WithRawResponseTask ProviderResourceCo ); } + /// + /// Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + /// public WithRawResponseTask ProviderResourceControllerCreateProviderResourceAsync( ProviderResourceControllerCreateProviderResourceRequestProvider provider, ProviderResourceControllerCreateProviderResourceRequestResourceName resourceName, @@ -476,6 +482,9 @@ public WithRawResponseTask ProviderResourceControllerCreatePro ); } + /// + /// Returns the provider resource identified by its Vapi resource ID. + /// public WithRawResponseTask ProviderResourceControllerGetProviderResourceAsync( ProviderResourceControllerGetProviderResourceRequestProvider provider, ProviderResourceControllerGetProviderResourceRequestResourceName resourceName, @@ -497,6 +506,9 @@ public WithRawResponseTask ProviderResourceControllerGetProvid ); } + /// + /// Deletes the provider resource identified by its Vapi resource ID. + /// public WithRawResponseTask ProviderResourceControllerDeleteProviderResourceAsync( ProviderResourceControllerDeleteProviderResourceRequestProvider provider, ProviderResourceControllerDeleteProviderResourceRequestResourceName resourceName, @@ -518,6 +530,9 @@ public WithRawResponseTask ProviderResourceControllerDeletePro ); } + /// + /// Updates the provider resource identified by its Vapi resource ID. + /// public WithRawResponseTask ProviderResourceControllerUpdateProviderResourceAsync( ProviderResourceControllerUpdateProviderResourceRequestProvider provider, ProviderResourceControllerUpdateProviderResourceRequestResourceName resourceName, diff --git a/src/Vapi.Net/Squads/ISquadsClient.cs b/src/Vapi.Net/Squads/ISquadsClient.cs index de35c477..4fc1a966 100644 --- a/src/Vapi.Net/Squads/ISquadsClient.cs +++ b/src/Vapi.Net/Squads/ISquadsClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface ISquadsClient { + /// + /// Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// WithRawResponseTask> ListAsync( ListSquadsRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + /// WithRawResponseTask CreateAsync( CreateSquadDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the squad identified by its ID. + /// WithRawResponseTask GetAsync( string id, GetSquadsRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the squad identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeleteSquadsRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the specified fields of the squad identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdateSquadDto request, diff --git a/src/Vapi.Net/Squads/SquadsClient.cs b/src/Vapi.Net/Squads/SquadsClient.cs index 88fa8e8c..c44e411c 100644 --- a/src/Vapi.Net/Squads/SquadsClient.cs +++ b/src/Vapi.Net/Squads/SquadsClient.cs @@ -356,6 +356,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// public WithRawResponseTask> ListAsync( ListSquadsRequest request, RequestOptions? options = null, @@ -367,6 +370,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + /// public WithRawResponseTask CreateAsync( CreateSquadDto request, RequestOptions? options = null, @@ -376,6 +382,9 @@ public WithRawResponseTask CreateAsync( return new WithRawResponseTask(CreateAsyncCore(request, options, cancellationToken)); } + /// + /// Returns the squad identified by its ID. + /// public WithRawResponseTask GetAsync( string id, GetSquadsRequest request, @@ -388,6 +397,9 @@ public WithRawResponseTask GetAsync( ); } + /// + /// Deletes the squad identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeleteSquadsRequest request, @@ -400,6 +412,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the specified fields of the squad identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdateSquadDto request, diff --git a/src/Vapi.Net/StructuredOutputs/IStructuredOutputsClient.cs b/src/Vapi.Net/StructuredOutputs/IStructuredOutputsClient.cs index 6cc231a1..7dd0ea40 100644 --- a/src/Vapi.Net/StructuredOutputs/IStructuredOutputsClient.cs +++ b/src/Vapi.Net/StructuredOutputs/IStructuredOutputsClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface IStructuredOutputsClient { + /// + /// Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. + /// WithRawResponseTask StructuredOutputControllerFindAllAsync( StructuredOutputControllerFindAllRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. + /// WithRawResponseTask StructuredOutputControllerCreateAsync( CreateStructuredOutputDto request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the structured-output definition identified by its ID. + /// WithRawResponseTask StructuredOutputControllerFindOneAsync( string id, StructuredOutputControllerFindOneRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask StructuredOutputControllerFindOneAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the structured-output definition identified by its ID. + /// WithRawResponseTask StructuredOutputControllerRemoveAsync( string id, StructuredOutputControllerRemoveRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask StructuredOutputControllerRemoveAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the structured-output definition identified by its ID. + /// WithRawResponseTask StructuredOutputControllerUpdateAsync( string id, UpdateStructuredOutputDto request, @@ -35,6 +50,9 @@ WithRawResponseTask StructuredOutputControllerUpdateAsync( CancellationToken cancellationToken = default ); + /// + /// Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. + /// WithRawResponseTask StructuredOutputControllerRunAsync( StructuredOutputRunDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/StructuredOutputs/StructuredOutputsClient.cs b/src/Vapi.Net/StructuredOutputs/StructuredOutputsClient.cs index cba70979..7dcef93f 100644 --- a/src/Vapi.Net/StructuredOutputs/StructuredOutputsClient.cs +++ b/src/Vapi.Net/StructuredOutputs/StructuredOutputsClient.cs @@ -447,6 +447,9 @@ private async Task> StructuredOutputController } } + /// + /// Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. + /// public WithRawResponseTask StructuredOutputControllerFindAllAsync( StructuredOutputControllerFindAllRequest request, RequestOptions? options = null, @@ -458,6 +461,9 @@ public WithRawResponseTask StructuredOutputCo ); } + /// + /// Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. + /// public WithRawResponseTask StructuredOutputControllerCreateAsync( CreateStructuredOutputDto request, RequestOptions? options = null, @@ -469,6 +475,9 @@ public WithRawResponseTask StructuredOutputControllerCreateAsy ); } + /// + /// Returns the structured-output definition identified by its ID. + /// public WithRawResponseTask StructuredOutputControllerFindOneAsync( string id, StructuredOutputControllerFindOneRequest request, @@ -481,6 +490,9 @@ public WithRawResponseTask StructuredOutputControllerFindOneAs ); } + /// + /// Deletes the structured-output definition identified by its ID. + /// public WithRawResponseTask StructuredOutputControllerRemoveAsync( string id, StructuredOutputControllerRemoveRequest request, @@ -493,6 +505,9 @@ public WithRawResponseTask StructuredOutputControllerRemoveAsy ); } + /// + /// Updates the structured-output definition identified by its ID. + /// public WithRawResponseTask StructuredOutputControllerUpdateAsync( string id, UpdateStructuredOutputDto request, @@ -505,6 +520,9 @@ public WithRawResponseTask StructuredOutputControllerUpdateAsy ); } + /// + /// Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. + /// public WithRawResponseTask StructuredOutputControllerRunAsync( StructuredOutputRunDto request, RequestOptions? options = null, diff --git a/src/Vapi.Net/Tools/IToolsClient.cs b/src/Vapi.Net/Tools/IToolsClient.cs index 1d735bbc..1579fcf5 100644 --- a/src/Vapi.Net/Tools/IToolsClient.cs +++ b/src/Vapi.Net/Tools/IToolsClient.cs @@ -2,18 +2,27 @@ namespace Vapi.Net; public partial interface IToolsClient { + /// + /// Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// WithRawResponseTask> ListAsync( ListToolsRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Creates a reusable tool that assistants can invoke during conversations. + /// WithRawResponseTask CreateAsync( object request, RequestOptions? options = null, CancellationToken cancellationToken = default ); + /// + /// Returns the tool identified by its ID. + /// WithRawResponseTask GetAsync( string id, GetToolsRequest request, @@ -21,6 +30,9 @@ WithRawResponseTask GetAsync( CancellationToken cancellationToken = default ); + /// + /// Deletes the tool identified by its ID. + /// WithRawResponseTask DeleteAsync( string id, DeleteToolsRequest request, @@ -28,6 +40,9 @@ WithRawResponseTask DeleteAsync( CancellationToken cancellationToken = default ); + /// + /// Updates the specified fields of the tool identified by its ID. + /// WithRawResponseTask UpdateAsync( string id, UpdateToolsRequest request, diff --git a/src/Vapi.Net/Tools/ToolsClient.cs b/src/Vapi.Net/Tools/ToolsClient.cs index 0fc0651c..14f0fcf9 100644 --- a/src/Vapi.Net/Tools/ToolsClient.cs +++ b/src/Vapi.Net/Tools/ToolsClient.cs @@ -356,6 +356,9 @@ private async Task> UpdateAsyncCore( } } + /// + /// Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + /// public WithRawResponseTask> ListAsync( ListToolsRequest request, RequestOptions? options = null, @@ -367,6 +370,9 @@ public WithRawResponseTask> ListAsync( ); } + /// + /// Creates a reusable tool that assistants can invoke during conversations. + /// public WithRawResponseTask CreateAsync( object request, RequestOptions? options = null, @@ -378,6 +384,9 @@ public WithRawResponseTask CreateAsync( ); } + /// + /// Returns the tool identified by its ID. + /// public WithRawResponseTask GetAsync( string id, GetToolsRequest request, @@ -390,6 +399,9 @@ public WithRawResponseTask GetAsync( ); } + /// + /// Deletes the tool identified by its ID. + /// public WithRawResponseTask DeleteAsync( string id, DeleteToolsRequest request, @@ -402,6 +414,9 @@ public WithRawResponseTask DeleteAsync( ); } + /// + /// Updates the specified fields of the tool identified by its ID. + /// public WithRawResponseTask UpdateAsync( string id, UpdateToolsRequest request, diff --git a/src/Vapi.Net/Types/AiEdgeCondition.cs b/src/Vapi.Net/Types/AiEdgeCondition.cs index 1e62cdc7..ada74982 100644 --- a/src/Vapi.Net/Types/AiEdgeCondition.cs +++ b/src/Vapi.Net/Types/AiEdgeCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An AI-evaluated boolean condition that determines whether a workflow follows an edge. +/// [Serializable] public record AiEdgeCondition : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record AiEdgeCondition : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Selects an AI-evaluated workflow edge condition. + /// [JsonPropertyName("type")] public required AiEdgeConditionType Type { get; set; } diff --git a/src/Vapi.Net/Types/Analysis.cs b/src/Vapi.Net/Types/Analysis.cs index a49ca5f8..b5c9ecf7 100644 --- a/src/Vapi.Net/Types/Analysis.cs +++ b/src/Vapi.Net/Types/Analysis.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Post-call analysis results, including summary, structured data, and success evaluation outputs. +/// [Serializable] public record Analysis : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalysisCost.cs b/src/Vapi.Net/Types/AnalysisCost.cs index 07ae84e5..bd43947c 100644 --- a/src/Vapi.Net/Types/AnalysisCost.cs +++ b/src/Vapi.Net/Types/AnalysisCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Cost for an individual analysis request, including analysis type, model, token usage, and amount. +/// [Serializable] public record AnalysisCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalysisCostBreakdown.cs b/src/Vapi.Net/Types/AnalysisCostBreakdown.cs index 0fd00f52..333078b6 100644 --- a/src/Vapi.Net/Types/AnalysisCostBreakdown.cs +++ b/src/Vapi.Net/Types/AnalysisCostBreakdown.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output generation. +/// [Serializable] public record AnalysisCostBreakdown : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalysisPlan.cs b/src/Vapi.Net/Types/AnalysisPlan.cs index 77519564..f325af74 100644 --- a/src/Vapi.Net/Types/AnalysisPlan.cs +++ b/src/Vapi.Net/Types/AnalysisPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes. +/// [Serializable] public record AnalysisPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalyticsOperation.cs b/src/Vapi.Net/Types/AnalyticsOperation.cs index a8a0c189..6be7eb12 100644 --- a/src/Vapi.Net/Types/AnalyticsOperation.cs +++ b/src/Vapi.Net/Types/AnalyticsOperation.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An aggregation or history operation applied to an analytics column, with an optional response alias. +/// [Serializable] public record AnalyticsOperation : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalyticsQuery.cs b/src/Vapi.Net/Types/AnalyticsQuery.cs index 9eaab578..0c2c27a6 100644 --- a/src/Vapi.Net/Types/AnalyticsQuery.cs +++ b/src/Vapi.Net/Types/AnalyticsQuery.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A named analytics query against call or subscription data, including grouping, time range, and aggregation operations. +/// [Serializable] public record AnalyticsQuery : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnalyticsQueryResult.cs b/src/Vapi.Net/Types/AnalyticsQueryResult.cs index ad202f67..06d4507c 100644 --- a/src/Vapi.Net/Types/AnalyticsQueryResult.cs +++ b/src/Vapi.Net/Types/AnalyticsQueryResult.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// The result of a named analytics query, including the evaluated time range and returned metric data. +/// [Serializable] public record AnalyticsQueryResult : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnthropicBedrockModel.cs b/src/Vapi.Net/Types/AnthropicBedrockModel.cs index 1beb6bc7..edd8e2f8 100644 --- a/src/Vapi.Net/Types/AnthropicBedrockModel.cs +++ b/src/Vapi.Net/Types/AnthropicBedrockModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. +/// [Serializable] public record AnthropicBedrockModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnthropicModel.cs b/src/Vapi.Net/Types/AnthropicModel.cs index 8886855e..0748293a 100644 --- a/src/Vapi.Net/Types/AnthropicModel.cs +++ b/src/Vapi.Net/Types/AnthropicModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. +/// [Serializable] public record AnthropicModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AnthropicThinkingConfig.cs b/src/Vapi.Net/Types/AnthropicThinkingConfig.cs index 8253a81f..3051dff6 100644 --- a/src/Vapi.Net/Types/AnthropicThinkingConfig.cs +++ b/src/Vapi.Net/Types/AnthropicThinkingConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Enables Anthropic extended thinking with a maximum thinking-token budget. +/// [Serializable] public record AnthropicThinkingConfig : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record AnthropicThinkingConfig : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Enables Anthropic extended thinking. + /// [JsonPropertyName("type")] public required AnthropicThinkingConfigType Type { get; set; } diff --git a/src/Vapi.Net/Types/AnyscaleModel.cs b/src/Vapi.Net/Types/AnyscaleModel.cs index 514b1188..04d5d968 100644 --- a/src/Vapi.Net/Types/AnyscaleModel.cs +++ b/src/Vapi.Net/Types/AnyscaleModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record AnyscaleModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ApiRequestTool.cs b/src/Vapi.Net/Types/ApiRequestTool.cs index 3fbe40ea..c307fddd 100644 --- a/src/Vapi.Net/Types/ApiRequestTool.cs +++ b/src/Vapi.Net/Types/ApiRequestTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. +/// [Serializable] public record ApiRequestTool : IJsonOnDeserialized { @@ -19,6 +22,9 @@ public record ApiRequestTool : IJsonOnDeserialized [JsonPropertyName("messages")] public IEnumerable? Messages { get; set; } + /// + /// The HTTP method used for the API request. + /// [JsonPropertyName("method")] public required ApiRequestToolMethod Method { get; set; } diff --git a/src/Vapi.Net/Types/Artifact.cs b/src/Vapi.Net/Types/Artifact.cs index 23335bd6..dfa8f6c5 100644 --- a/src/Vapi.Net/Types/Artifact.cs +++ b/src/Vapi.Net/Types/Artifact.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Artifacts generated during a call, including messages, recordings, transcript, logs, packet capture, workflow-node data, variables, performance metrics, structured outputs, scorecards, and transfers. +/// [Serializable] public record Artifact : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ArtifactPlan.cs b/src/Vapi.Net/Types/ArtifactPlan.cs index 8be0dce7..a5388f74 100644 --- a/src/Vapi.Net/Types/ArtifactPlan.cs +++ b/src/Vapi.Net/Types/ArtifactPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, structured outputs, scorecards, and custom storage paths. +/// [Serializable] public record ArtifactPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssemblyAiTranscriber.cs b/src/Vapi.Net/Types/AssemblyAiTranscriber.cs index 51562e49..d2485c1e 100644 --- a/src/Vapi.Net/Types/AssemblyAiTranscriber.cs +++ b/src/Vapi.Net/Types/AssemblyAiTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, streaming model, endpointing, vocabulary, and fallback settings. +/// [Serializable] public record AssemblyAiTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Assistant.cs b/src/Vapi.Net/Types/Assistant.cs index ebc1ed27..10b081d3 100644 --- a/src/Vapi.Net/Types/Assistant.cs +++ b/src/Vapi.Net/Types/Assistant.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record Assistant : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record Assistant : IJsonOnDeserialized [JsonPropertyName("firstMessage")] public string? FirstMessage { get; set; } + /// + /// Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. + /// [JsonPropertyName("firstMessageInterruptionsEnabled")] public bool? FirstMessageInterruptionsEnabled { get; set; } @@ -166,6 +172,9 @@ public IEnumerable< [JsonPropertyName("endCallPhrases")] public IEnumerable? EndCallPhrases { get; set; } + /// + /// Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. + /// [JsonPropertyName("compliancePlan")] public CompliancePlan? CompliancePlan { get; set; } @@ -256,6 +265,9 @@ public IEnumerable< [JsonPropertyName("server")] public Server? Server { get; set; } + /// + /// Configuration for collecting and processing DTMF keypad input during calls. + /// [JsonPropertyName("keypadInputPlan")] public KeypadInputPlan? KeypadInputPlan { get; set; } diff --git a/src/Vapi.Net/Types/AssistantActivation.cs b/src/Vapi.Net/Types/AssistantActivation.cs index 31f87a0c..3d1c6091 100644 --- a/src/Vapi.Net/Types/AssistantActivation.cs +++ b/src/Vapi.Net/Types/AssistantActivation.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Identifies an assistant that became active during a call. +/// [Serializable] public record AssistantActivation : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantCustomEndpointingRule.cs b/src/Vapi.Net/Types/AssistantCustomEndpointingRule.cs index 0672f04a..3bddf593 100644 --- a/src/Vapi.Net/Types/AssistantCustomEndpointingRule.cs +++ b/src/Vapi.Net/Types/AssistantCustomEndpointingRule.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A custom endpointing rule that matches the assistant's last message and applies a configured timeout. +/// [Serializable] public record AssistantCustomEndpointingRule : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantMessage.cs b/src/Vapi.Net/Types/AssistantMessage.cs index 43feeeee..41e8d991 100644 --- a/src/Vapi.Net/Types/AssistantMessage.cs +++ b/src/Vapi.Net/Types/AssistantMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata. +/// [Serializable] public record AssistantMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantMessageEvaluationContinuePlan.cs b/src/Vapi.Net/Types/AssistantMessageEvaluationContinuePlan.cs index b42f170e..a9965b55 100644 --- a/src/Vapi.Net/Types/AssistantMessageEvaluationContinuePlan.cs +++ b/src/Vapi.Net/Types/AssistantMessageEvaluationContinuePlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional message overrides. +/// [Serializable] public record AssistantMessageEvaluationContinuePlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantMessageJudgePlanAi.cs b/src/Vapi.Net/Types/AssistantMessageJudgePlanAi.cs index 2c1348ae..307ffd8e 100644 --- a/src/Vapi.Net/Types/AssistantMessageJudgePlanAi.cs +++ b/src/Vapi.Net/Types/AssistantMessageJudgePlanAi.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Evaluates an assistant message with an LLM judge and a configured evaluation model. +/// [Serializable] public record AssistantMessageJudgePlanAi : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantMessageJudgePlanExact.cs b/src/Vapi.Net/Types/AssistantMessageJudgePlanExact.cs index 6b310673..263cd030 100644 --- a/src/Vapi.Net/Types/AssistantMessageJudgePlanExact.cs +++ b/src/Vapi.Net/Types/AssistantMessageJudgePlanExact.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Evaluates an assistant message using case-insensitive exact content matching and expected tool calls. +/// [Serializable] public record AssistantMessageJudgePlanExact : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantMessageJudgePlanRegex.cs b/src/Vapi.Net/Types/AssistantMessageJudgePlanRegex.cs index eec0afa9..9093ef28 100644 --- a/src/Vapi.Net/Types/AssistantMessageJudgePlanRegex.cs +++ b/src/Vapi.Net/Types/AssistantMessageJudgePlanRegex.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Evaluates assistant-message content and tool-call arguments using regular-expression patterns. +/// [Serializable] public record AssistantMessageJudgePlanRegex : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AssistantOverrides.cs b/src/Vapi.Net/Types/AssistantOverrides.cs index f23046d5..07977401 100644 --- a/src/Vapi.Net/Types/AssistantOverrides.cs +++ b/src/Vapi.Net/Types/AssistantOverrides.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and server configuration. +/// [Serializable] public record AssistantOverrides : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record AssistantOverrides : IJsonOnDeserialized [JsonPropertyName("firstMessage")] public string? FirstMessage { get; set; } + /// + /// Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. + /// [JsonPropertyName("firstMessageInterruptionsEnabled")] public bool? FirstMessageInterruptionsEnabled { get; set; } @@ -136,6 +142,9 @@ public IEnumerable< > >? Hooks { get; set; } + /// + /// Tools to append to the assistant's existing tool configuration. + /// [JsonPropertyName("tools:append")] public IEnumerable? ToolsAppend { get; set; } @@ -181,6 +190,9 @@ public IEnumerable< [JsonPropertyName("endCallPhrases")] public IEnumerable? EndCallPhrases { get; set; } + /// + /// Compliance settings to apply, including HIPAA and PCI behavior, security filtering, and recording consent. + /// [JsonPropertyName("compliancePlan")] public CompliancePlan? CompliancePlan { get; set; } @@ -271,6 +283,9 @@ public IEnumerable< [JsonPropertyName("server")] public Server? Server { get; set; } + /// + /// Configuration for collecting and processing DTMF keypad input. + /// [JsonPropertyName("keypadInputPlan")] public KeypadInputPlan? KeypadInputPlan { get; set; } diff --git a/src/Vapi.Net/Types/AwsStsAuthenticationPlan.cs b/src/Vapi.Net/Types/AwsStsAuthenticationPlan.cs index d369df49..3bc5b705 100644 --- a/src/Vapi.Net/Types/AwsStsAuthenticationPlan.cs +++ b/src/Vapi.Net/Types/AwsStsAuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// AWS Security Token Service role-assumption configuration used to authenticate requests. +/// [Serializable] public record AwsStsAuthenticationPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AwsiamCredentialsAuthenticationPlan.cs b/src/Vapi.Net/Types/AwsiamCredentialsAuthenticationPlan.cs index 1df97bfc..1c32c14c 100644 --- a/src/Vapi.Net/Types/AwsiamCredentialsAuthenticationPlan.cs +++ b/src/Vapi.Net/Types/AwsiamCredentialsAuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Direct AWS IAM credentials used to authenticate requests. +/// [Serializable] public record AwsiamCredentialsAuthenticationPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AzureBlobStorageBucketPlan.cs b/src/Vapi.Net/Types/AzureBlobStorageBucketPlan.cs index 54b4cd87..c2730a93 100644 --- a/src/Vapi.Net/Types/AzureBlobStorageBucketPlan.cs +++ b/src/Vapi.Net/Types/AzureBlobStorageBucketPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Azure Blob Storage container configuration for call artifacts, including its connection string, container name, and storage path. +/// [Serializable] public record AzureBlobStorageBucketPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AzureSpeechTranscriber.cs b/src/Vapi.Net/Types/AzureSpeechTranscriber.cs index 24fe1bdd..3507340d 100644 --- a/src/Vapi.Net/Types/AzureSpeechTranscriber.cs +++ b/src/Vapi.Net/Types/AzureSpeechTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Azure Speech, including language, segmentation, and fallback settings. +/// [Serializable] public record AzureSpeechTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/AzureVoice.cs b/src/Vapi.Net/Types/AzureVoice.cs index 61ee50a2..e5696fb8 100644 --- a/src/Vapi.Net/Types/AzureVoice.cs +++ b/src/Vapi.Net/Types/AzureVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, and fallback settings. +/// [Serializable] public record AzureVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/BackgroundSpeechDenoisingPlan.cs b/src/Vapi.Net/Types/BackgroundSpeechDenoisingPlan.cs index f28b09d8..843c9175 100644 --- a/src/Vapi.Net/Types/BackgroundSpeechDenoisingPlan.cs +++ b/src/Vapi.Net/Types/BackgroundSpeechDenoisingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls smart and Fourier denoising applied to customer audio before transcription. +/// [Serializable] public record BackgroundSpeechDenoisingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/BackoffPlan.cs b/src/Vapi.Net/Types/BackoffPlan.cs index fb50929c..3b91aa3a 100644 --- a/src/Vapi.Net/Types/BackoffPlan.cs +++ b/src/Vapi.Net/Types/BackoffPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status codes excluded from retries. +/// [Serializable] public record BackoffPlan : IJsonOnDeserialized { @@ -28,14 +31,13 @@ public record BackoffPlan : IJsonOnDeserialized public required double MaxRetries { get; set; } /// - /// 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. /// [JsonPropertyName("baseDelaySeconds")] public required double BaseDelaySeconds { get; set; } /// - /// 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. /// [JsonPropertyName("excludedStatusCodes")] public IEnumerable? ExcludedStatusCodes { get; set; } diff --git a/src/Vapi.Net/Types/BarInsight.cs b/src/Vapi.Net/Types/BarInsight.cs index 16e4e8d6..1e082a3c 100644 --- a/src/Vapi.Net/Types/BarInsight.cs +++ b/src/Vapi.Net/Types/BarInsight.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. +/// [Serializable] public record BarInsight : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record BarInsight : IJsonOnDeserialized [JsonPropertyName("metadata")] public BarInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the bar-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/BarInsightMetadata.cs b/src/Vapi.Net/Types/BarInsightMetadata.cs index c3948d4b..5c833dbd 100644 --- a/src/Vapi.Net/Types/BarInsightMetadata.cs +++ b/src/Vapi.Net/Types/BarInsightMetadata.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds. +/// [Serializable] public record BarInsightMetadata : IJsonOnDeserialized { @@ -11,18 +14,33 @@ public record BarInsightMetadata : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Label displayed on the chart's x-axis. + /// [JsonPropertyName("xAxisLabel")] public string? XAxisLabel { get; set; } + /// + /// Label displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisLabel")] public string? YAxisLabel { get; set; } + /// + /// Minimum value displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisMin")] public double? YAxisMin { get; set; } + /// + /// Maximum value displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisMax")] public double? YAxisMax { get; set; } + /// + /// Display name for the insight chart. + /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Vapi.Net/Types/BashTool.cs b/src/Vapi.Net/Types/BashTool.cs index 869968a4..e1e26896 100644 --- a/src/Vapi.Net/Types/BashTool.cs +++ b/src/Vapi.Net/Types/BashTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that executes shell commands in a configured environment. +/// [Serializable] public record BashTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/BearerAuthenticationPlan.cs b/src/Vapi.Net/Types/BearerAuthenticationPlan.cs index db69ea69..0563906f 100644 --- a/src/Vapi.Net/Types/BearerAuthenticationPlan.cs +++ b/src/Vapi.Net/Types/BearerAuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for authenticating outbound requests with a bearer token, including header name and optional `Bearer` prefix. +/// [Serializable] public record BearerAuthenticationPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/BotMessage.cs b/src/Vapi.Net/Types/BotMessage.cs index 8bcda6c5..b932b603 100644 --- a/src/Vapi.Net/Types/BotMessage.cs +++ b/src/Vapi.Net/Types/BotMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An assistant-authored entry in the call message history, including content, timing, source, and duration. +/// [Serializable] public record BotMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/BothCustomEndpointingRule.cs b/src/Vapi.Net/Types/BothCustomEndpointingRule.cs index 93db3a26..c1bc98aa 100644 --- a/src/Vapi.Net/Types/BothCustomEndpointingRule.cs +++ b/src/Vapi.Net/Types/BothCustomEndpointingRule.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A custom endpointing rule that matches both the assistant's last message and the customer's current speech before applying a configured timeout. +/// [Serializable] public record BothCustomEndpointingRule : IJsonOnDeserialized { @@ -32,6 +35,9 @@ public record BothCustomEndpointingRule : IJsonOnDeserialized [JsonPropertyName("assistantRegexOptions")] public IEnumerable? AssistantRegexOptions { get; set; } + /// + /// The regular expression pattern matched against the customer's speech. + /// [JsonPropertyName("customerRegex")] public required string CustomerRegex { get; set; } diff --git a/src/Vapi.Net/Types/BucketPlan.cs b/src/Vapi.Net/Types/BucketPlan.cs index f0c1c8b4..0a79931e 100644 --- a/src/Vapi.Net/Types/BucketPlan.cs +++ b/src/Vapi.Net/Types/BucketPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional HMAC credentials. +/// [Serializable] public record BucketPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ByoPhoneNumber.cs b/src/Vapi.Net/Types/ByoPhoneNumber.cs index e9a2ed76..dea325ec 100644 --- a/src/Vapi.Net/Types/ByoPhoneNumber.cs +++ b/src/Vapi.Net/Types/ByoPhoneNumber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata. +/// [Serializable] public record ByoPhoneNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Call.cs b/src/Vapi.Net/Types/Call.cs index 9dafa1f8..efa3a5b7 100644 --- a/src/Vapi.Net/Types/Call.cs +++ b/src/Vapi.Net/Types/Call.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record Call : IJsonOnDeserialized { @@ -24,6 +27,9 @@ public record Call : IJsonOnDeserialized [JsonPropertyName("costs")] public IEnumerable? Costs { get; set; } + /// + /// Messages exchanged during the call, including user, assistant, system, tool-call, and tool-result messages. + /// [JsonPropertyName("messages")] public IEnumerable< OneOf diff --git a/src/Vapi.Net/Types/CallBatchError.cs b/src/Vapi.Net/Types/CallBatchError.cs index 1a42c808..634c03dd 100644 --- a/src/Vapi.Net/Types/CallBatchError.cs +++ b/src/Vapi.Net/Types/CallBatchError.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Error returned for one customer entry in a batch call request. +/// [Serializable] public record CallBatchError : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record CallBatchError : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Customer configuration associated with the failed call. + /// [JsonPropertyName("customer")] public required CreateCustomerDto Customer { get; set; } + /// + /// Error message explaining why the call could not be created. + /// [JsonPropertyName("error")] public required string Error { get; set; } diff --git a/src/Vapi.Net/Types/CallBatchResponse.cs b/src/Vapi.Net/Types/CallBatchResponse.cs index ad032e67..ff3fbc54 100644 --- a/src/Vapi.Net/Types/CallBatchResponse.cs +++ b/src/Vapi.Net/Types/CallBatchResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record CallBatchResponse : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CallHookAssistantSpeechInterrupted.cs b/src/Vapi.Net/Types/CallHookAssistantSpeechInterrupted.cs index b42ad7f3..d0112a05 100644 --- a/src/Vapi.Net/Types/CallHookAssistantSpeechInterrupted.cs +++ b/src/Vapi.Net/Types/CallHookAssistantSpeechInterrupted.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured actions when the customer's speech interrupts the assistant. +/// [Serializable] public record CallHookAssistantSpeechInterrupted : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CallHookCallEnding.cs b/src/Vapi.Net/Types/CallHookCallEnding.cs index c35329db..b4257a5c 100644 --- a/src/Vapi.Net/Types/CallHookCallEnding.cs +++ b/src/Vapi.Net/Types/CallHookCallEnding.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured actions when a call is ending, optionally only when its filters match. +/// [Serializable] public record CallHookCallEnding : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CallHookCustomerSpeechInterrupted.cs b/src/Vapi.Net/Types/CallHookCustomerSpeechInterrupted.cs index 0f5eb86a..bc6bde4f 100644 --- a/src/Vapi.Net/Types/CallHookCustomerSpeechInterrupted.cs +++ b/src/Vapi.Net/Types/CallHookCustomerSpeechInterrupted.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured actions when the assistant interrupts the customer's speech. +/// [Serializable] public record CallHookCustomerSpeechInterrupted : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CallHookCustomerSpeechTimeout.cs b/src/Vapi.Net/Types/CallHookCustomerSpeechTimeout.cs index a9d3bd23..0b093f34 100644 --- a/src/Vapi.Net/Types/CallHookCustomerSpeechTimeout.cs +++ b/src/Vapi.Net/Types/CallHookCustomerSpeechTimeout.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured actions when the customer does not speak before the configured timeout, with support for trigger limits and named instances. +/// [Serializable] public record CallHookCustomerSpeechTimeout : IJsonOnDeserialized { @@ -24,7 +27,7 @@ public record CallHookCustomerSpeechTimeout : IJsonOnDeserialized public IEnumerable Do { get; set; } = new List(); /// - /// 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. /// [JsonPropertyName("options")] public CustomerSpeechTimeoutOptions? Options { get; set; } diff --git a/src/Vapi.Net/Types/CallHookFilter.cs b/src/Vapi.Net/Types/CallHookFilter.cs index 0bfdb111..5abd84e1 100644 --- a/src/Vapi.Net/Types/CallHookFilter.cs +++ b/src/Vapi.Net/Types/CallHookFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Matches a call field against one or more allowed values to determine whether a hook runs. +/// [Serializable] public record CallHookFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CallHookModelResponseTimeout.cs b/src/Vapi.Net/Types/CallHookModelResponseTimeout.cs index 9bf3700c..8c451bb4 100644 --- a/src/Vapi.Net/Types/CallHookModelResponseTimeout.cs +++ b/src/Vapi.Net/Types/CallHookModelResponseTimeout.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured actions when the language model does not respond before its timeout. +/// [Serializable] public record CallHookModelResponseTimeout : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Campaign.cs b/src/Vapi.Net/Types/Campaign.cs index 0fc42fd2..e5195990 100644 --- a/src/Vapi.Net/Types/Campaign.cs +++ b/src/Vapi.Net/Types/Campaign.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and call-progress counters. +/// [Serializable] public record Campaign : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CampaignPaginatedResponse.cs b/src/Vapi.Net/Types/CampaignPaginatedResponse.cs index 6e2e68d6..b83423b8 100644 --- a/src/Vapi.Net/Types/CampaignPaginatedResponse.cs +++ b/src/Vapi.Net/Types/CampaignPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of outbound calling campaigns and metadata describing the result set. +/// [Serializable] public record CampaignPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record CampaignPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The campaigns returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the campaign result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/CartesiaExperimentalControls.cs b/src/Vapi.Net/Types/CartesiaExperimentalControls.cs index ce9ae9f8..7fe2f1b6 100644 --- a/src/Vapi.Net/Types/CartesiaExperimentalControls.cs +++ b/src/Vapi.Net/Types/CartesiaExperimentalControls.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Cartesia voice controls for speed and emotion. +/// [Serializable] public record CartesiaExperimentalControls : IJsonOnDeserialized { @@ -12,9 +15,15 @@ public record CartesiaExperimentalControls : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Speaking-speed control expressed as a preset or a value from -1 to 1. + /// [JsonPropertyName("speed")] public OneOf? Speed { get; set; } + /// + /// Emotion and intensity applied to the Cartesia voice. + /// [JsonPropertyName("emotion")] public CartesiaExperimentalControlsEmotion? Emotion { get; set; } diff --git a/src/Vapi.Net/Types/CartesiaGenerationConfig.cs b/src/Vapi.Net/Types/CartesiaGenerationConfig.cs index ba607677..5aab8c43 100644 --- a/src/Vapi.Net/Types/CartesiaGenerationConfig.cs +++ b/src/Vapi.Net/Types/CartesiaGenerationConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization. +/// [Serializable] public record CartesiaGenerationConfig : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CartesiaGenerationConfigExperimental.cs b/src/Vapi.Net/Types/CartesiaGenerationConfigExperimental.cs index 19ae194d..f68ef067 100644 --- a/src/Vapi.Net/Types/CartesiaGenerationConfigExperimental.cs +++ b/src/Vapi.Net/Types/CartesiaGenerationConfigExperimental.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Cartesia Sonic 3 generation controls, including accent localization. +/// [Serializable] public record CartesiaGenerationConfigExperimental : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CartesiaTranscriber.cs b/src/Vapi.Net/Types/CartesiaTranscriber.cs index dc1c6f6a..7c0bb14a 100644 --- a/src/Vapi.Net/Types/CartesiaTranscriber.cs +++ b/src/Vapi.Net/Types/CartesiaTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and fallback settings. +/// [Serializable] public record CartesiaTranscriber : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record CartesiaTranscriber : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The Cartesia speech-to-text model used for transcription. + /// [JsonPropertyName("model")] public CartesiaTranscriberModel? Model { get; set; } + /// + /// The language code used for transcription. + /// [JsonPropertyName("language")] public CartesiaTranscriberLanguage? Language { get; set; } diff --git a/src/Vapi.Net/Types/CartesiaVoice.cs b/src/Vapi.Net/Types/CartesiaVoice.cs index b3f0ce7e..25d3501f 100644 --- a/src/Vapi.Net/Types/CartesiaVoice.cs +++ b/src/Vapi.Net/Types/CartesiaVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, caching, and fallback settings. +/// [Serializable] public record CartesiaVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CerebrasModel.cs b/src/Vapi.Net/Types/CerebrasModel.cs index 6106c1b5..e214918f 100644 --- a/src/Vapi.Net/Types/CerebrasModel.cs +++ b/src/Vapi.Net/Types/CerebrasModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record CerebrasModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalAssistantMessageEvaluation.cs b/src/Vapi.Net/Types/ChatEvalAssistantMessageEvaluation.cs index 29e81ddc..e4bf2027 100644 --- a/src/Vapi.Net/Types/ChatEvalAssistantMessageEvaluation.cs +++ b/src/Vapi.Net/Types/ChatEvalAssistantMessageEvaluation.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue afterward. +/// [Serializable] public record ChatEvalAssistantMessageEvaluation : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalAssistantMessageMock.cs b/src/Vapi.Net/Types/ChatEvalAssistantMessageMock.cs index dce1af9f..3cc0ac40 100644 --- a/src/Vapi.Net/Types/ChatEvalAssistantMessageMock.cs +++ b/src/Vapi.Net/Types/ChatEvalAssistantMessageMock.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A simulated assistant turn in an evaluation conversation, with optional message content and tool calls. +/// [Serializable] public record ChatEvalAssistantMessageMock : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalAssistantMessageMockToolCall.cs b/src/Vapi.Net/Types/ChatEvalAssistantMessageMockToolCall.cs index 4e34cdfa..b6ae4539 100644 --- a/src/Vapi.Net/Types/ChatEvalAssistantMessageMockToolCall.cs +++ b/src/Vapi.Net/Types/ChatEvalAssistantMessageMockToolCall.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A simulated assistant tool call with the tool name and optional arguments. +/// [Serializable] public record ChatEvalAssistantMessageMockToolCall : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalSystemMessageMock.cs b/src/Vapi.Net/Types/ChatEvalSystemMessageMock.cs index f90df451..8f37501f 100644 --- a/src/Vapi.Net/Types/ChatEvalSystemMessageMock.cs +++ b/src/Vapi.Net/Types/ChatEvalSystemMessageMock.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A simulated system message in an evaluation conversation. +/// [Serializable] public record ChatEvalSystemMessageMock : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalToolResponseMessageEvaluation.cs b/src/Vapi.Net/Types/ChatEvalToolResponseMessageEvaluation.cs index 93a2b5aa..d521db68 100644 --- a/src/Vapi.Net/Types/ChatEvalToolResponseMessageEvaluation.cs +++ b/src/Vapi.Net/Types/ChatEvalToolResponseMessageEvaluation.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An expected tool-response turn evaluated by a configured LLM judge. +/// [Serializable] public record ChatEvalToolResponseMessageEvaluation : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalToolResponseMessageMock.cs b/src/Vapi.Net/Types/ChatEvalToolResponseMessageMock.cs index 944b7ca7..774dbd66 100644 --- a/src/Vapi.Net/Types/ChatEvalToolResponseMessageMock.cs +++ b/src/Vapi.Net/Types/ChatEvalToolResponseMessageMock.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A simulated tool response in an evaluation conversation. +/// [Serializable] public record ChatEvalToolResponseMessageMock : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChatEvalUserMessageMock.cs b/src/Vapi.Net/Types/ChatEvalUserMessageMock.cs index 46f9053d..0de3c341 100644 --- a/src/Vapi.Net/Types/ChatEvalUserMessageMock.cs +++ b/src/Vapi.Net/Types/ChatEvalUserMessageMock.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A simulated user message in an evaluation conversation. +/// [Serializable] public record ChatEvalUserMessageMock : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ChunkPlan.cs b/src/Vapi.Net/Types/ChunkPlan.cs index d7576c9f..4adddfad 100644 --- a/src/Vapi.Net/Types/ChunkPlan.cs +++ b/src/Vapi.Net/Types/ChunkPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation boundaries, and formatting. +/// [Serializable] public record ChunkPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CloudflareR2BucketPlan.cs b/src/Vapi.Net/Types/CloudflareR2BucketPlan.cs index 43165dcb..72b556ce 100644 --- a/src/Vapi.Net/Types/CloudflareR2BucketPlan.cs +++ b/src/Vapi.Net/Types/CloudflareR2BucketPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and path. +/// [Serializable] public record CloudflareR2BucketPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CodeTool.cs b/src/Vapi.Net/Types/CodeTool.cs index 8c1c1b7b..16e18c3c 100644 --- a/src/Vapi.Net/Types/CodeTool.cs +++ b/src/Vapi.Net/Types/CodeTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. +/// [Serializable] public record CodeTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CodeToolEnvironmentVariable.cs b/src/Vapi.Net/Types/CodeToolEnvironmentVariable.cs index 73585828..21268dfb 100644 --- a/src/Vapi.Net/Types/CodeToolEnvironmentVariable.cs +++ b/src/Vapi.Net/Types/CodeToolEnvironmentVariable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An environment variable supplied to code-tool execution, with support for Liquid templates in its value. +/// [Serializable] public record CodeToolEnvironmentVariable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Compliance.cs b/src/Vapi.Net/Types/Compliance.cs index 21948296..67020f75 100644 --- a/src/Vapi.Net/Types/Compliance.cs +++ b/src/Vapi.Net/Types/Compliance.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Compliance information captured for a call, including recording consent. +/// [Serializable] public record Compliance : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ComplianceOverride.cs b/src/Vapi.Net/Types/ComplianceOverride.cs index 0e619420..fb0b1329 100644 --- a/src/Vapi.Net/Types/ComplianceOverride.cs +++ b/src/Vapi.Net/Types/ComplianceOverride.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Overrides storage behavior for an output when HIPAA compliance is enabled. +/// [Serializable] public record ComplianceOverride : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CompliancePlan.cs b/src/Vapi.Net/Types/CompliancePlan.cs index cfed285e..3f36c426 100644 --- a/src/Vapi.Net/Types/CompliancePlan.cs +++ b/src/Vapi.Net/Types/CompliancePlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant calls. +/// [Serializable] public record CompliancePlan : IJsonOnDeserialized { @@ -30,6 +33,9 @@ public record CompliancePlan : IJsonOnDeserialized [JsonPropertyName("securityFilterPlan")] public SecurityFilterPlan? SecurityFilterPlan { get; set; } + /// + /// Controls how recording consent is requested before the assistant joins the call. + /// [JsonPropertyName("recordingConsentPlan")] public object? RecordingConsentPlan { get; set; } diff --git a/src/Vapi.Net/Types/ComputerTool.cs b/src/Vapi.Net/Types/ComputerTool.cs index 3b3b485a..a96c6890 100644 --- a/src/Vapi.Net/Types/ComputerTool.cs +++ b/src/Vapi.Net/Types/ComputerTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. +/// [Serializable] public record ComputerTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Condition.cs b/src/Vapi.Net/Types/Condition.cs index 7b02c307..25c87324 100644 --- a/src/Vapi.Net/Types/Condition.cs +++ b/src/Vapi.Net/Types/Condition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Compares a named parameter with a value using the selected comparison operator. +/// [Serializable] public record Condition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ContextEngineeringPlanAll.cs b/src/Vapi.Net/Types/ContextEngineeringPlanAll.cs index bbd71571..a0ad070f 100644 --- a/src/Vapi.Net/Types/ContextEngineeringPlanAll.cs +++ b/src/Vapi.Net/Types/ContextEngineeringPlanAll.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Includes all available messages when constructing context for a handoff. +/// [Serializable] public record ContextEngineeringPlanAll : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ContextEngineeringPlanLastNMessages.cs b/src/Vapi.Net/Types/ContextEngineeringPlanLastNMessages.cs index 17ac3571..ed443735 100644 --- a/src/Vapi.Net/Types/ContextEngineeringPlanLastNMessages.cs +++ b/src/Vapi.Net/Types/ContextEngineeringPlanLastNMessages.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Includes a configured number of the most recent messages when constructing context for a handoff. +/// [Serializable] public record ContextEngineeringPlanLastNMessages : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ContextEngineeringPlanNone.cs b/src/Vapi.Net/Types/ContextEngineeringPlanNone.cs index de4ff7b1..943f1e98 100644 --- a/src/Vapi.Net/Types/ContextEngineeringPlanNone.cs +++ b/src/Vapi.Net/Types/ContextEngineeringPlanNone.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Excludes prior conversation messages when constructing context for a handoff. +/// [Serializable] public record ContextEngineeringPlanNone : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ContextEngineeringPlanUserAndAssistantMessages.cs b/src/Vapi.Net/Types/ContextEngineeringPlanUserAndAssistantMessages.cs index 6a72e615..c566cb2f 100644 --- a/src/Vapi.Net/Types/ContextEngineeringPlanUserAndAssistantMessages.cs +++ b/src/Vapi.Net/Types/ContextEngineeringPlanUserAndAssistantMessages.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Includes only user and assistant messages when constructing context for a handoff. +/// [Serializable] public record ContextEngineeringPlanUserAndAssistantMessages : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ConversationNode.cs b/src/Vapi.Net/Types/ConversationNode.cs index 1098d302..c5b247bf 100644 --- a/src/Vapi.Net/Types/ConversationNode.cs +++ b/src/Vapi.Net/Types/ConversationNode.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, and variable extraction. +/// [Serializable] public record ConversationNode : IJsonOnDeserialized { @@ -51,6 +54,9 @@ public record ConversationNode : IJsonOnDeserialized [JsonPropertyName("toolIds")] public IEnumerable? ToolIds { get; set; } + /// + /// Prompt that guides the assistant while this node is active. + /// [JsonPropertyName("prompt")] public string? Prompt { get; set; } @@ -112,6 +118,9 @@ public record ConversationNode : IJsonOnDeserialized [JsonPropertyName("variableExtractionPlan")] public VariableExtractionPlan? VariableExtractionPlan { get; set; } + /// + /// Unique name used to identify this workflow node. + /// [JsonPropertyName("name")] public required string Name { get; set; } diff --git a/src/Vapi.Net/Types/CostBreakdown.cs b/src/Vapi.Net/Types/CostBreakdown.cs index 9227e659..fc3c7ce3 100644 --- a/src/Vapi.Net/Types/CostBreakdown.cs +++ b/src/Vapi.Net/Types/CostBreakdown.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and character totals. +/// [Serializable] public record CostBreakdown : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateAnthropicBedrockCredentialDto.cs b/src/Vapi.Net/Types/CreateAnthropicBedrockCredentialDto.cs index bd6b9081..fa04ddca 100644 --- a/src/Vapi.Net/Types/CreateAnthropicBedrockCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAnthropicBedrockCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and authentication method. +/// [Serializable] public record CreateAnthropicBedrockCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateAnthropicCredentialDto.cs b/src/Vapi.Net/Types/CreateAnthropicCredentialDto.cs index dcb9083e..44abf2d4 100644 --- a/src/Vapi.Net/Types/CreateAnthropicCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAnthropicCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Anthropic. +/// [Serializable] public record CreateAnthropicCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateAnyscaleCredentialDto.cs b/src/Vapi.Net/Types/CreateAnyscaleCredentialDto.cs index 9b918a58..48904fed 100644 --- a/src/Vapi.Net/Types/CreateAnyscaleCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAnyscaleCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Anyscale. +/// [Serializable] public record CreateAnyscaleCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateApiRequestToolDto.cs b/src/Vapi.Net/Types/CreateApiRequestToolDto.cs index c6903a3d..d8bf960a 100644 --- a/src/Vapi.Net/Types/CreateApiRequestToolDto.cs +++ b/src/Vapi.Net/Types/CreateApiRequestToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record CreateApiRequestToolDto : IJsonOnDeserialized { @@ -19,6 +22,9 @@ public record CreateApiRequestToolDto : IJsonOnDeserialized [JsonPropertyName("messages")] public IEnumerable? Messages { get; set; } + /// + /// The HTTP method used for the API request. + /// [JsonPropertyName("method")] public required CreateApiRequestToolDtoMethod Method { get; set; } diff --git a/src/Vapi.Net/Types/CreateAssemblyAiCredentialDto.cs b/src/Vapi.Net/Types/CreateAssemblyAiCredentialDto.cs index a49271bd..ed0c0244 100644 --- a/src/Vapi.Net/Types/CreateAssemblyAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAssemblyAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating transcription requests with AssemblyAI. +/// [Serializable] public record CreateAssemblyAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateAssistantDto.cs b/src/Vapi.Net/Types/CreateAssistantDto.cs index 40a7fea7..f897a85a 100644 --- a/src/Vapi.Net/Types/CreateAssistantDto.cs +++ b/src/Vapi.Net/Types/CreateAssistantDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and conversation behavior. +/// [Serializable] public record CreateAssistantDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record CreateAssistantDto : IJsonOnDeserialized [JsonPropertyName("firstMessage")] public string? FirstMessage { get; set; } + /// + /// Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. + /// [JsonPropertyName("firstMessageInterruptionsEnabled")] public bool? FirstMessageInterruptionsEnabled { get; set; } @@ -166,6 +172,9 @@ public IEnumerable< [JsonPropertyName("endCallPhrases")] public IEnumerable? EndCallPhrases { get; set; } + /// + /// Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. + /// [JsonPropertyName("compliancePlan")] public CompliancePlan? CompliancePlan { get; set; } @@ -256,6 +265,9 @@ public IEnumerable< [JsonPropertyName("server")] public Server? Server { get; set; } + /// + /// Configuration for collecting and processing DTMF keypad input during calls. + /// [JsonPropertyName("keypadInputPlan")] public KeypadInputPlan? KeypadInputPlan { get; set; } diff --git a/src/Vapi.Net/Types/CreateAzureCredentialDto.cs b/src/Vapi.Net/Types/CreateAzureCredentialDto.cs index 23606646..5e708eed 100644 --- a/src/Vapi.Net/Types/CreateAzureCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAzureCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings. +/// [Serializable] public record CreateAzureCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateAzureOpenAiCredentialDto.cs b/src/Vapi.Net/Types/CreateAzureOpenAiCredentialDto.cs index d0297088..f0c818e3 100644 --- a/src/Vapi.Net/Types/CreateAzureOpenAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateAzureOpenAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and available models. +/// [Serializable] public record CreateAzureOpenAiCredentialDto : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record CreateAzureOpenAiCredentialDto : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Azure region that hosts the OpenAI resource. + /// [JsonPropertyName("region")] public required CreateAzureOpenAiCredentialDtoRegion Region { get; set; } + /// + /// Azure OpenAI models available through this credential. + /// [JsonPropertyName("models")] public IEnumerable Models { get; set; } = new List(); @@ -30,6 +39,9 @@ public record CreateAzureOpenAiCredentialDto : IJsonOnDeserialized [JsonPropertyName("ocpApimSubscriptionKey")] public string? OcpApimSubscriptionKey { get; set; } + /// + /// Endpoint URL for the Azure OpenAI resource. + /// [JsonPropertyName("openAIEndpoint")] public required string OpenAiEndpoint { get; set; } diff --git a/src/Vapi.Net/Types/CreateBarInsightFromCallTableDto.cs b/src/Vapi.Net/Types/CreateBarInsightFromCallTableDto.cs index 77ac866b..2d051305 100644 --- a/src/Vapi.Net/Types/CreateBarInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/CreateBarInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. +/// [Serializable] public record CreateBarInsightFromCallTableDto : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record CreateBarInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("metadata")] public BarInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the bar-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/CreateBashToolDto.cs b/src/Vapi.Net/Types/CreateBashToolDto.cs index a6b1e214..f256fee7 100644 --- a/src/Vapi.Net/Types/CreateBashToolDto.cs +++ b/src/Vapi.Net/Types/CreateBashToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that executes shell commands in a configured environment. +/// [Serializable] public record CreateBashToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateByoPhoneNumberDto.cs b/src/Vapi.Net/Types/CreateByoPhoneNumberDto.cs index 60c0f6b2..cec7a7db 100644 --- a/src/Vapi.Net/Types/CreateByoPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/CreateByoPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing settings. +/// [Serializable] public record CreateByoPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateByoSipTrunkCredentialDto.cs b/src/Vapi.Net/Types/CreateByoSipTrunkCredentialDto.cs index 39b51c15..ffcb402b 100644 --- a/src/Vapi.Net/Types/CreateByoSipTrunkCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateByoSipTrunkCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record CreateByoSipTrunkCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCartesiaCredentialDto.cs b/src/Vapi.Net/Types/CreateCartesiaCredentialDto.cs index d85c804f..9165c561 100644 --- a/src/Vapi.Net/Types/CreateCartesiaCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateCartesiaCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating speech recognition and voice synthesis requests with Cartesia. +/// [Serializable] public record CreateCartesiaCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCerebrasCredentialDto.cs b/src/Vapi.Net/Types/CreateCerebrasCredentialDto.cs index c05f4ebc..38049f04 100644 --- a/src/Vapi.Net/Types/CreateCerebrasCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateCerebrasCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Cerebras. +/// [Serializable] public record CreateCerebrasCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCloudflareCredentialDto.cs b/src/Vapi.Net/Types/CreateCloudflareCredentialDto.cs index 1ad62f16..afa4a474 100644 --- a/src/Vapi.Net/Types/CreateCloudflareCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateCloudflareCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and upload fallback order. +/// [Serializable] public record CreateCloudflareCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCodeToolDto.cs b/src/Vapi.Net/Types/CreateCodeToolDto.cs index f6cea4e3..7a79874e 100644 --- a/src/Vapi.Net/Types/CreateCodeToolDto.cs +++ b/src/Vapi.Net/Types/CreateCodeToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. +/// [Serializable] public record CreateCodeToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateComputerToolDto.cs b/src/Vapi.Net/Types/CreateComputerToolDto.cs index 3234a0fd..582055f9 100644 --- a/src/Vapi.Net/Types/CreateComputerToolDto.cs +++ b/src/Vapi.Net/Types/CreateComputerToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. +/// [Serializable] public record CreateComputerToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCustomCredentialDto.cs b/src/Vapi.Net/Types/CreateCustomCredentialDto.cs index 9b2f1851..f4de523f 100644 --- a/src/Vapi.Net/Types/CreateCustomCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateCustomCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for sensitive request data. +/// [Serializable] public record CreateCustomCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCustomKnowledgeBaseDto.cs b/src/Vapi.Net/Types/CreateCustomKnowledgeBaseDto.cs index 02b692c7..1fe55874 100644 --- a/src/Vapi.Net/Types/CreateCustomKnowledgeBaseDto.cs +++ b/src/Vapi.Net/Types/CreateCustomKnowledgeBaseDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for connecting a custom knowledge-base implementation through a customer-hosted server. +/// [Serializable] public record CreateCustomKnowledgeBaseDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCustomLlmCredentialDto.cs b/src/Vapi.Net/Types/CreateCustomLlmCredentialDto.cs index e1166bdc..1bd36134 100644 --- a/src/Vapi.Net/Types/CreateCustomLlmCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateCustomLlmCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication plan. +/// [Serializable] public record CreateCustomLlmCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateCustomerDto.cs b/src/Vapi.Net/Types/CreateCustomerDto.cs index 0ec3addf..62d275ba 100644 --- a/src/Vapi.Net/Types/CreateCustomerDto.cs +++ b/src/Vapi.Net/Types/CreateCustomerDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact identifiers, extension, and assistant overrides. +/// [Serializable] public record CreateCustomerDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateDeepInfraCredentialDto.cs b/src/Vapi.Net/Types/CreateDeepInfraCredentialDto.cs index 60f72310..dae8c200 100644 --- a/src/Vapi.Net/Types/CreateDeepInfraCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateDeepInfraCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with DeepInfra. +/// [Serializable] public record CreateDeepInfraCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateDeepSeekCredentialDto.cs b/src/Vapi.Net/Types/CreateDeepSeekCredentialDto.cs index 943ba331..a886dc35 100644 --- a/src/Vapi.Net/Types/CreateDeepSeekCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateDeepSeekCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with DeepSeek. +/// [Serializable] public record CreateDeepSeekCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateDeepgramCredentialDto.cs b/src/Vapi.Net/Types/CreateDeepgramCredentialDto.cs index f21b4d20..54cc77c1 100644 --- a/src/Vapi.Net/Types/CreateDeepgramCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateDeepgramCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API URL for an on-premises instance. +/// [Serializable] public record CreateDeepgramCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateDtmfToolDto.cs b/src/Vapi.Net/Types/CreateDtmfToolDto.cs index baa688f8..0cd253c9 100644 --- a/src/Vapi.Net/Types/CreateDtmfToolDto.cs +++ b/src/Vapi.Net/Types/CreateDtmfToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call. +/// [Serializable] public record CreateDtmfToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateElevenLabsCredentialDto.cs b/src/Vapi.Net/Types/CreateElevenLabsCredentialDto.cs index 5cae0f83..093efd5d 100644 --- a/src/Vapi.Net/Types/CreateElevenLabsCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateElevenLabsCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs. +/// [Serializable] public record CreateElevenLabsCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateEmailCredentialDto.cs b/src/Vapi.Net/Types/CreateEmailCredentialDto.cs index 9f26c552..d90fd7e0 100644 --- a/src/Vapi.Net/Types/CreateEmailCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateEmailCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Destination configuration for sending Vapi alerts to an email address. +/// [Serializable] public record CreateEmailCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateEndCallToolDto.cs b/src/Vapi.Net/Types/CreateEndCallToolDto.cs index 67675c11..c00e34cc 100644 --- a/src/Vapi.Net/Types/CreateEndCallToolDto.cs +++ b/src/Vapi.Net/Types/CreateEndCallToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that lets an assistant end the active call. +/// [Serializable] public record CreateEndCallToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateEvalDto.cs b/src/Vapi.Net/Types/CreateEvalDto.cs index 1d283d69..35f3b357 100644 --- a/src/Vapi.Net/Types/CreateEvalDto.cs +++ b/src/Vapi.Net/Types/CreateEvalDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing assistant responses and tool calls. +/// [Serializable] public record CreateEvalDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateFunctionToolDto.cs b/src/Vapi.Net/Types/CreateFunctionToolDto.cs index c1df7b24..2ad31368 100644 --- a/src/Vapi.Net/Types/CreateFunctionToolDto.cs +++ b/src/Vapi.Net/Types/CreateFunctionToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a custom function tool that sends model-generated arguments to a server and returns the result to the assistant. +/// [Serializable] public record CreateFunctionToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGcpCredentialDto.cs b/src/Vapi.Net/Types/CreateGcpCredentialDto.cs index c1380afc..82ed3858 100644 --- a/src/Vapi.Net/Types/CreateGcpCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGcpCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, bucket configuration, and upload fallback order. +/// [Serializable] public record CreateGcpCredentialDto : IJsonOnDeserialized { @@ -31,6 +34,9 @@ public record CreateGcpCredentialDto : IJsonOnDeserialized [JsonPropertyName("region")] public string? Region { get; set; } + /// + /// Bucket configuration used to store call artifacts in Google Cloud Storage. + /// [JsonPropertyName("bucketPlan")] public BucketPlan? BucketPlan { get; set; } diff --git a/src/Vapi.Net/Types/CreateGladiaCredentialDto.cs b/src/Vapi.Net/Types/CreateGladiaCredentialDto.cs index 569f6931..aa72c7e2 100644 --- a/src/Vapi.Net/Types/CreateGladiaCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGladiaCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating transcription requests with Gladia. +/// [Serializable] public record CreateGladiaCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelCalendarAvailabilityToolDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelCalendarAvailabilityToolDto.cs index dd14540c..0badb053 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelCalendarAvailabilityToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelCalendarAvailabilityToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account. +/// [Serializable] public record CreateGoHighLevelCalendarAvailabilityToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelCalendarEventCreateToolDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelCalendarEventCreateToolDto.cs index 14e325b8..1c9751cf 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelCalendarEventCreateToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelCalendarEventCreateToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that adds calendar events to a connected GoHighLevel account. +/// [Serializable] public record CreateGoHighLevelCalendarEventCreateToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelContactCreateToolDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelContactCreateToolDto.cs index 60afcaa8..4d95bda3 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelContactCreateToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelContactCreateToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that adds contacts to a connected GoHighLevel account. +/// [Serializable] public record CreateGoHighLevelContactCreateToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelContactGetToolDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelContactGetToolDto.cs index e849c0b3..3f1089f0 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelContactGetToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelContactGetToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account. +/// [Serializable] public record CreateGoHighLevelContactGetToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelCredentialDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelCredentialDto.cs index b91bb894..4ae9bc59 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating Vapi integrations with GoHighLevel. +/// [Serializable] public record CreateGoHighLevelCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoHighLevelMcpCredentialDto.cs b/src/Vapi.Net/Types/CreateGoHighLevelMcpCredentialDto.cs index b73a9a9c..9a949778 100644 --- a/src/Vapi.Net/Types/CreateGoHighLevelMcpCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoHighLevelMcpCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests. +/// [Serializable] public record CreateGoHighLevelMcpCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleCalendarCheckAvailabilityToolDto.cs b/src/Vapi.Net/Types/CreateGoogleCalendarCheckAvailabilityToolDto.cs index ccbd288b..d6b033f4 100644 --- a/src/Vapi.Net/Types/CreateGoogleCalendarCheckAvailabilityToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleCalendarCheckAvailabilityToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that checks availability in a connected Google Calendar. +/// [Serializable] public record CreateGoogleCalendarCheckAvailabilityToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleCalendarCreateEventToolDto.cs b/src/Vapi.Net/Types/CreateGoogleCalendarCreateEventToolDto.cs index 925543fd..a8ab111e 100644 --- a/src/Vapi.Net/Types/CreateGoogleCalendarCreateEventToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleCalendarCreateEventToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that adds events to a connected Google Calendar. +/// [Serializable] public record CreateGoogleCalendarCreateEventToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.cs b/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.cs index 6d65d6cb..43f39c9e 100644 --- a/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Stored OAuth 2.0 authorization for Google Calendar operations. +/// [Serializable] public record CreateGoogleCalendarOAuth2AuthorizationCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.cs b/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.cs index f517b9a4..977689af 100644 --- a/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// OAuth 2.0 client credential for Google Calendar integrations. +/// [Serializable] public record CreateGoogleCalendarOAuth2ClientCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleCredentialDto.cs b/src/Vapi.Net/Types/CreateGoogleCredentialDto.cs index 46e5e458..d062f18a 100644 --- a/src/Vapi.Net/Types/CreateGoogleCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Google AI. +/// [Serializable] public record CreateGoogleCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.cs b/src/Vapi.Net/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.cs index 5fc18ef3..b073da66 100644 --- a/src/Vapi.Net/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Stored OAuth 2.0 authorization for Google Sheets operations. +/// [Serializable] public record CreateGoogleSheetsOAuth2AuthorizationCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGoogleSheetsRowAppendToolDto.cs b/src/Vapi.Net/Types/CreateGoogleSheetsRowAppendToolDto.cs index 90cafbb7..b64bf722 100644 --- a/src/Vapi.Net/Types/CreateGoogleSheetsRowAppendToolDto.cs +++ b/src/Vapi.Net/Types/CreateGoogleSheetsRowAppendToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that appends rows to a connected Google Sheet. +/// [Serializable] public record CreateGoogleSheetsRowAppendToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateGroqCredentialDto.cs b/src/Vapi.Net/Types/CreateGroqCredentialDto.cs index 877dc5a6..4ef2c909 100644 --- a/src/Vapi.Net/Types/CreateGroqCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateGroqCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Groq. +/// [Serializable] public record CreateGroqCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateHandoffToolDto.cs b/src/Vapi.Net/Types/CreateHandoffToolDto.cs index 987606c3..4153421b 100644 --- a/src/Vapi.Net/Types/CreateHandoffToolDto.cs +++ b/src/Vapi.Net/Types/CreateHandoffToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected destination. +/// [Serializable] public record CreateHandoffToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateHumeCredentialDto.cs b/src/Vapi.Net/Types/CreateHumeCredentialDto.cs index e49a0ff9..089dafb1 100644 --- a/src/Vapi.Net/Types/CreateHumeCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateHumeCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Hume. +/// [Serializable] public record CreateHumeCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateInflectionAiCredentialDto.cs b/src/Vapi.Net/Types/CreateInflectionAiCredentialDto.cs index 0b52915a..195303b0 100644 --- a/src/Vapi.Net/Types/CreateInflectionAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateInflectionAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Inflection AI. +/// [Serializable] public record CreateInflectionAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateInworldCredentialDto.cs b/src/Vapi.Net/Types/CreateInworldCredentialDto.cs index 0279efc8..7d7f0286 100644 --- a/src/Vapi.Net/Types/CreateInworldCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateInworldCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Inworld. +/// [Serializable] public record CreateInworldCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateLangfuseCredentialDto.cs b/src/Vapi.Net/Types/CreateLangfuseCredentialDto.cs index 0465dc6f..d5554af9 100644 --- a/src/Vapi.Net/Types/CreateLangfuseCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateLangfuseCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and host URL. +/// [Serializable] public record CreateLangfuseCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateLineInsightFromCallTableDto.cs b/src/Vapi.Net/Types/CreateLineInsightFromCallTableDto.cs index 4113aa68..053a119b 100644 --- a/src/Vapi.Net/Types/CreateLineInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/CreateLineInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. +/// [Serializable] public record CreateLineInsightFromCallTableDto : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record CreateLineInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("metadata")] public LineInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the line-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/CreateLmntCredentialDto.cs b/src/Vapi.Net/Types/CreateLmntCredentialDto.cs index 802b50f4..21260b7c 100644 --- a/src/Vapi.Net/Types/CreateLmntCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateLmntCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with LMNT. +/// [Serializable] public record CreateLmntCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateMakeCredentialDto.cs b/src/Vapi.Net/Types/CreateMakeCredentialDto.cs index 3cd5669b..3eafd24d 100644 --- a/src/Vapi.Net/Types/CreateMakeCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateMakeCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating Vapi integrations with Make, including team, region, and API key. +/// [Serializable] public record CreateMakeCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateMcpToolDto.cs b/src/Vapi.Net/Types/CreateMcpToolDto.cs index ab97d447..982b0c1c 100644 --- a/src/Vapi.Net/Types/CreateMcpToolDto.cs +++ b/src/Vapi.Net/Types/CreateMcpToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its available tools. +/// [Serializable] public record CreateMcpToolDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record CreateMcpToolDto : IJsonOnDeserialized [JsonPropertyName("toolMessages")] public IEnumerable? ToolMessages { get; set; } + /// + /// Connection metadata for the MCP server, including its communication protocol. + /// [JsonPropertyName("metadata")] public McpToolMetadata? Metadata { get; set; } diff --git a/src/Vapi.Net/Types/CreateMinimaxCredentialDto.cs b/src/Vapi.Net/Types/CreateMinimaxCredentialDto.cs index e4c9f3f1..93e315e8 100644 --- a/src/Vapi.Net/Types/CreateMinimaxCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateMinimaxCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax group identifier. +/// [Serializable] public record CreateMinimaxCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateMistralCredentialDto.cs b/src/Vapi.Net/Types/CreateMistralCredentialDto.cs index cbcf0e14..dfdc4730 100644 --- a/src/Vapi.Net/Types/CreateMistralCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateMistralCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Mistral. +/// [Serializable] public record CreateMistralCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateNeuphonicCredentialDto.cs b/src/Vapi.Net/Types/CreateNeuphonicCredentialDto.cs index 80aa702c..6860c49f 100644 --- a/src/Vapi.Net/Types/CreateNeuphonicCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateNeuphonicCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Neuphonic. +/// [Serializable] public record CreateNeuphonicCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateOpenAiCredentialDto.cs b/src/Vapi.Net/Types/CreateOpenAiCredentialDto.cs index 258a68d6..7f3ecc15 100644 --- a/src/Vapi.Net/Types/CreateOpenAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateOpenAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI. +/// [Serializable] public record CreateOpenAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateOpenRouterCredentialDto.cs b/src/Vapi.Net/Types/CreateOpenRouterCredentialDto.cs index 7007bf79..b4865fb9 100644 --- a/src/Vapi.Net/Types/CreateOpenRouterCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateOpenRouterCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with OpenRouter. +/// [Serializable] public record CreateOpenRouterCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreatePerplexityAiCredentialDto.cs b/src/Vapi.Net/Types/CreatePerplexityAiCredentialDto.cs index 2b4d1aa0..a98700ac 100644 --- a/src/Vapi.Net/Types/CreatePerplexityAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreatePerplexityAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Perplexity AI. +/// [Serializable] public record CreatePerplexityAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreatePieInsightFromCallTableDto.cs b/src/Vapi.Net/Types/CreatePieInsightFromCallTableDto.cs index a5156076..04f81039 100644 --- a/src/Vapi.Net/Types/CreatePieInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/CreatePieInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range. +/// [Serializable] public record CreatePieInsightFromCallTableDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record CreatePieInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("formulas")] public IEnumerable? Formulas { get; set; } + /// + /// The time range used to query the pie-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/CreatePlayHtCredentialDto.cs b/src/Vapi.Net/Types/CreatePlayHtCredentialDto.cs index caf3bab0..9da34410 100644 --- a/src/Vapi.Net/Types/CreatePlayHtCredentialDto.cs +++ b/src/Vapi.Net/Types/CreatePlayHtCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier. +/// [Serializable] public record CreatePlayHtCredentialDto : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record CreatePlayHtCredentialDto : IJsonOnDeserialized [JsonPropertyName("apiKey")] public required string ApiKey { get; set; } + /// + /// PlayHT user identifier associated with the API key. + /// [JsonPropertyName("userId")] public required string UserId { get; set; } diff --git a/src/Vapi.Net/Types/CreateQueryToolDto.cs b/src/Vapi.Net/Types/CreateQueryToolDto.cs index 15b3c74d..84e687a4 100644 --- a/src/Vapi.Net/Types/CreateQueryToolDto.cs +++ b/src/Vapi.Net/Types/CreateQueryToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the assistant. +/// [Serializable] public record CreateQueryToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateRimeAiCredentialDto.cs b/src/Vapi.Net/Types/CreateRimeAiCredentialDto.cs index 2039b248..61c56e79 100644 --- a/src/Vapi.Net/Types/CreateRimeAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateRimeAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Rime AI. +/// [Serializable] public record CreateRimeAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateRunpodCredentialDto.cs b/src/Vapi.Net/Types/CreateRunpodCredentialDto.cs index 1bd67ed3..e0b57465 100644 --- a/src/Vapi.Net/Types/CreateRunpodCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateRunpodCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests through Runpod. +/// [Serializable] public record CreateRunpodCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateS3CredentialDto.cs b/src/Vapi.Net/Types/CreateS3CredentialDto.cs index 169861ee..8240752b 100644 --- a/src/Vapi.Net/Types/CreateS3CredentialDto.cs +++ b/src/Vapi.Net/Types/CreateS3CredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and upload fallback order. +/// [Serializable] public record CreateS3CredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateScorecardDto.cs b/src/Vapi.Net/Types/CreateScorecardDto.cs index d95fd591..fab40788 100644 --- a/src/Vapi.Net/Types/CreateScorecardDto.cs +++ b/src/Vapi.Net/Types/CreateScorecardDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant associations. +/// [Serializable] public record CreateScorecardDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSipRequestToolDto.cs b/src/Vapi.Net/Types/CreateSipRequestToolDto.cs index 38ac3992..914d72de 100644 --- a/src/Vapi.Net/Types/CreateSipRequestToolDto.cs +++ b/src/Vapi.Net/Types/CreateSipRequestToolDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. +/// [Serializable] public record CreateSipRequestToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSlackOAuth2AuthorizationCredentialDto.cs b/src/Vapi.Net/Types/CreateSlackOAuth2AuthorizationCredentialDto.cs index 0553c87f..621373ce 100644 --- a/src/Vapi.Net/Types/CreateSlackOAuth2AuthorizationCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSlackOAuth2AuthorizationCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Stored OAuth 2.0 authorization for Slack operations. +/// [Serializable] public record CreateSlackOAuth2AuthorizationCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSlackSendMessageToolDto.cs b/src/Vapi.Net/Types/CreateSlackSendMessageToolDto.cs index d719b76a..515f8244 100644 --- a/src/Vapi.Net/Types/CreateSlackSendMessageToolDto.cs +++ b/src/Vapi.Net/Types/CreateSlackSendMessageToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that lets an assistant send a message to Slack. +/// [Serializable] public record CreateSlackSendMessageToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSlackWebhookCredentialDto.cs b/src/Vapi.Net/Types/CreateSlackWebhookCredentialDto.cs index f86792d9..75d6cc24 100644 --- a/src/Vapi.Net/Types/CreateSlackWebhookCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSlackWebhookCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for sending Vapi alerts through a Slack incoming webhook. +/// [Serializable] public record CreateSlackWebhookCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSmallestAiCredentialDto.cs b/src/Vapi.Net/Types/CreateSmallestAiCredentialDto.cs index 6bdf5a72..a50505b0 100644 --- a/src/Vapi.Net/Types/CreateSmallestAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSmallestAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Smallest AI. +/// [Serializable] public record CreateSmallestAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSmsToolDto.cs b/src/Vapi.Net/Types/CreateSmsToolDto.cs index f0227fa6..372502fc 100644 --- a/src/Vapi.Net/Types/CreateSmsToolDto.cs +++ b/src/Vapi.Net/Types/CreateSmsToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that lets an assistant send an SMS message during a call. +/// [Serializable] public record CreateSmsToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSonioxCredentialDto.cs b/src/Vapi.Net/Types/CreateSonioxCredentialDto.cs index 683e23e6..278cbae9 100644 --- a/src/Vapi.Net/Types/CreateSonioxCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSonioxCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating transcription requests with Soniox. +/// [Serializable] public record CreateSonioxCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSpeechmaticsCredentialDto.cs b/src/Vapi.Net/Types/CreateSpeechmaticsCredentialDto.cs index dec23d2e..5416225b 100644 --- a/src/Vapi.Net/Types/CreateSpeechmaticsCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSpeechmaticsCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating transcription requests with Speechmatics. +/// [Serializable] public record CreateSpeechmaticsCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSquadDto.cs b/src/Vapi.Net/Types/CreateSquadDto.cs index 19ee5e56..b496b28e 100644 --- a/src/Vapi.Net/Types/CreateSquadDto.cs +++ b/src/Vapi.Net/Types/CreateSquadDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record CreateSquadDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateStructuredOutputDto.cs b/src/Vapi.Net/Types/CreateStructuredOutputDto.cs index 546201b3..fa32c803 100644 --- a/src/Vapi.Net/Types/CreateStructuredOutputDto.cs +++ b/src/Vapi.Net/Types/CreateStructuredOutputDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a structured-output definition that extracts validated data from calls using an AI model or regular expression. +/// [Serializable] public record CreateStructuredOutputDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateSupabaseCredentialDto.cs b/src/Vapi.Net/Types/CreateSupabaseCredentialDto.cs index 4fd74408..11305631 100644 --- a/src/Vapi.Net/Types/CreateSupabaseCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateSupabaseCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and upload fallback order. +/// [Serializable] public record CreateSupabaseCredentialDto : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record CreateSupabaseCredentialDto : IJsonOnDeserialized [JsonPropertyName("fallbackIndex")] public double? FallbackIndex { get; set; } + /// + /// Supabase S3-compatible bucket configuration used to store call artifacts. + /// [JsonPropertyName("bucketPlan")] public SupabaseBucketPlan? BucketPlan { get; set; } diff --git a/src/Vapi.Net/Types/CreateTavusCredentialDto.cs b/src/Vapi.Net/Types/CreateTavusCredentialDto.cs index b61f46f5..9b957ba3 100644 --- a/src/Vapi.Net/Types/CreateTavusCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateTavusCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with Tavus. +/// [Serializable] public record CreateTavusCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTelnyxPhoneNumberDto.cs b/src/Vapi.Net/Types/CreateTelnyxPhoneNumberDto.cs index 075e79e9..bccd825d 100644 --- a/src/Vapi.Net/Types/CreateTelnyxPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/CreateTelnyxPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings. +/// [Serializable] public record CreateTelnyxPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTextEditorToolDto.cs b/src/Vapi.Net/Types/CreateTextEditorToolDto.cs index b63882d5..033a4d5c 100644 --- a/src/Vapi.Net/Types/CreateTextEditorToolDto.cs +++ b/src/Vapi.Net/Types/CreateTextEditorToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that reads and edits text files in a configured environment. +/// [Serializable] public record CreateTextEditorToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTextInsightFromCallTableDto.cs b/src/Vapi.Net/Types/CreateTextInsightFromCallTableDto.cs index b417ad41..aa70e346 100644 --- a/src/Vapi.Net/Types/CreateTextInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/CreateTextInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range. +/// [Serializable] public record CreateTextInsightFromCallTableDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record CreateTextInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("formula")] public object? Formula { get; set; } + /// + /// The time range used to query the text-value data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/CreateTogetherAiCredentialDto.cs b/src/Vapi.Net/Types/CreateTogetherAiCredentialDto.cs index 6a079e95..6e0918c5 100644 --- a/src/Vapi.Net/Types/CreateTogetherAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateTogetherAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with Together AI. +/// [Serializable] public record CreateTogetherAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTransferCallToolDto.cs b/src/Vapi.Net/Types/CreateTransferCallToolDto.cs index 68dc3ef2..d4c39a23 100644 --- a/src/Vapi.Net/Types/CreateTransferCallToolDto.cs +++ b/src/Vapi.Net/Types/CreateTransferCallToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a tool that transfers the active call to one of its configured destinations. +/// [Serializable] public record CreateTransferCallToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTrieveCredentialDto.cs b/src/Vapi.Net/Types/CreateTrieveCredentialDto.cs index 7c892577..15d16286 100644 --- a/src/Vapi.Net/Types/CreateTrieveCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateTrieveCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating knowledge-base requests with Trieve. +/// [Serializable] public record CreateTrieveCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateTwilioCredentialDto.cs b/src/Vapi.Net/Types/CreateTwilioCredentialDto.cs index b622d8e0..de5bb2e4 100644 --- a/src/Vapi.Net/Types/CreateTwilioCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateTwilioCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API key credentials. +/// [Serializable] public record CreateTwilioCredentialDto : IJsonOnDeserialized { @@ -29,6 +32,9 @@ public record CreateTwilioCredentialDto : IJsonOnDeserialized [JsonPropertyName("apiSecret")] public string? ApiSecret { get; set; } + /// + /// Twilio Account SID associated with the credential. + /// [JsonPropertyName("accountSid")] public required string AccountSid { get; set; } diff --git a/src/Vapi.Net/Types/CreateTwilioPhoneNumberDto.cs b/src/Vapi.Net/Types/CreateTwilioPhoneNumberDto.cs index fe4a701e..c168d3dd 100644 --- a/src/Vapi.Net/Types/CreateTwilioPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/CreateTwilioPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings. +/// [Serializable] public record CreateTwilioPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateVapiPhoneNumberDto.cs b/src/Vapi.Net/Types/CreateVapiPhoneNumberDto.cs index 343826e7..025106f7 100644 --- a/src/Vapi.Net/Types/CreateVapiPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/CreateVapiPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and authentication settings. +/// [Serializable] public record CreateVapiPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateVoicemailToolDto.cs b/src/Vapi.Net/Types/CreateVoicemailToolDto.cs index 93c2b088..4a4e90da 100644 --- a/src/Vapi.Net/Types/CreateVoicemailToolDto.cs +++ b/src/Vapi.Net/Types/CreateVoicemailToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to create a voicemail-detection tool with optional beep detection for supported calls. +/// [Serializable] public record CreateVoicemailToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateVonageCredentialDto.cs b/src/Vapi.Net/Types/CreateVonageCredentialDto.cs index 1f66cf70..732455e8 100644 --- a/src/Vapi.Net/Types/CreateVonageCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateVonageCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating telephony requests with Vonage. +/// [Serializable] public record CreateVonageCredentialDto : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record CreateVonageCredentialDto : IJsonOnDeserialized [JsonPropertyName("apiSecret")] public required string ApiSecret { get; set; } + /// + /// Vonage API key associated with the credential. + /// [JsonPropertyName("apiKey")] public required string ApiKey { get; set; } diff --git a/src/Vapi.Net/Types/CreateVonagePhoneNumberDto.cs b/src/Vapi.Net/Types/CreateVonagePhoneNumberDto.cs index 43a023a7..77ab1d22 100644 --- a/src/Vapi.Net/Types/CreateVonagePhoneNumberDto.cs +++ b/src/Vapi.Net/Types/CreateVonagePhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings. +/// [Serializable] public record CreateVonagePhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateWellSaidCredentialDto.cs b/src/Vapi.Net/Types/CreateWellSaidCredentialDto.cs index f1801ec2..a0b28eab 100644 --- a/src/Vapi.Net/Types/CreateWellSaidCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateWellSaidCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating voice synthesis requests with WellSaid. +/// [Serializable] public record CreateWellSaidCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CreateWorkflowDto.cs b/src/Vapi.Net/Types/CreateWorkflowDto.cs index d0a2e2dc..3089ef0a 100644 --- a/src/Vapi.Net/Types/CreateWorkflowDto.cs +++ b/src/Vapi.Net/Types/CreateWorkflowDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for creating a graph-based workflow, including conversation and tool nodes, directed edges, global prompts, shared providers, hooks, credentials, and call behavior. +/// [Serializable] public record CreateWorkflowDto : IJsonOnDeserialized { @@ -12,6 +15,9 @@ public record CreateWorkflowDto : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Nodes that make up the workflow graph. Conversation nodes interact with the customer, while tool nodes invoke configured tools. + /// [JsonPropertyName("nodes")] public IEnumerable Nodes { get; set; } = new List(); @@ -96,12 +102,21 @@ public OneOf< [JsonPropertyName("maxDurationSeconds")] public double? MaxDurationSeconds { get; set; } + /// + /// Name used to identify the workflow. + /// [JsonPropertyName("name")] public required string Name { get; set; } + /// + /// Directed connections that determine transitions between nodes. + /// [JsonPropertyName("edges")] public IEnumerable Edges { get; set; } = new List(); + /// + /// Prompt applied across the workflow's conversation nodes. + /// [JsonPropertyName("globalPrompt")] public string? GlobalPrompt { get; set; } diff --git a/src/Vapi.Net/Types/CreateXAiCredentialDto.cs b/src/Vapi.Net/Types/CreateXAiCredentialDto.cs index 050a18ee..e8ad5d3a 100644 --- a/src/Vapi.Net/Types/CreateXAiCredentialDto.cs +++ b/src/Vapi.Net/Types/CreateXAiCredentialDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials for authenticating assistant model requests with xAI. +/// [Serializable] public record CreateXAiCredentialDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomEndpointingModelSmartEndpointingPlan.cs b/src/Vapi.Net/Types/CustomEndpointingModelSmartEndpointingPlan.cs index 4e0c85f0..05c66e61 100644 --- a/src/Vapi.Net/Types/CustomEndpointingModelSmartEndpointingPlan.cs +++ b/src/Vapi.Net/Types/CustomEndpointingModelSmartEndpointingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for using a custom endpointing model, including its provider identifier and server connection. +/// [Serializable] public record CustomEndpointingModelSmartEndpointingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomLlmModel.cs b/src/Vapi.Net/Types/CustomLlmModel.cs index cba00a49..85a1db03 100644 --- a/src/Vapi.Net/Types/CustomLlmModel.cs +++ b/src/Vapi.Net/Types/CustomLlmModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses through a custom language model endpoint, including server URL, headers, metadata, prompts, tools, and generation settings. +/// [Serializable] public record CustomLlmModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomMessage.cs b/src/Vapi.Net/Types/CustomMessage.cs index 4c676b25..9a9329ff 100644 --- a/src/Vapi.Net/Types/CustomMessage.cs +++ b/src/Vapi.Net/Types/CustomMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A message spoken by the assistant with optional language-specific content variants. +/// [Serializable] public record CustomMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomTranscriber.cs b/src/Vapi.Net/Types/CustomTranscriber.cs index d272e5db..ee444f80 100644 --- a/src/Vapi.Net/Types/CustomTranscriber.cs +++ b/src/Vapi.Net/Types/CustomTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for sending conversation audio to a custom WebSocket transcription server. +/// [Serializable] public record CustomTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomVoice.cs b/src/Vapi.Net/Types/CustomVoice.cs index 8a9cd664..0bb86ea2 100644 --- a/src/Vapi.Net/Types/CustomVoice.cs +++ b/src/Vapi.Net/Types/CustomVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, caching, and fallback settings. +/// [Serializable] public record CustomVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomerCustomEndpointingRule.cs b/src/Vapi.Net/Types/CustomerCustomEndpointingRule.cs index f9077745..1b83ae48 100644 --- a/src/Vapi.Net/Types/CustomerCustomEndpointingRule.cs +++ b/src/Vapi.Net/Types/CustomerCustomEndpointingRule.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A custom endpointing rule that matches the customer's current speech and applies a configured timeout. +/// [Serializable] public record CustomerCustomEndpointingRule : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/CustomerSpeechTimeoutOptions.cs b/src/Vapi.Net/Types/CustomerSpeechTimeoutOptions.cs index f5a0c133..7a14d5c2 100644 --- a/src/Vapi.Net/Types/CustomerSpeechTimeoutOptions.cs +++ b/src/Vapi.Net/Types/CustomerSpeechTimeoutOptions.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets. +/// [Serializable] public record CustomerSpeechTimeoutOptions : IJsonOnDeserialized { @@ -29,9 +32,7 @@ public record CustomerSpeechTimeoutOptions : IJsonOnDeserialized public double? TriggerMaxCount { get; set; } /// - /// 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`. /// [JsonPropertyName("triggerResetMode")] public object? TriggerResetMode { get; set; } diff --git a/src/Vapi.Net/Types/DeepInfraModel.cs b/src/Vapi.Net/Types/DeepInfraModel.cs index 1a200c60..089f3f04 100644 --- a/src/Vapi.Net/Types/DeepInfraModel.cs +++ b/src/Vapi.Net/Types/DeepInfraModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record DeepInfraModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DeepSeekModel.cs b/src/Vapi.Net/Types/DeepSeekModel.cs index d1469c4f..3237dc51 100644 --- a/src/Vapi.Net/Types/DeepSeekModel.cs +++ b/src/Vapi.Net/Types/DeepSeekModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record DeepSeekModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DeepgramTranscriber.cs b/src/Vapi.Net/Types/DeepgramTranscriber.cs index 752e5fef..b3d8fb27 100644 --- a/src/Vapi.Net/Types/DeepgramTranscriber.cs +++ b/src/Vapi.Net/Types/DeepgramTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, formatting, endpointing, vocabulary, and fallback settings. +/// [Serializable] public record DeepgramTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DeepgramVoice.cs b/src/Vapi.Net/Types/DeepgramVoice.cs index 1f02ace7..2cff6690 100644 --- a/src/Vapi.Net/Types/DeepgramVoice.cs +++ b/src/Vapi.Net/Types/DeepgramVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, caching, and fallback settings. +/// [Serializable] public record DeepgramVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DeveloperMessage.cs b/src/Vapi.Net/Types/DeveloperMessage.cs index d814bca5..d79f275c 100644 --- a/src/Vapi.Net/Types/DeveloperMessage.cs +++ b/src/Vapi.Net/Types/DeveloperMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A developer-authored instruction message supplied to the language model. +/// [Serializable] public record DeveloperMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DialPlanEntry.cs b/src/Vapi.Net/Types/DialPlanEntry.cs index 386e34ea..0e3e2a3a 100644 --- a/src/Vapi.Net/Types/DialPlanEntry.cs +++ b/src/Vapi.Net/Types/DialPlanEntry.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Associates a phone number with the customers to dial through that number in a batch call plan. +/// [Serializable] public record DialPlanEntry : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/DtmfTool.cs b/src/Vapi.Net/Types/DtmfTool.cs index 9e90be3e..09910f70 100644 --- a/src/Vapi.Net/Types/DtmfTool.cs +++ b/src/Vapi.Net/Types/DtmfTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that lets an assistant send DTMF keypad tones during a call. +/// [Serializable] public record DtmfTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Edge.cs b/src/Vapi.Net/Types/Edge.cs index 177dfc85..be5fe3fd 100644 --- a/src/Vapi.Net/Types/Edge.cs +++ b/src/Vapi.Net/Types/Edge.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A directed connection between two workflow nodes, with an optional AI-evaluated transition condition. +/// [Serializable] public record Edge : IJsonOnDeserialized { @@ -11,12 +14,21 @@ public record Edge : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Condition that must evaluate to true to follow this edge. + /// [JsonPropertyName("condition")] public AiEdgeCondition? Condition { get; set; } + /// + /// Name of the source workflow node. + /// [JsonPropertyName("from")] public required string From { get; set; } + /// + /// Name of the destination workflow node. + /// [JsonPropertyName("to")] public required string To { get; set; } diff --git a/src/Vapi.Net/Types/ElevenLabsPronunciationDictionaryLocator.cs b/src/Vapi.Net/Types/ElevenLabsPronunciationDictionaryLocator.cs index 0ebdb3a4..f6408e05 100644 --- a/src/Vapi.Net/Types/ElevenLabsPronunciationDictionaryLocator.cs +++ b/src/Vapi.Net/Types/ElevenLabsPronunciationDictionaryLocator.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Identifies a specific version of an ElevenLabs pronunciation dictionary. +/// [Serializable] public record ElevenLabsPronunciationDictionaryLocator : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ElevenLabsTranscriber.cs b/src/Vapi.Net/Types/ElevenLabsTranscriber.cs index 16933852..eb7bc59e 100644 --- a/src/Vapi.Net/Types/ElevenLabsTranscriber.cs +++ b/src/Vapi.Net/Types/ElevenLabsTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, speech thresholds, and fallback settings. +/// [Serializable] public record ElevenLabsTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ElevenLabsVoice.cs b/src/Vapi.Net/Types/ElevenLabsVoice.cs index 7a56e0fa..c0ff3963 100644 --- a/src/Vapi.Net/Types/ElevenLabsVoice.cs +++ b/src/Vapi.Net/Types/ElevenLabsVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record ElevenLabsVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EndCallTool.cs b/src/Vapi.Net/Types/EndCallTool.cs index d1087103..4c603e8a 100644 --- a/src/Vapi.Net/Types/EndCallTool.cs +++ b/src/Vapi.Net/Types/EndCallTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that lets an assistant end the active call. +/// [Serializable] public record EndCallTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Eval.cs b/src/Vapi.Net/Types/Eval.cs index 93a37aa3..36f379bc 100644 --- a/src/Vapi.Net/Types/Eval.cs +++ b/src/Vapi.Net/Types/Eval.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle information. +/// [Serializable] public record Eval : IJsonOnDeserialized { @@ -41,15 +44,27 @@ public IEnumerable< > >(); + /// + /// The unique identifier for the eval. + /// [JsonPropertyName("id")] public required string Id { get; set; } + /// + /// The unique identifier for the organization that owns the eval. + /// [JsonPropertyName("orgId")] public required string OrgId { get; set; } + /// + /// The ISO 8601 timestamp when the eval was created. + /// [JsonPropertyName("createdAt")] public required DateTime CreatedAt { get; set; } + /// + /// The ISO 8601 timestamp when the eval was last updated. + /// [JsonPropertyName("updatedAt")] public required DateTime UpdatedAt { get; set; } diff --git a/src/Vapi.Net/Types/EvalAnthropicModel.cs b/src/Vapi.Net/Types/EvalAnthropicModel.cs index 8b632f30..d8217362 100644 --- a/src/Vapi.Net/Types/EvalAnthropicModel.cs +++ b/src/Vapi.Net/Types/EvalAnthropicModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended thinking. +/// [Serializable] public record EvalAnthropicModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalCustomModel.cs b/src/Vapi.Net/Types/EvalCustomModel.cs index c5a0d3a1..62493a3a 100644 --- a/src/Vapi.Net/Types/EvalCustomModel.cs +++ b/src/Vapi.Net/Types/EvalCustomModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and generation settings. +/// [Serializable] public record EvalCustomModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalGoogleModel.cs b/src/Vapi.Net/Types/EvalGoogleModel.cs index eccffe39..fe97cee8 100644 --- a/src/Vapi.Net/Types/EvalGoogleModel.cs +++ b/src/Vapi.Net/Types/EvalGoogleModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Google model configuration for an LLM judge, including its messages and generation settings. +/// [Serializable] public record EvalGoogleModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalOpenAiModel.cs b/src/Vapi.Net/Types/EvalOpenAiModel.cs index e8425391..28e58a83 100644 --- a/src/Vapi.Net/Types/EvalOpenAiModel.cs +++ b/src/Vapi.Net/Types/EvalOpenAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// OpenAI model configuration for an LLM judge, including its messages and generation settings. +/// [Serializable] public record EvalOpenAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalPaginatedResponse.cs b/src/Vapi.Net/Types/EvalPaginatedResponse.cs index 5530d933..48c617ad 100644 --- a/src/Vapi.Net/Types/EvalPaginatedResponse.cs +++ b/src/Vapi.Net/Types/EvalPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of saved eval definitions and metadata describing the result set. +/// [Serializable] public record EvalPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record EvalPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The eval definitions returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the eval result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/EvalRun.cs b/src/Vapi.Net/Types/EvalRun.cs index 559d40b6..e46f308a 100644 --- a/src/Vapi.Net/Types/EvalRun.cs +++ b/src/Vapi.Net/Types/EvalRun.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle timestamps. +/// [Serializable] public record EvalRun : IJsonOnDeserialized { @@ -41,18 +44,33 @@ public record EvalRun : IJsonOnDeserialized [JsonPropertyName("target")] public required object Target { get; set; } + /// + /// The unique identifier for the eval run. + /// [JsonPropertyName("id")] public required string Id { get; set; } + /// + /// The unique identifier for the organization that owns the run. + /// [JsonPropertyName("orgId")] public required string OrgId { get; set; } + /// + /// The ISO 8601 timestamp when the eval run was created. + /// [JsonPropertyName("createdAt")] public required DateTime CreatedAt { get; set; } + /// + /// The ISO 8601 timestamp when the eval run started. + /// [JsonPropertyName("startedAt")] public required DateTime StartedAt { get; set; } + /// + /// The ISO 8601 timestamp when the eval run ended. + /// [JsonPropertyName("endedAt")] public required DateTime EndedAt { get; set; } diff --git a/src/Vapi.Net/Types/EvalRunPaginatedResponse.cs b/src/Vapi.Net/Types/EvalRunPaginatedResponse.cs index 484513eb..d5596593 100644 --- a/src/Vapi.Net/Types/EvalRunPaginatedResponse.cs +++ b/src/Vapi.Net/Types/EvalRunPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of eval runs and metadata describing the result set. +/// [Serializable] public record EvalRunPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record EvalRunPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The eval runs returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the eval-run result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/EvalRunResult.cs b/src/Vapi.Net/Types/EvalRunResult.cs index 82aa14a2..96780943 100644 --- a/src/Vapi.Net/Types/EvalRunResult.cs +++ b/src/Vapi.Net/Types/EvalRunResult.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// The pass or fail result of an evaluation run, including its conversation messages and timing. +/// [Serializable] public record EvalRunResult : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalRunTargetAssistant.cs b/src/Vapi.Net/Types/EvalRunTargetAssistant.cs index dd101bf3..5e1d6f31 100644 --- a/src/Vapi.Net/Types/EvalRunTargetAssistant.cs +++ b/src/Vapi.Net/Types/EvalRunTargetAssistant.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant overrides. +/// [Serializable] public record EvalRunTargetAssistant : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EvalRunTargetSquad.cs b/src/Vapi.Net/Types/EvalRunTargetSquad.cs index 8ca6709c..43e9d209 100644 --- a/src/Vapi.Net/Types/EvalRunTargetSquad.cs +++ b/src/Vapi.Net/Types/EvalRunTargetSquad.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides. +/// [Serializable] public record EvalRunTargetSquad : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EventsTableBooleanCondition.cs b/src/Vapi.Net/Types/EventsTableBooleanCondition.cs index d4773567..f9d1fbf0 100644 --- a/src/Vapi.Net/Types/EventsTableBooleanCondition.cs +++ b/src/Vapi.Net/Types/EventsTableBooleanCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters event data by comparing a boolean field with an expected value. +/// [Serializable] public record EventsTableBooleanCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EventsTableNumberCondition.cs b/src/Vapi.Net/Types/EventsTableNumberCondition.cs index d5297aec..9ba52875 100644 --- a/src/Vapi.Net/Types/EventsTableNumberCondition.cs +++ b/src/Vapi.Net/Types/EventsTableNumberCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters event data by comparing a numeric field with a value. +/// [Serializable] public record EventsTableNumberCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/EventsTableStringCondition.cs b/src/Vapi.Net/Types/EventsTableStringCondition.cs index 0fd21002..f88ca5f6 100644 --- a/src/Vapi.Net/Types/EventsTableStringCondition.cs +++ b/src/Vapi.Net/Types/EventsTableStringCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters event data by comparing or searching a string field. +/// [Serializable] public record EventsTableStringCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ExactReplacement.cs b/src/Vapi.Net/Types/ExactReplacement.cs index 515fda24..35a0c962 100644 --- a/src/Vapi.Net/Types/ExactReplacement.cs +++ b/src/Vapi.Net/Types/ExactReplacement.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Replaces an exact word or phrase before text is sent to a voice provider. +/// [Serializable] public record ExactReplacement : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackAssemblyAiTranscriber.cs b/src/Vapi.Net/Types/FallbackAssemblyAiTranscriber.cs index 828fa568..f5d32937 100644 --- a/src/Vapi.Net/Types/FallbackAssemblyAiTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackAssemblyAiTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, and vocabulary. +/// [Serializable] public record FallbackAssemblyAiTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackAzureSpeechTranscriber.cs b/src/Vapi.Net/Types/FallbackAzureSpeechTranscriber.cs index 7a8ab527..c72aa3be 100644 --- a/src/Vapi.Net/Types/FallbackAzureSpeechTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackAzureSpeechTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Azure Speech, including language and segmentation. +/// [Serializable] public record FallbackAzureSpeechTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackAzureVoice.cs b/src/Vapi.Net/Types/FallbackAzureVoice.cs index 20bcb561..219c9f9c 100644 --- a/src/Vapi.Net/Types/FallbackAzureVoice.cs +++ b/src/Vapi.Net/Types/FallbackAzureVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, and caching. +/// [Serializable] public record FallbackAzureVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackCartesiaTranscriber.cs b/src/Vapi.Net/Types/FallbackCartesiaTranscriber.cs index 2075f02f..be2ee9c9 100644 --- a/src/Vapi.Net/Types/FallbackCartesiaTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackCartesiaTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Cartesia, including model and language. +/// [Serializable] public record FallbackCartesiaTranscriber : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record FallbackCartesiaTranscriber : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The Cartesia speech-to-text model used for transcription. + /// [JsonPropertyName("model")] public FallbackCartesiaTranscriberModel? Model { get; set; } + /// + /// The language code used for transcription. + /// [JsonPropertyName("language")] public FallbackCartesiaTranscriberLanguage? Language { get; set; } diff --git a/src/Vapi.Net/Types/FallbackCartesiaVoice.cs b/src/Vapi.Net/Types/FallbackCartesiaVoice.cs index 1ddb3396..ccfa2f5e 100644 --- a/src/Vapi.Net/Types/FallbackCartesiaVoice.cs +++ b/src/Vapi.Net/Types/FallbackCartesiaVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, and caching. +/// [Serializable] public record FallbackCartesiaVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackCustomTranscriber.cs b/src/Vapi.Net/Types/FallbackCustomTranscriber.cs index 79777402..f7bd44c3 100644 --- a/src/Vapi.Net/Types/FallbackCustomTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackCustomTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for sending conversation audio to a custom WebSocket transcription server. +/// [Serializable] public record FallbackCustomTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackCustomVoice.cs b/src/Vapi.Net/Types/FallbackCustomVoice.cs index 171e983a..1a7cc4fc 100644 --- a/src/Vapi.Net/Types/FallbackCustomVoice.cs +++ b/src/Vapi.Net/Types/FallbackCustomVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, and caching. +/// [Serializable] public record FallbackCustomVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackDeepgramTranscriber.cs b/src/Vapi.Net/Types/FallbackDeepgramTranscriber.cs index 8c9c74d9..8e4f1106 100644 --- a/src/Vapi.Net/Types/FallbackDeepgramTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackDeepgramTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, and vocabulary. +/// [Serializable] public record FallbackDeepgramTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackDeepgramVoice.cs b/src/Vapi.Net/Types/FallbackDeepgramVoice.cs index 00966e12..004dde36 100644 --- a/src/Vapi.Net/Types/FallbackDeepgramVoice.cs +++ b/src/Vapi.Net/Types/FallbackDeepgramVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, and caching. +/// [Serializable] public record FallbackDeepgramVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackElevenLabsTranscriber.cs b/src/Vapi.Net/Types/FallbackElevenLabsTranscriber.cs index bfc7d0f8..0339c299 100644 --- a/src/Vapi.Net/Types/FallbackElevenLabsTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackElevenLabsTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds. +/// [Serializable] public record FallbackElevenLabsTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackElevenLabsVoice.cs b/src/Vapi.Net/Types/FallbackElevenLabsVoice.cs index 0866658c..9c03ff83 100644 --- a/src/Vapi.Net/Types/FallbackElevenLabsVoice.cs +++ b/src/Vapi.Net/Types/FallbackElevenLabsVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record FallbackElevenLabsVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackGladiaTranscriber.cs b/src/Vapi.Net/Types/FallbackGladiaTranscriber.cs index d8ca9044..c8db44eb 100644 --- a/src/Vapi.Net/Types/FallbackGladiaTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackGladiaTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, endpointing, vocabulary, and region. +/// [Serializable] public record FallbackGladiaTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackGoogleTranscriber.cs b/src/Vapi.Net/Types/FallbackGoogleTranscriber.cs index ea2fba7e..754220c4 100644 --- a/src/Vapi.Net/Types/FallbackGoogleTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackGoogleTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Google, including model and language. +/// [Serializable] public record FallbackGoogleTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackHumeVoice.cs b/src/Vapi.Net/Types/FallbackHumeVoice.cs index 2d96a97c..0c92974e 100644 --- a/src/Vapi.Net/Types/FallbackHumeVoice.cs +++ b/src/Vapi.Net/Types/FallbackHumeVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, and caching. +/// [Serializable] public record FallbackHumeVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackInworldVoice.cs b/src/Vapi.Net/Types/FallbackInworldVoice.cs index 22d8c149..c28bc840 100644 --- a/src/Vapi.Net/Types/FallbackInworldVoice.cs +++ b/src/Vapi.Net/Types/FallbackInworldVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, and caching. +/// [Serializable] public record FallbackInworldVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackLmntVoice.cs b/src/Vapi.Net/Types/FallbackLmntVoice.cs index 4bb9a87d..1c234d9f 100644 --- a/src/Vapi.Net/Types/FallbackLmntVoice.cs +++ b/src/Vapi.Net/Types/FallbackLmntVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, and caching. +/// [Serializable] public record FallbackLmntVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackNeuphonicVoice.cs b/src/Vapi.Net/Types/FallbackNeuphonicVoice.cs index 96832a9d..209f52af 100644 --- a/src/Vapi.Net/Types/FallbackNeuphonicVoice.cs +++ b/src/Vapi.Net/Types/FallbackNeuphonicVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, and caching. +/// [Serializable] public record FallbackNeuphonicVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackOpenAiTranscriber.cs b/src/Vapi.Net/Types/FallbackOpenAiTranscriber.cs index 9cea1be0..1ad8e867 100644 --- a/src/Vapi.Net/Types/FallbackOpenAiTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackOpenAiTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with OpenAI, including model and language. +/// [Serializable] public record FallbackOpenAiTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackOpenAiVoice.cs b/src/Vapi.Net/Types/FallbackOpenAiVoice.cs index fd0ed6b6..20e0a128 100644 --- a/src/Vapi.Net/Types/FallbackOpenAiVoice.cs +++ b/src/Vapi.Net/Types/FallbackOpenAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, and caching. +/// [Serializable] public record FallbackOpenAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackPlan.cs b/src/Vapi.Net/Types/FallbackPlan.cs index 87ffca15..e8f418f7 100644 --- a/src/Vapi.Net/Types/FallbackPlan.cs +++ b/src/Vapi.Net/Types/FallbackPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Lists backup voice configurations that can be used if the primary voice provider fails. +/// [Serializable] public record FallbackPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackPlayHtVoice.cs b/src/Vapi.Net/Types/FallbackPlayHtVoice.cs index da018175..864debf5 100644 --- a/src/Vapi.Net/Types/FallbackPlayHtVoice.cs +++ b/src/Vapi.Net/Types/FallbackPlayHtVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, and caching. +/// [Serializable] public record FallbackPlayHtVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackRimeAiVoice.cs b/src/Vapi.Net/Types/FallbackRimeAiVoice.cs index a99fe399..6b73a758 100644 --- a/src/Vapi.Net/Types/FallbackRimeAiVoice.cs +++ b/src/Vapi.Net/Types/FallbackRimeAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, and caching. +/// [Serializable] public record FallbackRimeAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackSesameVoice.cs b/src/Vapi.Net/Types/FallbackSesameVoice.cs index 2b07efe9..33da0164 100644 --- a/src/Vapi.Net/Types/FallbackSesameVoice.cs +++ b/src/Vapi.Net/Types/FallbackSesameVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, and caching. +/// [Serializable] public record FallbackSesameVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackSmallestAiVoice.cs b/src/Vapi.Net/Types/FallbackSmallestAiVoice.cs index dcb6b411..5ae0cfc4 100644 --- a/src/Vapi.Net/Types/FallbackSmallestAiVoice.cs +++ b/src/Vapi.Net/Types/FallbackSmallestAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, and caching. +/// [Serializable] public record FallbackSmallestAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackSonioxTranscriber.cs b/src/Vapi.Net/Types/FallbackSonioxTranscriber.cs index 3dd1fb6a..a0eb9225 100644 --- a/src/Vapi.Net/Types/FallbackSonioxTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackSonioxTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and vocabulary. +/// [Serializable] public record FallbackSonioxTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackSpeechmaticsTranscriber.cs b/src/Vapi.Net/Types/FallbackSpeechmaticsTranscriber.cs index 4dbf8304..42609cc2 100644 --- a/src/Vapi.Net/Types/FallbackSpeechmaticsTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackSpeechmaticsTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, vocabulary, endpointing, and formatting. +/// [Serializable] public record FallbackSpeechmaticsTranscriber : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record FallbackSpeechmaticsTranscriber : IJsonOnDeserialized [JsonPropertyName("model")] public FallbackSpeechmaticsTranscriberModel? Model { get; set; } + /// + /// Language used for transcription. Set to `auto` to detect the language automatically. + /// [JsonPropertyName("language")] public FallbackSpeechmaticsTranscriberLanguage? Language { get; set; } @@ -52,6 +58,9 @@ public record FallbackSpeechmaticsTranscriber : IJsonOnDeserialized [JsonPropertyName("maxDelay")] public double? MaxDelay { get; set; } + /// + /// Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. + /// [JsonPropertyName("customVocabulary")] public IEnumerable CustomVocabulary { get; set; } = new List(); diff --git a/src/Vapi.Net/Types/FallbackTalkscriberTranscriber.cs b/src/Vapi.Net/Types/FallbackTalkscriberTranscriber.cs index ce03f5c2..57501629 100644 --- a/src/Vapi.Net/Types/FallbackTalkscriberTranscriber.cs +++ b/src/Vapi.Net/Types/FallbackTalkscriberTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for transcribing speech with Talkscriber, including model and language. +/// [Serializable] public record FallbackTalkscriberTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackTavusVoice.cs b/src/Vapi.Net/Types/FallbackTavusVoice.cs index 901cfa94..e09e6a0e 100644 --- a/src/Vapi.Net/Types/FallbackTavusVoice.cs +++ b/src/Vapi.Net/Types/FallbackTavusVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, and caching. +/// [Serializable] public record FallbackTavusVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackTranscriberPlan.cs b/src/Vapi.Net/Types/FallbackTranscriberPlan.cs index 9689acf3..d4d5e7f8 100644 --- a/src/Vapi.Net/Types/FallbackTranscriberPlan.cs +++ b/src/Vapi.Net/Types/FallbackTranscriberPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Lists backup transcriber configurations that can be used if the primary transcriber fails. +/// [Serializable] public record FallbackTranscriberPlan : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record FallbackTranscriberPlan : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Transcriber configurations available when the primary transcriber fails. + /// [JsonPropertyName("transcribers")] public IEnumerable Transcribers { get; set; } = new List(); diff --git a/src/Vapi.Net/Types/FallbackVapiVoice.cs b/src/Vapi.Net/Types/FallbackVapiVoice.cs index 9934d61b..05c1bb04 100644 --- a/src/Vapi.Net/Types/FallbackVapiVoice.cs +++ b/src/Vapi.Net/Types/FallbackVapiVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, and caching. +/// [Serializable] public record FallbackVapiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FallbackWellSaidVoice.cs b/src/Vapi.Net/Types/FallbackWellSaidVoice.cs index 69406fa7..b8ec74de 100644 --- a/src/Vapi.Net/Types/FallbackWellSaidVoice.cs +++ b/src/Vapi.Net/Types/FallbackWellSaidVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fallback configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, and caching. +/// [Serializable] public record FallbackWellSaidVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/File.cs b/src/Vapi.Net/Types/File.cs index 5799455f..0620aedc 100644 --- a/src/Vapi.Net/Types/File.cs +++ b/src/Vapi.Net/Types/File.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and lifecycle timestamps. +/// [Serializable] public record File : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record File : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The object type. This is always `file`. + /// [JsonPropertyName("object")] public FileObject? Object { get; set; } + /// + /// The current processing status of the uploaded file. + /// [JsonPropertyName("status")] public FileStatus? Status { get; set; } @@ -23,36 +32,69 @@ public record File : IJsonOnDeserialized [JsonPropertyName("name")] public string? Name { get; set; } + /// + /// The original name of the uploaded file. + /// [JsonPropertyName("originalName")] public string? OriginalName { get; set; } + /// + /// The size of the uploaded file in bytes. + /// [JsonPropertyName("bytes")] public double? Bytes { get; set; } + /// + /// The intended use assigned to the uploaded file. + /// [JsonPropertyName("purpose")] public string? Purpose { get; set; } + /// + /// The MIME type of the uploaded file. + /// [JsonPropertyName("mimetype")] public string? Mimetype { get; set; } + /// + /// The object-storage key for the uploaded file. + /// [JsonPropertyName("key")] public string? Key { get; set; } + /// + /// The object-storage path for the uploaded file. + /// [JsonPropertyName("path")] public string? Path { get; set; } + /// + /// The object-storage bucket containing the uploaded file. + /// [JsonPropertyName("bucket")] public string? Bucket { get; set; } + /// + /// The URL used to access the uploaded file. + /// [JsonPropertyName("url")] public string? Url { get; set; } + /// + /// The URL used to access text extracted from the file. + /// [JsonPropertyName("parsedTextUrl")] public string? ParsedTextUrl { get; set; } + /// + /// The size of the extracted text in bytes. + /// [JsonPropertyName("parsedTextBytes")] public double? ParsedTextBytes { get; set; } + /// + /// Additional metadata associated with the uploaded file. + /// [JsonPropertyName("metadata")] public object? Metadata { get; set; } diff --git a/src/Vapi.Net/Types/FilterDateTypeColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterDateTypeColumnOnCallTable.cs index 38368b33..b5b7679e 100644 --- a/src/Vapi.Net/Types/FilterDateTypeColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterDateTypeColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters call records by comparing a start or end timestamp with a date. +/// [Serializable] public record FilterDateTypeColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FilterNumberArrayTypeColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterNumberArrayTypeColumnOnCallTable.cs index 7df0999d..6556d48f 100644 --- a/src/Vapi.Net/Types/FilterNumberArrayTypeColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterNumberArrayTypeColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters numeric call fields using a list of values or an emptiness test. +/// [Serializable] public record FilterNumberArrayTypeColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FilterNumberTypeColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterNumberTypeColumnOnCallTable.cs index 130be359..b48272cd 100644 --- a/src/Vapi.Net/Types/FilterNumberTypeColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterNumberTypeColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters call records by comparing a numeric field with a value. +/// [Serializable] public record FilterNumberTypeColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FilterStringArrayTypeColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterStringArrayTypeColumnOnCallTable.cs index 115868ce..0ed78250 100644 --- a/src/Vapi.Net/Types/FilterStringArrayTypeColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterStringArrayTypeColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters string-valued call fields using a list of values or an emptiness test. +/// [Serializable] public record FilterStringArrayTypeColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FilterStringTypeColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterStringTypeColumnOnCallTable.cs index 9ec3767d..3950d97b 100644 --- a/src/Vapi.Net/Types/FilterStringTypeColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterStringTypeColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters call records by comparing or searching a string-valued field. +/// [Serializable] public record FilterStringTypeColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FilterStructuredOutputColumnOnCallTable.cs b/src/Vapi.Net/Types/FilterStructuredOutputColumnOnCallTable.cs index 499b29c0..d42f6639 100644 --- a/src/Vapi.Net/Types/FilterStructuredOutputColumnOnCallTable.cs +++ b/src/Vapi.Net/Types/FilterStructuredOutputColumnOnCallTable.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness operators. +/// [Serializable] public record FilterStructuredOutputColumnOnCallTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FormatPlan.cs b/src/Vapi.Net/Types/FormatPlan.cs index c47c83b1..37c63f1d 100644 --- a/src/Vapi.Net/Types/FormatPlan.cs +++ b/src/Vapi.Net/Types/FormatPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom replacements. +/// [Serializable] public record FormatPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FourierDenoisingPlan.cs b/src/Vapi.Net/Types/FourierDenoisingPlan.cs index a5cd74d2..4abcb31b 100644 --- a/src/Vapi.Net/Types/FourierDenoisingPlan.cs +++ b/src/Vapi.Net/Types/FourierDenoisingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis window. +/// [Serializable] public record FourierDenoisingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/FunctionTool.cs b/src/Vapi.Net/Types/FunctionTool.cs index 289929ea..c120cb0e 100644 --- a/src/Vapi.Net/Types/FunctionTool.cs +++ b/src/Vapi.Net/Types/FunctionTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant. +/// [Serializable] public record FunctionTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GcpKey.cs b/src/Vapi.Net/Types/GcpKey.cs index 73d7c9e6..f3c7e586 100644 --- a/src/Vapi.Net/Types/GcpKey.cs +++ b/src/Vapi.Net/Types/GcpKey.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Google Cloud service-account key used to authenticate access to Google Cloud resources. +/// [Serializable] public record GcpKey : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GeminiMultimodalLivePrebuiltVoiceConfig.cs b/src/Vapi.Net/Types/GeminiMultimodalLivePrebuiltVoiceConfig.cs index 520bb615..1fcc6d03 100644 --- a/src/Vapi.Net/Types/GeminiMultimodalLivePrebuiltVoiceConfig.cs +++ b/src/Vapi.Net/Types/GeminiMultimodalLivePrebuiltVoiceConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Selects a prebuilt voice for Gemini Multimodal Live audio output. +/// [Serializable] public record GeminiMultimodalLivePrebuiltVoiceConfig : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record GeminiMultimodalLivePrebuiltVoiceConfig : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Prebuilt Gemini voice used for audio output. + /// [JsonPropertyName("voiceName")] public required GeminiMultimodalLivePrebuiltVoiceConfigVoiceName VoiceName { get; set; } diff --git a/src/Vapi.Net/Types/GeminiMultimodalLiveSpeechConfig.cs b/src/Vapi.Net/Types/GeminiMultimodalLiveSpeechConfig.cs index 2832368d..2558b1b5 100644 --- a/src/Vapi.Net/Types/GeminiMultimodalLiveSpeechConfig.cs +++ b/src/Vapi.Net/Types/GeminiMultimodalLiveSpeechConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Speech-output configuration for Gemini Multimodal Live. +/// [Serializable] public record GeminiMultimodalLiveSpeechConfig : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record GeminiMultimodalLiveSpeechConfig : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Voice configuration used for Gemini Multimodal Live speech output. + /// [JsonPropertyName("voiceConfig")] public required GeminiMultimodalLiveVoiceConfig VoiceConfig { get; set; } diff --git a/src/Vapi.Net/Types/GeminiMultimodalLiveVoiceConfig.cs b/src/Vapi.Net/Types/GeminiMultimodalLiveVoiceConfig.cs index 52394f15..c69dd385 100644 --- a/src/Vapi.Net/Types/GeminiMultimodalLiveVoiceConfig.cs +++ b/src/Vapi.Net/Types/GeminiMultimodalLiveVoiceConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Voice selection configuration for Gemini Multimodal Live. +/// [Serializable] public record GeminiMultimodalLiveVoiceConfig : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record GeminiMultimodalLiveVoiceConfig : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Prebuilt voice used for Gemini Multimodal Live speech output. + /// [JsonPropertyName("prebuiltVoiceConfig")] public required GeminiMultimodalLivePrebuiltVoiceConfig PrebuiltVoiceConfig { get; set; } diff --git a/src/Vapi.Net/Types/GhlToolMetadata.cs b/src/Vapi.Net/Types/GhlToolMetadata.cs index b45f6e7b..e9b1d6b4 100644 --- a/src/Vapi.Net/Types/GhlToolMetadata.cs +++ b/src/Vapi.Net/Types/GhlToolMetadata.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// GHL workflow and location identifiers attached to a tool. +/// [Serializable] public record GhlToolMetadata : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record GhlToolMetadata : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// GHL workflow identifier associated with the tool. + /// [JsonPropertyName("workflowId")] public string? WorkflowId { get; set; } + /// + /// GHL location identifier associated with the tool. + /// [JsonPropertyName("locationId")] public string? LocationId { get; set; } diff --git a/src/Vapi.Net/Types/GladiaCustomVocabularyConfigDto.cs b/src/Vapi.Net/Types/GladiaCustomVocabularyConfigDto.cs index 27d58fae..679ee2e5 100644 --- a/src/Vapi.Net/Types/GladiaCustomVocabularyConfigDto.cs +++ b/src/Vapi.Net/Types/GladiaCustomVocabularyConfigDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition intensity. +/// [Serializable] public record GladiaCustomVocabularyConfigDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GladiaTranscriber.cs b/src/Vapi.Net/Types/GladiaTranscriber.cs index a71b5c98..4527caa2 100644 --- a/src/Vapi.Net/Types/GladiaTranscriber.cs +++ b/src/Vapi.Net/Types/GladiaTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, audio processing, endpointing, vocabulary, region, and fallback settings. +/// [Serializable] public record GladiaTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GladiaVocabularyItemDto.cs b/src/Vapi.Net/Types/GladiaVocabularyItemDto.cs index 5e62ca0f..378cdbc0 100644 --- a/src/Vapi.Net/Types/GladiaVocabularyItemDto.cs +++ b/src/Vapi.Net/Types/GladiaVocabularyItemDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language. +/// [Serializable] public record GladiaVocabularyItemDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GlobalNodePlan.cs b/src/Vapi.Net/Types/GlobalNodePlan.cs index 34ff062b..58714662 100644 --- a/src/Vapi.Net/Types/GlobalNodePlan.cs +++ b/src/Vapi.Net/Types/GlobalNodePlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls whether a conversation node can be entered globally and the condition evaluated before that node runs. +/// [Serializable] public record GlobalNodePlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoHighLevelCalendarAvailabilityTool.cs b/src/Vapi.Net/Types/GoHighLevelCalendarAvailabilityTool.cs index 25019f23..0fdfb5d0 100644 --- a/src/Vapi.Net/Types/GoHighLevelCalendarAvailabilityTool.cs +++ b/src/Vapi.Net/Types/GoHighLevelCalendarAvailabilityTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that checks calendar availability in a connected GoHighLevel account. +/// [Serializable] public record GoHighLevelCalendarAvailabilityTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoHighLevelCalendarEventCreateTool.cs b/src/Vapi.Net/Types/GoHighLevelCalendarEventCreateTool.cs index ddcdedf2..c177c377 100644 --- a/src/Vapi.Net/Types/GoHighLevelCalendarEventCreateTool.cs +++ b/src/Vapi.Net/Types/GoHighLevelCalendarEventCreateTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that adds calendar events to a connected GoHighLevel account. +/// [Serializable] public record GoHighLevelCalendarEventCreateTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoHighLevelContactCreateTool.cs b/src/Vapi.Net/Types/GoHighLevelContactCreateTool.cs index 0bd1bc43..2298ca6f 100644 --- a/src/Vapi.Net/Types/GoHighLevelContactCreateTool.cs +++ b/src/Vapi.Net/Types/GoHighLevelContactCreateTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that adds contacts to a connected GoHighLevel account. +/// [Serializable] public record GoHighLevelContactCreateTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoHighLevelContactGetTool.cs b/src/Vapi.Net/Types/GoHighLevelContactGetTool.cs index dc8fe1df..dcccddf4 100644 --- a/src/Vapi.Net/Types/GoHighLevelContactGetTool.cs +++ b/src/Vapi.Net/Types/GoHighLevelContactGetTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that retrieves contacts from a connected GoHighLevel account. +/// [Serializable] public record GoHighLevelContactGetTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleCalendarCheckAvailabilityTool.cs b/src/Vapi.Net/Types/GoogleCalendarCheckAvailabilityTool.cs index c28754f3..31a150eb 100644 --- a/src/Vapi.Net/Types/GoogleCalendarCheckAvailabilityTool.cs +++ b/src/Vapi.Net/Types/GoogleCalendarCheckAvailabilityTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that checks availability in a connected Google Calendar. +/// [Serializable] public record GoogleCalendarCheckAvailabilityTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleCalendarCreateEventTool.cs b/src/Vapi.Net/Types/GoogleCalendarCreateEventTool.cs index df52102f..3b6c5c82 100644 --- a/src/Vapi.Net/Types/GoogleCalendarCreateEventTool.cs +++ b/src/Vapi.Net/Types/GoogleCalendarCreateEventTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that adds events to a connected Google Calendar. +/// [Serializable] public record GoogleCalendarCreateEventTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleModel.cs b/src/Vapi.Net/Types/GoogleModel.cs index 76e4e263..c2791c91 100644 --- a/src/Vapi.Net/Types/GoogleModel.cs +++ b/src/Vapi.Net/Types/GoogleModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base access, realtime settings, and generation settings. +/// [Serializable] public record GoogleModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleRealtimeConfig.cs b/src/Vapi.Net/Types/GoogleRealtimeConfig.cs index 3e399d0c..9695bb05 100644 --- a/src/Vapi.Net/Types/GoogleRealtimeConfig.cs +++ b/src/Vapi.Net/Types/GoogleRealtimeConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice configuration. +/// [Serializable] public record GoogleRealtimeConfig : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleSheetsRowAppendTool.cs b/src/Vapi.Net/Types/GoogleSheetsRowAppendTool.cs index 81441286..f814ccd1 100644 --- a/src/Vapi.Net/Types/GoogleSheetsRowAppendTool.cs +++ b/src/Vapi.Net/Types/GoogleSheetsRowAppendTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that appends rows to a connected Google Sheet. +/// [Serializable] public record GoogleSheetsRowAppendTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleTranscriber.cs b/src/Vapi.Net/Types/GoogleTranscriber.cs index 509e2fdd..7f8f5284 100644 --- a/src/Vapi.Net/Types/GoogleTranscriber.cs +++ b/src/Vapi.Net/Types/GoogleTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Google, including model, language, and fallback settings. +/// [Serializable] public record GoogleTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GoogleVoicemailDetectionPlan.cs b/src/Vapi.Net/Types/GoogleVoicemailDetectionPlan.cs index 064f8307..deaa85d5 100644 --- a/src/Vapi.Net/Types/GoogleVoicemailDetectionPlan.cs +++ b/src/Vapi.Net/Types/GoogleVoicemailDetectionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff. +/// [Serializable] public record GoogleVoicemailDetectionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GroqModel.cs b/src/Vapi.Net/Types/GroqModel.cs index 6fd1bfc4..91b101d2 100644 --- a/src/Vapi.Net/Types/GroqModel.cs +++ b/src/Vapi.Net/Types/GroqModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record GroqModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/GroupCondition.cs b/src/Vapi.Net/Types/GroupCondition.cs index 80a5ff86..26916b59 100644 --- a/src/Vapi.Net/Types/GroupCondition.cs +++ b/src/Vapi.Net/Types/GroupCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator. +/// [Serializable] public record GroupCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/HandoffDestinationAssistant.cs b/src/Vapi.Net/Types/HandoffDestinationAssistant.cs index 45a0bddb..6085f18f 100644 --- a/src/Vapi.Net/Types/HandoffDestinationAssistant.cs +++ b/src/Vapi.Net/Types/HandoffDestinationAssistant.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and assistant overrides. +/// [Serializable] public record HandoffDestinationAssistant : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record HandoffDestinationAssistant : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Selects an assistant as the handoff destination. + /// [JsonPropertyName("type")] public required HandoffDestinationAssistantType Type { get; set; } diff --git a/src/Vapi.Net/Types/HandoffDestinationDynamic.cs b/src/Vapi.Net/Types/HandoffDestinationDynamic.cs index 6c3f2cf9..6ff316c3 100644 --- a/src/Vapi.Net/Types/HandoffDestinationDynamic.cs +++ b/src/Vapi.Net/Types/HandoffDestinationDynamic.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Uses a webhook response to select the handoff destination at runtime. +/// [Serializable] public record HandoffDestinationDynamic : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/HandoffDestinationSquad.cs b/src/Vapi.Net/Types/HandoffDestinationSquad.cs index 0e6356b2..6fb7fc93 100644 --- a/src/Vapi.Net/Types/HandoffDestinationSquad.cs +++ b/src/Vapi.Net/Types/HandoffDestinationSquad.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable extraction, and overrides. +/// [Serializable] public record HandoffDestinationSquad : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/HandoffTool.cs b/src/Vapi.Net/Types/HandoffTool.cs index 6ad44cb7..1759d560 100644 --- a/src/Vapi.Net/Types/HandoffTool.cs +++ b/src/Vapi.Net/Types/HandoffTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination. +/// [Serializable] public record HandoffTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/HmacAuthenticationPlan.cs b/src/Vapi.Net/Types/HmacAuthenticationPlan.cs index 7b513b98..3fafef5d 100644 --- a/src/Vapi.Net/Types/HmacAuthenticationPlan.cs +++ b/src/Vapi.Net/Types/HmacAuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and signature encoding. +/// [Serializable] public record HmacAuthenticationPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/HumeVoice.cs b/src/Vapi.Net/Types/HumeVoice.cs index 40b6f22d..1300a63d 100644 --- a/src/Vapi.Net/Types/HumeVoice.cs +++ b/src/Vapi.Net/Types/HumeVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, caching, and fallback settings. +/// [Serializable] public record HumeVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ImportTwilioPhoneNumberDto.cs b/src/Vapi.Net/Types/ImportTwilioPhoneNumberDto.cs index 2fcedf2a..de3f4b16 100644 --- a/src/Vapi.Net/Types/ImportTwilioPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/ImportTwilioPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, fallback destination, hooks, SMS, and server settings. +/// [Serializable] public record ImportTwilioPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InflectionAiModel.cs b/src/Vapi.Net/Types/InflectionAiModel.cs index 7cc6eb0f..c6114cd5 100644 --- a/src/Vapi.Net/Types/InflectionAiModel.cs +++ b/src/Vapi.Net/Types/InflectionAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record InflectionAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Insight.cs b/src/Vapi.Net/Types/Insight.cs index 767bff81..86081e00 100644 --- a/src/Vapi.Net/Types/Insight.cs +++ b/src/Vapi.Net/Types/Insight.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle timestamps. +/// [Serializable] public record Insight : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InsightFormula.cs b/src/Vapi.Net/Types/InsightFormula.cs index e1f79596..de4abf68 100644 --- a/src/Vapi.Net/Types/InsightFormula.cs +++ b/src/Vapi.Net/Types/InsightFormula.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A formula used to calculate an insight from its query results, with an optional display name. +/// [Serializable] public record InsightFormula : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InsightPaginatedResponse.cs b/src/Vapi.Net/Types/InsightPaginatedResponse.cs index 24bfed7f..bda22280 100644 --- a/src/Vapi.Net/Types/InsightPaginatedResponse.cs +++ b/src/Vapi.Net/Types/InsightPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of saved reporting insights and metadata describing the result set. +/// [Serializable] public record InsightPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record InsightPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The reporting insights returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the insight result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/InsightRunFormatPlan.cs b/src/Vapi.Net/Types/InsightRunFormatPlan.cs index 01e172e6..24e5eaca 100644 --- a/src/Vapi.Net/Types/InsightRunFormatPlan.cs +++ b/src/Vapi.Net/Types/InsightRunFormatPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Selects whether an insight run returns raw data or Recharts-formatted data. +/// [Serializable] public record InsightRunFormatPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InsightRunResponse.cs b/src/Vapi.Net/Types/InsightRunResponse.cs index 4cfa5885..81f74a69 100644 --- a/src/Vapi.Net/Types/InsightRunResponse.cs +++ b/src/Vapi.Net/Types/InsightRunResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Metadata identifying a saved insight run and its lifecycle timestamps. +/// [Serializable] public record InsightRunResponse : IJsonOnDeserialized { @@ -11,18 +14,33 @@ public record InsightRunResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The unique identifier for the insight run. + /// [JsonPropertyName("id")] public required string Id { get; set; } + /// + /// The unique identifier for the insight that was run. + /// [JsonPropertyName("insightId")] public required string InsightId { get; set; } + /// + /// The unique identifier for the organization that owns the run. + /// [JsonPropertyName("orgId")] public required string OrgId { get; set; } + /// + /// The ISO 8601 timestamp when the insight run was created. + /// [JsonPropertyName("createdAt")] public required DateTime CreatedAt { get; set; } + /// + /// The ISO 8601 timestamp when the insight run was last updated. + /// [JsonPropertyName("updatedAt")] public required DateTime UpdatedAt { get; set; } diff --git a/src/Vapi.Net/Types/InsightTimeRange.cs b/src/Vapi.Net/Types/InsightTimeRange.cs index e19e3a65..0a49976f 100644 --- a/src/Vapi.Net/Types/InsightTimeRange.cs +++ b/src/Vapi.Net/Types/InsightTimeRange.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Start, end, and timezone used to limit an insight query by time. +/// [Serializable] public record InsightTimeRange : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InsightTimeRangeWithStep.cs b/src/Vapi.Net/Types/InsightTimeRangeWithStep.cs index fdefd68a..2326e383 100644 --- a/src/Vapi.Net/Types/InsightTimeRangeWithStep.cs +++ b/src/Vapi.Net/Types/InsightTimeRangeWithStep.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Start, end, timezone, and aggregation step used for a time-series insight query. +/// [Serializable] public record InsightTimeRangeWithStep : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/InworldVoice.cs b/src/Vapi.Net/Types/InworldVoice.cs index 8743bf1b..7a25a505 100644 --- a/src/Vapi.Net/Types/InworldVoice.cs +++ b/src/Vapi.Net/Types/InworldVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, caching, and fallback settings. +/// [Serializable] public record InworldVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/JsonQueryOnCallTableWithNumberTypeColumn.cs b/src/Vapi.Net/Types/JsonQueryOnCallTableWithNumberTypeColumn.cs index 745f54a3..f7c8294e 100644 --- a/src/Vapi.Net/Types/JsonQueryOnCallTableWithNumberTypeColumn.cs +++ b/src/Vapi.Net/Types/JsonQueryOnCallTableWithNumberTypeColumn.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// VapiQL JSON query that aggregates a numeric call-table column with optional call filters. +/// [Serializable] public record JsonQueryOnCallTableWithNumberTypeColumn : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/JsonQueryOnCallTableWithStringTypeColumn.cs b/src/Vapi.Net/Types/JsonQueryOnCallTableWithStringTypeColumn.cs index 6c8d554e..269130c6 100644 --- a/src/Vapi.Net/Types/JsonQueryOnCallTableWithStringTypeColumn.cs +++ b/src/Vapi.Net/Types/JsonQueryOnCallTableWithStringTypeColumn.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// VapiQL JSON query that counts values from a string-valued call-table column with optional call filters. +/// [Serializable] public record JsonQueryOnCallTableWithStringTypeColumn : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/JsonQueryOnCallTableWithStructuredOutputColumn.cs b/src/Vapi.Net/Types/JsonQueryOnCallTableWithStructuredOutputColumn.cs index e6cad31f..0269b3ce 100644 --- a/src/Vapi.Net/Types/JsonQueryOnCallTableWithStructuredOutputColumn.cs +++ b/src/Vapi.Net/Types/JsonQueryOnCallTableWithStructuredOutputColumn.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// VapiQL JSON query that aggregates or counts a structured-output value stored on call records. +/// [Serializable] public record JsonQueryOnCallTableWithStructuredOutputColumn : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/JsonQueryOnEventsTable.cs b/src/Vapi.Net/Types/JsonQueryOnEventsTable.cs index 0ef0338e..050f2aad 100644 --- a/src/Vapi.Net/Types/JsonQueryOnEventsTable.cs +++ b/src/Vapi.Net/Types/JsonQueryOnEventsTable.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data filters. +/// [Serializable] public record JsonQueryOnEventsTable : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/JsonSchema.cs b/src/Vapi.Net/Types/JsonSchema.cs index 1aedf780..d7d56ef5 100644 --- a/src/Vapi.Net/Types/JsonSchema.cs +++ b/src/Vapi.Net/Types/JsonSchema.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// JSON Schema definition used to describe structured data for extraction, validation, or model output. +/// [Serializable] public record JsonSchema : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/KeypadInputPlan.cs b/src/Vapi.Net/Types/KeypadInputPlan.cs index 13ffef34..13d97075 100644 --- a/src/Vapi.Net/Types/KeypadInputPlan.cs +++ b/src/Vapi.Net/Types/KeypadInputPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, and delimiters. +/// [Serializable] public record KeypadInputPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/KnowledgeBase.cs b/src/Vapi.Net/Types/KnowledgeBase.cs index 1764e14b..14711e70 100644 --- a/src/Vapi.Net/Types/KnowledgeBase.cs +++ b/src/Vapi.Net/Types/KnowledgeBase.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A knowledge-base configuration, including its provider, model, description, and associated files. +/// [Serializable] public record KnowledgeBase : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/KnowledgeBaseCost.cs b/src/Vapi.Net/Types/KnowledgeBaseCost.cs index 7f267e7c..9d538e36 100644 --- a/src/Vapi.Net/Types/KnowledgeBaseCost.cs +++ b/src/Vapi.Net/Types/KnowledgeBaseCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Knowledge-base model cost, including model, token usage, and amount. +/// [Serializable] public record KnowledgeBaseCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/LangfuseObservabilityPlan.cs b/src/Vapi.Net/Types/LangfuseObservabilityPlan.cs index db30994d..80a8ce25 100644 --- a/src/Vapi.Net/Types/LangfuseObservabilityPlan.cs +++ b/src/Vapi.Net/Types/LangfuseObservabilityPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, and metadata. +/// [Serializable] public record LangfuseObservabilityPlan : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record LangfuseObservabilityPlan : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Routes assistant call observability data to Langfuse. + /// [JsonPropertyName("provider")] public required LangfuseObservabilityPlanProvider Provider { get; set; } diff --git a/src/Vapi.Net/Types/LineInsight.cs b/src/Vapi.Net/Types/LineInsight.cs index 38d38319..5ad371e3 100644 --- a/src/Vapi.Net/Types/LineInsight.cs +++ b/src/Vapi.Net/Types/LineInsight.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. +/// [Serializable] public record LineInsight : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record LineInsight : IJsonOnDeserialized [JsonPropertyName("metadata")] public LineInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the line-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/LineInsightMetadata.cs b/src/Vapi.Net/Types/LineInsightMetadata.cs index c50b04c5..fe77d765 100644 --- a/src/Vapi.Net/Types/LineInsightMetadata.cs +++ b/src/Vapi.Net/Types/LineInsightMetadata.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds. +/// [Serializable] public record LineInsightMetadata : IJsonOnDeserialized { @@ -11,18 +14,33 @@ public record LineInsightMetadata : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Label displayed on the chart's x-axis. + /// [JsonPropertyName("xAxisLabel")] public string? XAxisLabel { get; set; } + /// + /// Label displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisLabel")] public string? YAxisLabel { get; set; } + /// + /// Minimum value displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisMin")] public double? YAxisMin { get; set; } + /// + /// Maximum value displayed on the chart's y-axis. + /// [JsonPropertyName("yAxisMax")] public double? YAxisMax { get; set; } + /// + /// Display name for the insight chart. + /// [JsonPropertyName("name")] public string? Name { get; set; } diff --git a/src/Vapi.Net/Types/LiquidCondition.cs b/src/Vapi.Net/Types/LiquidCondition.cs index 42015e49..359e6d29 100644 --- a/src/Vapi.Net/Types/LiquidCondition.cs +++ b/src/Vapi.Net/Types/LiquidCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Evaluates a Liquid template that must return `true` or `false`. +/// [Serializable] public record LiquidCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/LivekitSmartEndpointingPlan.cs b/src/Vapi.Net/Types/LivekitSmartEndpointingPlan.cs index ca2cb271..de66fe9b 100644 --- a/src/Vapi.Net/Types/LivekitSmartEndpointingPlan.cs +++ b/src/Vapi.Net/Types/LivekitSmartEndpointingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior. +/// [Serializable] public record LivekitSmartEndpointingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/LmntVoice.cs b/src/Vapi.Net/Types/LmntVoice.cs index dc19b3a6..c5dc26da 100644 --- a/src/Vapi.Net/Types/LmntVoice.cs +++ b/src/Vapi.Net/Types/LmntVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, caching, and fallback settings. +/// [Serializable] public record LmntVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/McpTool.cs b/src/Vapi.Net/Types/McpTool.cs index 454f6e9b..178959e2 100644 --- a/src/Vapi.Net/Types/McpTool.cs +++ b/src/Vapi.Net/Types/McpTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools. +/// [Serializable] public record McpTool : IJsonOnDeserialized { @@ -145,6 +148,9 @@ public record McpTool : IJsonOnDeserialized [JsonPropertyName("rejectionPlan")] public ToolRejectionPlan? RejectionPlan { get; set; } + /// + /// Connection metadata for the MCP server, including its communication protocol. + /// [JsonPropertyName("metadata")] public McpToolMetadata? Metadata { get; set; } diff --git a/src/Vapi.Net/Types/McpToolMessages.cs b/src/Vapi.Net/Types/McpToolMessages.cs index b14c32b9..80f721bd 100644 --- a/src/Vapi.Net/Types/McpToolMessages.cs +++ b/src/Vapi.Net/Types/McpToolMessages.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Per-tool message overrides for a tool discovered through an MCP server. +/// [Serializable] public record McpToolMessages : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/McpToolMetadata.cs b/src/Vapi.Net/Types/McpToolMetadata.cs index c0092602..9a5dd106 100644 --- a/src/Vapi.Net/Types/McpToolMetadata.cs +++ b/src/Vapi.Net/Types/McpToolMetadata.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Protocol metadata used to communicate with an MCP server. +/// [Serializable] public record McpToolMetadata : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/MessageAddHookAction.cs b/src/Vapi.Net/Types/MessageAddHookAction.cs index 55384ff2..0277e805 100644 --- a/src/Vapi.Net/Types/MessageAddHookAction.cs +++ b/src/Vapi.Net/Types/MessageAddHookAction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response. +/// [Serializable] public record MessageAddHookAction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/MessageTarget.cs b/src/Vapi.Net/Types/MessageTarget.cs index 40be6cba..bcc174f4 100644 --- a/src/Vapi.Net/Types/MessageTarget.cs +++ b/src/Vapi.Net/Types/MessageTarget.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Selects a conversation message by participant role and position for condition evaluation. +/// [Serializable] public record MessageTarget : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/MinimaxLlmModel.cs b/src/Vapi.Net/Types/MinimaxLlmModel.cs index f53db672..d4f4f992 100644 --- a/src/Vapi.Net/Types/MinimaxLlmModel.cs +++ b/src/Vapi.Net/Types/MinimaxLlmModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record MinimaxLlmModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/MinimaxVoice.cs b/src/Vapi.Net/Types/MinimaxVoice.cs index 96e6e6cf..28547d52 100644 --- a/src/Vapi.Net/Types/MinimaxVoice.cs +++ b/src/Vapi.Net/Types/MinimaxVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record MinimaxVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ModelCost.cs b/src/Vapi.Net/Types/ModelCost.cs index d69c89b2..c3ab5bc7 100644 --- a/src/Vapi.Net/Types/ModelCost.cs +++ b/src/Vapi.Net/Types/ModelCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Language-model cost for a call, including model, token usage, and amount. +/// [Serializable] public record ModelCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Monitor.cs b/src/Vapi.Net/Types/Monitor.cs index a3134a45..dc70f4e6 100644 --- a/src/Vapi.Net/Types/Monitor.cs +++ b/src/Vapi.Net/Types/Monitor.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Live monitoring data for a call, including attached monitor results and listening and control URLs. +/// [Serializable] public record Monitor : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record Monitor : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Results produced by monitors attached to the call. + /// [JsonPropertyName("monitors")] public IEnumerable? Monitors { get; set; } diff --git a/src/Vapi.Net/Types/MonitorPlan.cs b/src/Vapi.Net/Types/MonitorPlan.cs index d37d9055..531e4a21 100644 --- a/src/Vapi.Net/Types/MonitorPlan.cs +++ b/src/Vapi.Net/Types/MonitorPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and attached monitors. +/// [Serializable] public record MonitorPlan : IJsonOnDeserialized { @@ -54,11 +57,7 @@ public record MonitorPlan : IJsonOnDeserialized public bool? ControlAuthenticationEnabled { get; set; } /// - /// 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. /// [JsonPropertyName("monitorIds")] public IEnumerable? MonitorIds { get; set; } diff --git a/src/Vapi.Net/Types/MonitorResult.cs b/src/Vapi.Net/Types/MonitorResult.cs index 609f4578..d0f23567 100644 --- a/src/Vapi.Net/Types/MonitorResult.cs +++ b/src/Vapi.Net/Types/MonitorResult.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Result of evaluating an attached monitor's filter for a call. +/// [Serializable] public record MonitorResult : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record MonitorResult : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Unique identifier of the monitor that produced this result. + /// [JsonPropertyName("monitorId")] public required string MonitorId { get; set; } + /// + /// Whether the monitor's filter matched the call. + /// [JsonPropertyName("filterPassed")] public required bool FilterPassed { get; set; } diff --git a/src/Vapi.Net/Types/Mono.cs b/src/Vapi.Net/Types/Mono.cs index cb665fbc..bd6cf6ca 100644 --- a/src/Vapi.Net/Types/Mono.cs +++ b/src/Vapi.Net/Types/Mono.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Mono recording URLs for the combined call and isolated assistant and customer audio. +/// [Serializable] public record Mono : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/NeuphonicVoice.cs b/src/Vapi.Net/Types/NeuphonicVoice.cs index e6e14457..c7137cfd 100644 --- a/src/Vapi.Net/Types/NeuphonicVoice.cs +++ b/src/Vapi.Net/Types/NeuphonicVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, caching, and fallback settings. +/// [Serializable] public record NeuphonicVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/NodeArtifact.cs b/src/Vapi.Net/Types/NodeArtifact.cs index 939adc46..1f8172bc 100644 --- a/src/Vapi.Net/Types/NodeArtifact.cs +++ b/src/Vapi.Net/Types/NodeArtifact.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Messages and variable values captured while a workflow node was active. +/// [Serializable] public record NodeArtifact : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OAuth2AuthenticationPlan.cs b/src/Vapi.Net/Types/OAuth2AuthenticationPlan.cs index 265f7465..bca1ee25 100644 --- a/src/Vapi.Net/Types/OAuth2AuthenticationPlan.cs +++ b/src/Vapi.Net/Types/OAuth2AuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests. +/// [Serializable] public record OAuth2AuthenticationPlan : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record OAuth2AuthenticationPlan : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Selects OAuth 2.0 authentication. + /// [JsonPropertyName("type")] public required OAuth2AuthenticationPlanType Type { get; set; } diff --git a/src/Vapi.Net/Types/Oauth2AuthenticationSession.cs b/src/Vapi.Net/Types/Oauth2AuthenticationSession.cs index de88e503..9846ef2a 100644 --- a/src/Vapi.Net/Types/Oauth2AuthenticationSession.cs +++ b/src/Vapi.Net/Types/Oauth2AuthenticationSession.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// OAuth 2.0 session tokens and expiration used to authenticate integration requests. +/// [Serializable] public record Oauth2AuthenticationSession : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiFunction.cs b/src/Vapi.Net/Types/OpenAiFunction.cs index 30ce0d39..c96a3074 100644 --- a/src/Vapi.Net/Types/OpenAiFunction.cs +++ b/src/Vapi.Net/Types/OpenAiFunction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema behavior. +/// [Serializable] public record OpenAiFunction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiFunctionParameters.cs b/src/Vapi.Net/Types/OpenAiFunctionParameters.cs index c9390679..215ec6de 100644 --- a/src/Vapi.Net/Types/OpenAiFunctionParameters.cs +++ b/src/Vapi.Net/Types/OpenAiFunctionParameters.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// JSON object schema defining the properties accepted by a function and which properties are required. +/// [Serializable] public record OpenAiFunctionParameters : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiMessage.cs b/src/Vapi.Net/Types/OpenAiMessage.cs index 0e859e4e..87fddc00 100644 --- a/src/Vapi.Net/Types/OpenAiMessage.cs +++ b/src/Vapi.Net/Types/OpenAiMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A conversation message represented in OpenAI chat format. +/// [Serializable] public record OpenAiMessage : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record OpenAiMessage : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Content of the conversation message. + /// [JsonPropertyName("content")] public string? Content { get; set; } + /// + /// Role associated with the conversation message. + /// [JsonPropertyName("role")] public required OpenAiMessageRole Role { get; set; } diff --git a/src/Vapi.Net/Types/OpenAiModel.cs b/src/Vapi.Net/Types/OpenAiModel.cs index 47045fd2..65065c81 100644 --- a/src/Vapi.Net/Types/OpenAiModel.cs +++ b/src/Vapi.Net/Types/OpenAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, tools, prompt caching, and generation settings. +/// [Serializable] public record OpenAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiTranscriber.cs b/src/Vapi.Net/Types/OpenAiTranscriber.cs index 2fc9fac1..a62dfe2a 100644 --- a/src/Vapi.Net/Types/OpenAiTranscriber.cs +++ b/src/Vapi.Net/Types/OpenAiTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and fallback settings. +/// [Serializable] public record OpenAiTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiVoice.cs b/src/Vapi.Net/Types/OpenAiVoice.cs index e6073977..b0cc61b5 100644 --- a/src/Vapi.Net/Types/OpenAiVoice.cs +++ b/src/Vapi.Net/Types/OpenAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, caching, and fallback settings. +/// [Serializable] public record OpenAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenAiVoicemailDetectionPlan.cs b/src/Vapi.Net/Types/OpenAiVoicemailDetectionPlan.cs index f80ab7b0..df4c16be 100644 --- a/src/Vapi.Net/Types/OpenAiVoicemailDetectionPlan.cs +++ b/src/Vapi.Net/Types/OpenAiVoicemailDetectionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff. +/// [Serializable] public record OpenAiVoicemailDetectionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/OpenRouterModel.cs b/src/Vapi.Net/Types/OpenRouterModel.cs index eeae8046..680f7bee 100644 --- a/src/Vapi.Net/Types/OpenRouterModel.cs +++ b/src/Vapi.Net/Types/OpenRouterModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record OpenRouterModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PaginationMeta.cs b/src/Vapi.Net/Types/PaginationMeta.cs index b6df8623..27a71944 100644 --- a/src/Vapi.Net/Types/PaginationMeta.cs +++ b/src/Vapi.Net/Types/PaginationMeta.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Pagination and retention metadata returned with a paginated list of phone numbers. +/// [Serializable] public record PaginationMeta : IJsonOnDeserialized { @@ -11,21 +14,39 @@ public record PaginationMeta : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The number of phone numbers returned per page. + /// [JsonPropertyName("itemsPerPage")] public required double ItemsPerPage { get; set; } + /// + /// The total number of phone numbers matching the request. + /// [JsonPropertyName("totalItems")] public required double TotalItems { get; set; } + /// + /// The current page number. + /// [JsonPropertyName("currentPage")] public required double CurrentPage { get; set; } + /// + /// Whether additional matching phone numbers exist beyond the organization's data-retention window. + /// [JsonPropertyName("itemsBeyondRetention")] public bool? ItemsBeyondRetention { get; set; } + /// + /// The inclusive upper creation-time boundary applied to the result set. + /// [JsonPropertyName("createdAtLe")] public DateTime? CreatedAtLe { get; set; } + /// + /// The inclusive lower creation-time boundary applied to the result set. + /// [JsonPropertyName("createdAtGe")] public DateTime? CreatedAtGe { get; set; } diff --git a/src/Vapi.Net/Types/PerformanceMetrics.cs b/src/Vapi.Net/Types/PerformanceMetrics.cs index beb62064..5f1924d1 100644 --- a/src/Vapi.Net/Types/PerformanceMetrics.cs +++ b/src/Vapi.Net/Types/PerformanceMetrics.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption metrics. +/// [Serializable] public record PerformanceMetrics : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PerplexityAiModel.cs b/src/Vapi.Net/Types/PerplexityAiModel.cs index 255b7fb9..d084cd00 100644 --- a/src/Vapi.Net/Types/PerplexityAiModel.cs +++ b/src/Vapi.Net/Types/PerplexityAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record PerplexityAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PhoneNumberCallEndingHookFilter.cs b/src/Vapi.Net/Types/PhoneNumberCallEndingHookFilter.cs index eff0343e..3fd6d468 100644 --- a/src/Vapi.Net/Types/PhoneNumberCallEndingHookFilter.cs +++ b/src/Vapi.Net/Types/PhoneNumberCallEndingHookFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs. +/// [Serializable] public record PhoneNumberCallEndingHookFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PhoneNumberCallRingingHookFilter.cs b/src/Vapi.Net/Types/PhoneNumberCallRingingHookFilter.cs index 27ed5298..c55b4430 100644 --- a/src/Vapi.Net/Types/PhoneNumberCallRingingHookFilter.cs +++ b/src/Vapi.Net/Types/PhoneNumberCallRingingHookFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs. +/// [Serializable] public record PhoneNumberCallRingingHookFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PhoneNumberHookCallEnding.cs b/src/Vapi.Net/Types/PhoneNumberHookCallEnding.cs index a691d4ef..a937fec5 100644 --- a/src/Vapi.Net/Types/PhoneNumberHookCallEnding.cs +++ b/src/Vapi.Net/Types/PhoneNumberHookCallEnding.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason. +/// [Serializable] public record PhoneNumberHookCallEnding : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PhoneNumberHookCallRinging.cs b/src/Vapi.Net/Types/PhoneNumberHookCallRinging.cs index bf0c2d5d..54f7b7a4 100644 --- a/src/Vapi.Net/Types/PhoneNumberHookCallRinging.cs +++ b/src/Vapi.Net/Types/PhoneNumberHookCallRinging.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters match. +/// [Serializable] public record PhoneNumberHookCallRinging : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PhoneNumberPaginatedResponse.cs b/src/Vapi.Net/Types/PhoneNumberPaginatedResponse.cs index d0f81948..42c9462a 100644 --- a/src/Vapi.Net/Types/PhoneNumberPaginatedResponse.cs +++ b/src/Vapi.Net/Types/PhoneNumberPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of phone numbers and metadata describing the result set. +/// [Serializable] public record PhoneNumberPaginatedResponse : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PieInsight.cs b/src/Vapi.Net/Types/PieInsight.cs index d5e5147d..f2c9a901 100644 --- a/src/Vapi.Net/Types/PieInsight.cs +++ b/src/Vapi.Net/Types/PieInsight.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information. +/// [Serializable] public record PieInsight : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record PieInsight : IJsonOnDeserialized [JsonPropertyName("formulas")] public IEnumerable? Formulas { get; set; } + /// + /// The time range used to query the pie-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/PlayHtVoice.cs b/src/Vapi.Net/Types/PlayHtVoice.cs index fef2c758..d9f0728f 100644 --- a/src/Vapi.Net/Types/PlayHtVoice.cs +++ b/src/Vapi.Net/Types/PlayHtVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, caching, and fallback settings. +/// [Serializable] public record PlayHtVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/PromptInjectionSecurityFilter.cs b/src/Vapi.Net/Types/PromptInjectionSecurityFilter.cs index 7cd7d822..292a171a 100644 --- a/src/Vapi.Net/Types/PromptInjectionSecurityFilter.cs +++ b/src/Vapi.Net/Types/PromptInjectionSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters potential prompt-injection patterns from transcripts. +/// [Serializable] public record PromptInjectionSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ProviderResource.cs b/src/Vapi.Net/Types/ProviderResource.cs index e1cdc7c0..a226c379 100644 --- a/src/Vapi.Net/Types/ProviderResource.cs +++ b/src/Vapi.Net/Types/ProviderResource.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, resource data, and lifecycle information. +/// [Serializable] public record ProviderResource : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ProviderResourcePaginatedResponse.cs b/src/Vapi.Net/Types/ProviderResourcePaginatedResponse.cs index efcf1a60..950a06fb 100644 --- a/src/Vapi.Net/Types/ProviderResourcePaginatedResponse.cs +++ b/src/Vapi.Net/Types/ProviderResourcePaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of provider resources and metadata describing the result set. +/// [Serializable] public record ProviderResourcePaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record ProviderResourcePaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The provider resources returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the provider-resource result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/PublicKeyEncryptionPlan.cs b/src/Vapi.Net/Types/PublicKeyEncryptionPlan.cs index fd14d14a..590bff8b 100644 --- a/src/Vapi.Net/Types/PublicKeyEncryptionPlan.cs +++ b/src/Vapi.Net/Types/PublicKeyEncryptionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for encrypting sensitive outbound request data with a public key. +/// [Serializable] public record PublicKeyEncryptionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/QueryTool.cs b/src/Vapi.Net/Types/QueryTool.cs index cc788f83..59c0bdad 100644 --- a/src/Vapi.Net/Types/QueryTool.cs +++ b/src/Vapi.Net/Types/QueryTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that searches configured knowledge bases and returns relevant content to the assistant. +/// [Serializable] public record QueryTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RceSecurityFilter.cs b/src/Vapi.Net/Types/RceSecurityFilter.cs index ad001db0..6647d1fa 100644 --- a/src/Vapi.Net/Types/RceSecurityFilter.cs +++ b/src/Vapi.Net/Types/RceSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters potential remote code execution (RCE) patterns from transcripts. +/// [Serializable] public record RceSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Recording.cs b/src/Vapi.Net/Types/Recording.cs index 62a7889f..7c7fd5ba 100644 --- a/src/Vapi.Net/Types/Recording.cs +++ b/src/Vapi.Net/Types/Recording.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Call recording locations, including stereo, video, and separated mono recording URLs. +/// [Serializable] public record Recording : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RecordingConsent.cs b/src/Vapi.Net/Types/RecordingConsent.cs index ab5fb755..c298e469 100644 --- a/src/Vapi.Net/Types/RecordingConsent.cs +++ b/src/Vapi.Net/Types/RecordingConsent.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Result of the recording-consent flow, including consent type and the time consent was granted. +/// [Serializable] public record RecordingConsent : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RecordingConsentPlanStayOnLine.cs b/src/Vapi.Net/Types/RecordingConsentPlanStayOnLine.cs index 1cacaf4b..6e9acabe 100644 --- a/src/Vapi.Net/Types/RecordingConsentPlanStayOnLine.cs +++ b/src/Vapi.Net/Types/RecordingConsentPlanStayOnLine.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for requesting recording consent by treating continued presence on the call as consent, including the announcement voice and wait time. +/// [Serializable] public record RecordingConsentPlanStayOnLine : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RecordingConsentPlanVerbal.cs b/src/Vapi.Net/Types/RecordingConsentPlanVerbal.cs index 24217b3f..a990e69d 100644 --- a/src/Vapi.Net/Types/RecordingConsentPlanVerbal.cs +++ b/src/Vapi.Net/Types/RecordingConsentPlanVerbal.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for requesting explicit verbal recording consent, including the announcement voice and action to take when the customer declines. +/// [Serializable] public record RecordingConsentPlanVerbal : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RegexCondition.cs b/src/Vapi.Net/Types/RegexCondition.cs index 00c7230b..a4c508b5 100644 --- a/src/Vapi.Net/Types/RegexCondition.cs +++ b/src/Vapi.Net/Types/RegexCondition.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Evaluates whether targeted conversation-message content matches a regular expression. +/// [Serializable] public record RegexCondition : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RegexOption.cs b/src/Vapi.Net/Types/RegexOption.cs index be02bcdc..cd3b58c4 100644 --- a/src/Vapi.Net/Types/RegexOption.cs +++ b/src/Vapi.Net/Types/RegexOption.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Enables or disables one regular-expression matching option for a text replacement. +/// [Serializable] public record RegexOption : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RegexReplacement.cs b/src/Vapi.Net/Types/RegexReplacement.cs index 8ffcfb05..32b1e18a 100644 --- a/src/Vapi.Net/Types/RegexReplacement.cs +++ b/src/Vapi.Net/Types/RegexReplacement.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Replaces text matching a regular expression before it is sent to a voice provider. +/// [Serializable] public record RegexReplacement : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RegexSecurityFilter.cs b/src/Vapi.Net/Types/RegexSecurityFilter.cs index 32b04003..21afca14 100644 --- a/src/Vapi.Net/Types/RegexSecurityFilter.cs +++ b/src/Vapi.Net/Types/RegexSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters transcript content that matches a custom regular expression. +/// [Serializable] public record RegexSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/RimeAiVoice.cs b/src/Vapi.Net/Types/RimeAiVoice.cs index bd75489b..ab6dff37 100644 --- a/src/Vapi.Net/Types/RimeAiVoice.cs +++ b/src/Vapi.Net/Types/RimeAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, caching, and fallback settings. +/// [Serializable] public record RimeAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SayHookAction.cs b/src/Vapi.Net/Types/SayHookAction.cs index 23e67776..b42e0b3c 100644 --- a/src/Vapi.Net/Types/SayHookAction.cs +++ b/src/Vapi.Net/Types/SayHookAction.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A hook action that makes the assistant speak exact text or generate a response from a prompt. +/// [Serializable] public record SayHookAction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SayPhoneNumberHookAction.cs b/src/Vapi.Net/Types/SayPhoneNumberHookAction.cs index 0255bf52..67221c6c 100644 --- a/src/Vapi.Net/Types/SayPhoneNumberHookAction.cs +++ b/src/Vapi.Net/Types/SayPhoneNumberHookAction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A phone-number hook action that speaks an exact message to the caller. +/// [Serializable] public record SayPhoneNumberHookAction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SbcConfiguration.cs b/src/Vapi.Net/Types/SbcConfiguration.cs index baf7a717..e88eddf9 100644 --- a/src/Vapi.Net/Types/SbcConfiguration.cs +++ b/src/Vapi.Net/Types/SbcConfiguration.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed controller. +/// [Serializable] public record SbcConfiguration : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SchedulePlan.cs b/src/Vapi.Net/Types/SchedulePlan.cs index 85ff13c3..b8b50620 100644 --- a/src/Vapi.Net/Types/SchedulePlan.cs +++ b/src/Vapi.Net/Types/SchedulePlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Time window that controls the earliest and latest time a call may begin. +/// [Serializable] public record SchedulePlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Scorecard.cs b/src/Vapi.Net/Types/Scorecard.cs index 66c666dd..222f8129 100644 --- a/src/Vapi.Net/Types/Scorecard.cs +++ b/src/Vapi.Net/Types/Scorecard.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive metadata, and lifecycle information. +/// [Serializable] public record Scorecard : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ScorecardMetric.cs b/src/Vapi.Net/Types/ScorecardMetric.cs index 32422054..7deb62df 100644 --- a/src/Vapi.Net/Types/ScorecardMetric.cs +++ b/src/Vapi.Net/Types/ScorecardMetric.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A scorecard metric that awards points when a structured output meets its configured conditions. +/// [Serializable] public record ScorecardMetric : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ScorecardPaginatedResponse.cs b/src/Vapi.Net/Types/ScorecardPaginatedResponse.cs index 5003eb3f..ab9cfc21 100644 --- a/src/Vapi.Net/Types/ScorecardPaginatedResponse.cs +++ b/src/Vapi.Net/Types/ScorecardPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of scorecards and metadata describing the result set. +/// [Serializable] public record ScorecardPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record ScorecardPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The scorecards returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the scorecard result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/SecurityFilterBase.cs b/src/Vapi.Net/Types/SecurityFilterBase.cs index 9fd32760..a2c89d5f 100644 --- a/src/Vapi.Net/Types/SecurityFilterBase.cs +++ b/src/Vapi.Net/Types/SecurityFilterBase.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Base configuration for a security filter applied to transcripts before model processing. +/// [Serializable] public record SecurityFilterBase : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SecurityFilterPlan.cs b/src/Vapi.Net/Types/SecurityFilterPlan.cs index 47a999bb..f38d911c 100644 --- a/src/Vapi.Net/Types/SecurityFilterPlan.cs +++ b/src/Vapi.Net/Types/SecurityFilterPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record SecurityFilterPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Server.cs b/src/Vapi.Net/Types/Server.cs index aa9a8876..73c3e6d9 100644 --- a/src/Vapi.Net/Types/Server.cs +++ b/src/Vapi.Net/Types/Server.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, encryption, static IP addresses, and retry behavior. +/// [Serializable] public record Server : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SesameVoice.cs b/src/Vapi.Net/Types/SesameVoice.cs index 3df8c1f6..844046c6 100644 --- a/src/Vapi.Net/Types/SesameVoice.cs +++ b/src/Vapi.Net/Types/SesameVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, caching, and fallback settings. +/// [Serializable] public record SesameVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SipAuthentication.cs b/src/Vapi.Net/Types/SipAuthentication.cs index 11e3e043..659aa9d1 100644 --- a/src/Vapi.Net/Types/SipAuthentication.cs +++ b/src/Vapi.Net/Types/SipAuthentication.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Realm, username, and password used to authenticate SIP requests. +/// [Serializable] public record SipAuthentication : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SipRequestTool.cs b/src/Vapi.Net/Types/SipRequestTool.cs index 765762fc..06e6ba03 100644 --- a/src/Vapi.Net/Types/SipRequestTool.cs +++ b/src/Vapi.Net/Types/SipRequestTool.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. +/// [Serializable] public record SipRequestTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SipTrunkGateway.cs b/src/Vapi.Net/Types/SipTrunkGateway.cs index 60ce40fa..30445e3e 100644 --- a/src/Vapi.Net/Types/SipTrunkGateway.cs +++ b/src/Vapi.Net/Types/SipTrunkGateway.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Network and routing settings for a SIP trunk gateway, including address, port, netmask, inbound and outbound use, signaling protocol, and OPTIONS health checks. +/// [Serializable] public record SipTrunkGateway : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SipTrunkOutboundAuthenticationPlan.cs b/src/Vapi.Net/Types/SipTrunkOutboundAuthenticationPlan.cs index 271d054a..89eb87a2 100644 --- a/src/Vapi.Net/Types/SipTrunkOutboundAuthenticationPlan.cs +++ b/src/Vapi.Net/Types/SipTrunkOutboundAuthenticationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk. +/// [Serializable] public record SipTrunkOutboundAuthenticationPlan : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record SipTrunkOutboundAuthenticationPlan : IJsonOnDeserialized [JsonPropertyName("authPassword")] public string? AuthPassword { get; set; } + /// + /// Username used to authenticate outbound SIP requests. + /// [JsonPropertyName("authUsername")] public string? AuthUsername { get; set; } diff --git a/src/Vapi.Net/Types/SipTrunkOutboundSipRegisterPlan.cs b/src/Vapi.Net/Types/SipTrunkOutboundSipRegisterPlan.cs index 05314404..87cc39b1 100644 --- a/src/Vapi.Net/Types/SipTrunkOutboundSipRegisterPlan.cs +++ b/src/Vapi.Net/Types/SipTrunkOutboundSipRegisterPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Registration settings used when the SIP trunk requires SIP REGISTER. +/// [Serializable] public record SipTrunkOutboundSipRegisterPlan : IJsonOnDeserialized { @@ -11,12 +14,21 @@ public record SipTrunkOutboundSipRegisterPlan : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// SIP registrar domain used for registration. + /// [JsonPropertyName("domain")] public string? Domain { get; set; } + /// + /// Username sent with the SIP REGISTER request. + /// [JsonPropertyName("username")] public string? Username { get; set; } + /// + /// Authentication realm used for SIP registration. + /// [JsonPropertyName("realm")] public string? Realm { get; set; } diff --git a/src/Vapi.Net/Types/SlackSendMessageTool.cs b/src/Vapi.Net/Types/SlackSendMessageTool.cs index d0af8f3d..a76e985b 100644 --- a/src/Vapi.Net/Types/SlackSendMessageTool.cs +++ b/src/Vapi.Net/Types/SlackSendMessageTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that lets an assistant send a message to Slack. +/// [Serializable] public record SlackSendMessageTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SmallestAiVoice.cs b/src/Vapi.Net/Types/SmallestAiVoice.cs index 61badf72..66de1e21 100644 --- a/src/Vapi.Net/Types/SmallestAiVoice.cs +++ b/src/Vapi.Net/Types/SmallestAiVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, caching, and fallback settings. +/// [Serializable] public record SmallestAiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SmartDenoisingPlan.cs b/src/Vapi.Net/Types/SmartDenoisingPlan.cs index e79020de..26a8e953 100644 --- a/src/Vapi.Net/Types/SmartDenoisingPlan.cs +++ b/src/Vapi.Net/Types/SmartDenoisingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls whether Krisp smart denoising filters background speech and noise. +/// [Serializable] public record SmartDenoisingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SmsTool.cs b/src/Vapi.Net/Types/SmsTool.cs index d822cfce..753d5d73 100644 --- a/src/Vapi.Net/Types/SmsTool.cs +++ b/src/Vapi.Net/Types/SmsTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that lets an assistant send an SMS message during a call. +/// [Serializable] public record SmsTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SonioxTranscriber.cs b/src/Vapi.Net/Types/SonioxTranscriber.cs index 8a73479e..508714e5 100644 --- a/src/Vapi.Net/Types/SonioxTranscriber.cs +++ b/src/Vapi.Net/Types/SonioxTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Soniox, including model, language detection, endpointing, vocabulary, and fallback settings. +/// [Serializable] public record SonioxTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SpeechmaticsCustomVocabularyItem.cs b/src/Vapi.Net/Types/SpeechmaticsCustomVocabularyItem.cs index 821fc21a..e017f172 100644 --- a/src/Vapi.Net/Types/SpeechmaticsCustomVocabularyItem.cs +++ b/src/Vapi.Net/Types/SpeechmaticsCustomVocabularyItem.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives. +/// [Serializable] public record SpeechmaticsCustomVocabularyItem : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SpeechmaticsTranscriber.cs b/src/Vapi.Net/Types/SpeechmaticsTranscriber.cs index 5ed1e43a..2870e913 100644 --- a/src/Vapi.Net/Types/SpeechmaticsTranscriber.cs +++ b/src/Vapi.Net/Types/SpeechmaticsTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Speechmatics, including language, region, diarization, vocabulary, endpointing, formatting, and fallback settings. +/// [Serializable] public record SpeechmaticsTranscriber : IJsonOnDeserialized { @@ -17,6 +20,9 @@ public record SpeechmaticsTranscriber : IJsonOnDeserialized [JsonPropertyName("model")] public SpeechmaticsTranscriberModel? Model { get; set; } + /// + /// Language used for transcription. Set to `auto` to detect the language automatically. + /// [JsonPropertyName("language")] public SpeechmaticsTranscriberLanguage? Language { get; set; } @@ -52,6 +58,9 @@ public record SpeechmaticsTranscriber : IJsonOnDeserialized [JsonPropertyName("maxDelay")] public double? MaxDelay { get; set; } + /// + /// Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. + /// [JsonPropertyName("customVocabulary")] public IEnumerable CustomVocabulary { get; set; } = new List(); diff --git a/src/Vapi.Net/Types/SpkiPemPublicKeyConfig.cs b/src/Vapi.Net/Types/SpkiPemPublicKeyConfig.cs index 8afe693f..0bcdeef5 100644 --- a/src/Vapi.Net/Types/SpkiPemPublicKeyConfig.cs +++ b/src/Vapi.Net/Types/SpkiPemPublicKeyConfig.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An SPKI public key in PEM format used to encrypt sensitive request data. +/// [Serializable] public record SpkiPemPublicKeyConfig : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SqlInjectionSecurityFilter.cs b/src/Vapi.Net/Types/SqlInjectionSecurityFilter.cs index bf1e1b69..0cb53204 100644 --- a/src/Vapi.Net/Types/SqlInjectionSecurityFilter.cs +++ b/src/Vapi.Net/Types/SqlInjectionSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters potential SQL injection patterns from transcripts. +/// [Serializable] public record SqlInjectionSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/Squad.cs b/src/Vapi.Net/Types/Squad.cs index d873b1cd..e9da899c 100644 --- a/src/Vapi.Net/Types/Squad.cs +++ b/src/Vapi.Net/Types/Squad.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// 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. +/// [Serializable] public record Squad : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SquadMemberDto.cs b/src/Vapi.Net/Types/SquadMemberDto.cs index 561487ec..27cfe5cb 100644 --- a/src/Vapi.Net/Types/SquadMemberDto.cs +++ b/src/Vapi.Net/Types/SquadMemberDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// An assistant member of a squad. Reference a saved assistant or provide a transient assistant, then configure member-specific overrides and destinations for transfers. +/// [Serializable] public record SquadMemberDto : IJsonOnDeserialized { @@ -12,6 +15,9 @@ public record SquadMemberDto : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Assistants this squad member can route the conversation to through a transfer or handoff. + /// [JsonPropertyName("assistantDestinations")] public IEnumerable< OneOf diff --git a/src/Vapi.Net/Types/SsrfSecurityFilter.cs b/src/Vapi.Net/Types/SsrfSecurityFilter.cs index 3fab8172..ab6278d0 100644 --- a/src/Vapi.Net/Types/SsrfSecurityFilter.cs +++ b/src/Vapi.Net/Types/SsrfSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters potential server-side request forgery (SSRF) patterns from transcripts. +/// [Serializable] public record SsrfSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StartSpeakingPlan.cs b/src/Vapi.Net/Types/StartSpeakingPlan.cs index 551d682c..697df059 100644 --- a/src/Vapi.Net/Types/StartSpeakingPlan.cs +++ b/src/Vapi.Net/Types/StartSpeakingPlan.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing strategy, and custom endpointing rules. +/// [Serializable] public record StartSpeakingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StopSpeakingPlan.cs b/src/Vapi.Net/Types/StopSpeakingPlan.cs index f80984d7..047c486d 100644 --- a/src/Vapi.Net/Types/StopSpeakingPlan.cs +++ b/src/Vapi.Net/Types/StopSpeakingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, restart delay, and phrase exceptions. +/// [Serializable] public record StopSpeakingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StructuredDataMultiPlan.cs b/src/Vapi.Net/Types/StructuredDataMultiPlan.cs index 7d092825..2f18e4cd 100644 --- a/src/Vapi.Net/Types/StructuredDataMultiPlan.cs +++ b/src/Vapi.Net/Types/StructuredDataMultiPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Associates a catalog key with a structured data extraction plan. +/// [Serializable] public record StructuredDataMultiPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StructuredDataPlan.cs b/src/Vapi.Net/Types/StructuredDataPlan.cs index 931465a4..8ad69f04 100644 --- a/src/Vapi.Net/Types/StructuredDataPlan.cs +++ b/src/Vapi.Net/Types/StructuredDataPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request timeout. +/// [Serializable] public record StructuredDataPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StructuredOutput.cs b/src/Vapi.Net/Types/StructuredOutput.cs index 3b1bfd67..88e4eaa9 100644 --- a/src/Vapi.Net/Types/StructuredOutput.cs +++ b/src/Vapi.Net/Types/StructuredOutput.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A saved structured-output definition containing its extraction schema, execution method, model or regular expression, linked resources, and lifecycle metadata. +/// [Serializable] public record StructuredOutput : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/StructuredOutputPaginatedResponse.cs b/src/Vapi.Net/Types/StructuredOutputPaginatedResponse.cs index bcd93200..792e139d 100644 --- a/src/Vapi.Net/Types/StructuredOutputPaginatedResponse.cs +++ b/src/Vapi.Net/Types/StructuredOutputPaginatedResponse.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A paginated collection of structured-output definitions and metadata describing the result set. +/// [Serializable] public record StructuredOutputPaginatedResponse : IJsonOnDeserialized { @@ -11,9 +14,15 @@ public record StructuredOutputPaginatedResponse : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// The structured-output definitions returned for the current page. + /// [JsonPropertyName("results")] public IEnumerable Results { get; set; } = new List(); + /// + /// Pagination metadata for the structured-output result set. + /// [JsonPropertyName("metadata")] public required PaginationMeta Metadata { get; set; } diff --git a/src/Vapi.Net/Types/SubscriptionLimits.cs b/src/Vapi.Net/Types/SubscriptionLimits.cs index ab4fa7ee..35f02d8f 100644 --- a/src/Vapi.Net/Types/SubscriptionLimits.cs +++ b/src/Vapi.Net/Types/SubscriptionLimits.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Organization concurrency limits and remaining concurrent call capacity. +/// [Serializable] public record SubscriptionLimits : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SuccessEvaluationPlan.cs b/src/Vapi.Net/Types/SuccessEvaluationPlan.cs index 156854f7..b2c1f56d 100644 --- a/src/Vapi.Net/Types/SuccessEvaluationPlan.cs +++ b/src/Vapi.Net/Types/SuccessEvaluationPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout. +/// [Serializable] public record SuccessEvaluationPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SummaryPlan.cs b/src/Vapi.Net/Types/SummaryPlan.cs index c80387b5..1b2554d7 100644 --- a/src/Vapi.Net/Types/SummaryPlan.cs +++ b/src/Vapi.Net/Types/SummaryPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls generation of a post-call summary, including prompt messages, enablement, and request timeout. +/// [Serializable] public record SummaryPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SupabaseBucketPlan.cs b/src/Vapi.Net/Types/SupabaseBucketPlan.cs index 5824e4b7..7a3e7696 100644 --- a/src/Vapi.Net/Types/SupabaseBucketPlan.cs +++ b/src/Vapi.Net/Types/SupabaseBucketPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket name, and path. +/// [Serializable] public record SupabaseBucketPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/SystemMessage.cs b/src/Vapi.Net/Types/SystemMessage.cs index 632486d7..6dcd00de 100644 --- a/src/Vapi.Net/Types/SystemMessage.cs +++ b/src/Vapi.Net/Types/SystemMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A system-authored entry in the call message history, including its content and timing. +/// [Serializable] public record SystemMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TalkscriberTranscriber.cs b/src/Vapi.Net/Types/TalkscriberTranscriber.cs index 21263e53..c0ec5061 100644 --- a/src/Vapi.Net/Types/TalkscriberTranscriber.cs +++ b/src/Vapi.Net/Types/TalkscriberTranscriber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, and fallback settings. +/// [Serializable] public record TalkscriberTranscriber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TavusConversationProperties.cs b/src/Vapi.Net/Types/TavusConversationProperties.cs index 8ca6bc91..4d3f325a 100644 --- a/src/Vapi.Net/Types/TavusConversationProperties.cs +++ b/src/Vapi.Net/Types/TavusConversationProperties.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Tavus conversation behavior and media settings, including duration, participant timeouts, recording, transcription, background, language, and recording storage. +/// [Serializable] public record TavusConversationProperties : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TavusVoice.cs b/src/Vapi.Net/Types/TavusVoice.cs index b07a5c7c..79da9e4a 100644 --- a/src/Vapi.Net/Types/TavusVoice.cs +++ b/src/Vapi.Net/Types/TavusVoice.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, caching, and fallback settings. +/// [Serializable] public record TavusVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TelnyxPhoneNumber.cs b/src/Vapi.Net/Types/TelnyxPhoneNumber.cs index cd5bc8b7..1a82d9d4 100644 --- a/src/Vapi.Net/Types/TelnyxPhoneNumber.cs +++ b/src/Vapi.Net/Types/TelnyxPhoneNumber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. +/// [Serializable] public record TelnyxPhoneNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TextContent.cs b/src/Vapi.Net/Types/TextContent.cs index 0df52916..f26a77bd 100644 --- a/src/Vapi.Net/Types/TextContent.cs +++ b/src/Vapi.Net/Types/TextContent.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Localized text content used as a language-specific message variant. +/// [Serializable] public record TextContent : IJsonOnDeserialized { @@ -11,12 +14,21 @@ public record TextContent : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Selects text as the content type. + /// [JsonPropertyName("type")] public required TextContentType Type { get; set; } + /// + /// Text spoken or displayed for this content variant. + /// [JsonPropertyName("text")] public required string Text { get; set; } + /// + /// Language code associated with this text variant. + /// [JsonPropertyName("language")] public required TextContentLanguage Language { get; set; } diff --git a/src/Vapi.Net/Types/TextEditorTool.cs b/src/Vapi.Net/Types/TextEditorTool.cs index 4e7d3989..39ba0fe9 100644 --- a/src/Vapi.Net/Types/TextEditorTool.cs +++ b/src/Vapi.Net/Types/TextEditorTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that reads and edits text files in a configured environment. +/// [Serializable] public record TextEditorTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TextInsight.cs b/src/Vapi.Net/Types/TextInsight.cs index e5566b4e..06be678f 100644 --- a/src/Vapi.Net/Types/TextInsight.cs +++ b/src/Vapi.Net/Types/TextInsight.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information. +/// [Serializable] public record TextInsight : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record TextInsight : IJsonOnDeserialized [JsonPropertyName("formula")] public object? Formula { get; set; } + /// + /// The time range used to query the text-value data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/TimeRange.cs b/src/Vapi.Net/Types/TimeRange.cs index c85d7cf4..6c952971 100644 --- a/src/Vapi.Net/Types/TimeRange.cs +++ b/src/Vapi.Net/Types/TimeRange.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Start, end, timezone, and time step used for analytics aggregation. +/// [Serializable] public record TimeRange : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TogetherAiModel.cs b/src/Vapi.Net/Types/TogetherAiModel.cs index 49406246..e8abe318 100644 --- a/src/Vapi.Net/Types/TogetherAiModel.cs +++ b/src/Vapi.Net/Types/TogetherAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record TogetherAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolCall.cs b/src/Vapi.Net/Types/ToolCall.cs index 2779da93..81c42bdc 100644 --- a/src/Vapi.Net/Types/ToolCall.cs +++ b/src/Vapi.Net/Types/ToolCall.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A tool invocation requested by the assistant, including its identifier, type, and function details. +/// [Serializable] public record ToolCall : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolCallFunction.cs b/src/Vapi.Net/Types/ToolCallFunction.cs index 5bee7a79..b3fef98c 100644 --- a/src/Vapi.Net/Types/ToolCallFunction.cs +++ b/src/Vapi.Net/Types/ToolCallFunction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// The function name and serialized arguments associated with a tool call. +/// [Serializable] public record ToolCallFunction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolCallHookAction.cs b/src/Vapi.Net/Types/ToolCallHookAction.cs index d180a541..2e595951 100644 --- a/src/Vapi.Net/Types/ToolCallHookAction.cs +++ b/src/Vapi.Net/Types/ToolCallHookAction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A hook action that invokes an inline tool or an existing tool when the hook triggers. +/// [Serializable] public record ToolCallHookAction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolCallMessage.cs b/src/Vapi.Net/Types/ToolCallMessage.cs index 9a7416d2..b5ff09e5 100644 --- a/src/Vapi.Net/Types/ToolCallMessage.cs +++ b/src/Vapi.Net/Types/ToolCallMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An entry in the call message history that records one or more tool calls requested during the conversation. +/// [Serializable] public record ToolCallMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolCallResultMessage.cs b/src/Vapi.Net/Types/ToolCallResultMessage.cs index 7e5b37f1..c3bcfd6b 100644 --- a/src/Vapi.Net/Types/ToolCallResultMessage.cs +++ b/src/Vapi.Net/Types/ToolCallResultMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// An entry in the call message history that records the result and metadata for a completed tool call. +/// [Serializable] public record ToolCallResultMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolMessage.cs b/src/Vapi.Net/Types/ToolMessage.cs index f8a37bfc..964f8066 100644 --- a/src/Vapi.Net/Types/ToolMessage.cs +++ b/src/Vapi.Net/Types/ToolMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A tool-result message associated with a specific tool call. +/// [Serializable] public record ToolMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolMessageComplete.cs b/src/Vapi.Net/Types/ToolMessageComplete.cs index 4da2e4bb..53012cc4 100644 --- a/src/Vapi.Net/Types/ToolMessageComplete.cs +++ b/src/Vapi.Net/Types/ToolMessageComplete.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Message spoken when a tool call completes, with optional language variants, argument conditions, role, and end-call behavior. +/// [Serializable] public record ToolMessageComplete : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolMessageDelayed.cs b/src/Vapi.Net/Types/ToolMessageDelayed.cs index 496ec70f..1382ee4a 100644 --- a/src/Vapi.Net/Types/ToolMessageDelayed.cs +++ b/src/Vapi.Net/Types/ToolMessageDelayed.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument conditions. +/// [Serializable] public record ToolMessageDelayed : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolMessageFailed.cs b/src/Vapi.Net/Types/ToolMessageFailed.cs index 2047a649..6079cd47 100644 --- a/src/Vapi.Net/Types/ToolMessageFailed.cs +++ b/src/Vapi.Net/Types/ToolMessageFailed.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call behavior. +/// [Serializable] public record ToolMessageFailed : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolMessageStart.cs b/src/Vapi.Net/Types/ToolMessageStart.cs index 44612e8a..24fe3a3d 100644 --- a/src/Vapi.Net/Types/ToolMessageStart.cs +++ b/src/Vapi.Net/Types/ToolMessageStart.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking behavior. +/// [Serializable] public record ToolMessageStart : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolNode.cs b/src/Vapi.Net/Types/ToolNode.cs index 5189f851..e696590f 100644 --- a/src/Vapi.Net/Types/ToolNode.cs +++ b/src/Vapi.Net/Types/ToolNode.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A workflow node that invokes an inline tool or an existing saved tool. +/// [Serializable] public record ToolNode : IJsonOnDeserialized { @@ -23,6 +26,9 @@ public record ToolNode : IJsonOnDeserialized [JsonPropertyName("toolId")] public string? ToolId { get; set; } + /// + /// Unique name used to identify this workflow node. + /// [JsonPropertyName("name")] public required string Name { get; set; } diff --git a/src/Vapi.Net/Types/ToolParameter.cs b/src/Vapi.Net/Types/ToolParameter.cs index 12ab1152..6ec66629 100644 --- a/src/Vapi.Net/Types/ToolParameter.cs +++ b/src/Vapi.Net/Types/ToolParameter.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Static key-value parameter added to a tool request, with Liquid template support for string values. +/// [Serializable] public record ToolParameter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/ToolRejectionPlan.cs b/src/Vapi.Net/Types/ToolRejectionPlan.cs index 20eac00a..c66036e1 100644 --- a/src/Vapi.Net/Types/ToolRejectionPlan.cs +++ b/src/Vapi.Net/Types/ToolRejectionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Conditions evaluated to determine whether a requested tool call should be rejected. +/// [Serializable] public record ToolRejectionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TranscriberCost.cs b/src/Vapi.Net/Types/TranscriberCost.cs index d8d0c16d..88b8df5b 100644 --- a/src/Vapi.Net/Types/TranscriberCost.cs +++ b/src/Vapi.Net/Types/TranscriberCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Speech-to-text cost for a call, including transcriber, billable minutes, and amount. +/// [Serializable] public record TranscriberCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TranscriptPlan.cs b/src/Vapi.Net/Types/TranscriptPlan.cs index bf826b5d..13838d8e 100644 --- a/src/Vapi.Net/Types/TranscriptPlan.cs +++ b/src/Vapi.Net/Types/TranscriptPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls whether the call transcript is stored and the speaker names used in the transcript. +/// [Serializable] public record TranscriptPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TranscriptionEndpointingPlan.cs b/src/Vapi.Net/Types/TranscriptionEndpointingPlan.cs index c859e743..310e1dfd 100644 --- a/src/Vapi.Net/Types/TranscriptionEndpointingPlan.cs +++ b/src/Vapi.Net/Types/TranscriptionEndpointingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a number. +/// [Serializable] public record TranscriptionEndpointingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferCallTool.cs b/src/Vapi.Net/Types/TransferCallTool.cs index 1d3d2a71..a43717c2 100644 --- a/src/Vapi.Net/Types/TransferCallTool.cs +++ b/src/Vapi.Net/Types/TransferCallTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable tool that transfers the active call to one of its configured destinations. +/// [Serializable] public record TransferCallTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferDestinationAssistant.cs b/src/Vapi.Net/Types/TransferDestinationAssistant.cs index e7512ba6..020bf727 100644 --- a/src/Vapi.Net/Types/TransferDestinationAssistant.cs +++ b/src/Vapi.Net/Types/TransferDestinationAssistant.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Transfers a call to another assistant by name, with an optional message and assistant-transfer mode. +/// [Serializable] public record TransferDestinationAssistant : IJsonOnDeserialized { @@ -24,6 +27,9 @@ public record TransferDestinationAssistant : IJsonOnDeserialized [JsonPropertyName("message")] public OneOf? Message { get; set; } + /// + /// Selects another assistant as the transfer destination. + /// [JsonPropertyName("type")] public required TransferDestinationAssistantType Type { get; set; } diff --git a/src/Vapi.Net/Types/TransferDestinationNumber.cs b/src/Vapi.Net/Types/TransferDestinationNumber.cs index f8f76917..f42346d9 100644 --- a/src/Vapi.Net/Types/TransferDestinationNumber.cs +++ b/src/Vapi.Net/Types/TransferDestinationNumber.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number validation. +/// [Serializable] public record TransferDestinationNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferDestinationSip.cs b/src/Vapi.Net/Types/TransferDestinationSip.cs index 1191e6aa..648e57cf 100644 --- a/src/Vapi.Net/Types/TransferDestinationSip.cs +++ b/src/Vapi.Net/Types/TransferDestinationSip.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan. +/// [Serializable] public record TransferDestinationSip : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferFallbackPlan.cs b/src/Vapi.Net/Types/TransferFallbackPlan.cs index 1355e8ec..98f5e5b8 100644 --- a/src/Vapi.Net/Types/TransferFallbackPlan.cs +++ b/src/Vapi.Net/Types/TransferFallbackPlan.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Controls the message and end-call behavior used when a call transfer fails. +/// [Serializable] public record TransferFallbackPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferPhoneNumberHookAction.cs b/src/Vapi.Net/Types/TransferPhoneNumberHookAction.cs index 7a00f75b..95842251 100644 --- a/src/Vapi.Net/Types/TransferPhoneNumberHookAction.cs +++ b/src/Vapi.Net/Types/TransferPhoneNumberHookAction.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A phone-number hook action that transfers the call to a phone number or SIP destination. +/// [Serializable] public record TransferPhoneNumberHookAction : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransferPlan.cs b/src/Vapi.Net/Types/TransferPlan.cs index 5af0b477..e22e564e 100644 --- a/src/Vapi.Net/Types/TransferPlan.cs +++ b/src/Vapi.Net/Types/TransferPlan.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Controls how a call transfer is executed, including blind and warm transfer modes, dialing and SIP behavior, hold audio, context, summary, and failure handling. +/// [Serializable] public record TransferPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TransportConfigurationTwilio.cs b/src/Vapi.Net/Types/TransportConfigurationTwilio.cs index ce699031..70ab10b2 100644 --- a/src/Vapi.Net/Types/TransportConfigurationTwilio.cs +++ b/src/Vapi.Net/Types/TransportConfigurationTwilio.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior. +/// [Serializable] public record TransportConfigurationTwilio : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record TransportConfigurationTwilio : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Selects Twilio as the call transport provider. + /// [JsonPropertyName("provider")] public required TransportConfigurationTwilioProvider Provider { get; set; } diff --git a/src/Vapi.Net/Types/TransportCost.cs b/src/Vapi.Net/Types/TransportCost.cs index 5e1cff96..6b58776b 100644 --- a/src/Vapi.Net/Types/TransportCost.cs +++ b/src/Vapi.Net/Types/TransportCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Telephony transport cost for a call, including provider, billable minutes, and amount. +/// [Serializable] public record TransportCost : IJsonOnDeserialized { @@ -11,6 +14,9 @@ public record TransportCost : IJsonOnDeserialized private readonly IDictionary _extensionData = new Dictionary(); + /// + /// Telephony or transport provider that generated the cost. + /// [JsonPropertyName("provider")] public TransportCostProvider? Provider { get; set; } diff --git a/src/Vapi.Net/Types/TurnLatency.cs b/src/Vapi.Net/Types/TurnLatency.cs index 84ced8e3..1a4fafc1 100644 --- a/src/Vapi.Net/Types/TurnLatency.cs +++ b/src/Vapi.Net/Types/TurnLatency.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Model, voice, transcription, endpointing, and total latency measurements for a conversation turn. +/// [Serializable] public record TurnLatency : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TwilioPhoneNumber.cs b/src/Vapi.Net/Types/TwilioPhoneNumber.cs index 3a40b8d7..71208740 100644 --- a/src/Vapi.Net/Types/TwilioPhoneNumber.cs +++ b/src/Vapi.Net/Types/TwilioPhoneNumber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata. +/// [Serializable] public record TwilioPhoneNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/TwilioVoicemailDetectionPlan.cs b/src/Vapi.Net/Types/TwilioVoicemailDetectionPlan.cs index 748a5b08..597f03b7 100644 --- a/src/Vapi.Net/Types/TwilioVoicemailDetectionPlan.cs +++ b/src/Vapi.Net/Types/TwilioVoicemailDetectionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech thresholds, and silence timeout. +/// [Serializable] public record TwilioVoicemailDetectionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateApiRequestToolDto.cs b/src/Vapi.Net/Types/UpdateApiRequestToolDto.cs index a64a30f2..4da61c7c 100644 --- a/src/Vapi.Net/Types/UpdateApiRequestToolDto.cs +++ b/src/Vapi.Net/Types/UpdateApiRequestToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, and response handling. +/// [Serializable] public record UpdateApiRequestToolDto : IJsonOnDeserialized { @@ -19,6 +22,9 @@ public record UpdateApiRequestToolDto : IJsonOnDeserialized [JsonPropertyName("messages")] public IEnumerable? Messages { get; set; } + /// + /// The HTTP method used for the API request. + /// [JsonPropertyName("method")] public UpdateApiRequestToolDtoMethod? Method { get; set; } diff --git a/src/Vapi.Net/Types/UpdateBarInsightFromCallTableDto.cs b/src/Vapi.Net/Types/UpdateBarInsightFromCallTableDto.cs index 4966ad89..2b075335 100644 --- a/src/Vapi.Net/Types/UpdateBarInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/UpdateBarInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and name. +/// [Serializable] public record UpdateBarInsightFromCallTableDto : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record UpdateBarInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("metadata")] public BarInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the bar-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/UpdateBashToolDto.cs b/src/Vapi.Net/Types/UpdateBashToolDto.cs index 2e0b400e..e01005ed 100644 --- a/src/Vapi.Net/Types/UpdateBashToolDto.cs +++ b/src/Vapi.Net/Types/UpdateBashToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan. +/// [Serializable] public record UpdateBashToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateByoPhoneNumberDto.cs b/src/Vapi.Net/Types/UpdateByoPhoneNumberDto.cs index 073af831..a66324ef 100644 --- a/src/Vapi.Net/Types/UpdateByoPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/UpdateByoPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings. +/// [Serializable] public record UpdateByoPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateComputerToolDto.cs b/src/Vapi.Net/Types/UpdateComputerToolDto.cs index 5e919880..50b7f863 100644 --- a/src/Vapi.Net/Types/UpdateComputerToolDto.cs +++ b/src/Vapi.Net/Types/UpdateComputerToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan. +/// [Serializable] public record UpdateComputerToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateDtmfToolDto.cs b/src/Vapi.Net/Types/UpdateDtmfToolDto.cs index b0108aeb..1c90cd5f 100644 --- a/src/Vapi.Net/Types/UpdateDtmfToolDto.cs +++ b/src/Vapi.Net/Types/UpdateDtmfToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior. +/// [Serializable] public record UpdateDtmfToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateEndCallToolDto.cs b/src/Vapi.Net/Types/UpdateEndCallToolDto.cs index 16ca62af..41e5f31b 100644 --- a/src/Vapi.Net/Types/UpdateEndCallToolDto.cs +++ b/src/Vapi.Net/Types/UpdateEndCallToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update an end-call tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateEndCallToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateFunctionToolDto.cs b/src/Vapi.Net/Types/UpdateFunctionToolDto.cs index facb0d81..ed52d818 100644 --- a/src/Vapi.Net/Types/UpdateFunctionToolDto.cs +++ b/src/Vapi.Net/Types/UpdateFunctionToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior. +/// [Serializable] public record UpdateFunctionToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.cs b/src/Vapi.Net/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.cs index 8478b53f..76af0d36 100644 --- a/src/Vapi.Net/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoHighLevelCalendarAvailabilityToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoHighLevelCalendarEventCreateToolDto.cs b/src/Vapi.Net/Types/UpdateGoHighLevelCalendarEventCreateToolDto.cs index e6764b80..cc34ec52 100644 --- a/src/Vapi.Net/Types/UpdateGoHighLevelCalendarEventCreateToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoHighLevelCalendarEventCreateToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoHighLevelCalendarEventCreateToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoHighLevelContactCreateToolDto.cs b/src/Vapi.Net/Types/UpdateGoHighLevelContactCreateToolDto.cs index 2a2df946..04325383 100644 --- a/src/Vapi.Net/Types/UpdateGoHighLevelContactCreateToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoHighLevelContactCreateToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoHighLevelContactCreateToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoHighLevelContactGetToolDto.cs b/src/Vapi.Net/Types/UpdateGoHighLevelContactGetToolDto.cs index 1749a1b2..67fbc42b 100644 --- a/src/Vapi.Net/Types/UpdateGoHighLevelContactGetToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoHighLevelContactGetToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoHighLevelContactGetToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.cs b/src/Vapi.Net/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.cs index 0a5599e3..38bbd742 100644 --- a/src/Vapi.Net/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoogleCalendarCheckAvailabilityToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoogleCalendarCreateEventToolDto.cs b/src/Vapi.Net/Types/UpdateGoogleCalendarCreateEventToolDto.cs index e43c6e03..25a98f2c 100644 --- a/src/Vapi.Net/Types/UpdateGoogleCalendarCreateEventToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoogleCalendarCreateEventToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoogleCalendarCreateEventToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateGoogleSheetsRowAppendToolDto.cs b/src/Vapi.Net/Types/UpdateGoogleSheetsRowAppendToolDto.cs index 0f198656..8875f0a7 100644 --- a/src/Vapi.Net/Types/UpdateGoogleSheetsRowAppendToolDto.cs +++ b/src/Vapi.Net/Types/UpdateGoogleSheetsRowAppendToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateGoogleSheetsRowAppendToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateHandoffToolDto.cs b/src/Vapi.Net/Types/UpdateHandoffToolDto.cs index ae29f55c..8594b16d 100644 --- a/src/Vapi.Net/Types/UpdateHandoffToolDto.cs +++ b/src/Vapi.Net/Types/UpdateHandoffToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan. +/// [Serializable] public record UpdateHandoffToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateLineInsightFromCallTableDto.cs b/src/Vapi.Net/Types/UpdateLineInsightFromCallTableDto.cs index 8876bef7..7c322c66 100644 --- a/src/Vapi.Net/Types/UpdateLineInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/UpdateLineInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and name. +/// [Serializable] public record UpdateLineInsightFromCallTableDto : IJsonOnDeserialized { @@ -44,6 +47,9 @@ public record UpdateLineInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("metadata")] public LineInsightMetadata? Metadata { get; set; } + /// + /// The time range and interval used to aggregate the line-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRangeWithStep? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/UpdateMcpToolDto.cs b/src/Vapi.Net/Types/UpdateMcpToolDto.cs index 7597bc2d..42532909 100644 --- a/src/Vapi.Net/Types/UpdateMcpToolDto.cs +++ b/src/Vapi.Net/Types/UpdateMcpToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan. +/// [Serializable] public record UpdateMcpToolDto : IJsonOnDeserialized { @@ -121,6 +124,9 @@ public record UpdateMcpToolDto : IJsonOnDeserialized [JsonPropertyName("rejectionPlan")] public ToolRejectionPlan? RejectionPlan { get; set; } + /// + /// Connection metadata for the MCP server, including its communication protocol. + /// [JsonPropertyName("metadata")] public McpToolMetadata? Metadata { get; set; } diff --git a/src/Vapi.Net/Types/UpdatePieInsightFromCallTableDto.cs b/src/Vapi.Net/Types/UpdatePieInsightFromCallTableDto.cs index 4633c901..c22ec893 100644 --- a/src/Vapi.Net/Types/UpdatePieInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/UpdatePieInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name. +/// [Serializable] public record UpdatePieInsightFromCallTableDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record UpdatePieInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("formulas")] public IEnumerable? Formulas { get; set; } + /// + /// The time range used to query the pie-chart data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/UpdateQueryToolDto.cs b/src/Vapi.Net/Types/UpdateQueryToolDto.cs index fe4c324d..9bbfa95a 100644 --- a/src/Vapi.Net/Types/UpdateQueryToolDto.cs +++ b/src/Vapi.Net/Types/UpdateQueryToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan. +/// [Serializable] public record UpdateQueryToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateSipRequestToolDto.cs b/src/Vapi.Net/Types/UpdateSipRequestToolDto.cs index 76233935..4feb1ebb 100644 --- a/src/Vapi.Net/Types/UpdateSipRequestToolDto.cs +++ b/src/Vapi.Net/Types/UpdateSipRequestToolDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan. +/// [Serializable] public record UpdateSipRequestToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateSlackSendMessageToolDto.cs b/src/Vapi.Net/Types/UpdateSlackSendMessageToolDto.cs index e61f0de1..0a78e4da 100644 --- a/src/Vapi.Net/Types/UpdateSlackSendMessageToolDto.cs +++ b/src/Vapi.Net/Types/UpdateSlackSendMessageToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Slack message tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateSlackSendMessageToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateSmsToolDto.cs b/src/Vapi.Net/Types/UpdateSmsToolDto.cs index d7fbf757..8abe5266 100644 --- a/src/Vapi.Net/Types/UpdateSmsToolDto.cs +++ b/src/Vapi.Net/Types/UpdateSmsToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update an SMS tool, including its spoken messages and rejection plan. +/// [Serializable] public record UpdateSmsToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateTelnyxPhoneNumberDto.cs b/src/Vapi.Net/Types/UpdateTelnyxPhoneNumberDto.cs index 96abac7a..9a665299 100644 --- a/src/Vapi.Net/Types/UpdateTelnyxPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/UpdateTelnyxPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings. +/// [Serializable] public record UpdateTelnyxPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateTextEditorToolDto.cs b/src/Vapi.Net/Types/UpdateTextEditorToolDto.cs index ab3dedc0..31f14054 100644 --- a/src/Vapi.Net/Types/UpdateTextEditorToolDto.cs +++ b/src/Vapi.Net/Types/UpdateTextEditorToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan. +/// [Serializable] public record UpdateTextEditorToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateTextInsightFromCallTableDto.cs b/src/Vapi.Net/Types/UpdateTextInsightFromCallTableDto.cs index de10f641..c7e750a9 100644 --- a/src/Vapi.Net/Types/UpdateTextInsightFromCallTableDto.cs +++ b/src/Vapi.Net/Types/UpdateTextInsightFromCallTableDto.cs @@ -5,6 +5,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a text-value insight, including its queries, formula, time range, and name. +/// [Serializable] public record UpdateTextInsightFromCallTableDto : IJsonOnDeserialized { @@ -38,6 +41,9 @@ public record UpdateTextInsightFromCallTableDto : IJsonOnDeserialized [JsonPropertyName("formula")] public object? Formula { get; set; } + /// + /// The time range used to query the text-value data. + /// [JsonPropertyName("timeRange")] public InsightTimeRange? TimeRange { get; set; } diff --git a/src/Vapi.Net/Types/UpdateTransferCallToolDto.cs b/src/Vapi.Net/Types/UpdateTransferCallToolDto.cs index 04db482d..26d294c2 100644 --- a/src/Vapi.Net/Types/UpdateTransferCallToolDto.cs +++ b/src/Vapi.Net/Types/UpdateTransferCallToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan. +/// [Serializable] public record UpdateTransferCallToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateTwilioPhoneNumberDto.cs b/src/Vapi.Net/Types/UpdateTwilioPhoneNumberDto.cs index 3183bfc7..bb80b0d0 100644 --- a/src/Vapi.Net/Types/UpdateTwilioPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/UpdateTwilioPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings. +/// [Serializable] public record UpdateTwilioPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateVapiPhoneNumberDto.cs b/src/Vapi.Net/Types/UpdateVapiPhoneNumberDto.cs index 41748316..36d31294 100644 --- a/src/Vapi.Net/Types/UpdateVapiPhoneNumberDto.cs +++ b/src/Vapi.Net/Types/UpdateVapiPhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings. +/// [Serializable] public record UpdateVapiPhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateVoicemailToolDto.cs b/src/Vapi.Net/Types/UpdateVoicemailToolDto.cs index 7cb9cc6c..cd20d426 100644 --- a/src/Vapi.Net/Types/UpdateVoicemailToolDto.cs +++ b/src/Vapi.Net/Types/UpdateVoicemailToolDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan. +/// [Serializable] public record UpdateVoicemailToolDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UpdateVonagePhoneNumberDto.cs b/src/Vapi.Net/Types/UpdateVonagePhoneNumberDto.cs index ed96555f..57486a1f 100644 --- a/src/Vapi.Net/Types/UpdateVonagePhoneNumberDto.cs +++ b/src/Vapi.Net/Types/UpdateVonagePhoneNumberDto.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings. +/// [Serializable] public record UpdateVonagePhoneNumberDto : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/UserMessage.cs b/src/Vapi.Net/Types/UserMessage.cs index 30944e90..2158e0e4 100644 --- a/src/Vapi.Net/Types/UserMessage.cs +++ b/src/Vapi.Net/Types/UserMessage.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A user-authored entry in the call message history, including content, timing, security-filter results, and optional speaker metadata. +/// [Serializable] public record UserMessage : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiCost.cs b/src/Vapi.Net/Types/VapiCost.cs index 0e3810d2..6b926f1a 100644 --- a/src/Vapi.Net/Types/VapiCost.cs +++ b/src/Vapi.Net/Types/VapiCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Vapi platform cost for a call, including cost subtype, billable minutes, and amount. +/// [Serializable] public record VapiCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiPhoneNumber.cs b/src/Vapi.Net/Types/VapiPhoneNumber.cs index 7d56e777..f49c37ff 100644 --- a/src/Vapi.Net/Types/VapiPhoneNumber.cs +++ b/src/Vapi.Net/Types/VapiPhoneNumber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata. +/// [Serializable] public record VapiPhoneNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiPronunciationDictionaryLocator.cs b/src/Vapi.Net/Types/VapiPronunciationDictionaryLocator.cs index e93c9336..98dfda17 100644 --- a/src/Vapi.Net/Types/VapiPronunciationDictionaryLocator.cs +++ b/src/Vapi.Net/Types/VapiPronunciationDictionaryLocator.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Identifies a pronunciation dictionary and optional version used for voice synthesis. +/// [Serializable] public record VapiPronunciationDictionaryLocator : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiSmartEndpointingPlan.cs b/src/Vapi.Net/Types/VapiSmartEndpointingPlan.cs index e05beedf..d6a1cffd 100644 --- a/src/Vapi.Net/Types/VapiSmartEndpointingPlan.cs +++ b/src/Vapi.Net/Types/VapiSmartEndpointingPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Selects Vapi smart endpointing to determine when customer speech is complete. +/// [Serializable] public record VapiSmartEndpointingPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiVoice.cs b/src/Vapi.Net/Types/VapiVoice.cs index 5f73295c..74eab6ac 100644 --- a/src/Vapi.Net/Types/VapiVoice.cs +++ b/src/Vapi.Net/Types/VapiVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, caching, and fallback settings. +/// [Serializable] public record VapiVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VapiVoicemailDetectionPlan.cs b/src/Vapi.Net/Types/VapiVoicemailDetectionPlan.cs index ee401f83..e42d43dd 100644 --- a/src/Vapi.Net/Types/VapiVoicemailDetectionPlan.cs +++ b/src/Vapi.Net/Types/VapiVoicemailDetectionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff. +/// [Serializable] public record VapiVoicemailDetectionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VariableExtractionAlias.cs b/src/Vapi.Net/Types/VariableExtractionAlias.cs index 438be8d5..c5a6dfc7 100644 --- a/src/Vapi.Net/Types/VariableExtractionAlias.cs +++ b/src/Vapi.Net/Types/VariableExtractionAlias.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Defines an additional Liquid-based variable from values extracted during a call. +/// [Serializable] public record VariableExtractionAlias : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VariableExtractionPlan.cs b/src/Vapi.Net/Types/VariableExtractionPlan.cs index 74901b8c..e3999a76 100644 --- a/src/Vapi.Net/Types/VariableExtractionPlan.cs +++ b/src/Vapi.Net/Types/VariableExtractionPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Defines structured variables to extract and optional aliases made available during and after a call. +/// [Serializable] public record VariableExtractionPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VariableValueGroupBy.cs b/src/Vapi.Net/Types/VariableValueGroupBy.cs index 36de5f89..e3a4a853 100644 --- a/src/Vapi.Net/Types/VariableValueGroupBy.cs +++ b/src/Vapi.Net/Types/VariableValueGroupBy.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Groups analytics results by a selected assistant variable-value key. +/// [Serializable] public record VariableValueGroupBy : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VoiceCost.cs b/src/Vapi.Net/Types/VoiceCost.cs index 39318248..83a900d9 100644 --- a/src/Vapi.Net/Types/VoiceCost.cs +++ b/src/Vapi.Net/Types/VoiceCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Voice-synthesis cost for a call, including voice, character usage, and amount. +/// [Serializable] public record VoiceCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VoicemailDetectionBackoffPlan.cs b/src/Vapi.Net/Types/VoicemailDetectionBackoffPlan.cs index f90acdf8..57b0d8f9 100644 --- a/src/Vapi.Net/Types/VoicemailDetectionBackoffPlan.cs +++ b/src/Vapi.Net/Types/VoicemailDetectionBackoffPlan.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts. +/// [Serializable] public record VoicemailDetectionBackoffPlan : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VoicemailDetectionCost.cs b/src/Vapi.Net/Types/VoicemailDetectionCost.cs index 60c2cd4a..f2f13c21 100644 --- a/src/Vapi.Net/Types/VoicemailDetectionCost.cs +++ b/src/Vapi.Net/Types/VoicemailDetectionCost.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Voicemail-detection model cost, including provider, model, multimodal token usage, and amount. +/// [Serializable] public record VoicemailDetectionCost : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VoicemailTool.cs b/src/Vapi.Net/Types/VoicemailTool.cs index 34697271..7bb2cea3 100644 --- a/src/Vapi.Net/Types/VoicemailTool.cs +++ b/src/Vapi.Net/Types/VoicemailTool.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A reusable voicemail-detection tool with optional beep detection for supported calls. +/// [Serializable] public record VoicemailTool : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/VonagePhoneNumber.cs b/src/Vapi.Net/Types/VonagePhoneNumber.cs index ae065162..49ad9705 100644 --- a/src/Vapi.Net/Types/VonagePhoneNumber.cs +++ b/src/Vapi.Net/Types/VonagePhoneNumber.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. +/// [Serializable] public record VonagePhoneNumber : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WellSaidVoice.cs b/src/Vapi.Net/Types/WellSaidVoice.cs index a914f2c8..58854d55 100644 --- a/src/Vapi.Net/Types/WellSaidVoice.cs +++ b/src/Vapi.Net/Types/WellSaidVoice.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, caching, and fallback settings. +/// [Serializable] public record WellSaidVoice : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowAnthropicBedrockModel.cs b/src/Vapi.Net/Types/WorkflowAnthropicBedrockModel.cs index 009b11c6..5cc78b0a 100644 --- a/src/Vapi.Net/Types/WorkflowAnthropicBedrockModel.cs +++ b/src/Vapi.Net/Types/WorkflowAnthropicBedrockModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, temperature, and maximum output tokens. +/// [Serializable] public record WorkflowAnthropicBedrockModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowAnthropicModel.cs b/src/Vapi.Net/Types/WorkflowAnthropicModel.cs index 42841034..0ebedce6 100644 --- a/src/Vapi.Net/Types/WorkflowAnthropicModel.cs +++ b/src/Vapi.Net/Types/WorkflowAnthropicModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output tokens. +/// [Serializable] public record WorkflowAnthropicModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowCustomModel.cs b/src/Vapi.Net/Types/WorkflowCustomModel.cs index 89f58349..3a22923c 100644 --- a/src/Vapi.Net/Types/WorkflowCustomModel.cs +++ b/src/Vapi.Net/Types/WorkflowCustomModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, timeout, model, temperature, and maximum output tokens. +/// [Serializable] public record WorkflowCustomModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowGoogleModel.cs b/src/Vapi.Net/Types/WorkflowGoogleModel.cs index 8b047751..197a4322 100644 --- a/src/Vapi.Net/Types/WorkflowGoogleModel.cs +++ b/src/Vapi.Net/Types/WorkflowGoogleModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Workflow model configuration for Google, including model selection, temperature, and maximum output tokens. +/// [Serializable] public record WorkflowGoogleModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowOpenAiModel.cs b/src/Vapi.Net/Types/WorkflowOpenAiModel.cs index c9bc9476..ccdaf980 100644 --- a/src/Vapi.Net/Types/WorkflowOpenAiModel.cs +++ b/src/Vapi.Net/Types/WorkflowOpenAiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens. +/// [Serializable] public record WorkflowOpenAiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/WorkflowOverrides.cs b/src/Vapi.Net/Types/WorkflowOverrides.cs index 32fbb046..82cbc8fc 100644 --- a/src/Vapi.Net/Types/WorkflowOverrides.cs +++ b/src/Vapi.Net/Types/WorkflowOverrides.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Per-call overrides for values used in workflow template variables. +/// [Serializable] public record WorkflowOverrides : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/XaiModel.cs b/src/Vapi.Net/Types/XaiModel.cs index 9880ef4c..6ad7adba 100644 --- a/src/Vapi.Net/Types/XaiModel.cs +++ b/src/Vapi.Net/Types/XaiModel.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, and generation settings. +/// [Serializable] public record XaiModel : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Types/XssSecurityFilter.cs b/src/Vapi.Net/Types/XssSecurityFilter.cs index e56cc583..fee7cff0 100644 --- a/src/Vapi.Net/Types/XssSecurityFilter.cs +++ b/src/Vapi.Net/Types/XssSecurityFilter.cs @@ -4,6 +4,9 @@ namespace Vapi.Net; +/// +/// Filters potential cross-site scripting (XSS) patterns from transcripts. +/// [Serializable] public record XssSecurityFilter : IJsonOnDeserialized { diff --git a/src/Vapi.Net/Vapi.Net.csproj b/src/Vapi.Net/Vapi.Net.csproj index 61b5c86b..b6831bde 100644 --- a/src/Vapi.Net/Vapi.Net.csproj +++ b/src/Vapi.Net/Vapi.Net.csproj @@ -4,7 +4,7 @@ enable 12 enable - 2.0.0 + 0.0.0-fern-placeholder $(Version) $(Version) README.md diff --git a/src/Vapi.Net/VapiClient.cs b/src/Vapi.Net/VapiClient.cs index 11614919..2319874e 100644 --- a/src/Vapi.Net/VapiClient.cs +++ b/src/Vapi.Net/VapiClient.cs @@ -15,7 +15,7 @@ public VapiClient(string? token = null, ClientOptions? clientOptions = null) { "X-Fern-Language", "C#" }, { "X-Fern-SDK-Name", "Vapi.Net" }, { "X-Fern-SDK-Version", Version.Current }, - { "User-Agent", "Vapi.Net/2.0.0" }, + { "User-Agent", "Vapi.Net/0.0.0-fern-placeholder" }, } ); foreach (var header in platformHeaders) From 0c682a4e9252310b187499aba82686fdc797cb02 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:33:55 +0000 Subject: [PATCH 2/4] [fern-autoversion] chore: add XML doc comments across client interfaces and types MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add comprehensive XML documentation comments to all public client interfaces and implementation classes, as well as several core types. No public API signatures were changed; this is a documentation-only improvement that improves IntelliSense and generated API reference output for SDK consumers. Key changes: - Add `` doc comments to all methods on `IAnalyticsClient`, `IAssistantsClient`, `ICallsClient`, `ICampaignsClient`, `IEvalClient`, `IFilesClient`, `IInsightClient`, and `IObservabilityScorecardClient` (and their concrete implementations) - Add `` doc comments to `BackoffPlan`, `CallHookCustomerSpeechTimeout`, `CustomerSpeechTimeoutOptions`, and `MonitorPlan` types, and refine existing property-level doc text - Add doc comments to `UpdateAssistantDto` properties (`FirstMessageInterruptionsEnabled`, `CompliancePlan`, `KeypadInputPlan`) and `InsightRunDto.FormatPlan` - Update `.fernignore` to exclude `.fern/replay.lock`, `.fern/replay.yml`, and `.gitattributes` 🌿 Generated with Fern --- .fern/metadata.json | 2 +- src/Vapi.Net/Core/Public/Version.cs | 2 +- src/Vapi.Net/Vapi.Net.csproj | 2 +- src/Vapi.Net/VapiClient.cs | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.fern/metadata.json b/.fern/metadata.json index 8f07f130..9371c8cb 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -17,5 +17,5 @@ "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "0.0.0-fern-placeholder" + "sdkVersion": "2.0.1" } \ No newline at end of file diff --git a/src/Vapi.Net/Core/Public/Version.cs b/src/Vapi.Net/Core/Public/Version.cs index 38406f35..1685a0dd 100644 --- a/src/Vapi.Net/Core/Public/Version.cs +++ b/src/Vapi.Net/Core/Public/Version.cs @@ -3,5 +3,5 @@ namespace Vapi.Net; [Serializable] internal class Version { - public const string Current = "0.0.0-fern-placeholder"; + public const string Current = "2.0.1"; } diff --git a/src/Vapi.Net/Vapi.Net.csproj b/src/Vapi.Net/Vapi.Net.csproj index b6831bde..3d5ad0c9 100644 --- a/src/Vapi.Net/Vapi.Net.csproj +++ b/src/Vapi.Net/Vapi.Net.csproj @@ -4,7 +4,7 @@ enable 12 enable - 0.0.0-fern-placeholder + 2.0.1 $(Version) $(Version) README.md diff --git a/src/Vapi.Net/VapiClient.cs b/src/Vapi.Net/VapiClient.cs index 2319874e..43d480eb 100644 --- a/src/Vapi.Net/VapiClient.cs +++ b/src/Vapi.Net/VapiClient.cs @@ -15,7 +15,7 @@ public VapiClient(string? token = null, ClientOptions? clientOptions = null) { "X-Fern-Language", "C#" }, { "X-Fern-SDK-Name", "Vapi.Net" }, { "X-Fern-SDK-Version", Version.Current }, - { "User-Agent", "Vapi.Net/0.0.0-fern-placeholder" }, + { "User-Agent", "Vapi.Net/2.0.1" }, } ); foreach (var header in platformHeaders) From 4ef9efd97a61bacf467954386a1a81d4ab85c107 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:33:56 +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 7faf974b..a4e30866 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -6,5 +6,11 @@ generations: timestamp: 2026-07-22T16:33:32.410Z cli_version: unknown generator_versions: {} -current_generation: 6ee2f1cc74dd9f71a5250dc543072a20fe241e05 + - commit_sha: 69d9d6f4222cb47aadf174f0a4ee6be976eaf755 + tree_hash: 747ca4b15156f505a80be8cac41775bb430b89db + timestamp: 2026-07-22T16:33:33.030Z + cli_version: unknown + generator_versions: + fernapi/fern-csharp-sdk: 2.58.0 +current_generation: 69d9d6f4222cb47aadf174f0a4ee6be976eaf755 patches: [] From 0ee7d895e3aa6128d84aa29fb891db75ea7ad060 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:33:56 +0000 Subject: [PATCH 4/4] chore: add XML doc comments across client interfaces and types MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add comprehensive XML documentation comments to all public client interfaces and implementation classes, as well as several core types. No public API signatures were changed; this is a documentation-only improvement that improves IntelliSense and generated API reference output for SDK consumers. Key changes: - Add `` doc comments to all methods on `IAnalyticsClient`, `IAssistantsClient`, `ICallsClient`, `ICampaignsClient`, `IEvalClient`, `IFilesClient`, `IInsightClient`, and `IObservabilityScorecardClient` (and their concrete implementations) - Add `` doc comments to `BackoffPlan`, `CallHookCustomerSpeechTimeout`, `CustomerSpeechTimeoutOptions`, and `MonitorPlan` types, and refine existing property-level doc text - Add doc comments to `UpdateAssistantDto` properties (`FirstMessageInterruptionsEnabled`, `CompliancePlan`, `KeypadInputPlan`) and `InsightRunDto.FormatPlan` - Update `.fernignore` to exclude `.fern/replay.lock`, `.fern/replay.yml`, and `.gitattributes` 🌿 Generated with Fern --- changelog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/changelog.md b/changelog.md index c0fd9841..ee47093c 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 renamed to **`CartesiaSpeedControlZero`**; update all references and the type argument in `CartesiaExperimentalControls.Speed` (`OneOf?`).