vapi_server_sdk 0.0.0.pre.alpha7

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.
Files changed (541) hide show
  1. checksums.yaml +7 -0
  2. data/lib/core/file_utilities.rb +26 -0
  3. data/lib/environment.rb +7 -0
  4. data/lib/gemconfig.rb +14 -0
  5. data/lib/requests.rb +174 -0
  6. data/lib/types_export.rb +526 -0
  7. data/lib/vapi_server_sdk/analytics/client.rb +115 -0
  8. data/lib/vapi_server_sdk/assistants/client.rb +949 -0
  9. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_background_sound.rb +12 -0
  10. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_client_messages_item.rb +22 -0
  11. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_first_message_mode.rb +21 -0
  12. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_model.rb +201 -0
  13. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +23 -0
  14. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_transcriber.rb +110 -0
  15. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_voice.rb +188 -0
  16. data/lib/vapi_server_sdk/blocks/client.rb +552 -0
  17. data/lib/vapi_server_sdk/blocks/types/blocks_create_request.rb +109 -0
  18. data/lib/vapi_server_sdk/blocks/types/blocks_create_response.rb +109 -0
  19. data/lib/vapi_server_sdk/blocks/types/blocks_delete_response.rb +109 -0
  20. data/lib/vapi_server_sdk/blocks/types/blocks_get_response.rb +109 -0
  21. data/lib/vapi_server_sdk/blocks/types/blocks_list_response_item.rb +109 -0
  22. data/lib/vapi_server_sdk/blocks/types/blocks_update_response.rb +109 -0
  23. data/lib/vapi_server_sdk/blocks/types/update_block_dto_messages_item.rb +96 -0
  24. data/lib/vapi_server_sdk/blocks/types/update_block_dto_steps_item.rb +96 -0
  25. data/lib/vapi_server_sdk/blocks/types/update_block_dto_tool.rb +163 -0
  26. data/lib/vapi_server_sdk/calls/client.rb +966 -0
  27. data/lib/vapi_server_sdk/files/client.rb +347 -0
  28. data/lib/vapi_server_sdk/logs/client.rb +174 -0
  29. data/lib/vapi_server_sdk/logs/types/logs_get_request_sort_order.rb +10 -0
  30. data/lib/vapi_server_sdk/logs/types/logs_get_request_type.rb +12 -0
  31. data/lib/vapi_server_sdk/phone_numbers/client.rb +455 -0
  32. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_create_request.rb +122 -0
  33. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_create_response.rb +122 -0
  34. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_delete_response.rb +122 -0
  35. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_get_response.rb +122 -0
  36. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_list_response_item.rb +122 -0
  37. data/lib/vapi_server_sdk/phone_numbers/types/phone_numbers_update_response.rb +122 -0
  38. data/lib/vapi_server_sdk/phone_numbers/types/update_phone_number_dto_fallback_destination.rb +103 -0
  39. data/lib/vapi_server_sdk/squads/client.rb +1050 -0
  40. data/lib/vapi_server_sdk/tools/client.rb +473 -0
  41. data/lib/vapi_server_sdk/tools/types/tools_create_request.rb +161 -0
  42. data/lib/vapi_server_sdk/tools/types/tools_create_response.rb +161 -0
  43. data/lib/vapi_server_sdk/tools/types/tools_delete_response.rb +161 -0
  44. data/lib/vapi_server_sdk/tools/types/tools_get_response.rb +161 -0
  45. data/lib/vapi_server_sdk/tools/types/tools_list_response_item.rb +161 -0
  46. data/lib/vapi_server_sdk/tools/types/tools_update_response.rb +161 -0
  47. data/lib/vapi_server_sdk/tools/types/update_tool_dto_messages_item.rb +122 -0
  48. data/lib/vapi_server_sdk/types/add_voice_to_provider_dto.rb +78 -0
  49. data/lib/vapi_server_sdk/types/analysis.rb +88 -0
  50. data/lib/vapi_server_sdk/types/analysis_cost.rb +93 -0
  51. data/lib/vapi_server_sdk/types/analysis_cost_analysis_type.rb +10 -0
  52. data/lib/vapi_server_sdk/types/analysis_cost_breakdown.rb +137 -0
  53. data/lib/vapi_server_sdk/types/analysis_plan.rb +103 -0
  54. data/lib/vapi_server_sdk/types/analytics_operation.rb +76 -0
  55. data/lib/vapi_server_sdk/types/analytics_operation_column.rb +17 -0
  56. data/lib/vapi_server_sdk/types/analytics_operation_operation.rb +12 -0
  57. data/lib/vapi_server_sdk/types/analytics_query.rb +107 -0
  58. data/lib/vapi_server_sdk/types/analytics_query_group_by_item.rb +11 -0
  59. data/lib/vapi_server_sdk/types/analytics_query_result.rb +96 -0
  60. data/lib/vapi_server_sdk/types/anthropic_credential.rb +101 -0
  61. data/lib/vapi_server_sdk/types/anthropic_model.rb +170 -0
  62. data/lib/vapi_server_sdk/types/anthropic_model_model.rb +11 -0
  63. data/lib/vapi_server_sdk/types/anthropic_model_tools_item.rb +159 -0
  64. data/lib/vapi_server_sdk/types/anyscale_credential.rb +101 -0
  65. data/lib/vapi_server_sdk/types/anyscale_model.rb +169 -0
  66. data/lib/vapi_server_sdk/types/anyscale_model_tools_item.rb +159 -0
  67. data/lib/vapi_server_sdk/types/artifact.rb +133 -0
  68. data/lib/vapi_server_sdk/types/artifact_messages_item.rb +96 -0
  69. data/lib/vapi_server_sdk/types/artifact_plan.rb +139 -0
  70. data/lib/vapi_server_sdk/types/assignment_mutation.rb +189 -0
  71. data/lib/vapi_server_sdk/types/assignment_mutation_conditions_item.rb +94 -0
  72. data/lib/vapi_server_sdk/types/assistant.rb +562 -0
  73. data/lib/vapi_server_sdk/types/assistant_background_sound.rb +10 -0
  74. data/lib/vapi_server_sdk/types/assistant_client_messages_item.rb +20 -0
  75. data/lib/vapi_server_sdk/types/assistant_first_message_mode.rb +19 -0
  76. data/lib/vapi_server_sdk/types/assistant_model.rb +199 -0
  77. data/lib/vapi_server_sdk/types/assistant_overrides.rb +539 -0
  78. data/lib/vapi_server_sdk/types/assistant_overrides_background_sound.rb +10 -0
  79. data/lib/vapi_server_sdk/types/assistant_overrides_client_messages_item.rb +20 -0
  80. data/lib/vapi_server_sdk/types/assistant_overrides_first_message_mode.rb +19 -0
  81. data/lib/vapi_server_sdk/types/assistant_overrides_model.rb +199 -0
  82. data/lib/vapi_server_sdk/types/assistant_overrides_server_messages_item.rb +21 -0
  83. data/lib/vapi_server_sdk/types/assistant_overrides_transcriber.rb +108 -0
  84. data/lib/vapi_server_sdk/types/assistant_overrides_voice.rb +186 -0
  85. data/lib/vapi_server_sdk/types/assistant_server_messages_item.rb +21 -0
  86. data/lib/vapi_server_sdk/types/assistant_transcriber.rb +108 -0
  87. data/lib/vapi_server_sdk/types/assistant_voice.rb +186 -0
  88. data/lib/vapi_server_sdk/types/azure_open_ai_credential.rb +128 -0
  89. data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +14 -0
  90. data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb +21 -0
  91. data/lib/vapi_server_sdk/types/azure_voice.rb +104 -0
  92. data/lib/vapi_server_sdk/types/azure_voice_id.rb +53 -0
  93. data/lib/vapi_server_sdk/types/azure_voice_id_enum.rb +9 -0
  94. data/lib/vapi_server_sdk/types/block_complete_message.rb +73 -0
  95. data/lib/vapi_server_sdk/types/block_complete_message_conditions_item.rb +94 -0
  96. data/lib/vapi_server_sdk/types/block_start_message.rb +73 -0
  97. data/lib/vapi_server_sdk/types/block_start_message_conditions_item.rb +94 -0
  98. data/lib/vapi_server_sdk/types/bot_message.rb +111 -0
  99. data/lib/vapi_server_sdk/types/bucket_plan.rb +139 -0
  100. data/lib/vapi_server_sdk/types/buy_phone_number_dto.rb +151 -0
  101. data/lib/vapi_server_sdk/types/buy_phone_number_dto_fallback_destination.rb +100 -0
  102. data/lib/vapi_server_sdk/types/byo_phone_number.rb +224 -0
  103. data/lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb +100 -0
  104. data/lib/vapi_server_sdk/types/byo_sip_trunk_credential.rb +166 -0
  105. data/lib/vapi_server_sdk/types/call.rb +425 -0
  106. data/lib/vapi_server_sdk/types/call_costs_item.rb +146 -0
  107. data/lib/vapi_server_sdk/types/call_destination.rb +96 -0
  108. data/lib/vapi_server_sdk/types/call_ended_reason.rb +175 -0
  109. data/lib/vapi_server_sdk/types/call_messages_item.rb +96 -0
  110. data/lib/vapi_server_sdk/types/call_paginated_response.rb +75 -0
  111. data/lib/vapi_server_sdk/types/call_phone_call_provider.rb +11 -0
  112. data/lib/vapi_server_sdk/types/call_phone_call_transport.rb +10 -0
  113. data/lib/vapi_server_sdk/types/call_status.rb +12 -0
  114. data/lib/vapi_server_sdk/types/call_type.rb +10 -0
  115. data/lib/vapi_server_sdk/types/callback_step.rb +204 -0
  116. data/lib/vapi_server_sdk/types/callback_step_block.rb +108 -0
  117. data/lib/vapi_server_sdk/types/cartesia_credential.rb +101 -0
  118. data/lib/vapi_server_sdk/types/cartesia_voice.rb +113 -0
  119. data/lib/vapi_server_sdk/types/cartesia_voice_language.rb +15 -0
  120. data/lib/vapi_server_sdk/types/cartesia_voice_model.rb +10 -0
  121. data/lib/vapi_server_sdk/types/chunk_plan.rb +128 -0
  122. data/lib/vapi_server_sdk/types/client_inbound_message.rb +63 -0
  123. data/lib/vapi_server_sdk/types/client_inbound_message_add_message.rb +61 -0
  124. data/lib/vapi_server_sdk/types/client_inbound_message_control.rb +56 -0
  125. data/lib/vapi_server_sdk/types/client_inbound_message_control_control.rb +10 -0
  126. data/lib/vapi_server_sdk/types/client_inbound_message_message.rb +109 -0
  127. data/lib/vapi_server_sdk/types/client_inbound_message_say.rb +67 -0
  128. data/lib/vapi_server_sdk/types/client_message.rb +65 -0
  129. data/lib/vapi_server_sdk/types/client_message_conversation_update.rb +79 -0
  130. data/lib/vapi_server_sdk/types/client_message_conversation_update_messages_item.rb +97 -0
  131. data/lib/vapi_server_sdk/types/client_message_hang.rb +47 -0
  132. data/lib/vapi_server_sdk/types/client_message_language_changed.rb +55 -0
  133. data/lib/vapi_server_sdk/types/client_message_message.rb +214 -0
  134. data/lib/vapi_server_sdk/types/client_message_metadata.rb +55 -0
  135. data/lib/vapi_server_sdk/types/client_message_model_output.rb +55 -0
  136. data/lib/vapi_server_sdk/types/client_message_speech_update.rb +67 -0
  137. data/lib/vapi_server_sdk/types/client_message_speech_update_role.rb +9 -0
  138. data/lib/vapi_server_sdk/types/client_message_speech_update_status.rb +9 -0
  139. data/lib/vapi_server_sdk/types/client_message_tool_calls.rb +75 -0
  140. data/lib/vapi_server_sdk/types/client_message_tool_calls_result.rb +55 -0
  141. data/lib/vapi_server_sdk/types/client_message_tool_calls_tool_with_tool_call_list_item.rb +108 -0
  142. data/lib/vapi_server_sdk/types/client_message_transcript.rb +74 -0
  143. data/lib/vapi_server_sdk/types/client_message_transcript_role.rb +9 -0
  144. data/lib/vapi_server_sdk/types/client_message_transcript_transcript_type.rb +9 -0
  145. data/lib/vapi_server_sdk/types/client_message_user_interrupted.rb +47 -0
  146. data/lib/vapi_server_sdk/types/client_message_voice_input.rb +55 -0
  147. data/lib/vapi_server_sdk/types/clone_voice_dto.rb +83 -0
  148. data/lib/vapi_server_sdk/types/condition.rb +73 -0
  149. data/lib/vapi_server_sdk/types/condition_operator.rb +13 -0
  150. data/lib/vapi_server_sdk/types/conversation_block.rb +239 -0
  151. data/lib/vapi_server_sdk/types/conversation_block_messages_item.rb +94 -0
  152. data/lib/vapi_server_sdk/types/cost_breakdown.rb +141 -0
  153. data/lib/vapi_server_sdk/types/create_anthropic_credential_dto.rb +65 -0
  154. data/lib/vapi_server_sdk/types/create_anyscale_credential_dto.rb +65 -0
  155. data/lib/vapi_server_sdk/types/create_assistant_dto.rb +529 -0
  156. data/lib/vapi_server_sdk/types/create_assistant_dto_background_sound.rb +10 -0
  157. data/lib/vapi_server_sdk/types/create_assistant_dto_client_messages_item.rb +20 -0
  158. data/lib/vapi_server_sdk/types/create_assistant_dto_first_message_mode.rb +19 -0
  159. data/lib/vapi_server_sdk/types/create_assistant_dto_model.rb +199 -0
  160. data/lib/vapi_server_sdk/types/create_assistant_dto_server_messages_item.rb +21 -0
  161. data/lib/vapi_server_sdk/types/create_assistant_dto_transcriber.rb +108 -0
  162. data/lib/vapi_server_sdk/types/create_assistant_dto_voice.rb +186 -0
  163. data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto.rb +94 -0
  164. data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +14 -0
  165. data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_region.rb +21 -0
  166. data/lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb +191 -0
  167. data/lib/vapi_server_sdk/types/create_byo_phone_number_dto_fallback_destination.rb +101 -0
  168. data/lib/vapi_server_sdk/types/create_byo_sip_trunk_credential_dto.rb +133 -0
  169. data/lib/vapi_server_sdk/types/create_cartesia_credential_dto.rb +65 -0
  170. data/lib/vapi_server_sdk/types/create_conversation_block_dto.rb +206 -0
  171. data/lib/vapi_server_sdk/types/create_conversation_block_dto_messages_item.rb +95 -0
  172. data/lib/vapi_server_sdk/types/create_custom_llm_credential_dto.rb +65 -0
  173. data/lib/vapi_server_sdk/types/create_customer_dto.rb +117 -0
  174. data/lib/vapi_server_sdk/types/create_deep_infra_credential_dto.rb +65 -0
  175. data/lib/vapi_server_sdk/types/create_deepgram_credential_dto.rb +76 -0
  176. data/lib/vapi_server_sdk/types/create_dtmf_tool_dto.rb +139 -0
  177. data/lib/vapi_server_sdk/types/create_dtmf_tool_dto_messages_item.rb +120 -0
  178. data/lib/vapi_server_sdk/types/create_eleven_labs_credential_dto.rb +65 -0
  179. data/lib/vapi_server_sdk/types/create_end_call_tool_dto.rb +139 -0
  180. data/lib/vapi_server_sdk/types/create_end_call_tool_dto_messages_item.rb +120 -0
  181. data/lib/vapi_server_sdk/types/create_function_tool_dto.rb +139 -0
  182. data/lib/vapi_server_sdk/types/create_function_tool_dto_messages_item.rb +120 -0
  183. data/lib/vapi_server_sdk/types/create_gcp_credential_dto.rb +104 -0
  184. data/lib/vapi_server_sdk/types/create_ghl_tool_dto.rb +158 -0
  185. data/lib/vapi_server_sdk/types/create_ghl_tool_dto_messages_item.rb +120 -0
  186. data/lib/vapi_server_sdk/types/create_gladia_credential_dto.rb +65 -0
  187. data/lib/vapi_server_sdk/types/create_go_high_level_credential_dto.rb +65 -0
  188. data/lib/vapi_server_sdk/types/create_groq_credential_dto.rb +65 -0
  189. data/lib/vapi_server_sdk/types/create_lmnt_credential_dto.rb +65 -0
  190. data/lib/vapi_server_sdk/types/create_make_credential_dto.rb +79 -0
  191. data/lib/vapi_server_sdk/types/create_make_tool_dto.rb +158 -0
  192. data/lib/vapi_server_sdk/types/create_make_tool_dto_messages_item.rb +120 -0
  193. data/lib/vapi_server_sdk/types/create_open_ai_credential_dto.rb +65 -0
  194. data/lib/vapi_server_sdk/types/create_open_router_credential_dto.rb +65 -0
  195. data/lib/vapi_server_sdk/types/create_org_dto.rb +129 -0
  196. data/lib/vapi_server_sdk/types/create_outbound_call_dto.rb +191 -0
  197. data/lib/vapi_server_sdk/types/create_output_tool_dto.rb +139 -0
  198. data/lib/vapi_server_sdk/types/create_output_tool_dto_messages_item.rb +120 -0
  199. data/lib/vapi_server_sdk/types/create_perplexity_ai_credential_dto.rb +65 -0
  200. data/lib/vapi_server_sdk/types/create_play_ht_credential_dto.rb +72 -0
  201. data/lib/vapi_server_sdk/types/create_rime_ai_credential_dto.rb +65 -0
  202. data/lib/vapi_server_sdk/types/create_runpod_credential_dto.rb +65 -0
  203. data/lib/vapi_server_sdk/types/create_s_3_credential_dto.rb +101 -0
  204. data/lib/vapi_server_sdk/types/create_squad_dto.rb +94 -0
  205. data/lib/vapi_server_sdk/types/create_together_ai_credential_dto.rb +65 -0
  206. data/lib/vapi_server_sdk/types/create_token_dto.rb +81 -0
  207. data/lib/vapi_server_sdk/types/create_token_dto_tag.rb +9 -0
  208. data/lib/vapi_server_sdk/types/create_tool_call_block_dto.rb +168 -0
  209. data/lib/vapi_server_sdk/types/create_tool_call_block_dto_messages_item.rb +94 -0
  210. data/lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb +161 -0
  211. data/lib/vapi_server_sdk/types/create_tool_template_dto.rb +131 -0
  212. data/lib/vapi_server_sdk/types/create_tool_template_dto_details.rb +159 -0
  213. data/lib/vapi_server_sdk/types/create_tool_template_dto_provider.rb +9 -0
  214. data/lib/vapi_server_sdk/types/create_tool_template_dto_provider_details.rb +107 -0
  215. data/lib/vapi_server_sdk/types/create_tool_template_dto_visibility.rb +8 -0
  216. data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto.rb +161 -0
  217. data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto_destinations_item.rb +121 -0
  218. data/lib/vapi_server_sdk/types/create_transfer_call_tool_dto_messages_item.rb +121 -0
  219. data/lib/vapi_server_sdk/types/create_twilio_credential_dto.rb +72 -0
  220. data/lib/vapi_server_sdk/types/create_twilio_phone_number_dto.rb +167 -0
  221. data/lib/vapi_server_sdk/types/create_twilio_phone_number_dto_fallback_destination.rb +101 -0
  222. data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb +155 -0
  223. data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto_fallback_destination.rb +101 -0
  224. data/lib/vapi_server_sdk/types/create_voicemail_tool_dto.rb +139 -0
  225. data/lib/vapi_server_sdk/types/create_voicemail_tool_dto_messages_item.rb +120 -0
  226. data/lib/vapi_server_sdk/types/create_vonage_credential_dto.rb +72 -0
  227. data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto.rb +161 -0
  228. data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto_fallback_destination.rb +101 -0
  229. data/lib/vapi_server_sdk/types/create_web_call_dto.rb +123 -0
  230. data/lib/vapi_server_sdk/types/create_workflow_block_dto.rb +154 -0
  231. data/lib/vapi_server_sdk/types/create_workflow_block_dto_messages_item.rb +94 -0
  232. data/lib/vapi_server_sdk/types/create_workflow_block_dto_steps_item.rb +94 -0
  233. data/lib/vapi_server_sdk/types/custom_llm_credential.rb +101 -0
  234. data/lib/vapi_server_sdk/types/custom_llm_model.rb +204 -0
  235. data/lib/vapi_server_sdk/types/custom_llm_model_metadata_send_mode.rb +18 -0
  236. data/lib/vapi_server_sdk/types/custom_llm_model_tools_item.rb +159 -0
  237. data/lib/vapi_server_sdk/types/deep_infra_credential.rb +101 -0
  238. data/lib/vapi_server_sdk/types/deep_infra_model.rb +169 -0
  239. data/lib/vapi_server_sdk/types/deep_infra_model_tools_item.rb +159 -0
  240. data/lib/vapi_server_sdk/types/deepgram_credential.rb +114 -0
  241. data/lib/vapi_server_sdk/types/deepgram_transcriber.rb +143 -0
  242. data/lib/vapi_server_sdk/types/deepgram_transcriber_language.rb +62 -0
  243. data/lib/vapi_server_sdk/types/deepgram_transcriber_model.rb +34 -0
  244. data/lib/vapi_server_sdk/types/deepgram_voice.rb +96 -0
  245. data/lib/vapi_server_sdk/types/deepgram_voice_id.rb +53 -0
  246. data/lib/vapi_server_sdk/types/deepgram_voice_id_enum.rb +18 -0
  247. data/lib/vapi_server_sdk/types/dtmf_tool.rb +178 -0
  248. data/lib/vapi_server_sdk/types/dtmf_tool_messages_item.rb +120 -0
  249. data/lib/vapi_server_sdk/types/eleven_labs_credential.rb +101 -0
  250. data/lib/vapi_server_sdk/types/eleven_labs_voice.rb +176 -0
  251. data/lib/vapi_server_sdk/types/eleven_labs_voice_id.rb +54 -0
  252. data/lib/vapi_server_sdk/types/eleven_labs_voice_id_enum.rb +21 -0
  253. data/lib/vapi_server_sdk/types/eleven_labs_voice_model.rb +12 -0
  254. data/lib/vapi_server_sdk/types/end_call_tool.rb +178 -0
  255. data/lib/vapi_server_sdk/types/end_call_tool_messages_item.rb +120 -0
  256. data/lib/vapi_server_sdk/types/error.rb +55 -0
  257. data/lib/vapi_server_sdk/types/exact_replacement.rb +65 -0
  258. data/lib/vapi_server_sdk/types/file.rb +185 -0
  259. data/lib/vapi_server_sdk/types/file_status.rb +8 -0
  260. data/lib/vapi_server_sdk/types/format_plan.rb +130 -0
  261. data/lib/vapi_server_sdk/types/format_plan_replacements_item.rb +94 -0
  262. data/lib/vapi_server_sdk/types/function_tool.rb +178 -0
  263. data/lib/vapi_server_sdk/types/function_tool_messages_item.rb +120 -0
  264. data/lib/vapi_server_sdk/types/function_tool_provider_details.rb +71 -0
  265. data/lib/vapi_server_sdk/types/function_tool_with_tool_call.rb +158 -0
  266. data/lib/vapi_server_sdk/types/function_tool_with_tool_call_messages_item.rb +120 -0
  267. data/lib/vapi_server_sdk/types/gcp_credential.rb +138 -0
  268. data/lib/vapi_server_sdk/types/gcp_key.rb +143 -0
  269. data/lib/vapi_server_sdk/types/ghl_tool.rb +192 -0
  270. data/lib/vapi_server_sdk/types/ghl_tool_messages_item.rb +120 -0
  271. data/lib/vapi_server_sdk/types/ghl_tool_metadata.rb +67 -0
  272. data/lib/vapi_server_sdk/types/ghl_tool_provider_details.rb +115 -0
  273. data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb +173 -0
  274. data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call_messages_item.rb +120 -0
  275. data/lib/vapi_server_sdk/types/gladia_credential.rb +101 -0
  276. data/lib/vapi_server_sdk/types/gladia_transcriber.rb +122 -0
  277. data/lib/vapi_server_sdk/types/gladia_transcriber_language.rb +108 -0
  278. data/lib/vapi_server_sdk/types/gladia_transcriber_language_behaviour.rb +9 -0
  279. data/lib/vapi_server_sdk/types/gladia_transcriber_model.rb +8 -0
  280. data/lib/vapi_server_sdk/types/go_high_level_credential.rb +101 -0
  281. data/lib/vapi_server_sdk/types/groq_credential.rb +101 -0
  282. data/lib/vapi_server_sdk/types/groq_model.rb +170 -0
  283. data/lib/vapi_server_sdk/types/groq_model_model.rb +17 -0
  284. data/lib/vapi_server_sdk/types/groq_model_tools_item.rb +159 -0
  285. data/lib/vapi_server_sdk/types/handoff_step.rb +204 -0
  286. data/lib/vapi_server_sdk/types/handoff_step_block.rb +108 -0
  287. data/lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb +167 -0
  288. data/lib/vapi_server_sdk/types/import_twilio_phone_number_dto_fallback_destination.rb +101 -0
  289. data/lib/vapi_server_sdk/types/import_vonage_phone_number_dto.rb +165 -0
  290. data/lib/vapi_server_sdk/types/import_vonage_phone_number_dto_fallback_destination.rb +101 -0
  291. data/lib/vapi_server_sdk/types/invite_user_dto.rb +66 -0
  292. data/lib/vapi_server_sdk/types/invite_user_dto_role.rb +9 -0
  293. data/lib/vapi_server_sdk/types/json_schema.rb +125 -0
  294. data/lib/vapi_server_sdk/types/json_schema_type.rb +21 -0
  295. data/lib/vapi_server_sdk/types/knowledge_base.rb +74 -0
  296. data/lib/vapi_server_sdk/types/lmnt_credential.rb +101 -0
  297. data/lib/vapi_server_sdk/types/lmnt_voice.rb +104 -0
  298. data/lib/vapi_server_sdk/types/lmnt_voice_id.rb +53 -0
  299. data/lib/vapi_server_sdk/types/lmnt_voice_id_enum.rb +8 -0
  300. data/lib/vapi_server_sdk/types/log.rb +248 -0
  301. data/lib/vapi_server_sdk/types/log_request_http_method.rb +12 -0
  302. data/lib/vapi_server_sdk/types/log_resource.rb +15 -0
  303. data/lib/vapi_server_sdk/types/log_type.rb +11 -0
  304. data/lib/vapi_server_sdk/types/logs_paginated_response.rb +75 -0
  305. data/lib/vapi_server_sdk/types/make_credential.rb +118 -0
  306. data/lib/vapi_server_sdk/types/make_tool.rb +192 -0
  307. data/lib/vapi_server_sdk/types/make_tool_messages_item.rb +120 -0
  308. data/lib/vapi_server_sdk/types/make_tool_metadata.rb +67 -0
  309. data/lib/vapi_server_sdk/types/make_tool_provider_details.rb +107 -0
  310. data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb +173 -0
  311. data/lib/vapi_server_sdk/types/make_tool_with_tool_call_messages_item.rb +120 -0
  312. data/lib/vapi_server_sdk/types/message_plan.rb +107 -0
  313. data/lib/vapi_server_sdk/types/metrics.rb +165 -0
  314. data/lib/vapi_server_sdk/types/model_based_condition.rb +117 -0
  315. data/lib/vapi_server_sdk/types/model_cost.rb +106 -0
  316. data/lib/vapi_server_sdk/types/monitor.rb +71 -0
  317. data/lib/vapi_server_sdk/types/monitor_plan.rb +85 -0
  318. data/lib/vapi_server_sdk/types/neets_voice.rb +96 -0
  319. data/lib/vapi_server_sdk/types/neets_voice_id.rb +53 -0
  320. data/lib/vapi_server_sdk/types/neets_voice_id_enum.rb +7 -0
  321. data/lib/vapi_server_sdk/types/open_ai_credential.rb +101 -0
  322. data/lib/vapi_server_sdk/types/open_ai_function.rb +96 -0
  323. data/lib/vapi_server_sdk/types/open_ai_function_parameters.rb +85 -0
  324. data/lib/vapi_server_sdk/types/open_ai_message.rb +68 -0
  325. data/lib/vapi_server_sdk/types/open_ai_message_role.rb +11 -0
  326. data/lib/vapi_server_sdk/types/open_ai_model.rb +191 -0
  327. data/lib/vapi_server_sdk/types/open_ai_model_fallback_models_item.rb +23 -0
  328. data/lib/vapi_server_sdk/types/open_ai_model_model.rb +24 -0
  329. data/lib/vapi_server_sdk/types/open_ai_model_tools_item.rb +159 -0
  330. data/lib/vapi_server_sdk/types/open_ai_voice.rb +99 -0
  331. data/lib/vapi_server_sdk/types/open_ai_voice_id.rb +13 -0
  332. data/lib/vapi_server_sdk/types/open_router_credential.rb +101 -0
  333. data/lib/vapi_server_sdk/types/open_router_model.rb +169 -0
  334. data/lib/vapi_server_sdk/types/open_router_model_tools_item.rb +159 -0
  335. data/lib/vapi_server_sdk/types/org.rb +212 -0
  336. data/lib/vapi_server_sdk/types/org_plan.rb +79 -0
  337. data/lib/vapi_server_sdk/types/output_tool.rb +178 -0
  338. data/lib/vapi_server_sdk/types/output_tool_messages_item.rb +120 -0
  339. data/lib/vapi_server_sdk/types/pagination_meta.rb +72 -0
  340. data/lib/vapi_server_sdk/types/perplexity_ai_credential.rb +101 -0
  341. data/lib/vapi_server_sdk/types/perplexity_ai_model.rb +169 -0
  342. data/lib/vapi_server_sdk/types/perplexity_ai_model_tools_item.rb +159 -0
  343. data/lib/vapi_server_sdk/types/play_ht_credential.rb +109 -0
  344. data/lib/vapi_server_sdk/types/play_ht_voice.rb +166 -0
  345. data/lib/vapi_server_sdk/types/play_ht_voice_emotion.rb +19 -0
  346. data/lib/vapi_server_sdk/types/play_ht_voice_id.rb +53 -0
  347. data/lib/vapi_server_sdk/types/play_ht_voice_id_enum.rb +16 -0
  348. data/lib/vapi_server_sdk/types/punctuation_boundary.rb +21 -0
  349. data/lib/vapi_server_sdk/types/regex_option.rb +74 -0
  350. data/lib/vapi_server_sdk/types/regex_option_type.rb +13 -0
  351. data/lib/vapi_server_sdk/types/regex_replacement.rb +82 -0
  352. data/lib/vapi_server_sdk/types/rime_ai_credential.rb +101 -0
  353. data/lib/vapi_server_sdk/types/rime_ai_voice.rb +114 -0
  354. data/lib/vapi_server_sdk/types/rime_ai_voice_id.rb +53 -0
  355. data/lib/vapi_server_sdk/types/rime_ai_voice_id_enum.rb +87 -0
  356. data/lib/vapi_server_sdk/types/rime_ai_voice_model.rb +9 -0
  357. data/lib/vapi_server_sdk/types/rule_based_condition.rb +195 -0
  358. data/lib/vapi_server_sdk/types/rule_based_condition_operator.rb +14 -0
  359. data/lib/vapi_server_sdk/types/runpod_credential.rb +101 -0
  360. data/lib/vapi_server_sdk/types/s_3_credential.rb +134 -0
  361. data/lib/vapi_server_sdk/types/sbc_configuration.rb +47 -0
  362. data/lib/vapi_server_sdk/types/server.rb +82 -0
  363. data/lib/vapi_server_sdk/types/server_message.rb +77 -0
  364. data/lib/vapi_server_sdk/types/server_message_assistant_request.rb +169 -0
  365. data/lib/vapi_server_sdk/types/server_message_assistant_request_phone_number.rb +125 -0
  366. data/lib/vapi_server_sdk/types/server_message_conversation_update.rb +197 -0
  367. data/lib/vapi_server_sdk/types/server_message_conversation_update_messages_item.rb +97 -0
  368. data/lib/vapi_server_sdk/types/server_message_conversation_update_phone_number.rb +125 -0
  369. data/lib/vapi_server_sdk/types/server_message_end_of_call_report.rb +241 -0
  370. data/lib/vapi_server_sdk/types/server_message_end_of_call_report_costs_item.rb +147 -0
  371. data/lib/vapi_server_sdk/types/server_message_end_of_call_report_ended_reason.rb +176 -0
  372. data/lib/vapi_server_sdk/types/server_message_end_of_call_report_phone_number.rb +125 -0
  373. data/lib/vapi_server_sdk/types/server_message_hang.rb +169 -0
  374. data/lib/vapi_server_sdk/types/server_message_hang_phone_number.rb +124 -0
  375. data/lib/vapi_server_sdk/types/server_message_language_changed.rb +177 -0
  376. data/lib/vapi_server_sdk/types/server_message_language_changed_phone_number.rb +125 -0
  377. data/lib/vapi_server_sdk/types/server_message_message.rb +285 -0
  378. data/lib/vapi_server_sdk/types/server_message_model_output.rb +177 -0
  379. data/lib/vapi_server_sdk/types/server_message_model_output_phone_number.rb +124 -0
  380. data/lib/vapi_server_sdk/types/server_message_phone_call_control.rb +192 -0
  381. data/lib/vapi_server_sdk/types/server_message_phone_call_control_destination.rb +96 -0
  382. data/lib/vapi_server_sdk/types/server_message_phone_call_control_phone_number.rb +125 -0
  383. data/lib/vapi_server_sdk/types/server_message_phone_call_control_request.rb +9 -0
  384. data/lib/vapi_server_sdk/types/server_message_response.rb +65 -0
  385. data/lib/vapi_server_sdk/types/server_message_response_assistant_request.rb +162 -0
  386. data/lib/vapi_server_sdk/types/server_message_response_assistant_request_destination.rb +98 -0
  387. data/lib/vapi_server_sdk/types/server_message_response_message_response.rb +85 -0
  388. data/lib/vapi_server_sdk/types/server_message_response_tool_calls.rb +71 -0
  389. data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request.rb +75 -0
  390. data/lib/vapi_server_sdk/types/server_message_response_transfer_destination_request_destination.rb +122 -0
  391. data/lib/vapi_server_sdk/types/server_message_response_voice_request.rb +97 -0
  392. data/lib/vapi_server_sdk/types/server_message_speech_update.rb +187 -0
  393. data/lib/vapi_server_sdk/types/server_message_speech_update_phone_number.rb +124 -0
  394. data/lib/vapi_server_sdk/types/server_message_speech_update_role.rb +9 -0
  395. data/lib/vapi_server_sdk/types/server_message_speech_update_status.rb +9 -0
  396. data/lib/vapi_server_sdk/types/server_message_status_update.rb +255 -0
  397. data/lib/vapi_server_sdk/types/server_message_status_update_destination.rb +96 -0
  398. data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb +175 -0
  399. data/lib/vapi_server_sdk/types/server_message_status_update_messages_item.rb +97 -0
  400. data/lib/vapi_server_sdk/types/server_message_status_update_phone_number.rb +124 -0
  401. data/lib/vapi_server_sdk/types/server_message_status_update_status.rb +12 -0
  402. data/lib/vapi_server_sdk/types/server_message_tool_calls.rb +195 -0
  403. data/lib/vapi_server_sdk/types/server_message_tool_calls_phone_number.rb +124 -0
  404. data/lib/vapi_server_sdk/types/server_message_tool_calls_tool_with_tool_call_list_item.rb +108 -0
  405. data/lib/vapi_server_sdk/types/server_message_transcript.rb +195 -0
  406. data/lib/vapi_server_sdk/types/server_message_transcript_phone_number.rb +124 -0
  407. data/lib/vapi_server_sdk/types/server_message_transcript_role.rb +9 -0
  408. data/lib/vapi_server_sdk/types/server_message_transcript_transcript_type.rb +9 -0
  409. data/lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb +171 -0
  410. data/lib/vapi_server_sdk/types/server_message_transfer_destination_request_phone_number.rb +125 -0
  411. data/lib/vapi_server_sdk/types/server_message_transfer_update.rb +213 -0
  412. data/lib/vapi_server_sdk/types/server_message_transfer_update_destination.rb +122 -0
  413. data/lib/vapi_server_sdk/types/server_message_transfer_update_phone_number.rb +125 -0
  414. data/lib/vapi_server_sdk/types/server_message_user_interrupted.rb +169 -0
  415. data/lib/vapi_server_sdk/types/server_message_user_interrupted_phone_number.rb +125 -0
  416. data/lib/vapi_server_sdk/types/server_message_voice_input.rb +177 -0
  417. data/lib/vapi_server_sdk/types/server_message_voice_input_phone_number.rb +124 -0
  418. data/lib/vapi_server_sdk/types/server_message_voice_request.rb +185 -0
  419. data/lib/vapi_server_sdk/types/server_message_voice_request_phone_number.rb +124 -0
  420. data/lib/vapi_server_sdk/types/sip_trunk_gateway.rb +138 -0
  421. data/lib/vapi_server_sdk/types/sip_trunk_gateway_outbound_protocol.rb +12 -0
  422. data/lib/vapi_server_sdk/types/sip_trunk_outbound_authentication_plan.rb +86 -0
  423. data/lib/vapi_server_sdk/types/sip_trunk_outbound_sip_register_plan.rb +74 -0
  424. data/lib/vapi_server_sdk/types/squad.rb +132 -0
  425. data/lib/vapi_server_sdk/types/squad_member_dto.rb +113 -0
  426. data/lib/vapi_server_sdk/types/start_speaking_plan.rb +119 -0
  427. data/lib/vapi_server_sdk/types/step_destination.rb +82 -0
  428. data/lib/vapi_server_sdk/types/step_destination_conditions_item.rb +94 -0
  429. data/lib/vapi_server_sdk/types/stop_speaking_plan.rb +120 -0
  430. data/lib/vapi_server_sdk/types/structured_data_plan.rb +140 -0
  431. data/lib/vapi_server_sdk/types/success_evaluation_plan.rb +161 -0
  432. data/lib/vapi_server_sdk/types/success_evaluation_plan_rubric.rb +29 -0
  433. data/lib/vapi_server_sdk/types/summary_plan.rb +110 -0
  434. data/lib/vapi_server_sdk/types/sync_voice_library_dto.rb +58 -0
  435. data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb +16 -0
  436. data/lib/vapi_server_sdk/types/system_message.rb +79 -0
  437. data/lib/vapi_server_sdk/types/talkscriber_transcriber.rb +72 -0
  438. data/lib/vapi_server_sdk/types/talkscriber_transcriber_language.rb +109 -0
  439. data/lib/vapi_server_sdk/types/template.rb +164 -0
  440. data/lib/vapi_server_sdk/types/template_details.rb +159 -0
  441. data/lib/vapi_server_sdk/types/template_provider.rb +9 -0
  442. data/lib/vapi_server_sdk/types/template_provider_details.rb +107 -0
  443. data/lib/vapi_server_sdk/types/template_visibility.rb +8 -0
  444. data/lib/vapi_server_sdk/types/time_range.rb +91 -0
  445. data/lib/vapi_server_sdk/types/time_range_step.rb +18 -0
  446. data/lib/vapi_server_sdk/types/together_ai_credential.rb +101 -0
  447. data/lib/vapi_server_sdk/types/together_ai_model.rb +169 -0
  448. data/lib/vapi_server_sdk/types/together_ai_model_tools_item.rb +159 -0
  449. data/lib/vapi_server_sdk/types/token.rb +127 -0
  450. data/lib/vapi_server_sdk/types/token_restrictions.rb +103 -0
  451. data/lib/vapi_server_sdk/types/token_tag.rb +9 -0
  452. data/lib/vapi_server_sdk/types/tool_call.rb +78 -0
  453. data/lib/vapi_server_sdk/types/tool_call_block.rb +201 -0
  454. data/lib/vapi_server_sdk/types/tool_call_block_messages_item.rb +94 -0
  455. data/lib/vapi_server_sdk/types/tool_call_block_tool.rb +161 -0
  456. data/lib/vapi_server_sdk/types/tool_call_function.rb +65 -0
  457. data/lib/vapi_server_sdk/types/tool_call_message.rb +92 -0
  458. data/lib/vapi_server_sdk/types/tool_call_result.rb +126 -0
  459. data/lib/vapi_server_sdk/types/tool_call_result_message.rb +100 -0
  460. data/lib/vapi_server_sdk/types/tool_call_result_message_item.rb +94 -0
  461. data/lib/vapi_server_sdk/types/tool_message_complete.rb +130 -0
  462. data/lib/vapi_server_sdk/types/tool_message_complete_role.rb +24 -0
  463. data/lib/vapi_server_sdk/types/tool_message_delayed.rb +86 -0
  464. data/lib/vapi_server_sdk/types/tool_message_failed.rb +88 -0
  465. data/lib/vapi_server_sdk/types/tool_message_start.rb +73 -0
  466. data/lib/vapi_server_sdk/types/tool_template_metadata.rb +78 -0
  467. data/lib/vapi_server_sdk/types/tool_template_setup.rb +86 -0
  468. data/lib/vapi_server_sdk/types/transcriber_cost.rb +90 -0
  469. data/lib/vapi_server_sdk/types/transcript_plan.rb +122 -0
  470. data/lib/vapi_server_sdk/types/transcription_endpointing_plan.rb +109 -0
  471. data/lib/vapi_server_sdk/types/transfer_call_tool.rb +194 -0
  472. data/lib/vapi_server_sdk/types/transfer_call_tool_destinations_item.rb +120 -0
  473. data/lib/vapi_server_sdk/types/transfer_call_tool_messages_item.rb +120 -0
  474. data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb +181 -0
  475. data/lib/vapi_server_sdk/types/transfer_destination_number.rb +163 -0
  476. data/lib/vapi_server_sdk/types/transfer_destination_sip.rb +90 -0
  477. data/lib/vapi_server_sdk/types/transfer_destination_step.rb +90 -0
  478. data/lib/vapi_server_sdk/types/transfer_mode.rb +8 -0
  479. data/lib/vapi_server_sdk/types/transport_configuration_twilio.rb +125 -0
  480. data/lib/vapi_server_sdk/types/transport_configuration_twilio_recording_channels.rb +16 -0
  481. data/lib/vapi_server_sdk/types/transport_cost.rb +67 -0
  482. data/lib/vapi_server_sdk/types/twilio_credential.rb +110 -0
  483. data/lib/vapi_server_sdk/types/twilio_phone_number.rb +200 -0
  484. data/lib/vapi_server_sdk/types/twilio_phone_number_fallback_destination.rb +100 -0
  485. data/lib/vapi_server_sdk/types/twilio_voicemail_detection.rb +248 -0
  486. data/lib/vapi_server_sdk/types/twilio_voicemail_detection_voicemail_detection_types_item.rb +13 -0
  487. data/lib/vapi_server_sdk/types/update_anthropic_credential_dto.rb +65 -0
  488. data/lib/vapi_server_sdk/types/update_anyscale_credential_dto.rb +65 -0
  489. data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto.rb +94 -0
  490. data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +14 -0
  491. data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb +21 -0
  492. data/lib/vapi_server_sdk/types/update_byo_sip_trunk_credential_dto.rb +133 -0
  493. data/lib/vapi_server_sdk/types/update_cartesia_credential_dto.rb +65 -0
  494. data/lib/vapi_server_sdk/types/update_custom_llm_credential_dto.rb +65 -0
  495. data/lib/vapi_server_sdk/types/update_deep_infra_credential_dto.rb +65 -0
  496. data/lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb +76 -0
  497. data/lib/vapi_server_sdk/types/update_eleven_labs_credential_dto.rb +65 -0
  498. data/lib/vapi_server_sdk/types/update_gcp_credential_dto.rb +104 -0
  499. data/lib/vapi_server_sdk/types/update_gladia_credential_dto.rb +65 -0
  500. data/lib/vapi_server_sdk/types/update_go_high_level_credential_dto.rb +65 -0
  501. data/lib/vapi_server_sdk/types/update_groq_credential_dto.rb +65 -0
  502. data/lib/vapi_server_sdk/types/update_lmnt_credential_dto.rb +65 -0
  503. data/lib/vapi_server_sdk/types/update_make_credential_dto.rb +79 -0
  504. data/lib/vapi_server_sdk/types/update_open_ai_credential_dto.rb +65 -0
  505. data/lib/vapi_server_sdk/types/update_open_router_credential_dto.rb +65 -0
  506. data/lib/vapi_server_sdk/types/update_org_dto.rb +129 -0
  507. data/lib/vapi_server_sdk/types/update_perplexity_ai_credential_dto.rb +65 -0
  508. data/lib/vapi_server_sdk/types/update_play_ht_credential_dto.rb +72 -0
  509. data/lib/vapi_server_sdk/types/update_rime_ai_credential_dto.rb +65 -0
  510. data/lib/vapi_server_sdk/types/update_runpod_credential_dto.rb +65 -0
  511. data/lib/vapi_server_sdk/types/update_s_3_credential_dto.rb +101 -0
  512. data/lib/vapi_server_sdk/types/update_together_ai_credential_dto.rb +65 -0
  513. data/lib/vapi_server_sdk/types/update_tool_template_dto.rb +131 -0
  514. data/lib/vapi_server_sdk/types/update_tool_template_dto_details.rb +159 -0
  515. data/lib/vapi_server_sdk/types/update_tool_template_dto_provider.rb +9 -0
  516. data/lib/vapi_server_sdk/types/update_tool_template_dto_provider_details.rb +107 -0
  517. data/lib/vapi_server_sdk/types/update_tool_template_dto_visibility.rb +8 -0
  518. data/lib/vapi_server_sdk/types/update_twilio_credential_dto.rb +72 -0
  519. data/lib/vapi_server_sdk/types/update_user_role_dto.rb +66 -0
  520. data/lib/vapi_server_sdk/types/update_user_role_dto_role.rb +9 -0
  521. data/lib/vapi_server_sdk/types/update_vonage_credential_dto.rb +72 -0
  522. data/lib/vapi_server_sdk/types/user.rb +95 -0
  523. data/lib/vapi_server_sdk/types/user_message.rb +102 -0
  524. data/lib/vapi_server_sdk/types/vapi_cost.rb +67 -0
  525. data/lib/vapi_server_sdk/types/vapi_model.rb +181 -0
  526. data/lib/vapi_server_sdk/types/vapi_model_steps_item.rb +94 -0
  527. data/lib/vapi_server_sdk/types/vapi_model_tools_item.rb +159 -0
  528. data/lib/vapi_server_sdk/types/vapi_phone_number.rb +188 -0
  529. data/lib/vapi_server_sdk/types/vapi_phone_number_fallback_destination.rb +100 -0
  530. data/lib/vapi_server_sdk/types/voice_cost.rb +90 -0
  531. data/lib/vapi_server_sdk/types/voice_library.rb +209 -0
  532. data/lib/vapi_server_sdk/types/voice_library_gender.rb +9 -0
  533. data/lib/vapi_server_sdk/types/voice_library_voice_response.rb +111 -0
  534. data/lib/vapi_server_sdk/types/vonage_credential.rb +128 -0
  535. data/lib/vapi_server_sdk/types/vonage_phone_number.rb +194 -0
  536. data/lib/vapi_server_sdk/types/vonage_phone_number_fallback_destination.rb +100 -0
  537. data/lib/vapi_server_sdk/types/workflow_block.rb +187 -0
  538. data/lib/vapi_server_sdk/types/workflow_block_messages_item.rb +94 -0
  539. data/lib/vapi_server_sdk/types/workflow_block_steps_item.rb +94 -0
  540. data/lib/vapi_server_sdk.rb +110 -0
  541. metadata +697 -0
