vapi-server-sdk 0.0.0a7__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- vapi/__init__.py +1081 -0
- vapi/analytics/__init__.py +2 -0
- vapi/analytics/client.py +159 -0
- vapi/assistants/__init__.py +21 -0
- vapi/assistants/client.py +1593 -0
- vapi/assistants/types/__init__.py +19 -0
- vapi/assistants/types/update_assistant_dto_background_sound.py +5 -0
- vapi/assistants/types/update_assistant_dto_client_messages_item.py +23 -0
- vapi/assistants/types/update_assistant_dto_first_message_mode.py +10 -0
- vapi/assistants/types/update_assistant_dto_model.py +26 -0
- vapi/assistants/types/update_assistant_dto_server_messages_item.py +24 -0
- vapi/assistants/types/update_assistant_dto_transcriber.py +8 -0
- vapi/assistants/types/update_assistant_dto_voice.py +24 -0
- vapi/blocks/__init__.py +25 -0
- vapi/blocks/client.py +804 -0
- vapi/blocks/types/__init__.py +23 -0
- vapi/blocks/types/blocks_create_request.py +8 -0
- vapi/blocks/types/blocks_create_response.py +8 -0
- vapi/blocks/types/blocks_delete_response.py +8 -0
- vapi/blocks/types/blocks_get_response.py +8 -0
- vapi/blocks/types/blocks_list_response_item.py +8 -0
- vapi/blocks/types/blocks_update_response.py +8 -0
- vapi/blocks/types/update_block_dto_messages_item.py +7 -0
- vapi/blocks/types/update_block_dto_steps_item.py +7 -0
- vapi/blocks/types/update_block_dto_tool.py +20 -0
- vapi/calls/__init__.py +2 -0
- vapi/calls/client.py +776 -0
- vapi/client.py +172 -0
- vapi/core/__init__.py +50 -0
- vapi/core/api_error.py +15 -0
- vapi/core/client_wrapper.py +76 -0
- vapi/core/datetime_utils.py +28 -0
- vapi/core/file.py +62 -0
- vapi/core/http_client.py +487 -0
- vapi/core/jsonable_encoder.py +101 -0
- vapi/core/pagination.py +88 -0
- vapi/core/pydantic_utilities.py +296 -0
- vapi/core/query_encoder.py +58 -0
- vapi/core/remove_none_from_dict.py +11 -0
- vapi/core/request_options.py +32 -0
- vapi/core/serialization.py +272 -0
- vapi/environment.py +7 -0
- vapi/errors/__init__.py +5 -0
- vapi/errors/bad_request_error.py +9 -0
- vapi/files/__init__.py +2 -0
- vapi/files/client.py +544 -0
- vapi/logs/__init__.py +5 -0
- vapi/logs/client.py +367 -0
- vapi/logs/types/__init__.py +6 -0
- vapi/logs/types/logs_get_request_sort_order.py +5 -0
- vapi/logs/types/logs_get_request_type.py +5 -0
- vapi/phone_numbers/__init__.py +21 -0
- vapi/phone_numbers/client.py +735 -0
- vapi/phone_numbers/types/__init__.py +19 -0
- vapi/phone_numbers/types/phone_numbers_create_request.py +11 -0
- vapi/phone_numbers/types/phone_numbers_create_response.py +9 -0
- vapi/phone_numbers/types/phone_numbers_delete_response.py +9 -0
- vapi/phone_numbers/types/phone_numbers_get_response.py +9 -0
- vapi/phone_numbers/types/phone_numbers_list_response_item.py +9 -0
- vapi/phone_numbers/types/phone_numbers_update_response.py +9 -0
- vapi/phone_numbers/types/update_phone_number_dto_fallback_destination.py +7 -0
- vapi/py.typed +0 -0
- vapi/squads/__init__.py +2 -0
- vapi/squads/client.py +723 -0
- vapi/tools/__init__.py +21 -0
- vapi/tools/client.py +717 -0
- vapi/tools/types/__init__.py +19 -0
- vapi/tools/types/tools_create_request.py +20 -0
- vapi/tools/types/tools_create_response.py +12 -0
- vapi/tools/types/tools_delete_response.py +12 -0
- vapi/tools/types/tools_get_response.py +12 -0
- vapi/tools/types/tools_list_response_item.py +14 -0
- vapi/tools/types/tools_update_response.py +12 -0
- vapi/tools/types/update_tool_dto_messages_item.py +9 -0
- vapi/types/__init__.py +993 -0
- vapi/types/add_voice_to_provider_dto.py +34 -0
- vapi/types/analysis.py +38 -0
- vapi/types/analysis_cost.py +52 -0
- vapi/types/analysis_cost_analysis_type.py +5 -0
- vapi/types/analysis_cost_breakdown.py +80 -0
- vapi/types/analysis_plan.py +43 -0
- vapi/types/analytics_operation.py +34 -0
- vapi/types/analytics_operation_column.py +19 -0
- vapi/types/analytics_operation_operation.py +5 -0
- vapi/types/analytics_query.py +51 -0
- vapi/types/analytics_query_group_by_item.py +7 -0
- vapi/types/analytics_query_result.py +42 -0
- vapi/types/anthropic_credential.py +46 -0
- vapi/types/anthropic_model.py +91 -0
- vapi/types/anthropic_model_model.py +10 -0
- vapi/types/anthropic_model_tools_item.py +20 -0
- vapi/types/anyscale_credential.py +46 -0
- vapi/types/anyscale_model.py +90 -0
- vapi/types/anyscale_model_tools_item.py +20 -0
- vapi/types/artifact.py +66 -0
- vapi/types/artifact_messages_item.py +10 -0
- vapi/types/artifact_plan.py +70 -0
- vapi/types/assignment_mutation.py +85 -0
- vapi/types/assignment_mutation_conditions_item.py +7 -0
- vapi/types/assistant.py +330 -0
- vapi/types/assistant_background_sound.py +5 -0
- vapi/types/assistant_client_messages_item.py +23 -0
- vapi/types/assistant_first_message_mode.py +10 -0
- vapi/types/assistant_model.py +26 -0
- vapi/types/assistant_overrides.py +316 -0
- vapi/types/assistant_overrides_background_sound.py +5 -0
- vapi/types/assistant_overrides_client_messages_item.py +23 -0
- vapi/types/assistant_overrides_first_message_mode.py +10 -0
- vapi/types/assistant_overrides_model.py +26 -0
- vapi/types/assistant_overrides_server_messages_item.py +24 -0
- vapi/types/assistant_overrides_transcriber.py +8 -0
- vapi/types/assistant_overrides_voice.py +24 -0
- vapi/types/assistant_server_messages_item.py +24 -0
- vapi/types/assistant_transcriber.py +8 -0
- vapi/types/assistant_voice.py +24 -0
- vapi/types/azure_open_ai_credential.py +52 -0
- vapi/types/azure_open_ai_credential_models_item.py +17 -0
- vapi/types/azure_open_ai_credential_region.py +24 -0
- vapi/types/azure_voice.py +52 -0
- vapi/types/azure_voice_id.py +6 -0
- vapi/types/azure_voice_id_enum.py +5 -0
- vapi/types/block_complete_message.py +33 -0
- vapi/types/block_complete_message_conditions_item.py +7 -0
- vapi/types/block_start_message.py +33 -0
- vapi/types/block_start_message_conditions_item.py +7 -0
- vapi/types/bot_message.py +54 -0
- vapi/types/bucket_plan.py +72 -0
- vapi/types/buy_phone_number_dto.py +81 -0
- vapi/types/buy_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/byo_phone_number.py +126 -0
- vapi/types/byo_phone_number_fallback_destination.py +7 -0
- vapi/types/byo_sip_trunk_credential.py +85 -0
- vapi/types/call.py +241 -0
- vapi/types/call_costs_item.py +11 -0
- vapi/types/call_destination.py +7 -0
- vapi/types/call_ended_reason.py +177 -0
- vapi/types/call_messages_item.py +10 -0
- vapi/types/call_paginated_response.py +32 -0
- vapi/types/call_phone_call_provider.py +5 -0
- vapi/types/call_phone_call_transport.py +5 -0
- vapi/types/call_status.py +5 -0
- vapi/types/call_type.py +5 -0
- vapi/types/callback_step.py +116 -0
- vapi/types/callback_step_block.py +11 -0
- vapi/types/cartesia_credential.py +46 -0
- vapi/types/cartesia_voice.py +58 -0
- vapi/types/cartesia_voice_language.py +5 -0
- vapi/types/cartesia_voice_model.py +5 -0
- vapi/types/chunk_plan.py +70 -0
- vapi/types/client_inbound_message.py +23 -0
- vapi/types/client_inbound_message_add_message.py +28 -0
- vapi/types/client_inbound_message_control.py +32 -0
- vapi/types/client_inbound_message_control_control.py +7 -0
- vapi/types/client_inbound_message_message.py +10 -0
- vapi/types/client_inbound_message_say.py +36 -0
- vapi/types/client_message.py +23 -0
- vapi/types/client_message_conversation_update.py +38 -0
- vapi/types/client_message_conversation_update_messages_item.py +12 -0
- vapi/types/client_message_hang.py +27 -0
- vapi/types/client_message_language_changed.py +27 -0
- vapi/types/client_message_message.py +28 -0
- vapi/types/client_message_metadata.py +27 -0
- vapi/types/client_message_model_output.py +27 -0
- vapi/types/client_message_speech_update.py +34 -0
- vapi/types/client_message_speech_update_role.py +5 -0
- vapi/types/client_message_speech_update_status.py +5 -0
- vapi/types/client_message_tool_calls.py +40 -0
- vapi/types/client_message_tool_calls_result.py +31 -0
- vapi/types/client_message_tool_calls_tool_with_tool_call_list_item.py +10 -0
- vapi/types/client_message_transcript.py +43 -0
- vapi/types/client_message_transcript_role.py +5 -0
- vapi/types/client_message_transcript_transcript_type.py +5 -0
- vapi/types/client_message_user_interrupted.py +22 -0
- vapi/types/client_message_voice_input.py +27 -0
- vapi/types/clone_voice_dto.py +37 -0
- vapi/types/condition.py +33 -0
- vapi/types/condition_operator.py +5 -0
- vapi/types/conversation_block.py +109 -0
- vapi/types/conversation_block_messages_item.py +7 -0
- vapi/types/cost_breakdown.py +78 -0
- vapi/types/create_anthropic_credential_dto.py +25 -0
- vapi/types/create_anyscale_credential_dto.py +25 -0
- vapi/types/create_assistant_dto.py +309 -0
- vapi/types/create_assistant_dto_background_sound.py +5 -0
- vapi/types/create_assistant_dto_client_messages_item.py +23 -0
- vapi/types/create_assistant_dto_first_message_mode.py +10 -0
- vapi/types/create_assistant_dto_model.py +26 -0
- vapi/types/create_assistant_dto_server_messages_item.py +24 -0
- vapi/types/create_assistant_dto_transcriber.py +8 -0
- vapi/types/create_assistant_dto_voice.py +24 -0
- vapi/types/create_azure_open_ai_credential_dto.py +31 -0
- vapi/types/create_azure_open_ai_credential_dto_models_item.py +17 -0
- vapi/types/create_azure_open_ai_credential_dto_region.py +24 -0
- vapi/types/create_byo_phone_number_dto.py +105 -0
- vapi/types/create_byo_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/create_byo_sip_trunk_credential_dto.py +64 -0
- vapi/types/create_cartesia_credential_dto.py +25 -0
- vapi/types/create_conversation_block_dto.py +88 -0
- vapi/types/create_conversation_block_dto_messages_item.py +7 -0
- vapi/types/create_custom_llm_credential_dto.py +25 -0
- vapi/types/create_customer_dto.py +59 -0
- vapi/types/create_deep_infra_credential_dto.py +25 -0
- vapi/types/create_deepgram_credential_dto.py +32 -0
- vapi/types/create_dtmf_tool_dto.py +61 -0
- vapi/types/create_dtmf_tool_dto_messages_item.py +11 -0
- vapi/types/create_eleven_labs_credential_dto.py +25 -0
- vapi/types/create_end_call_tool_dto.py +61 -0
- vapi/types/create_end_call_tool_dto_messages_item.py +11 -0
- vapi/types/create_function_tool_dto.py +61 -0
- vapi/types/create_function_tool_dto_messages_item.py +11 -0
- vapi/types/create_gcp_credential_dto.py +41 -0
- vapi/types/create_ghl_tool_dto.py +63 -0
- vapi/types/create_ghl_tool_dto_messages_item.py +11 -0
- vapi/types/create_gladia_credential_dto.py +25 -0
- vapi/types/create_go_high_level_credential_dto.py +25 -0
- vapi/types/create_groq_credential_dto.py +25 -0
- vapi/types/create_lmnt_credential_dto.py +25 -0
- vapi/types/create_make_credential_dto.py +35 -0
- vapi/types/create_make_tool_dto.py +63 -0
- vapi/types/create_make_tool_dto_messages_item.py +11 -0
- vapi/types/create_open_ai_credential_dto.py +25 -0
- vapi/types/create_open_router_credential_dto.py +25 -0
- vapi/types/create_org_dto.py +63 -0
- vapi/types/create_outbound_call_dto.py +104 -0
- vapi/types/create_output_tool_dto.py +61 -0
- vapi/types/create_output_tool_dto_messages_item.py +11 -0
- vapi/types/create_perplexity_ai_credential_dto.py +25 -0
- vapi/types/create_play_ht_credential_dto.py +27 -0
- vapi/types/create_rime_ai_credential_dto.py +25 -0
- vapi/types/create_runpod_credential_dto.py +25 -0
- vapi/types/create_s_3_credential_dto.py +51 -0
- vapi/types/create_squad_dto.py +52 -0
- vapi/types/create_together_ai_credential_dto.py +25 -0
- vapi/types/create_token_dto.py +34 -0
- vapi/types/create_token_dto_tag.py +5 -0
- vapi/types/create_tool_call_block_dto.py +75 -0
- vapi/types/create_tool_call_block_dto_messages_item.py +7 -0
- vapi/types/create_tool_call_block_dto_tool.py +20 -0
- vapi/types/create_tool_template_dto.py +38 -0
- vapi/types/create_tool_template_dto_details.py +20 -0
- vapi/types/create_tool_template_dto_provider.py +5 -0
- vapi/types/create_tool_template_dto_provider_details.py +10 -0
- vapi/types/create_tool_template_dto_visibility.py +5 -0
- vapi/types/create_transfer_call_tool_dto.py +67 -0
- vapi/types/create_transfer_call_tool_dto_destinations_item.py +11 -0
- vapi/types/create_transfer_call_tool_dto_messages_item.py +11 -0
- vapi/types/create_twilio_credential_dto.py +27 -0
- vapi/types/create_twilio_phone_number_dto.py +92 -0
- vapi/types/create_twilio_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/create_vapi_phone_number_dto.py +84 -0
- vapi/types/create_vapi_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/create_voicemail_tool_dto.py +65 -0
- vapi/types/create_voicemail_tool_dto_messages_item.py +11 -0
- vapi/types/create_vonage_credential_dto.py +27 -0
- vapi/types/create_vonage_phone_number_dto.py +87 -0
- vapi/types/create_vonage_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/create_web_call_dto.py +63 -0
- vapi/types/create_workflow_block_dto.py +78 -0
- vapi/types/create_workflow_block_dto_messages_item.py +7 -0
- vapi/types/create_workflow_block_dto_steps_item.py +10 -0
- vapi/types/custom_llm_credential.py +46 -0
- vapi/types/custom_llm_model.py +115 -0
- vapi/types/custom_llm_model_metadata_send_mode.py +5 -0
- vapi/types/custom_llm_model_tools_item.py +20 -0
- vapi/types/deep_infra_credential.py +46 -0
- vapi/types/deep_infra_model.py +90 -0
- vapi/types/deep_infra_model_tools_item.py +20 -0
- vapi/types/deepgram_credential.py +53 -0
- vapi/types/deepgram_transcriber.py +68 -0
- vapi/types/deepgram_transcriber_language.py +65 -0
- vapi/types/deepgram_transcriber_model.py +37 -0
- vapi/types/deepgram_voice.py +47 -0
- vapi/types/deepgram_voice_id.py +6 -0
- vapi/types/deepgram_voice_id_enum.py +10 -0
- vapi/types/dtmf_tool.py +82 -0
- vapi/types/dtmf_tool_messages_item.py +9 -0
- vapi/types/eleven_labs_credential.py +46 -0
- vapi/types/eleven_labs_voice.py +98 -0
- vapi/types/eleven_labs_voice_id.py +6 -0
- vapi/types/eleven_labs_voice_id_enum.py +24 -0
- vapi/types/eleven_labs_voice_model.py +8 -0
- vapi/types/end_call_tool.py +82 -0
- vapi/types/end_call_tool_messages_item.py +9 -0
- vapi/types/error.py +19 -0
- vapi/types/exact_replacement.py +40 -0
- vapi/types/file.py +57 -0
- vapi/types/file_status.py +5 -0
- vapi/types/format_plan.py +64 -0
- vapi/types/format_plan_replacements_item.py +7 -0
- vapi/types/function_tool.py +82 -0
- vapi/types/function_tool_messages_item.py +9 -0
- vapi/types/function_tool_provider_details.py +35 -0
- vapi/types/function_tool_with_tool_call.py +67 -0
- vapi/types/function_tool_with_tool_call_messages_item.py +11 -0
- vapi/types/gcp_credential.py +62 -0
- vapi/types/gcp_key.py +78 -0
- vapi/types/ghl_tool.py +85 -0
- vapi/types/ghl_tool_messages_item.py +9 -0
- vapi/types/ghl_tool_metadata.py +22 -0
- vapi/types/ghl_tool_provider_details.py +41 -0
- vapi/types/ghl_tool_with_tool_call.py +69 -0
- vapi/types/ghl_tool_with_tool_call_messages_item.py +11 -0
- vapi/types/gladia_credential.py +46 -0
- vapi/types/gladia_transcriber.py +56 -0
- vapi/types/gladia_transcriber_language.py +109 -0
- vapi/types/gladia_transcriber_language_behaviour.py +7 -0
- vapi/types/gladia_transcriber_model.py +5 -0
- vapi/types/go_high_level_credential.py +46 -0
- vapi/types/groq_credential.py +46 -0
- vapi/types/groq_model.py +91 -0
- vapi/types/groq_model_model.py +19 -0
- vapi/types/groq_model_tools_item.py +20 -0
- vapi/types/handoff_step.py +116 -0
- vapi/types/handoff_step_block.py +11 -0
- vapi/types/import_twilio_phone_number_dto.py +91 -0
- vapi/types/import_twilio_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/import_vonage_phone_number_dto.py +88 -0
- vapi/types/import_vonage_phone_number_dto_fallback_destination.py +7 -0
- vapi/types/invite_user_dto.py +21 -0
- vapi/types/invite_user_dto_role.py +5 -0
- vapi/types/json_schema.py +57 -0
- vapi/types/json_schema_type.py +5 -0
- vapi/types/knowledge_base.py +23 -0
- vapi/types/lmnt_credential.py +46 -0
- vapi/types/lmnt_voice.py +52 -0
- vapi/types/lmnt_voice_id.py +6 -0
- vapi/types/lmnt_voice_id_enum.py +5 -0
- vapi/types/log.py +164 -0
- vapi/types/log_request_http_method.py +5 -0
- vapi/types/log_resource.py +7 -0
- vapi/types/log_type.py +5 -0
- vapi/types/logs_paginated_response.py +22 -0
- vapi/types/make_credential.py +56 -0
- vapi/types/make_tool.py +85 -0
- vapi/types/make_tool_messages_item.py +9 -0
- vapi/types/make_tool_metadata.py +22 -0
- vapi/types/make_tool_provider_details.py +40 -0
- vapi/types/make_tool_with_tool_call.py +69 -0
- vapi/types/make_tool_with_tool_call_messages_item.py +11 -0
- vapi/types/message_plan.py +51 -0
- vapi/types/metrics.py +44 -0
- vapi/types/model_based_condition.py +54 -0
- vapi/types/model_cost.py +53 -0
- vapi/types/monitor.py +33 -0
- vapi/types/monitor_plan.py +43 -0
- vapi/types/neets_voice.py +47 -0
- vapi/types/neets_voice_id.py +6 -0
- vapi/types/neets_voice_id_enum.py +5 -0
- vapi/types/open_ai_credential.py +46 -0
- vapi/types/open_ai_function.py +35 -0
- vapi/types/open_ai_function_parameters.py +35 -0
- vapi/types/open_ai_message.py +21 -0
- vapi/types/open_ai_message_role.py +5 -0
- vapi/types/open_ai_model.py +106 -0
- vapi/types/open_ai_model_fallback_models_item.py +26 -0
- vapi/types/open_ai_model_model.py +26 -0
- vapi/types/open_ai_model_tools_item.py +20 -0
- vapi/types/open_ai_voice.py +52 -0
- vapi/types/open_ai_voice_id.py +5 -0
- vapi/types/open_router_credential.py +46 -0
- vapi/types/open_router_model.py +90 -0
- vapi/types/open_router_model_tools_item.py +20 -0
- vapi/types/org.py +120 -0
- vapi/types/org_plan.py +28 -0
- vapi/types/output_tool.py +82 -0
- vapi/types/output_tool_messages_item.py +9 -0
- vapi/types/pagination_meta.py +23 -0
- vapi/types/perplexity_ai_credential.py +46 -0
- vapi/types/perplexity_ai_model.py +90 -0
- vapi/types/perplexity_ai_model_tools_item.py +20 -0
- vapi/types/play_ht_credential.py +48 -0
- vapi/types/play_ht_voice.py +84 -0
- vapi/types/play_ht_voice_emotion.py +21 -0
- vapi/types/play_ht_voice_id.py +6 -0
- vapi/types/play_ht_voice_id_enum.py +8 -0
- vapi/types/punctuation_boundary.py +7 -0
- vapi/types/regex_option.py +34 -0
- vapi/types/regex_option_type.py +5 -0
- vapi/types/regex_replacement.py +48 -0
- vapi/types/rime_ai_credential.py +46 -0
- vapi/types/rime_ai_voice.py +58 -0
- vapi/types/rime_ai_voice_id.py +6 -0
- vapi/types/rime_ai_voice_id_enum.py +90 -0
- vapi/types/rime_ai_voice_model.py +5 -0
- vapi/types/rule_based_condition.py +96 -0
- vapi/types/rule_based_condition_operator.py +5 -0
- vapi/types/runpod_credential.py +46 -0
- vapi/types/s_3_credential.py +72 -0
- vapi/types/sbc_configuration.py +17 -0
- vapi/types/server.py +40 -0
- vapi/types/server_message.py +40 -0
- vapi/types/server_message_assistant_request.py +96 -0
- vapi/types/server_message_assistant_request_phone_number.py +11 -0
- vapi/types/server_message_conversation_update.py +110 -0
- vapi/types/server_message_conversation_update_messages_item.py +12 -0
- vapi/types/server_message_conversation_update_phone_number.py +11 -0
- vapi/types/server_message_end_of_call_report.py +134 -0
- vapi/types/server_message_end_of_call_report_costs_item.py +13 -0
- vapi/types/server_message_end_of_call_report_ended_reason.py +177 -0
- vapi/types/server_message_end_of_call_report_phone_number.py +11 -0
- vapi/types/server_message_hang.py +101 -0
- vapi/types/server_message_hang_phone_number.py +11 -0
- vapi/types/server_message_language_changed.py +101 -0
- vapi/types/server_message_language_changed_phone_number.py +11 -0
- vapi/types/server_message_message.py +38 -0
- vapi/types/server_message_model_output.py +101 -0
- vapi/types/server_message_model_output_phone_number.py +11 -0
- vapi/types/server_message_phone_call_control.py +110 -0
- vapi/types/server_message_phone_call_control_destination.py +7 -0
- vapi/types/server_message_phone_call_control_phone_number.py +11 -0
- vapi/types/server_message_phone_call_control_request.py +5 -0
- vapi/types/server_message_response.py +39 -0
- vapi/types/server_message_response_assistant_request.py +80 -0
- vapi/types/server_message_response_assistant_request_destination.py +7 -0
- vapi/types/server_message_response_message_response.py +14 -0
- vapi/types/server_message_response_tool_calls.py +28 -0
- vapi/types/server_message_response_transfer_destination_request.py +32 -0
- vapi/types/server_message_response_transfer_destination_request_destination.py +11 -0
- vapi/types/server_message_response_voice_request.py +44 -0
- vapi/types/server_message_speech_update.py +108 -0
- vapi/types/server_message_speech_update_phone_number.py +11 -0
- vapi/types/server_message_speech_update_role.py +5 -0
- vapi/types/server_message_speech_update_status.py +5 -0
- vapi/types/server_message_status_update.py +145 -0
- vapi/types/server_message_status_update_destination.py +7 -0
- vapi/types/server_message_status_update_ended_reason.py +177 -0
- vapi/types/server_message_status_update_messages_item.py +12 -0
- vapi/types/server_message_status_update_phone_number.py +11 -0
- vapi/types/server_message_status_update_status.py +7 -0
- vapi/types/server_message_tool_calls.py +112 -0
- vapi/types/server_message_tool_calls_phone_number.py +11 -0
- vapi/types/server_message_tool_calls_tool_with_tool_call_list_item.py +10 -0
- vapi/types/server_message_transcript.py +115 -0
- vapi/types/server_message_transcript_phone_number.py +11 -0
- vapi/types/server_message_transcript_role.py +5 -0
- vapi/types/server_message_transcript_transcript_type.py +5 -0
- vapi/types/server_message_transfer_destination_request.py +98 -0
- vapi/types/server_message_transfer_destination_request_phone_number.py +11 -0
- vapi/types/server_message_transfer_update.py +116 -0
- vapi/types/server_message_transfer_update_destination.py +11 -0
- vapi/types/server_message_transfer_update_phone_number.py +11 -0
- vapi/types/server_message_user_interrupted.py +96 -0
- vapi/types/server_message_user_interrupted_phone_number.py +11 -0
- vapi/types/server_message_voice_input.py +101 -0
- vapi/types/server_message_voice_input_phone_number.py +11 -0
- vapi/types/server_message_voice_request.py +128 -0
- vapi/types/server_message_voice_request_phone_number.py +11 -0
- vapi/types/sip_trunk_gateway.py +79 -0
- vapi/types/sip_trunk_gateway_outbound_protocol.py +5 -0
- vapi/types/sip_trunk_outbound_authentication_plan.py +35 -0
- vapi/types/sip_trunk_outbound_sip_register_plan.py +21 -0
- vapi/types/squad.py +73 -0
- vapi/types/squad_member_dto.py +60 -0
- vapi/types/start_speaking_plan.py +62 -0
- vapi/types/step_destination.py +28 -0
- vapi/types/step_destination_conditions_item.py +7 -0
- vapi/types/stop_speaking_plan.py +65 -0
- vapi/types/structured_data_plan.py +66 -0
- vapi/types/success_evaluation_plan.py +75 -0
- vapi/types/success_evaluation_plan_rubric.py +17 -0
- vapi/types/summary_plan.py +56 -0
- vapi/types/sync_voice_library_dto.py +23 -0
- vapi/types/sync_voice_library_dto_providers_item.py +10 -0
- vapi/types/system_message.py +39 -0
- vapi/types/talkscriber_transcriber.py +33 -0
- vapi/types/talkscriber_transcriber_language.py +109 -0
- vapi/types/template.py +58 -0
- vapi/types/template_details.py +20 -0
- vapi/types/template_provider.py +5 -0
- vapi/types/template_provider_details.py +8 -0
- vapi/types/template_visibility.py +5 -0
- vapi/types/time_range.py +47 -0
- vapi/types/time_range_step.py +8 -0
- vapi/types/together_ai_credential.py +46 -0
- vapi/types/together_ai_model.py +90 -0
- vapi/types/together_ai_model_tools_item.py +20 -0
- vapi/types/token.py +62 -0
- vapi/types/token_restrictions.py +53 -0
- vapi/types/token_tag.py +5 -0
- vapi/types/tool_call.py +33 -0
- vapi/types/tool_call_block.py +96 -0
- vapi/types/tool_call_block_messages_item.py +7 -0
- vapi/types/tool_call_block_tool.py +20 -0
- vapi/types/tool_call_function.py +27 -0
- vapi/types/tool_call_message.py +46 -0
- vapi/types/tool_call_result.py +62 -0
- vapi/types/tool_call_result_message.py +49 -0
- vapi/types/tool_call_result_message_item.py +7 -0
- vapi/types/tool_message_complete.py +74 -0
- vapi/types/tool_message_complete_role.py +5 -0
- vapi/types/tool_message_delayed.py +49 -0
- vapi/types/tool_message_failed.py +50 -0
- vapi/types/tool_message_start.py +37 -0
- vapi/types/tool_template_metadata.py +23 -0
- vapi/types/tool_template_setup.py +24 -0
- vapi/types/transcriber_cost.py +46 -0
- vapi/types/transcript_plan.py +66 -0
- vapi/types/transcription_endpointing_plan.py +52 -0
- vapi/types/transfer_call_tool.py +88 -0
- vapi/types/transfer_call_tool_destinations_item.py +11 -0
- vapi/types/transfer_call_tool_messages_item.py +11 -0
- vapi/types/transfer_destination_assistant.py +90 -0
- vapi/types/transfer_destination_number.py +77 -0
- vapi/types/transfer_destination_sip.py +39 -0
- vapi/types/transfer_destination_step.py +39 -0
- vapi/types/transfer_mode.py +5 -0
- vapi/types/transport_configuration_twilio.py +55 -0
- vapi/types/transport_configuration_twilio_recording_channels.py +5 -0
- vapi/types/transport_cost.py +32 -0
- vapi/types/twilio_credential.py +48 -0
- vapi/types/twilio_phone_number.py +113 -0
- vapi/types/twilio_phone_number_fallback_destination.py +7 -0
- vapi/types/twilio_voicemail_detection.py +107 -0
- vapi/types/twilio_voicemail_detection_voicemail_detection_types_item.py +10 -0
- vapi/types/update_anthropic_credential_dto.py +25 -0
- vapi/types/update_anyscale_credential_dto.py +25 -0
- vapi/types/update_azure_open_ai_credential_dto.py +31 -0
- vapi/types/update_azure_open_ai_credential_dto_models_item.py +17 -0
- vapi/types/update_azure_open_ai_credential_dto_region.py +24 -0
- vapi/types/update_byo_sip_trunk_credential_dto.py +64 -0
- vapi/types/update_cartesia_credential_dto.py +25 -0
- vapi/types/update_custom_llm_credential_dto.py +25 -0
- vapi/types/update_deep_infra_credential_dto.py +25 -0
- vapi/types/update_deepgram_credential_dto.py +32 -0
- vapi/types/update_eleven_labs_credential_dto.py +25 -0
- vapi/types/update_gcp_credential_dto.py +41 -0
- vapi/types/update_gladia_credential_dto.py +25 -0
- vapi/types/update_go_high_level_credential_dto.py +25 -0
- vapi/types/update_groq_credential_dto.py +25 -0
- vapi/types/update_lmnt_credential_dto.py +25 -0
- vapi/types/update_make_credential_dto.py +35 -0
- vapi/types/update_open_ai_credential_dto.py +25 -0
- vapi/types/update_open_router_credential_dto.py +25 -0
- vapi/types/update_org_dto.py +63 -0
- vapi/types/update_perplexity_ai_credential_dto.py +25 -0
- vapi/types/update_play_ht_credential_dto.py +27 -0
- vapi/types/update_rime_ai_credential_dto.py +25 -0
- vapi/types/update_runpod_credential_dto.py +25 -0
- vapi/types/update_s_3_credential_dto.py +51 -0
- vapi/types/update_together_ai_credential_dto.py +25 -0
- vapi/types/update_tool_template_dto.py +38 -0
- vapi/types/update_tool_template_dto_details.py +20 -0
- vapi/types/update_tool_template_dto_provider.py +5 -0
- vapi/types/update_tool_template_dto_provider_details.py +10 -0
- vapi/types/update_tool_template_dto_visibility.py +5 -0
- vapi/types/update_twilio_credential_dto.py +27 -0
- vapi/types/update_user_role_dto.py +23 -0
- vapi/types/update_user_role_dto_role.py +5 -0
- vapi/types/update_vonage_credential_dto.py +27 -0
- vapi/types/user.py +47 -0
- vapi/types/user_message.py +49 -0
- vapi/types/vapi_cost.py +32 -0
- vapi/types/vapi_model.py +102 -0
- vapi/types/vapi_model_steps_item.py +7 -0
- vapi/types/vapi_model_tools_item.py +20 -0
- vapi/types/vapi_phone_number.py +105 -0
- vapi/types/vapi_phone_number_fallback_destination.py +7 -0
- vapi/types/voice_cost.py +46 -0
- vapi/types/voice_library.py +126 -0
- vapi/types/voice_library_gender.py +5 -0
- vapi/types/voice_library_voice_response.py +27 -0
- vapi/types/vonage_credential.py +64 -0
- vapi/types/vonage_phone_number.py +108 -0
- vapi/types/vonage_phone_number_fallback_destination.py +7 -0
- vapi/types/workflow_block.py +99 -0
- vapi/types/workflow_block_messages_item.py +7 -0
- vapi/types/workflow_block_steps_item.py +7 -0
- vapi/version.py +3 -0
- vapi_server_sdk-0.0.0a7.dist-info/METADATA +179 -0
- vapi_server_sdk-0.0.0a7.dist-info/RECORD +571 -0
- vapi_server_sdk-0.0.0a7.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,735 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
import typing
|
|
4
|
+
from ..core.client_wrapper import SyncClientWrapper
|
|
5
|
+
import datetime as dt
|
|
6
|
+
from ..core.request_options import RequestOptions
|
|
7
|
+
from .types.phone_numbers_list_response_item import PhoneNumbersListResponseItem
|
|
8
|
+
from ..core.datetime_utils import serialize_datetime
|
|
9
|
+
from ..core.pydantic_utilities import parse_obj_as
|
|
10
|
+
from json.decoder import JSONDecodeError
|
|
11
|
+
from ..core.api_error import ApiError
|
|
12
|
+
from .types.phone_numbers_create_request import PhoneNumbersCreateRequest
|
|
13
|
+
from .types.phone_numbers_create_response import PhoneNumbersCreateResponse
|
|
14
|
+
from ..core.serialization import convert_and_respect_annotation_metadata
|
|
15
|
+
from .types.phone_numbers_get_response import PhoneNumbersGetResponse
|
|
16
|
+
from ..core.jsonable_encoder import jsonable_encoder
|
|
17
|
+
from .types.phone_numbers_delete_response import PhoneNumbersDeleteResponse
|
|
18
|
+
from .types.update_phone_number_dto_fallback_destination import UpdatePhoneNumberDtoFallbackDestination
|
|
19
|
+
from .types.phone_numbers_update_response import PhoneNumbersUpdateResponse
|
|
20
|
+
from ..core.client_wrapper import AsyncClientWrapper
|
|
21
|
+
|
|
22
|
+
# this is used as the default value for optional parameters
|
|
23
|
+
OMIT = typing.cast(typing.Any, ...)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class PhoneNumbersClient:
|
|
27
|
+
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
|
28
|
+
self._client_wrapper = client_wrapper
|
|
29
|
+
|
|
30
|
+
def list(
|
|
31
|
+
self,
|
|
32
|
+
*,
|
|
33
|
+
limit: typing.Optional[float] = None,
|
|
34
|
+
created_at_gt: typing.Optional[dt.datetime] = None,
|
|
35
|
+
created_at_lt: typing.Optional[dt.datetime] = None,
|
|
36
|
+
created_at_ge: typing.Optional[dt.datetime] = None,
|
|
37
|
+
created_at_le: typing.Optional[dt.datetime] = None,
|
|
38
|
+
updated_at_gt: typing.Optional[dt.datetime] = None,
|
|
39
|
+
updated_at_lt: typing.Optional[dt.datetime] = None,
|
|
40
|
+
updated_at_ge: typing.Optional[dt.datetime] = None,
|
|
41
|
+
updated_at_le: typing.Optional[dt.datetime] = None,
|
|
42
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
43
|
+
) -> typing.List[PhoneNumbersListResponseItem]:
|
|
44
|
+
"""
|
|
45
|
+
Parameters
|
|
46
|
+
----------
|
|
47
|
+
limit : typing.Optional[float]
|
|
48
|
+
This is the maximum number of items to return. Defaults to 100.
|
|
49
|
+
|
|
50
|
+
created_at_gt : typing.Optional[dt.datetime]
|
|
51
|
+
This will return items where the createdAt is greater than the specified value.
|
|
52
|
+
|
|
53
|
+
created_at_lt : typing.Optional[dt.datetime]
|
|
54
|
+
This will return items where the createdAt is less than the specified value.
|
|
55
|
+
|
|
56
|
+
created_at_ge : typing.Optional[dt.datetime]
|
|
57
|
+
This will return items where the createdAt is greater than or equal to the specified value.
|
|
58
|
+
|
|
59
|
+
created_at_le : typing.Optional[dt.datetime]
|
|
60
|
+
This will return items where the createdAt is less than or equal to the specified value.
|
|
61
|
+
|
|
62
|
+
updated_at_gt : typing.Optional[dt.datetime]
|
|
63
|
+
This will return items where the updatedAt is greater than the specified value.
|
|
64
|
+
|
|
65
|
+
updated_at_lt : typing.Optional[dt.datetime]
|
|
66
|
+
This will return items where the updatedAt is less than the specified value.
|
|
67
|
+
|
|
68
|
+
updated_at_ge : typing.Optional[dt.datetime]
|
|
69
|
+
This will return items where the updatedAt is greater than or equal to the specified value.
|
|
70
|
+
|
|
71
|
+
updated_at_le : typing.Optional[dt.datetime]
|
|
72
|
+
This will return items where the updatedAt is less than or equal to the specified value.
|
|
73
|
+
|
|
74
|
+
request_options : typing.Optional[RequestOptions]
|
|
75
|
+
Request-specific configuration.
|
|
76
|
+
|
|
77
|
+
Returns
|
|
78
|
+
-------
|
|
79
|
+
typing.List[PhoneNumbersListResponseItem]
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
Examples
|
|
83
|
+
--------
|
|
84
|
+
from vapi import Vapi
|
|
85
|
+
|
|
86
|
+
client = Vapi(
|
|
87
|
+
token="YOUR_TOKEN",
|
|
88
|
+
)
|
|
89
|
+
client.phone_numbers.list()
|
|
90
|
+
"""
|
|
91
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
92
|
+
"phone-number",
|
|
93
|
+
method="GET",
|
|
94
|
+
params={
|
|
95
|
+
"limit": limit,
|
|
96
|
+
"createdAtGt": serialize_datetime(created_at_gt) if created_at_gt is not None else None,
|
|
97
|
+
"createdAtLt": serialize_datetime(created_at_lt) if created_at_lt is not None else None,
|
|
98
|
+
"createdAtGe": serialize_datetime(created_at_ge) if created_at_ge is not None else None,
|
|
99
|
+
"createdAtLe": serialize_datetime(created_at_le) if created_at_le is not None else None,
|
|
100
|
+
"updatedAtGt": serialize_datetime(updated_at_gt) if updated_at_gt is not None else None,
|
|
101
|
+
"updatedAtLt": serialize_datetime(updated_at_lt) if updated_at_lt is not None else None,
|
|
102
|
+
"updatedAtGe": serialize_datetime(updated_at_ge) if updated_at_ge is not None else None,
|
|
103
|
+
"updatedAtLe": serialize_datetime(updated_at_le) if updated_at_le is not None else None,
|
|
104
|
+
},
|
|
105
|
+
request_options=request_options,
|
|
106
|
+
)
|
|
107
|
+
try:
|
|
108
|
+
if 200 <= _response.status_code < 300:
|
|
109
|
+
return typing.cast(
|
|
110
|
+
typing.List[PhoneNumbersListResponseItem],
|
|
111
|
+
parse_obj_as(
|
|
112
|
+
type_=typing.List[PhoneNumbersListResponseItem], # type: ignore
|
|
113
|
+
object_=_response.json(),
|
|
114
|
+
),
|
|
115
|
+
)
|
|
116
|
+
_response_json = _response.json()
|
|
117
|
+
except JSONDecodeError:
|
|
118
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
119
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
120
|
+
|
|
121
|
+
def create(
|
|
122
|
+
self, *, request: PhoneNumbersCreateRequest, request_options: typing.Optional[RequestOptions] = None
|
|
123
|
+
) -> PhoneNumbersCreateResponse:
|
|
124
|
+
"""
|
|
125
|
+
Parameters
|
|
126
|
+
----------
|
|
127
|
+
request : PhoneNumbersCreateRequest
|
|
128
|
+
|
|
129
|
+
request_options : typing.Optional[RequestOptions]
|
|
130
|
+
Request-specific configuration.
|
|
131
|
+
|
|
132
|
+
Returns
|
|
133
|
+
-------
|
|
134
|
+
PhoneNumbersCreateResponse
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
Examples
|
|
138
|
+
--------
|
|
139
|
+
from vapi import CreateByoPhoneNumberDto, Vapi
|
|
140
|
+
|
|
141
|
+
client = Vapi(
|
|
142
|
+
token="YOUR_TOKEN",
|
|
143
|
+
)
|
|
144
|
+
client.phone_numbers.create(
|
|
145
|
+
request=CreateByoPhoneNumberDto(
|
|
146
|
+
credential_id="credentialId",
|
|
147
|
+
),
|
|
148
|
+
)
|
|
149
|
+
"""
|
|
150
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
151
|
+
"phone-number",
|
|
152
|
+
method="POST",
|
|
153
|
+
json=convert_and_respect_annotation_metadata(
|
|
154
|
+
object_=request, annotation=PhoneNumbersCreateRequest, direction="write"
|
|
155
|
+
),
|
|
156
|
+
request_options=request_options,
|
|
157
|
+
omit=OMIT,
|
|
158
|
+
)
|
|
159
|
+
try:
|
|
160
|
+
if 200 <= _response.status_code < 300:
|
|
161
|
+
return typing.cast(
|
|
162
|
+
PhoneNumbersCreateResponse,
|
|
163
|
+
parse_obj_as(
|
|
164
|
+
type_=PhoneNumbersCreateResponse, # type: ignore
|
|
165
|
+
object_=_response.json(),
|
|
166
|
+
),
|
|
167
|
+
)
|
|
168
|
+
_response_json = _response.json()
|
|
169
|
+
except JSONDecodeError:
|
|
170
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
171
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
172
|
+
|
|
173
|
+
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> PhoneNumbersGetResponse:
|
|
174
|
+
"""
|
|
175
|
+
Parameters
|
|
176
|
+
----------
|
|
177
|
+
id : str
|
|
178
|
+
|
|
179
|
+
request_options : typing.Optional[RequestOptions]
|
|
180
|
+
Request-specific configuration.
|
|
181
|
+
|
|
182
|
+
Returns
|
|
183
|
+
-------
|
|
184
|
+
PhoneNumbersGetResponse
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
Examples
|
|
188
|
+
--------
|
|
189
|
+
from vapi import Vapi
|
|
190
|
+
|
|
191
|
+
client = Vapi(
|
|
192
|
+
token="YOUR_TOKEN",
|
|
193
|
+
)
|
|
194
|
+
client.phone_numbers.get(
|
|
195
|
+
id="id",
|
|
196
|
+
)
|
|
197
|
+
"""
|
|
198
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
199
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
200
|
+
method="GET",
|
|
201
|
+
request_options=request_options,
|
|
202
|
+
)
|
|
203
|
+
try:
|
|
204
|
+
if 200 <= _response.status_code < 300:
|
|
205
|
+
return typing.cast(
|
|
206
|
+
PhoneNumbersGetResponse,
|
|
207
|
+
parse_obj_as(
|
|
208
|
+
type_=PhoneNumbersGetResponse, # type: ignore
|
|
209
|
+
object_=_response.json(),
|
|
210
|
+
),
|
|
211
|
+
)
|
|
212
|
+
_response_json = _response.json()
|
|
213
|
+
except JSONDecodeError:
|
|
214
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
215
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
216
|
+
|
|
217
|
+
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> PhoneNumbersDeleteResponse:
|
|
218
|
+
"""
|
|
219
|
+
Parameters
|
|
220
|
+
----------
|
|
221
|
+
id : str
|
|
222
|
+
|
|
223
|
+
request_options : typing.Optional[RequestOptions]
|
|
224
|
+
Request-specific configuration.
|
|
225
|
+
|
|
226
|
+
Returns
|
|
227
|
+
-------
|
|
228
|
+
PhoneNumbersDeleteResponse
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
Examples
|
|
232
|
+
--------
|
|
233
|
+
from vapi import Vapi
|
|
234
|
+
|
|
235
|
+
client = Vapi(
|
|
236
|
+
token="YOUR_TOKEN",
|
|
237
|
+
)
|
|
238
|
+
client.phone_numbers.delete(
|
|
239
|
+
id="id",
|
|
240
|
+
)
|
|
241
|
+
"""
|
|
242
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
243
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
244
|
+
method="DELETE",
|
|
245
|
+
request_options=request_options,
|
|
246
|
+
)
|
|
247
|
+
try:
|
|
248
|
+
if 200 <= _response.status_code < 300:
|
|
249
|
+
return typing.cast(
|
|
250
|
+
PhoneNumbersDeleteResponse,
|
|
251
|
+
parse_obj_as(
|
|
252
|
+
type_=PhoneNumbersDeleteResponse, # type: ignore
|
|
253
|
+
object_=_response.json(),
|
|
254
|
+
),
|
|
255
|
+
)
|
|
256
|
+
_response_json = _response.json()
|
|
257
|
+
except JSONDecodeError:
|
|
258
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
259
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
260
|
+
|
|
261
|
+
def update(
|
|
262
|
+
self,
|
|
263
|
+
id: str,
|
|
264
|
+
*,
|
|
265
|
+
fallback_destination: typing.Optional[UpdatePhoneNumberDtoFallbackDestination] = OMIT,
|
|
266
|
+
name: typing.Optional[str] = OMIT,
|
|
267
|
+
assistant_id: typing.Optional[str] = OMIT,
|
|
268
|
+
squad_id: typing.Optional[str] = OMIT,
|
|
269
|
+
server_url: typing.Optional[str] = OMIT,
|
|
270
|
+
server_url_secret: typing.Optional[str] = OMIT,
|
|
271
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
272
|
+
) -> PhoneNumbersUpdateResponse:
|
|
273
|
+
"""
|
|
274
|
+
Parameters
|
|
275
|
+
----------
|
|
276
|
+
id : str
|
|
277
|
+
|
|
278
|
+
fallback_destination : typing.Optional[UpdatePhoneNumberDtoFallbackDestination]
|
|
279
|
+
This is the fallback destination an inbound call will be transferred to if:
|
|
280
|
+
1. `assistantId` is not set
|
|
281
|
+
2. `squadId` is not set
|
|
282
|
+
3. and, `assistant-request` message to the `serverUrl` fails
|
|
283
|
+
|
|
284
|
+
If this is not set and above conditions are met, the inbound call is hung up with an error message.
|
|
285
|
+
|
|
286
|
+
name : typing.Optional[str]
|
|
287
|
+
This is the name of the phone number. This is just for your own reference.
|
|
288
|
+
|
|
289
|
+
assistant_id : typing.Optional[str]
|
|
290
|
+
This is the assistant that will be used for incoming calls to this phone number.
|
|
291
|
+
|
|
292
|
+
If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
|
|
293
|
+
|
|
294
|
+
squad_id : typing.Optional[str]
|
|
295
|
+
This is the squad that will be used for incoming calls to this phone number.
|
|
296
|
+
|
|
297
|
+
If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
|
|
298
|
+
|
|
299
|
+
server_url : typing.Optional[str]
|
|
300
|
+
This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.
|
|
301
|
+
|
|
302
|
+
You can see the shape of the messages sent in `ServerMessage`.
|
|
303
|
+
|
|
304
|
+
This overrides the `org.serverUrl`. Order of precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
305
|
+
|
|
306
|
+
server_url_secret : typing.Optional[str]
|
|
307
|
+
This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.
|
|
308
|
+
|
|
309
|
+
Same precedence logic as serverUrl.
|
|
310
|
+
|
|
311
|
+
request_options : typing.Optional[RequestOptions]
|
|
312
|
+
Request-specific configuration.
|
|
313
|
+
|
|
314
|
+
Returns
|
|
315
|
+
-------
|
|
316
|
+
PhoneNumbersUpdateResponse
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
Examples
|
|
320
|
+
--------
|
|
321
|
+
from vapi import Vapi
|
|
322
|
+
|
|
323
|
+
client = Vapi(
|
|
324
|
+
token="YOUR_TOKEN",
|
|
325
|
+
)
|
|
326
|
+
client.phone_numbers.update(
|
|
327
|
+
id="id",
|
|
328
|
+
)
|
|
329
|
+
"""
|
|
330
|
+
_response = self._client_wrapper.httpx_client.request(
|
|
331
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
332
|
+
method="PATCH",
|
|
333
|
+
json={
|
|
334
|
+
"fallbackDestination": convert_and_respect_annotation_metadata(
|
|
335
|
+
object_=fallback_destination, annotation=UpdatePhoneNumberDtoFallbackDestination, direction="write"
|
|
336
|
+
),
|
|
337
|
+
"name": name,
|
|
338
|
+
"assistantId": assistant_id,
|
|
339
|
+
"squadId": squad_id,
|
|
340
|
+
"serverUrl": server_url,
|
|
341
|
+
"serverUrlSecret": server_url_secret,
|
|
342
|
+
},
|
|
343
|
+
request_options=request_options,
|
|
344
|
+
omit=OMIT,
|
|
345
|
+
)
|
|
346
|
+
try:
|
|
347
|
+
if 200 <= _response.status_code < 300:
|
|
348
|
+
return typing.cast(
|
|
349
|
+
PhoneNumbersUpdateResponse,
|
|
350
|
+
parse_obj_as(
|
|
351
|
+
type_=PhoneNumbersUpdateResponse, # type: ignore
|
|
352
|
+
object_=_response.json(),
|
|
353
|
+
),
|
|
354
|
+
)
|
|
355
|
+
_response_json = _response.json()
|
|
356
|
+
except JSONDecodeError:
|
|
357
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
358
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
class AsyncPhoneNumbersClient:
|
|
362
|
+
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
|
363
|
+
self._client_wrapper = client_wrapper
|
|
364
|
+
|
|
365
|
+
async def list(
|
|
366
|
+
self,
|
|
367
|
+
*,
|
|
368
|
+
limit: typing.Optional[float] = None,
|
|
369
|
+
created_at_gt: typing.Optional[dt.datetime] = None,
|
|
370
|
+
created_at_lt: typing.Optional[dt.datetime] = None,
|
|
371
|
+
created_at_ge: typing.Optional[dt.datetime] = None,
|
|
372
|
+
created_at_le: typing.Optional[dt.datetime] = None,
|
|
373
|
+
updated_at_gt: typing.Optional[dt.datetime] = None,
|
|
374
|
+
updated_at_lt: typing.Optional[dt.datetime] = None,
|
|
375
|
+
updated_at_ge: typing.Optional[dt.datetime] = None,
|
|
376
|
+
updated_at_le: typing.Optional[dt.datetime] = None,
|
|
377
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
378
|
+
) -> typing.List[PhoneNumbersListResponseItem]:
|
|
379
|
+
"""
|
|
380
|
+
Parameters
|
|
381
|
+
----------
|
|
382
|
+
limit : typing.Optional[float]
|
|
383
|
+
This is the maximum number of items to return. Defaults to 100.
|
|
384
|
+
|
|
385
|
+
created_at_gt : typing.Optional[dt.datetime]
|
|
386
|
+
This will return items where the createdAt is greater than the specified value.
|
|
387
|
+
|
|
388
|
+
created_at_lt : typing.Optional[dt.datetime]
|
|
389
|
+
This will return items where the createdAt is less than the specified value.
|
|
390
|
+
|
|
391
|
+
created_at_ge : typing.Optional[dt.datetime]
|
|
392
|
+
This will return items where the createdAt is greater than or equal to the specified value.
|
|
393
|
+
|
|
394
|
+
created_at_le : typing.Optional[dt.datetime]
|
|
395
|
+
This will return items where the createdAt is less than or equal to the specified value.
|
|
396
|
+
|
|
397
|
+
updated_at_gt : typing.Optional[dt.datetime]
|
|
398
|
+
This will return items where the updatedAt is greater than the specified value.
|
|
399
|
+
|
|
400
|
+
updated_at_lt : typing.Optional[dt.datetime]
|
|
401
|
+
This will return items where the updatedAt is less than the specified value.
|
|
402
|
+
|
|
403
|
+
updated_at_ge : typing.Optional[dt.datetime]
|
|
404
|
+
This will return items where the updatedAt is greater than or equal to the specified value.
|
|
405
|
+
|
|
406
|
+
updated_at_le : typing.Optional[dt.datetime]
|
|
407
|
+
This will return items where the updatedAt is less than or equal to the specified value.
|
|
408
|
+
|
|
409
|
+
request_options : typing.Optional[RequestOptions]
|
|
410
|
+
Request-specific configuration.
|
|
411
|
+
|
|
412
|
+
Returns
|
|
413
|
+
-------
|
|
414
|
+
typing.List[PhoneNumbersListResponseItem]
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
Examples
|
|
418
|
+
--------
|
|
419
|
+
import asyncio
|
|
420
|
+
|
|
421
|
+
from vapi import AsyncVapi
|
|
422
|
+
|
|
423
|
+
client = AsyncVapi(
|
|
424
|
+
token="YOUR_TOKEN",
|
|
425
|
+
)
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
async def main() -> None:
|
|
429
|
+
await client.phone_numbers.list()
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
asyncio.run(main())
|
|
433
|
+
"""
|
|
434
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
435
|
+
"phone-number",
|
|
436
|
+
method="GET",
|
|
437
|
+
params={
|
|
438
|
+
"limit": limit,
|
|
439
|
+
"createdAtGt": serialize_datetime(created_at_gt) if created_at_gt is not None else None,
|
|
440
|
+
"createdAtLt": serialize_datetime(created_at_lt) if created_at_lt is not None else None,
|
|
441
|
+
"createdAtGe": serialize_datetime(created_at_ge) if created_at_ge is not None else None,
|
|
442
|
+
"createdAtLe": serialize_datetime(created_at_le) if created_at_le is not None else None,
|
|
443
|
+
"updatedAtGt": serialize_datetime(updated_at_gt) if updated_at_gt is not None else None,
|
|
444
|
+
"updatedAtLt": serialize_datetime(updated_at_lt) if updated_at_lt is not None else None,
|
|
445
|
+
"updatedAtGe": serialize_datetime(updated_at_ge) if updated_at_ge is not None else None,
|
|
446
|
+
"updatedAtLe": serialize_datetime(updated_at_le) if updated_at_le is not None else None,
|
|
447
|
+
},
|
|
448
|
+
request_options=request_options,
|
|
449
|
+
)
|
|
450
|
+
try:
|
|
451
|
+
if 200 <= _response.status_code < 300:
|
|
452
|
+
return typing.cast(
|
|
453
|
+
typing.List[PhoneNumbersListResponseItem],
|
|
454
|
+
parse_obj_as(
|
|
455
|
+
type_=typing.List[PhoneNumbersListResponseItem], # type: ignore
|
|
456
|
+
object_=_response.json(),
|
|
457
|
+
),
|
|
458
|
+
)
|
|
459
|
+
_response_json = _response.json()
|
|
460
|
+
except JSONDecodeError:
|
|
461
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
462
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
463
|
+
|
|
464
|
+
async def create(
|
|
465
|
+
self, *, request: PhoneNumbersCreateRequest, request_options: typing.Optional[RequestOptions] = None
|
|
466
|
+
) -> PhoneNumbersCreateResponse:
|
|
467
|
+
"""
|
|
468
|
+
Parameters
|
|
469
|
+
----------
|
|
470
|
+
request : PhoneNumbersCreateRequest
|
|
471
|
+
|
|
472
|
+
request_options : typing.Optional[RequestOptions]
|
|
473
|
+
Request-specific configuration.
|
|
474
|
+
|
|
475
|
+
Returns
|
|
476
|
+
-------
|
|
477
|
+
PhoneNumbersCreateResponse
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
Examples
|
|
481
|
+
--------
|
|
482
|
+
import asyncio
|
|
483
|
+
|
|
484
|
+
from vapi import AsyncVapi, CreateByoPhoneNumberDto
|
|
485
|
+
|
|
486
|
+
client = AsyncVapi(
|
|
487
|
+
token="YOUR_TOKEN",
|
|
488
|
+
)
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
async def main() -> None:
|
|
492
|
+
await client.phone_numbers.create(
|
|
493
|
+
request=CreateByoPhoneNumberDto(
|
|
494
|
+
credential_id="credentialId",
|
|
495
|
+
),
|
|
496
|
+
)
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
asyncio.run(main())
|
|
500
|
+
"""
|
|
501
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
502
|
+
"phone-number",
|
|
503
|
+
method="POST",
|
|
504
|
+
json=convert_and_respect_annotation_metadata(
|
|
505
|
+
object_=request, annotation=PhoneNumbersCreateRequest, direction="write"
|
|
506
|
+
),
|
|
507
|
+
request_options=request_options,
|
|
508
|
+
omit=OMIT,
|
|
509
|
+
)
|
|
510
|
+
try:
|
|
511
|
+
if 200 <= _response.status_code < 300:
|
|
512
|
+
return typing.cast(
|
|
513
|
+
PhoneNumbersCreateResponse,
|
|
514
|
+
parse_obj_as(
|
|
515
|
+
type_=PhoneNumbersCreateResponse, # type: ignore
|
|
516
|
+
object_=_response.json(),
|
|
517
|
+
),
|
|
518
|
+
)
|
|
519
|
+
_response_json = _response.json()
|
|
520
|
+
except JSONDecodeError:
|
|
521
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
522
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
523
|
+
|
|
524
|
+
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> PhoneNumbersGetResponse:
|
|
525
|
+
"""
|
|
526
|
+
Parameters
|
|
527
|
+
----------
|
|
528
|
+
id : str
|
|
529
|
+
|
|
530
|
+
request_options : typing.Optional[RequestOptions]
|
|
531
|
+
Request-specific configuration.
|
|
532
|
+
|
|
533
|
+
Returns
|
|
534
|
+
-------
|
|
535
|
+
PhoneNumbersGetResponse
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
Examples
|
|
539
|
+
--------
|
|
540
|
+
import asyncio
|
|
541
|
+
|
|
542
|
+
from vapi import AsyncVapi
|
|
543
|
+
|
|
544
|
+
client = AsyncVapi(
|
|
545
|
+
token="YOUR_TOKEN",
|
|
546
|
+
)
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
async def main() -> None:
|
|
550
|
+
await client.phone_numbers.get(
|
|
551
|
+
id="id",
|
|
552
|
+
)
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
asyncio.run(main())
|
|
556
|
+
"""
|
|
557
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
558
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
559
|
+
method="GET",
|
|
560
|
+
request_options=request_options,
|
|
561
|
+
)
|
|
562
|
+
try:
|
|
563
|
+
if 200 <= _response.status_code < 300:
|
|
564
|
+
return typing.cast(
|
|
565
|
+
PhoneNumbersGetResponse,
|
|
566
|
+
parse_obj_as(
|
|
567
|
+
type_=PhoneNumbersGetResponse, # type: ignore
|
|
568
|
+
object_=_response.json(),
|
|
569
|
+
),
|
|
570
|
+
)
|
|
571
|
+
_response_json = _response.json()
|
|
572
|
+
except JSONDecodeError:
|
|
573
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
574
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
575
|
+
|
|
576
|
+
async def delete(
|
|
577
|
+
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
578
|
+
) -> PhoneNumbersDeleteResponse:
|
|
579
|
+
"""
|
|
580
|
+
Parameters
|
|
581
|
+
----------
|
|
582
|
+
id : str
|
|
583
|
+
|
|
584
|
+
request_options : typing.Optional[RequestOptions]
|
|
585
|
+
Request-specific configuration.
|
|
586
|
+
|
|
587
|
+
Returns
|
|
588
|
+
-------
|
|
589
|
+
PhoneNumbersDeleteResponse
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
Examples
|
|
593
|
+
--------
|
|
594
|
+
import asyncio
|
|
595
|
+
|
|
596
|
+
from vapi import AsyncVapi
|
|
597
|
+
|
|
598
|
+
client = AsyncVapi(
|
|
599
|
+
token="YOUR_TOKEN",
|
|
600
|
+
)
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
async def main() -> None:
|
|
604
|
+
await client.phone_numbers.delete(
|
|
605
|
+
id="id",
|
|
606
|
+
)
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
asyncio.run(main())
|
|
610
|
+
"""
|
|
611
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
612
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
613
|
+
method="DELETE",
|
|
614
|
+
request_options=request_options,
|
|
615
|
+
)
|
|
616
|
+
try:
|
|
617
|
+
if 200 <= _response.status_code < 300:
|
|
618
|
+
return typing.cast(
|
|
619
|
+
PhoneNumbersDeleteResponse,
|
|
620
|
+
parse_obj_as(
|
|
621
|
+
type_=PhoneNumbersDeleteResponse, # type: ignore
|
|
622
|
+
object_=_response.json(),
|
|
623
|
+
),
|
|
624
|
+
)
|
|
625
|
+
_response_json = _response.json()
|
|
626
|
+
except JSONDecodeError:
|
|
627
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
628
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
629
|
+
|
|
630
|
+
async def update(
|
|
631
|
+
self,
|
|
632
|
+
id: str,
|
|
633
|
+
*,
|
|
634
|
+
fallback_destination: typing.Optional[UpdatePhoneNumberDtoFallbackDestination] = OMIT,
|
|
635
|
+
name: typing.Optional[str] = OMIT,
|
|
636
|
+
assistant_id: typing.Optional[str] = OMIT,
|
|
637
|
+
squad_id: typing.Optional[str] = OMIT,
|
|
638
|
+
server_url: typing.Optional[str] = OMIT,
|
|
639
|
+
server_url_secret: typing.Optional[str] = OMIT,
|
|
640
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
641
|
+
) -> PhoneNumbersUpdateResponse:
|
|
642
|
+
"""
|
|
643
|
+
Parameters
|
|
644
|
+
----------
|
|
645
|
+
id : str
|
|
646
|
+
|
|
647
|
+
fallback_destination : typing.Optional[UpdatePhoneNumberDtoFallbackDestination]
|
|
648
|
+
This is the fallback destination an inbound call will be transferred to if:
|
|
649
|
+
1. `assistantId` is not set
|
|
650
|
+
2. `squadId` is not set
|
|
651
|
+
3. and, `assistant-request` message to the `serverUrl` fails
|
|
652
|
+
|
|
653
|
+
If this is not set and above conditions are met, the inbound call is hung up with an error message.
|
|
654
|
+
|
|
655
|
+
name : typing.Optional[str]
|
|
656
|
+
This is the name of the phone number. This is just for your own reference.
|
|
657
|
+
|
|
658
|
+
assistant_id : typing.Optional[str]
|
|
659
|
+
This is the assistant that will be used for incoming calls to this phone number.
|
|
660
|
+
|
|
661
|
+
If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
|
|
662
|
+
|
|
663
|
+
squad_id : typing.Optional[str]
|
|
664
|
+
This is the squad that will be used for incoming calls to this phone number.
|
|
665
|
+
|
|
666
|
+
If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
|
|
667
|
+
|
|
668
|
+
server_url : typing.Optional[str]
|
|
669
|
+
This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.
|
|
670
|
+
|
|
671
|
+
You can see the shape of the messages sent in `ServerMessage`.
|
|
672
|
+
|
|
673
|
+
This overrides the `org.serverUrl`. Order of precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
674
|
+
|
|
675
|
+
server_url_secret : typing.Optional[str]
|
|
676
|
+
This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.
|
|
677
|
+
|
|
678
|
+
Same precedence logic as serverUrl.
|
|
679
|
+
|
|
680
|
+
request_options : typing.Optional[RequestOptions]
|
|
681
|
+
Request-specific configuration.
|
|
682
|
+
|
|
683
|
+
Returns
|
|
684
|
+
-------
|
|
685
|
+
PhoneNumbersUpdateResponse
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
Examples
|
|
689
|
+
--------
|
|
690
|
+
import asyncio
|
|
691
|
+
|
|
692
|
+
from vapi import AsyncVapi
|
|
693
|
+
|
|
694
|
+
client = AsyncVapi(
|
|
695
|
+
token="YOUR_TOKEN",
|
|
696
|
+
)
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
async def main() -> None:
|
|
700
|
+
await client.phone_numbers.update(
|
|
701
|
+
id="id",
|
|
702
|
+
)
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
asyncio.run(main())
|
|
706
|
+
"""
|
|
707
|
+
_response = await self._client_wrapper.httpx_client.request(
|
|
708
|
+
f"phone-number/{jsonable_encoder(id)}",
|
|
709
|
+
method="PATCH",
|
|
710
|
+
json={
|
|
711
|
+
"fallbackDestination": convert_and_respect_annotation_metadata(
|
|
712
|
+
object_=fallback_destination, annotation=UpdatePhoneNumberDtoFallbackDestination, direction="write"
|
|
713
|
+
),
|
|
714
|
+
"name": name,
|
|
715
|
+
"assistantId": assistant_id,
|
|
716
|
+
"squadId": squad_id,
|
|
717
|
+
"serverUrl": server_url,
|
|
718
|
+
"serverUrlSecret": server_url_secret,
|
|
719
|
+
},
|
|
720
|
+
request_options=request_options,
|
|
721
|
+
omit=OMIT,
|
|
722
|
+
)
|
|
723
|
+
try:
|
|
724
|
+
if 200 <= _response.status_code < 300:
|
|
725
|
+
return typing.cast(
|
|
726
|
+
PhoneNumbersUpdateResponse,
|
|
727
|
+
parse_obj_as(
|
|
728
|
+
type_=PhoneNumbersUpdateResponse, # type: ignore
|
|
729
|
+
object_=_response.json(),
|
|
730
|
+
),
|
|
731
|
+
)
|
|
732
|
+
_response_json = _response.json()
|
|
733
|
+
except JSONDecodeError:
|
|
734
|
+
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
735
|
+
raise ApiError(status_code=_response.status_code, body=_response_json)
|