Module: Vapi::Internal::Types::Enum

Includes:

Type

Included in:

Assistants::Types::UpdateAssistantDtoBackgroundSoundZero, Assistants::Types::UpdateAssistantDtoClientMessagesItem, Assistants::Types::UpdateAssistantDtoFirstMessageMode, Assistants::Types::UpdateAssistantDtoServerMessagesItem, Assistants::Types::UpdateAssistantDtoVoicemailDetectionZero, Campaigns::Types::CampaignControllerFindAllRequestSortOrder, Campaigns::Types::CampaignControllerFindAllRequestStatus, Campaigns::Types::UpdateCampaignDtoStatus, Chats::Types::ListChatsRequestSortOrder, Eval::Types::CreateEvalRunDtoType, Eval::Types::EvalControllerGetPaginatedRequestSortOrder, Eval::Types::EvalControllerGetRunsPaginatedRequestSortOrder, Eval::Types::UpdateEvalDtoType, Vapi::Insight::Types::InsightControllerFindAllRequestSortOrder, ObservabilityScorecard::Types::ScorecardControllerGetPaginatedRequestSortOrder, PhoneNumbers::Types::PhoneNumberControllerFindAllPaginatedRequestSortOrder, ProviderResources::Types::ProviderResourceControllerCreateProviderResourceRequestProvider, ProviderResources::Types::ProviderResourceControllerCreateProviderResourceRequestResourceName, ProviderResources::Types::ProviderResourceControllerDeleteProviderResourceRequestProvider, ProviderResources::Types::ProviderResourceControllerDeleteProviderResourceRequestResourceName, ProviderResources::Types::ProviderResourceControllerGetProviderResourceRequestProvider, ProviderResources::Types::ProviderResourceControllerGetProviderResourceRequestResourceName, ProviderResources::Types::ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider, ProviderResources::Types::ProviderResourceControllerGetProviderResourcesPaginatedRequestResourceName, ProviderResources::Types::ProviderResourceControllerGetProviderResourcesPaginatedRequestSortOrder, ProviderResources::Types::ProviderResourceControllerUpdateProviderResourceRequestProvider, ProviderResources::Types::ProviderResourceControllerUpdateProviderResourceRequestResourceName, Sessions::Types::CreateSessionDtoStatus, Sessions::Types::ListSessionsRequestSortOrder, Sessions::Types::UpdateSessionDtoStatus, StructuredOutputs::Types::StructuredOutputControllerFindAllRequestSortOrder, StructuredOutputs::Types::UpdateStructuredOutputDtoType, Types::AiEdgeConditionType, Types::AnalysisCostAnalysisType, Types::AnalyticsOperationColumn, Types::AnalyticsOperationOperation, Types::AnalyticsQueryGroupByItem, Types::AnalyticsQueryTable, Types::AnthropicBedrockCredentialProvider, Types::AnthropicBedrockCredentialRegion, Types::AnthropicBedrockModelModel, Types::AnthropicCredentialProvider, Types::AnthropicModelModel, Types::AnthropicThinkingConfigType, Types::AnyscaleCredentialProvider, Types::ApiRequestToolMethod, Types::ArtifactPlanRecordingFormat, Types::AssemblyAiCredentialProvider, Types::AssemblyAiTranscriberLanguage, Types::AssemblyAiTranscriberSpeechModel, Types::AssistantBackgroundSoundZero, Types::AssistantClientMessagesItem, Types::AssistantFirstMessageMode, Types::AssistantMessageJudgePlanAiType, Types::AssistantMessageRole, Types::AssistantOverridesBackgroundSoundZero, Types::AssistantOverridesClientMessagesItem, Types::AssistantOverridesFirstMessageMode, Types::AssistantOverridesServerMessagesItem, Types::AssistantOverridesVoicemailDetectionZero, Types::AssistantServerMessagesItem, Types::AssistantVoicemailDetectionZero, Types::AzureCredentialProvider, Types::AzureCredentialRegion, Types::AzureCredentialService, Types::AzureOpenAiCredentialModelsItem, Types::AzureOpenAiCredentialProvider, Types::AzureOpenAiCredentialRegion, Types::AzureSpeechTranscriberLanguage, Types::AzureSpeechTranscriberSegmentationStrategy, Types::AzureVoiceIdEnum, Types::BarInsightFromCallTableGroupBy, Types::BarInsightFromCallTableType, Types::BarInsightGroupBy, Types::BashToolName, Types::BashToolSubType, Types::BashToolWithToolCallName, Types::BashToolWithToolCallSubType, Types::ByoPhoneNumberStatus, Types::ByoSipTrunkCredentialProvider, Types::CallEndedReason, Types::CallHookAssistantSpeechInterruptedOn, Types::CallHookCallEndingOn, Types::CallHookCustomerSpeechInterruptedOn, Types::CallHookFilterType, Types::CallHookModelResponseTimeoutOn, Types::CallPhoneCallProvider, Types::CallPhoneCallTransport, Types::CallStatus, Types::CallType, Types::CampaignEndedReason, Types::CampaignStatus, Types::CartesiaCredentialProvider, Types::CartesiaExperimentalControlsEmotion, Types::CartesiaExperimentalControlsSpeedZero, Types::CartesiaTranscriberLanguage, Types::CartesiaTranscriberModel, Types::CartesiaVoiceLanguage, Types::CartesiaVoiceModel, Types::CerebrasCredentialProvider, Types::CerebrasModelModel, Types::ChatEvalAssistantMessageEvaluationRole, Types::ChatEvalAssistantMessageMockRole, Types::ChatEvalSystemMessageMockRole, Types::ChatEvalToolResponseMessageEvaluationRole, Types::ChatEvalToolResponseMessageMockRole, Types::ChatEvalUserMessageMockRole, Types::ClientInboundMessageControlControl, Types::ClientMessageAssistantSpeechSource, Types::ClientMessageAssistantSpeechType, Types::ClientMessageAssistantStartedType, Types::ClientMessageCallDeleteFailedType, Types::ClientMessageCallDeletedType, Types::ClientMessageChatCreatedType, Types::ClientMessageChatDeletedType, Types::ClientMessageConversationUpdateType, Types::ClientMessageHangType, Types::ClientMessageLanguageChangeDetectedType, Types::ClientMessageMetadataType, Types::ClientMessageModelOutputType, Types::ClientMessageSessionCreatedType, Types::ClientMessageSessionDeletedType, Types::ClientMessageSessionUpdatedType, Types::ClientMessageSpeechUpdateRole, Types::ClientMessageSpeechUpdateStatus, Types::ClientMessageSpeechUpdateType, Types::ClientMessageToolCallsResultType, Types::ClientMessageToolCallsType, Types::ClientMessageTranscriptRole, Types::ClientMessageTranscriptTranscriptType, Types::ClientMessageTranscriptType, Types::ClientMessageTransferUpdateType, Types::ClientMessageUserInterruptedType, Types::ClientMessageVoiceInputType, Types::ClientMessageWorkflowNodeStartedType, Types::CloudflareCredentialProvider, Types::ComputerToolName, Types::ComputerToolSubType, Types::ComputerToolWithToolCallName, Types::ComputerToolWithToolCallSubType, Types::ConditionOperator, Types::CreateAnthropicBedrockCredentialDtoRegion, Types::CreateApiRequestToolDtoMethod, Types::CreateAssistantDtoBackgroundSoundZero, Types::CreateAssistantDtoClientMessagesItem, Types::CreateAssistantDtoFirstMessageMode, Types::CreateAssistantDtoServerMessagesItem, Types::CreateAssistantDtoVoicemailDetectionZero, Types::CreateAzureCredentialDtoRegion, Types::CreateAzureCredentialDtoService, Types::CreateAzureOpenAiCredentialDtoModelsItem, Types::CreateAzureOpenAiCredentialDtoRegion, Types::CreateBarInsightFromCallTableDtoGroupBy, Types::CreateBashToolDtoName, Types::CreateBashToolDtoSubType, Types::CreateComputerToolDtoName, Types::CreateComputerToolDtoSubType, Types::CreateCustomKnowledgeBaseDtoProvider, Types::CreateEvalDtoType, Types::CreateGhlToolDtoType, Types::CreateLineInsightFromCallTableDtoGroupBy, Types::CreateMakeToolDtoType, Types::CreateOrgDtoChannel, Types::CreateOutputToolDtoType, Types::CreatePieInsightFromCallTableDtoGroupBy, Types::CreateSipRequestToolDtoVerb, Types::CreateStructuredOutputDtoType, Types::CreateTestSuiteTestChatDtoType, Types::CreateTestSuiteTestVoiceDtoType, Types::CreateTextEditorToolDtoName, Types::CreateTextEditorToolDtoSubType, Types::CreateTokenDtoTag, Types::CreateToolTemplateDtoProvider, Types::CreateToolTemplateDtoType, Types::CreateToolTemplateDtoVisibility, Types::CreateTrieveKnowledgeBaseDtoProvider, Types::CreateWorkflowDtoBackgroundSoundZero, Types::CreateWorkflowDtoVoicemailDetectionZero, Types::CredentialWebhookDtoAuthMode, Types::CredentialWebhookDtoOperation, Types::CredentialWebhookDtoType, Types::CustomCredentialProvider, Types::CustomEndpointingModelSmartEndpointingPlanProvider, Types::CustomKnowledgeBaseProvider, Types::CustomLlmCredentialProvider, Types::CustomLlmModelMetadataSendMode, Types::CustomMessageType, Types::DeepInfraCredentialProvider, Types::DeepSeekCredentialProvider, Types::DeepSeekModelModel, Types::DeepgramCredentialProvider, Types::DeepgramTranscriberLanguage, Types::DeepgramTranscriberModel, Types::DeepgramVoiceId, Types::DeepgramVoiceModel, Types::DeveloperMessageRole, Types::ElevenLabsPronunciationDictionaryPermissionOnResource, Types::ElevenLabsTranscriberLanguage, Types::ElevenLabsTranscriberModel, Types::ElevenLabsVoiceIdEnum, Types::ElevenLabsVoiceModel, Types::EmailCredentialProvider, Types::EvalAnthropicModelModel, Types::EvalGoogleModelModel, Types::EvalGroqModelModel, Types::EvalGroqModelProvider, Types::EvalModelListOptionsProvider, Types::EvalOpenAiModelModel, Types::EvalRunEndedReason, Types::EvalRunResultStatus, Types::EvalRunStatus, Types::EvalRunType, Types::EvalType, Types::EvalUserEditableType, Types::EvaluationPlanItemComparator, Types::EventsTableBooleanConditionOperator, Types::EventsTableNumberConditionOperator, Types::EventsTableStringConditionOperator, Types::ExportChatDtoColumns, Types::ExportChatDtoFormat, Types::ExportChatDtoSortOrder, Types::ExportSessionDtoColumns, Types::ExportSessionDtoFormat, Types::ExportSessionDtoSortOrder, Types::FallbackAssemblyAiTranscriberLanguage, Types::FallbackAssemblyAiTranscriberSpeechModel, Types::FallbackAzureSpeechTranscriberLanguage, Types::FallbackAzureSpeechTranscriberSegmentationStrategy, Types::FallbackAzureVoiceVoiceIdZero, Types::FallbackCartesiaTranscriberLanguage, Types::FallbackCartesiaTranscriberModel, Types::FallbackCartesiaVoiceLanguage, Types::FallbackCartesiaVoiceModel, Types::FallbackDeepgramTranscriberLanguage, Types::FallbackDeepgramTranscriberModel, Types::FallbackDeepgramVoiceId, Types::FallbackDeepgramVoiceModel, Types::FallbackElevenLabsTranscriberLanguage, Types::FallbackElevenLabsTranscriberModel, Types::FallbackElevenLabsVoiceIdEnum, Types::FallbackElevenLabsVoiceModel, Types::FallbackGladiaTranscriberLanguage, Types::FallbackGladiaTranscriberLanguageBehaviour, Types::FallbackGladiaTranscriberLanguages, Types::FallbackGladiaTranscriberModel, Types::FallbackGladiaTranscriberRegion, Types::FallbackGoogleTranscriberLanguage, Types::FallbackGoogleTranscriberModel, Types::FallbackHumeVoiceModel, Types::FallbackInworldVoiceLanguageCode, Types::FallbackInworldVoiceModel, Types::FallbackInworldVoiceVoiceId, Types::FallbackLmntVoiceIdEnum, Types::FallbackLmntVoiceLanguage, Types::FallbackMinimaxVoiceLanguageBoost, Types::FallbackMinimaxVoiceModel, Types::FallbackMinimaxVoiceProvider, Types::FallbackMinimaxVoiceRegion, Types::FallbackMinimaxVoiceSubtitleType, Types::FallbackNeuphonicVoiceModel, Types::FallbackOpenAiTranscriberLanguage, Types::FallbackOpenAiTranscriberModel, Types::FallbackOpenAiVoiceIdEnum, Types::FallbackOpenAiVoiceModel, Types::FallbackPlayHtVoiceEmotion, Types::FallbackPlayHtVoiceIdEnum, Types::FallbackPlayHtVoiceLanguage, Types::FallbackPlayHtVoiceModel, Types::FallbackRimeAiVoiceIdEnum, Types::FallbackRimeAiVoiceLanguage, Types::FallbackRimeAiVoiceModel, Types::FallbackSesameVoiceModel, Types::FallbackSmallestAiVoiceIdEnum, Types::FallbackSmallestAiVoiceModel, Types::FallbackSonioxTranscriberLanguage, Types::FallbackSonioxTranscriberModel, Types::FallbackSpeechmaticsTranscriberLanguage, Types::FallbackSpeechmaticsTranscriberModel, Types::FallbackSpeechmaticsTranscriberNumeralStyle, Types::FallbackSpeechmaticsTranscriberOperatingPoint, Types::FallbackSpeechmaticsTranscriberRegion, Types::FallbackTalkscriberTranscriberLanguage, Types::FallbackTalkscriberTranscriberModel, Types::FallbackTavusVoiceVoiceIdZero, Types::FallbackVapiVoiceVoiceId, Types::FallbackWellSaidVoiceModel, Types::FileObject, Types::FileStatus, Types::FilterDateTypeColumnOnCallTableColumn, Types::FilterDateTypeColumnOnCallTableOperator, Types::FilterNumberArrayTypeColumnOnCallTableColumn, Types::FilterNumberArrayTypeColumnOnCallTableOperator, Types::FilterNumberTypeColumnOnCallTableColumn, Types::FilterNumberTypeColumnOnCallTableOperator, Types::FilterStringArrayTypeColumnOnCallTableColumn, Types::FilterStringArrayTypeColumnOnCallTableOperator, Types::FilterStringTypeColumnOnCallTableColumn, Types::FilterStringTypeColumnOnCallTableOperator, Types::FilterStructuredOutputColumnOnCallTableColumn, Types::FilterStructuredOutputColumnOnCallTableOperator, Types::FormatPlanFormattersEnabledItem, Types::FunctionCallHookActionType, Types::GcpCredentialProvider, Types::GeminiMultimodalLivePrebuiltVoiceConfigVoiceName, Types::GeneratedScenarioCategory, Types::GetChatPaginatedDtoSortOrder, Types::GetEvalPaginatedDtoSortOrder, Types::GetEvalRunPaginatedDtoSortOrder, Types::GetSessionPaginatedDtoSortOrder, Types::GhlToolType, Types::GladiaCredentialProvider, Types::GladiaTranscriberLanguage, Types::GladiaTranscriberLanguageBehaviour, Types::GladiaTranscriberLanguages, Types::GladiaTranscriberModel, Types::GladiaTranscriberRegion, Types::GoHighLevelCalendarAvailabilityToolWithToolCallType, Types::GoHighLevelCalendarEventCreateToolWithToolCallType, Types::GoHighLevelContactCreateToolWithToolCallType, Types::GoHighLevelContactGetToolWithToolCallType, Types::GoHighLevelCredentialProvider, Types::GoHighLevelMcpCredentialProvider, Types::GoogleCalendarOAuth2AuthorizationCredentialProvider, Types::GoogleCalendarOAuth2ClientCredentialProvider, Types::GoogleCredentialProvider, Types::GoogleModelModel, Types::GoogleSheetsOAuth2AuthorizationCredentialProvider, Types::GoogleSheetsRowAppendToolWithToolCallType, Types::GoogleTranscriberLanguage, Types::GoogleTranscriberModel, Types::GoogleVoicemailDetectionPlanProvider, Types::GoogleVoicemailDetectionPlanType, Types::GroqCredentialProvider, Types::GroqModelModel, Types::GroupConditionOperator, Types::HandoffDestinationAssistantType, Types::HangupNodeType, Types::HmacAuthenticationPlanAlgorithm, Types::HmacAuthenticationPlanSignatureEncoding, Types::HumeCredentialProvider, Types::HumeVoiceModel, Types::InflectionAiCredentialProvider, Types::InflectionAiModelModel, Types::InsightRunFormatPlanFormat, Types::InsightTimeRangeWithStepStep, Types::InsightType, Types::InviteUserDtoRole, Types::InworldCredentialProvider, Types::InworldVoiceLanguageCode, Types::InworldVoiceModel, Types::InworldVoiceVoiceId, Types::JsonQueryOnCallTableWithNumberTypeColumnColumn, Types::JsonQueryOnCallTableWithNumberTypeColumnOperation, Types::JsonQueryOnCallTableWithNumberTypeColumnTable, Types::JsonQueryOnCallTableWithNumberTypeColumnType, Types::JsonQueryOnCallTableWithStringTypeColumnColumn, Types::JsonQueryOnCallTableWithStringTypeColumnOperation, Types::JsonQueryOnCallTableWithStringTypeColumnTable, Types::JsonQueryOnCallTableWithStringTypeColumnType, Types::JsonQueryOnCallTableWithStructuredOutputColumnColumn, Types::JsonQueryOnCallTableWithStructuredOutputColumnOperation, Types::JsonQueryOnCallTableWithStructuredOutputColumnTable, Types::JsonQueryOnCallTableWithStructuredOutputColumnType, Types::JsonQueryOnEventsTableOn, Types::JsonQueryOnEventsTableOperation, Types::JsonQueryOnEventsTableTable, Types::JsonQueryOnEventsTableType, Types::JsonSchemaFormat, Types::JsonSchemaType, Types::KeypadInputPlanDelimiters, Types::KnowledgeBaseModel, Types::KnowledgeBaseProvider, Types::LangfuseCredentialProvider, Types::LangfuseObservabilityPlanProvider, Types::LineInsightFromCallTableGroupBy, Types::LineInsightFromCallTableType, Types::LineInsightGroupBy, Types::LivekitSmartEndpointingPlanProvider, Types::LmntCredentialProvider, Types::LmntVoiceIdEnum, Types::LmntVoiceLanguage, Types::MakeCredentialProvider, Types::MakeToolType, Types::McpToolMetadataProtocol, Types::MessageTargetRole, Types::MinimaxLlmModelModel, Types::MinimaxVoiceLanguageBoost, Types::MinimaxVoiceModel, Types::MinimaxVoiceRegion, Types::MinimaxVoiceSubtitleType, Types::MistralCredentialProvider, Types::NeuphonicCredentialProvider, Types::NeuphonicVoiceModel, Types::OAuth2AuthenticationPlanType, Types::OpenAiCredentialProvider, Types::OpenAiFunctionParametersType, Types::OpenAiMessageRole, Types::OpenAiModelFallbackModelsItem, Types::OpenAiModelModel, Types::OpenAiModelPromptCacheRetention, Types::OpenAiModelToolStrictCompatibilityMode, Types::OpenAiTranscriberLanguage, Types::OpenAiTranscriberModel, Types::OpenAiVoiceIdEnum, Types::OpenAiVoiceModel, Types::OpenAiVoicemailDetectionPlanProvider, Types::OpenAiVoicemailDetectionPlanType, Types::OpenRouterCredentialProvider, Types::OrgChannel, Types::OutputToolType, Types::PerplexityAiCredentialProvider, Types::PhoneNumberCallEndingHookFilterKey, Types::PhoneNumberCallEndingHookFilterOneOfItem, Types::PhoneNumberCallEndingHookFilterType, Types::PhoneNumberCallRingingHookFilterKey, Types::PhoneNumberCallRingingHookFilterType, Types::PieInsightFromCallTableGroupBy, Types::PieInsightFromCallTableType, Types::PieInsightGroupBy, Types::PlayHtCredentialProvider, Types::PlayHtVoiceEmotion, Types::PlayHtVoiceIdEnum, Types::PlayHtVoiceLanguage, Types::PlayHtVoiceModel, Types::PromptInjectionSecurityFilterType, Types::ProviderResourceProvider, Types::ProviderResourceResourceName, Types::PublicKeyEncryptionPlanAlgorithm, Types::PunctuationBoundary, Types::RceSecurityFilterType, Types::RegexOptionType, Types::RegexSecurityFilterType, Types::RelayCommandOptionsType, Types::RelayResponseStatus, Types::RelayTargetOptionsType, Types::ResponseCompletedEventType, Types::ResponseErrorEventType, Types::ResponseObjectObject, Types::ResponseObjectStatus, Types::ResponseOutputMessageRole, Types::ResponseOutputMessageStatus, Types::ResponseOutputMessageType, Types::ResponseOutputTextType, Types::ResponseTextDeltaEventType, Types::ResponseTextDoneEventType, Types::RimeAiCredentialProvider, Types::RimeAiVoiceIdEnum, Types::RimeAiVoiceLanguage, Types::RimeAiVoiceModel, Types::RunpodCredentialProvider, Types::S3CredentialProvider, Types::SecurityFilterPlanMode, Types::ServerMessageAssistantRequestType, Types::ServerMessageAssistantSpeechSource, Types::ServerMessageAssistantSpeechType, Types::ServerMessageCallDeleteFailedType, Types::ServerMessageCallDeletedType, Types::ServerMessageCallEndpointingRequestType, Types::ServerMessageChatCreatedType, Types::ServerMessageChatDeletedType, Types::ServerMessageConversationUpdateType, Types::ServerMessageEndOfCallReportEndedReason, Types::ServerMessageEndOfCallReportType, Types::ServerMessageHandoffDestinationRequestType, Types::ServerMessageHangType, Types::ServerMessageKnowledgeBaseRequestType, Types::ServerMessageLanguageChangeDetectedType, Types::ServerMessageModelOutputType, Types::ServerMessagePhoneCallControlRequest, Types::ServerMessagePhoneCallControlType, Types::ServerMessageSessionCreatedType, Types::ServerMessageSessionDeletedType, Types::ServerMessageSessionUpdatedType, Types::ServerMessageSpeechUpdateRole, Types::ServerMessageSpeechUpdateStatus, Types::ServerMessageSpeechUpdateType, Types::ServerMessageStatusUpdateEndedReason, Types::ServerMessageStatusUpdateStatus, Types::ServerMessageStatusUpdateType, Types::ServerMessageToolCallsType, Types::ServerMessageTranscriptRole, Types::ServerMessageTranscriptTranscriptType, Types::ServerMessageTranscriptType, Types::ServerMessageTransferDestinationRequestType, Types::ServerMessageTransferUpdateType, Types::ServerMessageUserInterruptedType, Types::ServerMessageVoiceInputType, Types::ServerMessageVoiceRequestType, Types::SesameVoiceModel, Types::SessionCreatedHookOn, Types::SessionStatus, Types::SimulationHookWebhookActionType, Types::SimulationRunItemStatus, Types::SimulationRunStatus, Types::SimulationRunTransportConfigurationProvider, Types::SipRequestToolVerb, Types::SipTrunkGatewayOutboundProtocol, Types::SlackOAuth2AuthorizationCredentialProvider, Types::SlackWebhookCredentialProvider, Types::SmallestAiCredentialProvider, Types::SmallestAiVoiceIdEnum, Types::SmallestAiVoiceModel, Types::SonioxCredentialProvider, Types::SonioxTranscriberLanguage, Types::SonioxTranscriberModel, Types::SpeechmaticsCredentialProvider, Types::SpeechmaticsTranscriberLanguage, Types::SpeechmaticsTranscriberModel, Types::SpeechmaticsTranscriberNumeralStyle, Types::SpeechmaticsTranscriberOperatingPoint, Types::SpeechmaticsTranscriberRegion, Types::SqlInjectionSecurityFilterType, Types::SsrfSecurityFilterType, Types::StartSpeakingPlanSmartEndpointingEnabledOne, Types::StructuredOutputEvaluationResultComparator, Types::StructuredOutputType, Types::SubscriptionMinutesIncludedResetFrequency, Types::SubscriptionStatus, Types::SubscriptionType, Types::SuccessEvaluationPlanRubric, Types::SupabaseBucketPlanRegion, Types::SupabaseCredentialProvider, Types::SyncVoiceLibraryDtoProvidersItem, Types::TalkscriberTranscriberLanguage, Types::TalkscriberTranscriberModel, Types::TavusCredentialProvider, Types::TavusVoiceVoiceIdZero, Types::TelnyxPhoneNumberStatus, Types::TemplateProvider, Types::TemplateType, Types::TemplateVisibility, Types::TestSuitePhoneNumberProvider, Types::TestSuiteRunScorerAiResult, Types::TestSuiteRunScorerAiType, Types::TestSuiteRunStatus, Types::TestSuiteTestScorerAiType, Types::TestSuiteTestVoiceType, Types::TextContentLanguage, Types::TextContentType, Types::TextEditorToolName, Types::TextEditorToolSubType, Types::TextEditorToolWithToolCallName, Types::TextEditorToolWithToolCallSubType, Types::TextInsightFromCallTableType, Types::TimeRangeStep, Types::TogetherAiCredentialProvider, Types::TokenTag, Types::ToolCallHookActionType, Types::ToolMessageCompleteRole, Types::ToolMessageRole, Types::TransferAssistantBackgroundSoundZero, Types::TransferAssistantFirstMessageMode, Types::TransferAssistantModelProvider, Types::TransferCancelToolUserEditableType, Types::TransferDestinationAssistantType, Types::TransferHookActionType, Types::TransferMode, Types::TransferPlanMode, Types::TransferSuccessfulToolUserEditableType, Types::TransportConfigurationTwilioProvider, Types::TransportConfigurationTwilioRecordingChannels, Types::TransportCostProvider, Types::TrieveCredentialProvider, Types::TrieveKnowledgeBaseCreateType, Types::TrieveKnowledgeBaseImportType, Types::TrieveKnowledgeBaseProvider, Types::TrieveKnowledgeBaseSearchPlanSearchType, Types::TwilioCredentialProvider, Types::TwilioPhoneNumberStatus, Types::TwilioSmsChatTransportConversationType, Types::TwilioSmsChatTransportType, Types::TwilioVoicemailDetectionPlanProvider, Types::TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem, Types::UpdateAnthropicBedrockCredentialDtoRegion, Types::UpdateApiRequestToolDtoMethod, Types::UpdateAzureCredentialDtoRegion, Types::UpdateAzureCredentialDtoService, Types::UpdateAzureOpenAiCredentialDtoModelsItem, Types::UpdateAzureOpenAiCredentialDtoRegion, Types::UpdateBarInsightFromCallTableDtoGroupBy, Types::UpdateBashToolDtoName, Types::UpdateBashToolDtoSubType, Types::UpdateComputerToolDtoName, Types::UpdateComputerToolDtoSubType, Types::UpdateLineInsightFromCallTableDtoGroupBy, Types::UpdateOrgDtoChannel, Types::UpdatePieInsightFromCallTableDtoGroupBy, Types::UpdateSipRequestToolDtoVerb, Types::UpdateTestSuiteTestChatDtoType, Types::UpdateTestSuiteTestVoiceDtoType, Types::UpdateTextEditorToolDtoName, Types::UpdateTextEditorToolDtoSubType, Types::UpdateTokenDtoTag, Types::UpdateToolTemplateDtoProvider, Types::UpdateToolTemplateDtoType, Types::UpdateToolTemplateDtoVisibility, Types::UpdateUserRoleDtoRole, Types::UpdateWorkflowDtoBackgroundSoundZero, Types::UpdateWorkflowDtoVoicemailDetectionZero, Types::VapiCostSubType, Types::VapiModelProvider, Types::VapiPhoneNumberStatus, Types::VapiSipTransportMessageSipVerb, Types::VapiSmartEndpointingPlanProvider, Types::VapiVoiceVoiceId, Types::VapiVoicemailDetectionPlanProvider, Types::VapiVoicemailDetectionPlanType, Types::VoiceLibraryGender, Types::VoicemailDetectionCostProvider, Types::VonageCredentialProvider, Types::VonagePhoneNumberStatus, Types::WebhookCredentialProvider, Types::WellSaidCredentialProvider, Types::WellSaidVoiceModel, Types::WorkflowAnthropicBedrockModelModel, Types::WorkflowAnthropicModelModel, Types::WorkflowBackgroundSoundZero, Types::WorkflowCustomModelMetadataSendMode, Types::WorkflowGoogleModelModel, Types::WorkflowOpenAiModelModel, Types::WorkflowUserEditableBackgroundSoundZero, Types::WorkflowUserEditableVoicemailDetectionZero, Types::WorkflowVoicemailDetectionZero, Types::XAiCredentialProvider, Types::XaiModelModel, Types::XssSecurityFilterType