@@ -0,0 +1,949 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../requests"
4
+ require "date"
5
+ require_relative "../types/assistant"
6
+ require "json"
7
+ require_relative "../types/create_assistant_dto"
8
+ require_relative "types/update_assistant_dto_transcriber"
9
+ require_relative "types/update_assistant_dto_model"
10
+ require_relative "types/update_assistant_dto_voice"
11
+ require_relative "types/update_assistant_dto_first_message_mode"
12
+ require_relative "types/update_assistant_dto_client_messages_item"
13
+ require_relative "types/update_assistant_dto_server_messages_item"
14
+ require_relative "types/update_assistant_dto_background_sound"
15
+ require_relative "../types/transport_configuration_twilio"
16
+ require_relative "../types/twilio_voicemail_detection"
17
+ require_relative "../types/analysis_plan"
18
+ require_relative "../types/artifact_plan"
19
+ require_relative "../types/message_plan"
20
+ require_relative "../types/start_speaking_plan"
21
+ require_relative "../types/stop_speaking_plan"
22
+ require_relative "../types/monitor_plan"
23
+ require "async"
24
+
25
+ module Vapi
26
+ class AssistantsClient
27
+ # @return [Vapi::RequestClient]
28
+ attr_reader :request_client
29
+
30
+ # @param request_client [Vapi::RequestClient]
31
+ # @return [Vapi::AssistantsClient]
32
+ def initialize(request_client:)
33
+ @request_client = request_client
34
+ end
35
+
36
+ # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
37
+ # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
38
+ # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
39
+ # @param created_at_ge [DateTime] This will return items where the createdAt is greater than or equal to the
40
+ # specified value.
41
+ # @param created_at_le [DateTime] This will return items where the createdAt is less than or equal to the
42
+ # specified value.
43
+ # @param updated_at_gt [DateTime] This will return items where the updatedAt is greater than the specified value.
44
+ # @param updated_at_lt [DateTime] This will return items where the updatedAt is less than the specified value.
45
+ # @param updated_at_ge [DateTime] This will return items where the updatedAt is greater than or equal to the
46
+ # specified value.
47
+ # @param updated_at_le [DateTime] This will return items where the updatedAt is less than or equal to the
48
+ # specified value.
49
+ # @param request_options [Vapi::RequestOptions]
50
+ # @return [Array<Vapi::Assistant>]
51
+ # @example
52
+ # api = Vapi::Client.new(
53
+ # base_url: "https://api.example.com",
54
+ # environment: Vapi::Environment::DEFAULT,
55
+ # token: "YOUR_AUTH_TOKEN"
56
+ # )
57
+ # api.assistants.list
58
+ def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
59
+ updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
60
+ response = @request_client.conn.get do |req|
61
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
62
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
63
+ req.headers = {
64
+ **(req.headers || {}),
65
+ **@request_client.get_headers,
66
+ **(request_options&.additional_headers || {})
67
+ }.compact
68
+ req.params = {
69
+ **(request_options&.additional_query_parameters || {}),
70
+ "limit": limit,
71
+ "createdAtGt": created_at_gt,
72
+ "createdAtLt": created_at_lt,
73
+ "createdAtGe": created_at_ge,
74
+ "createdAtLe": created_at_le,
75
+ "updatedAtGt": updated_at_gt,
76
+ "updatedAtLt": updated_at_lt,
77
+ "updatedAtGe": updated_at_ge,
78
+ "updatedAtLe": updated_at_le
79
+ }.compact
80
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
81
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
82
+ end
83
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant"
84
+ end
85
+ parsed_json = JSON.parse(response.body)
86
+ parsed_json&.map do |item|
87
+ item = item.to_json
88
+ Vapi::Assistant.from_json(json_object: item)
89
+ end
90
+ end
91
+
92
+ # @param request [Hash] Request of type Vapi::CreateAssistantDto, as a Hash
93
+ # * :transcriber (Hash)
94
+ # * :model (Hash)
95
+ # * :voice (Hash)
96
+ # * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
97
+ # * :hipaa_enabled (Boolean)
98
+ # * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
99
+ # * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
100
+ # * :silence_timeout_seconds (Float)
101
+ # * :max_duration_seconds (Float)
102
+ # * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
103
+ # * :backchanneling_enabled (Boolean)
104
+ # * :background_denoising_enabled (Boolean)
105
+ # * :model_output_in_messages_enabled (Boolean)
106
+ # * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
107
+ # * :name (String)
108
+ # * :first_message (String)
109
+ # * :voicemail_detection (Hash)
110
+ # * :provider (String)
111
+ # * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
112
+ # * :enabled (Boolean)
113
+ # * :machine_detection_timeout (Float)
114
+ # * :machine_detection_speech_threshold (Float)
115
+ # * :machine_detection_speech_end_threshold (Float)
116
+ # * :machine_detection_silence_timeout (Float)
117
+ # * :voicemail_message (String)
118
+ # * :end_call_message (String)
119
+ # * :end_call_phrases (Array<String>)
120
+ # * :metadata (Hash{String => Object})
121
+ # * :server_url (String)
122
+ # * :server_url_secret (String)
123
+ # * :analysis_plan (Hash)
124
+ # * :summary_plan (Hash)
125
+ # * :messages (Array<Hash{String => Object}>)
126
+ # * :enabled (Boolean)
127
+ # * :timeout_seconds (Float)
128
+ # * :structured_data_plan (Hash)
129
+ # * :messages (Array<Hash{String => Object}>)
130
+ # * :enabled (Boolean)
131
+ # * :schema (Hash)
132
+ # * :type (Vapi::JsonSchemaType)
133
+ # * :items (Hash{String => Object})
134
+ # * :properties (Hash{String => Object})
135
+ # * :description (String)
136
+ # * :required (Array<String>)
137
+ # * :timeout_seconds (Float)
138
+ # * :success_evaluation_plan (Hash)
139
+ # * :rubric (Vapi::SuccessEvaluationPlanRubric)
140
+ # * :messages (Array<Hash{String => Object}>)
141
+ # * :enabled (Boolean)
142
+ # * :timeout_seconds (Float)
143
+ # * :artifact_plan (Hash)
144
+ # * :recording_enabled (Boolean)
145
+ # * :video_recording_enabled (Boolean)
146
+ # * :transcript_plan (Hash)
147
+ # * :enabled (Boolean)
148
+ # * :assistant_name (String)
149
+ # * :user_name (String)
150
+ # * :recording_path (String)
151
+ # * :message_plan (Hash)
152
+ # * :idle_messages (Array<String>)
153
+ # * :idle_message_max_spoken_count (Float)
154
+ # * :idle_timeout_seconds (Float)
155
+ # * :start_speaking_plan (Hash)
156
+ # * :wait_seconds (Float)
157
+ # * :smart_endpointing_enabled (Boolean)
158
+ # * :transcription_endpointing_plan (Hash)
159
+ # * :on_punctuation_seconds (Float)
160
+ # * :on_no_punctuation_seconds (Float)
161
+ # * :on_number_seconds (Float)
162
+ # * :stop_speaking_plan (Hash)
163
+ # * :num_words (Float)
164
+ # * :voice_seconds (Float)
165
+ # * :backoff_seconds (Float)
166
+ # * :monitor_plan (Hash)
167
+ # * :listen_enabled (Boolean)
168
+ # * :control_enabled (Boolean)
169
+ # * :credential_ids (Array<String>)
170
+ # @param request_options [Vapi::RequestOptions]
171
+ # @return [Vapi::Assistant]
172
+ # @example
173
+ # api = Vapi::Client.new(
174
+ # base_url: "https://api.example.com",
175
+ # environment: Vapi::Environment::DEFAULT,
176
+ # token: "YOUR_AUTH_TOKEN"
177
+ # )
178
+ # api.assistants.create(request: { })
179
+ def create(request:, request_options: nil)
180
+ response = @request_client.conn.post do |req|
181
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
182
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
183
+ req.headers = {
184
+ **(req.headers || {}),
185
+ **@request_client.get_headers,
186
+ **(request_options&.additional_headers || {})
187
+ }.compact
188
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
189
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
190
+ end
191
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
192
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant"
193
+ end
194
+ Vapi::Assistant.from_json(json_object: response.body)
195
+ end
196
+
197
+ # @param id [String]
198
+ # @param request_options [Vapi::RequestOptions]
199
+ # @return [Vapi::Assistant]
200
+ # @example
201
+ # api = Vapi::Client.new(
202
+ # base_url: "https://api.example.com",
203
+ # environment: Vapi::Environment::DEFAULT,
204
+ # token: "YOUR_AUTH_TOKEN"
205
+ # )
206
+ # api.assistants.get(id: "id")
207
+ def get(id:, request_options: nil)
208
+ response = @request_client.conn.get do |req|
209
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
210
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
211
+ req.headers = {
212
+ **(req.headers || {}),
213
+ **@request_client.get_headers,
214
+ **(request_options&.additional_headers || {})
215
+ }.compact
216
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
217
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
218
+ end
219
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
220
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
221
+ end
222
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
223
+ end
224
+ Vapi::Assistant.from_json(json_object: response.body)
225
+ end
226
+
227
+ # @param id [String]
228
+ # @param request_options [Vapi::RequestOptions]
229
+ # @return [Vapi::Assistant]
230
+ # @example
231
+ # api = Vapi::Client.new(
232
+ # base_url: "https://api.example.com",
233
+ # environment: Vapi::Environment::DEFAULT,
234
+ # token: "YOUR_AUTH_TOKEN"
235
+ # )
236
+ # api.assistants.delete(id: "id")
237
+ def delete(id:, request_options: nil)
238
+ response = @request_client.conn.delete do |req|
239
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
240
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
241
+ req.headers = {
242
+ **(req.headers || {}),
243
+ **@request_client.get_headers,
244
+ **(request_options&.additional_headers || {})
245
+ }.compact
246
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
247
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
248
+ end
249
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
250
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
251
+ end
252
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
253
+ end
254
+ Vapi::Assistant.from_json(json_object: response.body)
255
+ end
256
+
257
+ # @param id [String]
258
+ # @param transcriber [Vapi::Assistants::UpdateAssistantDtoTranscriber] These are the options for the assistant's transcriber.
259
+ # @param model [Vapi::Assistants::UpdateAssistantDtoModel] These are the options for the assistant's LLM.
260
+ # @param voice [Vapi::Assistants::UpdateAssistantDtoVoice] These are the options for the assistant's voice.
261
+ # @param first_message_mode [Vapi::Assistants::UpdateAssistantDtoFirstMessageMode] This is the mode for the first message. Default is 'assistant-speaks-first'.
262
+ # Use:
263
+ # - 'assistant-speaks-first' to have the assistant speak first.
264
+ # - 'assistant-waits-for-user' to have the assistant wait for the user to speak
265
+ # first.
266
+ # - 'assistant-speaks-first-with-model-generated-message' to have the assistant
267
+ # speak first with a message generated by the model based on the conversation
268
+ # state. (`assistant.model.messages` at call start, `call.messages` at squad
269
+ # transfer points).
270
+ # @default 'assistant-speaks-first'
271
+ # @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
272
+ # the end of the call, you will still receive an end-of-call-report message to
273
+ # store on your server. Defaults to false.
274
+ # @param client_messages [Array<Vapi::Assistants::UpdateAssistantDtoClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
275
+ # ,speech-update,status-update,transcript,tool-calls,user-interrupted,voice-input.
276
+ # You can check the shape of the messages in ClientMessage schema.
277
+ # @param server_messages [Array<Vapi::Assistants::UpdateAssistantDtoServerMessagesItem>] These are the messages that will be sent to your Server URL. Default is
278
+ # h-update,status-update,tool-calls,transfer-destination-request,user-interrupted.
279
+ # You can check the shape of the messages in ServerMessage schema.
280
+ # @param silence_timeout_seconds [Float] How many seconds of silence to wait before ending the call. Defaults to 30.
281
+ # @default 30
282
+ # @param max_duration_seconds [Float] This is the maximum number of seconds that the call will last. When the call
283
+ # reaches this duration, it will be ended.
284
+ # @default 600 (10 minutes)
285
+ # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSound] This is the background sound in the call. Default for phone calls is 'office'
286
+ # and default for web calls is 'off'.
287
+ # @param backchanneling_enabled [Boolean] This determines whether the model says 'mhmm', 'ahem' etc. while user is
288
+ # speaking.
289
+ # Default `false` while in beta.
290
+ # @default false
291
+ # @param background_denoising_enabled [Boolean] This enables filtering of noise and background speech while the user is talking.
292
+ # Default `false` while in beta.
293
+ # @default false
294
+ # @param model_output_in_messages_enabled [Boolean] This determines whether the model's output is used in conversation history
295
+ # rather than the transcription of assistant's speech.
296
+ # Default `false` while in beta.
297
+ # @default false
298
+ # @param transport_configurations [Array<Hash>] These are the configurations to be passed to the transport providers of
299
+ # assistant's calls, like Twilio. You can store multiple configurations for
300
+ # different transport providers. For a call, only the configuration matching the
301
+ # call transport provider is used.Request of type Array<Vapi::TransportConfigurationTwilio>, as a Hash
302
+ # * :provider (String)
303
+ # * :timeout (Float)
304
+ # * :record (Boolean)
305
+ # * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
306
+ # @param name [String] This is the name of the assistant.
307
+ # This is required when you want to transfer between assistants in a call.
308
+ # @param first_message [String] This is the first message that the assistant will say. This can also be a URL to
309
+ # a containerized audio file (mp3, wav, etc.).
310
+ # If unspecified, assistant will wait for user to speak and use the model to
311
+ # respond once they speak.
312
+ # @param voicemail_detection [Hash] These are the settings to configure or disable voicemail detection.
313
+ # Alternatively, voicemail detection can be configured using the
314
+ # model.tools=[VoicemailTool].
315
+ # This uses Twilio's built-in detection while the VoicemailTool relies on the
316
+ # model to detect if a voicemail was reached.
317
+ # You can use neither of them, one of them, or both of them. By default, Twilio
318
+ # built-in detection is enabled while VoicemailTool is not.Request of type Vapi::TwilioVoicemailDetection, as a Hash
319
+ # * :provider (String)
320
+ # * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
321
+ # * :enabled (Boolean)
322
+ # * :machine_detection_timeout (Float)
323
+ # * :machine_detection_speech_threshold (Float)
324
+ # * :machine_detection_speech_end_threshold (Float)
325
+ # * :machine_detection_silence_timeout (Float)
326
+ # @param voicemail_message [String] This is the message that the assistant will say if the call is forwarded to
327
+ # voicemail.
328
+ # If unspecified, it will hang up.
329
+ # @param end_call_message [String] This is the message that the assistant will say if it ends the call.
330
+ # If unspecified, it will hang up without saying anything.
331
+ # @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
332
+ # call to be hung up. Case insensitive.
333
+ # @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
334
+ # @param server_url [String] This is the URL Vapi will communicate with via HTTP GET and POST Requests. This
335
+ # is used for retrieving context, function calling, and end-of-call reports.
336
+ # All requests will be sent with the call object among other things relevant to
337
+ # that message. You can find more details in the Server URL documentation.
338
+ # This overrides the serverUrl set on the org and the phoneNumber. Order of
339
+ # precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl >
340
+ # org.serverUrl
341
+ # @param server_url_secret [String] This is the secret you can set that Vapi will send with every request to your
342
+ # server. Will be sent as a header called x-vapi-secret.
343
+ # Same precedence logic as serverUrl.
344
+ # @param analysis_plan [Hash] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.Request of type Vapi::AnalysisPlan, as a Hash
345
+ # * :summary_plan (Hash)
346
+ # * :messages (Array<Hash{String => Object}>)
347
+ # * :enabled (Boolean)
348
+ # * :timeout_seconds (Float)
349
+ # * :structured_data_plan (Hash)
350
+ # * :messages (Array<Hash{String => Object}>)
351
+ # * :enabled (Boolean)
352
+ # * :schema (Hash)
353
+ # * :type (Vapi::JsonSchemaType)
354
+ # * :items (Hash{String => Object})
355
+ # * :properties (Hash{String => Object})
356
+ # * :description (String)
357
+ # * :required (Array<String>)
358
+ # * :timeout_seconds (Float)
359
+ # * :success_evaluation_plan (Hash)
360
+ # * :rubric (Vapi::SuccessEvaluationPlanRubric)
361
+ # * :messages (Array<Hash{String => Object}>)
362
+ # * :enabled (Boolean)
363
+ # * :timeout_seconds (Float)
364
+ # @param artifact_plan [Hash] This is the plan for artifacts generated during assistant's calls. Stored in
365
+ # `call.artifact`.
366
+ # Note: `recordingEnabled` is currently at the root level. It will be moved to
367
+ # `artifactPlan` in the future, but will remain backwards compatible.Request of type Vapi::ArtifactPlan, as a Hash
368
+ # * :recording_enabled (Boolean)
369
+ # * :video_recording_enabled (Boolean)
370
+ # * :transcript_plan (Hash)
371
+ # * :enabled (Boolean)
372
+ # * :assistant_name (String)
373
+ # * :user_name (String)
374
+ # * :recording_path (String)
375
+ # @param message_plan [Hash] This is the plan for static predefined messages that can be spoken by the
376
+ # assistant during the call, like `idleMessages`.
377
+ # Note: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at
378
+ # the root level. They will be moved to `messagePlan` in the future, but will
379
+ # remain backwards compatible.Request of type Vapi::MessagePlan, as a Hash
380
+ # * :idle_messages (Array<String>)
381
+ # * :idle_message_max_spoken_count (Float)
382
+ # * :idle_timeout_seconds (Float)
383
+ # @param start_speaking_plan [Hash] This is the plan for when the assistant should start talking.
384
+ # You should configure this if you're running into these issues:
385
+ # - The assistant is too slow to start talking after the customer is done
386
+ # speaking.
387
+ # - The assistant is too fast to start talking after the customer is done
388
+ # speaking.
389
+ # - The assistant is so fast that it's actually interrupting the customer.Request of type Vapi::StartSpeakingPlan, as a Hash
390
+ # * :wait_seconds (Float)
391
+ # * :smart_endpointing_enabled (Boolean)
392
+ # * :transcription_endpointing_plan (Hash)
393
+ # * :on_punctuation_seconds (Float)
394
+ # * :on_no_punctuation_seconds (Float)
395
+ # * :on_number_seconds (Float)
396
+ # @param stop_speaking_plan [Hash] This is the plan for when assistant should stop talking on customer
397
+ # interruption.
398
+ # You should configure this if you're running into these issues:
399
+ # - The assistant is too slow to recognize customer's interruption.
400
+ # - The assistant is too fast to recognize customer's interruption.
401
+ # - The assistant is getting interrupted by phrases that are just acknowledgments.
402
+ # - The assistant is getting interrupted by background noises.
403
+ # - The assistant is not properly stopping -- it starts talking right after
404
+ # getting interrupted.Request of type Vapi::StopSpeakingPlan, as a Hash
405
+ # * :num_words (Float)
406
+ # * :voice_seconds (Float)
407
+ # * :backoff_seconds (Float)
408
+ # @param monitor_plan [Hash] This is the plan for real-time monitoring of the assistant's calls.
409
+ # Usage:
410
+ # - To enable live listening of the assistant's calls, set
411
+ # `monitorPlan.listenEnabled` to `true`.
412
+ # - To enable live control of the assistant's calls, set
413
+ # `monitorPlan.controlEnabled` to `true`.
414
+ # Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are
415
+ # currently at the root level but will be moved to `monitorPlan` in the future.
416
+ # Will remain backwards compatibleRequest of type Vapi::MonitorPlan, as a Hash
417
+ # * :listen_enabled (Boolean)
418
+ # * :control_enabled (Boolean)
419
+ # @param credential_ids [Array<String>] These are the credentials that will be used for the assistant calls. By default,
420
+ # all the credentials are available for use in the call but you can provide a
421
+ # subset using this.
422
+ # @param request_options [Vapi::RequestOptions]
423
+ # @return [Vapi::Assistant]
424
+ # @example
425
+ # api = Vapi::Client.new(
426
+ # base_url: "https://api.example.com",
427
+ # environment: Vapi::Environment::DEFAULT,
428
+ # token: "YOUR_AUTH_TOKEN"
429
+ # )
430
+ # api.assistants.update(id: "id")
431
+ def update(id:, transcriber: nil, model: nil, voice: nil, first_message_mode: nil, hipaa_enabled: nil,
432
+ client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, backchanneling_enabled: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, name: nil, first_message: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, server_url: nil, server_url_secret: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, request_options: nil)
433
+ response = @request_client.conn.patch do |req|
434
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
435
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
436
+ req.headers = {
437
+ **(req.headers || {}),
438
+ **@request_client.get_headers,
439
+ **(request_options&.additional_headers || {})
440
+ }.compact
441
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
442
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
443
+ end
444
+ req.body = {
445
+ **(request_options&.additional_body_parameters || {}),
446
+ transcriber: transcriber,
447
+ model: model,
448
+ voice: voice,
449
+ firstMessageMode: first_message_mode,
450
+ hipaaEnabled: hipaa_enabled,
451
+ clientMessages: client_messages,
452
+ serverMessages: server_messages,
453
+ silenceTimeoutSeconds: silence_timeout_seconds,
454
+ maxDurationSeconds: max_duration_seconds,
455
+ backgroundSound: background_sound,
456
+ backchannelingEnabled: backchanneling_enabled,
457
+ backgroundDenoisingEnabled: background_denoising_enabled,
458
+ modelOutputInMessagesEnabled: model_output_in_messages_enabled,
459
+ transportConfigurations: transport_configurations,
460
+ name: name,
461
+ firstMessage: first_message,
462
+ voicemailDetection: voicemail_detection,
463
+ voicemailMessage: voicemail_message,
464
+ endCallMessage: end_call_message,
465
+ endCallPhrases: end_call_phrases,
466
+ metadata: metadata,
467
+ serverUrl: server_url,
468
+ serverUrlSecret: server_url_secret,
469
+ analysisPlan: analysis_plan,
470
+ artifactPlan: artifact_plan,
471
+ messagePlan: message_plan,
472
+ startSpeakingPlan: start_speaking_plan,
473
+ stopSpeakingPlan: stop_speaking_plan,
474
+ monitorPlan: monitor_plan,
475
+ credentialIds: credential_ids
476
+ }.compact
477
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
478
+ end
479
+ Vapi::Assistant.from_json(json_object: response.body)
480
+ end
481
+ end
482
+
483
+ class AsyncAssistantsClient
484
+ # @return [Vapi::AsyncRequestClient]
485
+ attr_reader :request_client
486
+
487
+ # @param request_client [Vapi::AsyncRequestClient]
488
+ # @return [Vapi::AsyncAssistantsClient]
489
+ def initialize(request_client:)
490
+ @request_client = request_client
491
+ end
492
+
493
+ # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
494
+ # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
495
+ # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
496
+ # @param created_at_ge [DateTime] This will return items where the createdAt is greater than or equal to the
497
+ # specified value.
498
+ # @param created_at_le [DateTime] This will return items where the createdAt is less than or equal to the
499
+ # specified value.
500
+ # @param updated_at_gt [DateTime] This will return items where the updatedAt is greater than the specified value.
501
+ # @param updated_at_lt [DateTime] This will return items where the updatedAt is less than the specified value.
502
+ # @param updated_at_ge [DateTime] This will return items where the updatedAt is greater than or equal to the
503
+ # specified value.
504
+ # @param updated_at_le [DateTime] This will return items where the updatedAt is less than or equal to the
505
+ # specified value.
506
+ # @param request_options [Vapi::RequestOptions]
507
+ # @return [Array<Vapi::Assistant>]
508
+ # @example
509
+ # api = Vapi::Client.new(
510
+ # base_url: "https://api.example.com",
511
+ # environment: Vapi::Environment::DEFAULT,
512
+ # token: "YOUR_AUTH_TOKEN"
513
+ # )
514
+ # api.assistants.list
515
+ def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
516
+ updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
517
+ Async do
518
+ response = @request_client.conn.get do |req|
519
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
520
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
521
+ req.headers = {
522
+ **(req.headers || {}),
523
+ **@request_client.get_headers,
524
+ **(request_options&.additional_headers || {})
525
+ }.compact
526
+ req.params = {
527
+ **(request_options&.additional_query_parameters || {}),
528
+ "limit": limit,
529
+ "createdAtGt": created_at_gt,
530
+ "createdAtLt": created_at_lt,
531
+ "createdAtGe": created_at_ge,
532
+ "createdAtLe": created_at_le,
533
+ "updatedAtGt": updated_at_gt,
534
+ "updatedAtLt": updated_at_lt,
535
+ "updatedAtGe": updated_at_ge,
536
+ "updatedAtLe": updated_at_le
537
+ }.compact
538
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
539
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
540
+ end
541
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant"
542
+ end
543
+ parsed_json = JSON.parse(response.body)
544
+ parsed_json&.map do |item|
545
+ item = item.to_json
546
+ Vapi::Assistant.from_json(json_object: item)
547
+ end
548
+ end
549
+ end
550
+
551
+ # @param request [Hash] Request of type Vapi::CreateAssistantDto, as a Hash
552
+ # * :transcriber (Hash)
553
+ # * :model (Hash)
554
+ # * :voice (Hash)
555
+ # * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
556
+ # * :hipaa_enabled (Boolean)
557
+ # * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
558
+ # * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
559
+ # * :silence_timeout_seconds (Float)
560
+ # * :max_duration_seconds (Float)
561
+ # * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
562
+ # * :backchanneling_enabled (Boolean)
563
+ # * :background_denoising_enabled (Boolean)
564
+ # * :model_output_in_messages_enabled (Boolean)
565
+ # * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
566
+ # * :name (String)
567
+ # * :first_message (String)
568
+ # * :voicemail_detection (Hash)
569
+ # * :provider (String)
570
+ # * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
571
+ # * :enabled (Boolean)
572
+ # * :machine_detection_timeout (Float)
573
+ # * :machine_detection_speech_threshold (Float)
574
+ # * :machine_detection_speech_end_threshold (Float)
575
+ # * :machine_detection_silence_timeout (Float)
576
+ # * :voicemail_message (String)
577
+ # * :end_call_message (String)
578
+ # * :end_call_phrases (Array<String>)
579
+ # * :metadata (Hash{String => Object})
580
+ # * :server_url (String)
581
+ # * :server_url_secret (String)
582
+ # * :analysis_plan (Hash)
583
+ # * :summary_plan (Hash)
584
+ # * :messages (Array<Hash{String => Object}>)
585
+ # * :enabled (Boolean)
586
+ # * :timeout_seconds (Float)
587
+ # * :structured_data_plan (Hash)
588
+ # * :messages (Array<Hash{String => Object}>)
589
+ # * :enabled (Boolean)
590
+ # * :schema (Hash)
591
+ # * :type (Vapi::JsonSchemaType)
592
+ # * :items (Hash{String => Object})
593
+ # * :properties (Hash{String => Object})
594
+ # * :description (String)
595
+ # * :required (Array<String>)
596
+ # * :timeout_seconds (Float)
597
+ # * :success_evaluation_plan (Hash)
598
+ # * :rubric (Vapi::SuccessEvaluationPlanRubric)
599
+ # * :messages (Array<Hash{String => Object}>)
600
+ # * :enabled (Boolean)
601
+ # * :timeout_seconds (Float)
602
+ # * :artifact_plan (Hash)
603
+ # * :recording_enabled (Boolean)
604
+ # * :video_recording_enabled (Boolean)
605
+ # * :transcript_plan (Hash)
606
+ # * :enabled (Boolean)
607
+ # * :assistant_name (String)
608
+ # * :user_name (String)
609
+ # * :recording_path (String)
610
+ # * :message_plan (Hash)
611
+ # * :idle_messages (Array<String>)
612
+ # * :idle_message_max_spoken_count (Float)
613
+ # * :idle_timeout_seconds (Float)
614
+ # * :start_speaking_plan (Hash)
615
+ # * :wait_seconds (Float)
616
+ # * :smart_endpointing_enabled (Boolean)
617
+ # * :transcription_endpointing_plan (Hash)
618
+ # * :on_punctuation_seconds (Float)
619
+ # * :on_no_punctuation_seconds (Float)
620
+ # * :on_number_seconds (Float)
621
+ # * :stop_speaking_plan (Hash)
622
+ # * :num_words (Float)
623
+ # * :voice_seconds (Float)
624
+ # * :backoff_seconds (Float)
625
+ # * :monitor_plan (Hash)
626
+ # * :listen_enabled (Boolean)
627
+ # * :control_enabled (Boolean)
628
+ # * :credential_ids (Array<String>)
629
+ # @param request_options [Vapi::RequestOptions]
630
+ # @return [Vapi::Assistant]
631
+ # @example
632
+ # api = Vapi::Client.new(
633
+ # base_url: "https://api.example.com",
634
+ # environment: Vapi::Environment::DEFAULT,
635
+ # token: "YOUR_AUTH_TOKEN"
636
+ # )
637
+ # api.assistants.create(request: { })
638
+ def create(request:, request_options: nil)
639
+ Async do
640
+ response = @request_client.conn.post do |req|
641
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
642
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
643
+ req.headers = {
644
+ **(req.headers || {}),
645
+ **@request_client.get_headers,
646
+ **(request_options&.additional_headers || {})
647
+ }.compact
648
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
649
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
650
+ end
651
+ req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
652
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant"
653
+ end
654
+ Vapi::Assistant.from_json(json_object: response.body)
655
+ end
656
+ end
657
+
658
+ # @param id [String]
659
+ # @param request_options [Vapi::RequestOptions]
660
+ # @return [Vapi::Assistant]
661
+ # @example
662
+ # api = Vapi::Client.new(
663
+ # base_url: "https://api.example.com",
664
+ # environment: Vapi::Environment::DEFAULT,
665
+ # token: "YOUR_AUTH_TOKEN"
666
+ # )
667
+ # api.assistants.get(id: "id")
668
+ def get(id:, request_options: nil)
669
+ Async do
670
+ response = @request_client.conn.get do |req|
671
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
672
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
673
+ req.headers = {
674
+ **(req.headers || {}),
675
+ **@request_client.get_headers,
676
+ **(request_options&.additional_headers || {})
677
+ }.compact
678
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
679
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
680
+ end
681
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
682
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
683
+ end
684
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
685
+ end
686
+ Vapi::Assistant.from_json(json_object: response.body)
687
+ end
688
+ end
689
+
690
+ # @param id [String]
691
+ # @param request_options [Vapi::RequestOptions]
692
+ # @return [Vapi::Assistant]
693
+ # @example
694
+ # api = Vapi::Client.new(
695
+ # base_url: "https://api.example.com",
696
+ # environment: Vapi::Environment::DEFAULT,
697
+ # token: "YOUR_AUTH_TOKEN"
698
+ # )
699
+ # api.assistants.delete(id: "id")
700
+ def delete(id:, request_options: nil)
701
+ Async do
702
+ response = @request_client.conn.delete do |req|
703
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
704
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
705
+ req.headers = {
706
+ **(req.headers || {}),
707
+ **@request_client.get_headers,
708
+ **(request_options&.additional_headers || {})
709
+ }.compact
710
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
711
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
712
+ end
713
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
714
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
715
+ end
716
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
717
+ end
718
+ Vapi::Assistant.from_json(json_object: response.body)
719
+ end
720
+ end
721
+
722
+ # @param id [String]
723
+ # @param transcriber [Vapi::Assistants::UpdateAssistantDtoTranscriber] These are the options for the assistant's transcriber.
724
+ # @param model [Vapi::Assistants::UpdateAssistantDtoModel] These are the options for the assistant's LLM.
725
+ # @param voice [Vapi::Assistants::UpdateAssistantDtoVoice] These are the options for the assistant's voice.
726
+ # @param first_message_mode [Vapi::Assistants::UpdateAssistantDtoFirstMessageMode] This is the mode for the first message. Default is 'assistant-speaks-first'.
727
+ # Use:
728
+ # - 'assistant-speaks-first' to have the assistant speak first.
729
+ # - 'assistant-waits-for-user' to have the assistant wait for the user to speak
730
+ # first.
731
+ # - 'assistant-speaks-first-with-model-generated-message' to have the assistant
732
+ # speak first with a message generated by the model based on the conversation
733
+ # state. (`assistant.model.messages` at call start, `call.messages` at squad
734
+ # transfer points).
735
+ # @default 'assistant-speaks-first'
736
+ # @param hipaa_enabled [Boolean] When this is enabled, no logs, recordings, or transcriptions will be stored. At
737
+ # the end of the call, you will still receive an end-of-call-report message to
738
+ # store on your server. Defaults to false.
739
+ # @param client_messages [Array<Vapi::Assistants::UpdateAssistantDtoClientMessagesItem>] These are the messages that will be sent to your Client SDKs. Default is
740
+ # ,speech-update,status-update,transcript,tool-calls,user-interrupted,voice-input.
741
+ # You can check the shape of the messages in ClientMessage schema.
742
+ # @param server_messages [Array<Vapi::Assistants::UpdateAssistantDtoServerMessagesItem>] These are the messages that will be sent to your Server URL. Default is
743
+ # h-update,status-update,tool-calls,transfer-destination-request,user-interrupted.
744
+ # You can check the shape of the messages in ServerMessage schema.
745
+ # @param silence_timeout_seconds [Float] How many seconds of silence to wait before ending the call. Defaults to 30.
746
+ # @default 30
747
+ # @param max_duration_seconds [Float] This is the maximum number of seconds that the call will last. When the call
748
+ # reaches this duration, it will be ended.
749
+ # @default 600 (10 minutes)
750
+ # @param background_sound [Vapi::Assistants::UpdateAssistantDtoBackgroundSound] This is the background sound in the call. Default for phone calls is 'office'
751
+ # and default for web calls is 'off'.
752
+ # @param backchanneling_enabled [Boolean] This determines whether the model says 'mhmm', 'ahem' etc. while user is
753
+ # speaking.
754
+ # Default `false` while in beta.
755
+ # @default false
756
+ # @param background_denoising_enabled [Boolean] This enables filtering of noise and background speech while the user is talking.
757
+ # Default `false` while in beta.
758
+ # @default false
759
+ # @param model_output_in_messages_enabled [Boolean] This determines whether the model's output is used in conversation history
760
+ # rather than the transcription of assistant's speech.
761
+ # Default `false` while in beta.
762
+ # @default false
763
+ # @param transport_configurations [Array<Hash>] These are the configurations to be passed to the transport providers of
764
+ # assistant's calls, like Twilio. You can store multiple configurations for
765
+ # different transport providers. For a call, only the configuration matching the
766
+ # call transport provider is used.Request of type Array<Vapi::TransportConfigurationTwilio>, as a Hash
767
+ # * :provider (String)
768
+ # * :timeout (Float)
769
+ # * :record (Boolean)
770
+ # * :recording_channels (Vapi::TransportConfigurationTwilioRecordingChannels)
771
+ # @param name [String] This is the name of the assistant.
772
+ # This is required when you want to transfer between assistants in a call.
773
+ # @param first_message [String] This is the first message that the assistant will say. This can also be a URL to
774
+ # a containerized audio file (mp3, wav, etc.).
775
+ # If unspecified, assistant will wait for user to speak and use the model to
776
+ # respond once they speak.
777
+ # @param voicemail_detection [Hash] These are the settings to configure or disable voicemail detection.
778
+ # Alternatively, voicemail detection can be configured using the
779
+ # model.tools=[VoicemailTool].
780
+ # This uses Twilio's built-in detection while the VoicemailTool relies on the
781
+ # model to detect if a voicemail was reached.
782
+ # You can use neither of them, one of them, or both of them. By default, Twilio
783
+ # built-in detection is enabled while VoicemailTool is not.Request of type Vapi::TwilioVoicemailDetection, as a Hash
784
+ # * :provider (String)
785
+ # * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
786
+ # * :enabled (Boolean)
787
+ # * :machine_detection_timeout (Float)
788
+ # * :machine_detection_speech_threshold (Float)
789
+ # * :machine_detection_speech_end_threshold (Float)
790
+ # * :machine_detection_silence_timeout (Float)
791
+ # @param voicemail_message [String] This is the message that the assistant will say if the call is forwarded to
792
+ # voicemail.
793
+ # If unspecified, it will hang up.
794
+ # @param end_call_message [String] This is the message that the assistant will say if it ends the call.
795
+ # If unspecified, it will hang up without saying anything.
796
+ # @param end_call_phrases [Array<String>] This list contains phrases that, if spoken by the assistant, will trigger the
797
+ # call to be hung up. Case insensitive.
798
+ # @param metadata [Hash{String => Object}] This is for metadata you want to store on the assistant.
799
+ # @param server_url [String] This is the URL Vapi will communicate with via HTTP GET and POST Requests. This
800
+ # is used for retrieving context, function calling, and end-of-call reports.
801
+ # All requests will be sent with the call object among other things relevant to
802
+ # that message. You can find more details in the Server URL documentation.
803
+ # This overrides the serverUrl set on the org and the phoneNumber. Order of
804
+ # precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl >
805
+ # org.serverUrl
806
+ # @param server_url_secret [String] This is the secret you can set that Vapi will send with every request to your
807
+ # server. Will be sent as a header called x-vapi-secret.
808
+ # Same precedence logic as serverUrl.
809
+ # @param analysis_plan [Hash] This is the plan for analysis of assistant's calls. Stored in `call.analysis`.Request of type Vapi::AnalysisPlan, as a Hash
810
+ # * :summary_plan (Hash)
811
+ # * :messages (Array<Hash{String => Object}>)
812
+ # * :enabled (Boolean)
813
+ # * :timeout_seconds (Float)
814
+ # * :structured_data_plan (Hash)
815
+ # * :messages (Array<Hash{String => Object}>)
816
+ # * :enabled (Boolean)
817
+ # * :schema (Hash)
818
+ # * :type (Vapi::JsonSchemaType)
819
+ # * :items (Hash{String => Object})
820
+ # * :properties (Hash{String => Object})
821
+ # * :description (String)
822
+ # * :required (Array<String>)
823
+ # * :timeout_seconds (Float)
824
+ # * :success_evaluation_plan (Hash)
825
+ # * :rubric (Vapi::SuccessEvaluationPlanRubric)
826
+ # * :messages (Array<Hash{String => Object}>)
827
+ # * :enabled (Boolean)
828
+ # * :timeout_seconds (Float)
829
+ # @param artifact_plan [Hash] This is the plan for artifacts generated during assistant's calls. Stored in
830
+ # `call.artifact`.
831
+ # Note: `recordingEnabled` is currently at the root level. It will be moved to
832
+ # `artifactPlan` in the future, but will remain backwards compatible.Request of type Vapi::ArtifactPlan, as a Hash
833
+ # * :recording_enabled (Boolean)
834
+ # * :video_recording_enabled (Boolean)
835
+ # * :transcript_plan (Hash)
836
+ # * :enabled (Boolean)
837
+ # * :assistant_name (String)
838
+ # * :user_name (String)
839
+ # * :recording_path (String)
840
+ # @param message_plan [Hash] This is the plan for static predefined messages that can be spoken by the
841
+ # assistant during the call, like `idleMessages`.
842
+ # Note: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at
843
+ # the root level. They will be moved to `messagePlan` in the future, but will
844
+ # remain backwards compatible.Request of type Vapi::MessagePlan, as a Hash
845
+ # * :idle_messages (Array<String>)
846
+ # * :idle_message_max_spoken_count (Float)
847
+ # * :idle_timeout_seconds (Float)
848
+ # @param start_speaking_plan [Hash] This is the plan for when the assistant should start talking.
849
+ # You should configure this if you're running into these issues:
850
+ # - The assistant is too slow to start talking after the customer is done
851
+ # speaking.
852
+ # - The assistant is too fast to start talking after the customer is done
853
+ # speaking.
854
+ # - The assistant is so fast that it's actually interrupting the customer.Request of type Vapi::StartSpeakingPlan, as a Hash
855
+ # * :wait_seconds (Float)
856
+ # * :smart_endpointing_enabled (Boolean)
857
+ # * :transcription_endpointing_plan (Hash)
858
+ # * :on_punctuation_seconds (Float)
859
+ # * :on_no_punctuation_seconds (Float)
860
+ # * :on_number_seconds (Float)
861
+ # @param stop_speaking_plan [Hash] This is the plan for when assistant should stop talking on customer
862
+ # interruption.
863
+ # You should configure this if you're running into these issues:
864
+ # - The assistant is too slow to recognize customer's interruption.
865
+ # - The assistant is too fast to recognize customer's interruption.
866
+ # - The assistant is getting interrupted by phrases that are just acknowledgments.
867
+ # - The assistant is getting interrupted by background noises.
868
+ # - The assistant is not properly stopping -- it starts talking right after
869
+ # getting interrupted.Request of type Vapi::StopSpeakingPlan, as a Hash
870
+ # * :num_words (Float)
871
+ # * :voice_seconds (Float)
872
+ # * :backoff_seconds (Float)
873
+ # @param monitor_plan [Hash] This is the plan for real-time monitoring of the assistant's calls.
874
+ # Usage:
875
+ # - To enable live listening of the assistant's calls, set
876
+ # `monitorPlan.listenEnabled` to `true`.
877
+ # - To enable live control of the assistant's calls, set
878
+ # `monitorPlan.controlEnabled` to `true`.
879
+ # Note, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are
880
+ # currently at the root level but will be moved to `monitorPlan` in the future.
881
+ # Will remain backwards compatibleRequest of type Vapi::MonitorPlan, as a Hash
882
+ # * :listen_enabled (Boolean)
883
+ # * :control_enabled (Boolean)
884
+ # @param credential_ids [Array<String>] These are the credentials that will be used for the assistant calls. By default,
885
+ # all the credentials are available for use in the call but you can provide a
886
+ # subset using this.
887
+ # @param request_options [Vapi::RequestOptions]
888
+ # @return [Vapi::Assistant]
889
+ # @example
890
+ # api = Vapi::Client.new(
891
+ # base_url: "https://api.example.com",
892
+ # environment: Vapi::Environment::DEFAULT,
893
+ # token: "YOUR_AUTH_TOKEN"
894
+ # )
895
+ # api.assistants.update(id: "id")
896
+ def update(id:, transcriber: nil, model: nil, voice: nil, first_message_mode: nil, hipaa_enabled: nil,
897
+ client_messages: nil, server_messages: nil, silence_timeout_seconds: nil, max_duration_seconds: nil, background_sound: nil, backchanneling_enabled: nil, background_denoising_enabled: nil, model_output_in_messages_enabled: nil, transport_configurations: nil, name: nil, first_message: nil, voicemail_detection: nil, voicemail_message: nil, end_call_message: nil, end_call_phrases: nil, metadata: nil, server_url: nil, server_url_secret: nil, analysis_plan: nil, artifact_plan: nil, message_plan: nil, start_speaking_plan: nil, stop_speaking_plan: nil, monitor_plan: nil, credential_ids: nil, request_options: nil)
898
+ Async do
899
+ response = @request_client.conn.patch do |req|
900
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
901
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
902
+ req.headers = {
903
+ **(req.headers || {}),
904
+ **@request_client.get_headers,
905
+ **(request_options&.additional_headers || {})
906
+ }.compact
907
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
908
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
909
+ end
910
+ req.body = {
911
+ **(request_options&.additional_body_parameters || {}),
912
+ transcriber: transcriber,
913
+ model: model,
914
+ voice: voice,
915
+ firstMessageMode: first_message_mode,
916
+ hipaaEnabled: hipaa_enabled,
917
+ clientMessages: client_messages,
918
+ serverMessages: server_messages,
919
+ silenceTimeoutSeconds: silence_timeout_seconds,
920
+ maxDurationSeconds: max_duration_seconds,
921
+ backgroundSound: background_sound,
922
+ backchannelingEnabled: backchanneling_enabled,
923
+ backgroundDenoisingEnabled: background_denoising_enabled,
924
+ modelOutputInMessagesEnabled: model_output_in_messages_enabled,
925
+ transportConfigurations: transport_configurations,
926
+ name: name,
927
+ firstMessage: first_message,
928
+ voicemailDetection: voicemail_detection,
929
+ voicemailMessage: voicemail_message,
930
+ endCallMessage: end_call_message,
931
+ endCallPhrases: end_call_phrases,
932
+ metadata: metadata,
933
+ serverUrl: server_url,
934
+ serverUrlSecret: server_url_secret,
935
+ analysisPlan: analysis_plan,
936
+ artifactPlan: artifact_plan,
937
+ messagePlan: message_plan,
938
+ startSpeakingPlan: start_speaking_plan,
939
+ stopSpeakingPlan: stop_speaking_plan,
940
+ monitorPlan: monitor_plan,
941
+ credentialIds: credential_ids
942
+ }.compact
943
+ req.url "#{@request_client.get_url(request_options: request_options)}/assistant/#{id}"
944
+ end
945
+ Vapi::Assistant.from_json(json_object: response.body)
946
+ end
947
+ end
948
+ end
949
+ end