Defined in:

lib/vapi/internal/types/enum.rb

Overview

Module for defining enums

Instance Method Summary

• #coerce(value, strict: strict?) ) ⇒ Object
• #finalize! ⇒ Object private
• #inspect ⇒ Object
• #load(str) ⇒ String

  Parse JSON string and coerce to the enum value.

• #strict! ⇒ Object private
• #strict? ⇒ Boolean private
• #values ⇒ Array<Object> private

Methods included from JSON::Serializable

#dump

Instance Method Details

#coerce(value, strict: strict?) ) ⇒ Object

Raises:

• (Errors::TypeError)

# File 'lib/vapi/internal/types/enum.rb', line 32

def coerce(value, strict: strict?)
  coerced_value = Utils.coerce(Symbol, value)

  return coerced_value if values.include?(coerced_value)

  raise Errors::TypeError, "`#{value}` not in enum #{self}" if strict

  value
end

#finalize! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/vapi/internal/types/enum.rb', line 18

def finalize!
  values
end

#inspect ⇒ Object

# File 'lib/vapi/internal/types/enum.rb', line 50

def inspect
  "#{name}[#{values.join(", ")}]"
end

#load(str) ⇒ String

Parse JSON string and coerce to the enum value

Parameters:

• str (String) —

  JSON string to parse

Returns:

• (String) —

  The enum value

# File 'lib/vapi/internal/types/enum.rb', line 46

def load(str)
  coerce(::JSON.parse(str))
end

#strict! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/vapi/internal/types/enum.rb', line 28

def strict!
  @strict = true
end

#strict? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/vapi/internal/types/enum.rb', line 23

def strict?
  @strict ||= false
end

#values ⇒ Array<Object>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Array<Object>)

# File 'lib/vapi/internal/types/enum.rb', line 13

def values
  @values ||= constants.map { |c| const_get(c) }
end