vapi_server_sdk 0.3.0 → 0.5.0

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 (208) hide show
  1. checksums.yaml +4 -4
  2. data/lib/requests.rb +2 -2
  3. data/lib/types_export.rb +83 -12
  4. data/lib/vapi_server_sdk/analytics/client.rb +41 -26
  5. data/lib/vapi_server_sdk/assistants/client.rb +84 -84
  6. data/lib/vapi_server_sdk/assistants/types/update_assistant_dto_server_messages_item.rb +1 -0
  7. data/lib/vapi_server_sdk/blocks/client.rb +0 -70
  8. data/lib/vapi_server_sdk/calls/client.rb +110 -76
  9. data/lib/vapi_server_sdk/files/client.rb +0 -70
  10. data/lib/vapi_server_sdk/knowledge_bases/client.rb +0 -70
  11. data/lib/vapi_server_sdk/logs/client.rb +15 -46
  12. data/lib/vapi_server_sdk/logs/types/logging_controller_logs_delete_query_request_type.rb +12 -0
  13. data/lib/vapi_server_sdk/phone_numbers/client.rb +0 -70
  14. data/lib/vapi_server_sdk/squads/client.rb +136 -78
  15. data/lib/vapi_server_sdk/test_suite_runs/client.rb +328 -0
  16. data/lib/vapi_server_sdk/test_suite_runs/types/test_suite_run_controller_find_all_paginated_request_sort_order.rb +10 -0
  17. data/lib/vapi_server_sdk/test_suite_tests/client.rb +331 -0
  18. data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_create_request.rb +81 -0
  19. data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_find_all_paginated_request_sort_order.rb +10 -0
  20. data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_remove_response.rb +82 -0
  21. data/lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_update_request.rb +81 -0
  22. data/lib/vapi_server_sdk/test_suites/client.rb +338 -0
  23. data/lib/vapi_server_sdk/test_suites/types/test_suite_controller_find_all_paginated_request_sort_order.rb +10 -0
  24. data/lib/vapi_server_sdk/tools/client.rb +0 -70
  25. data/lib/vapi_server_sdk/types/ai_edge_condition.rb +55 -0
  26. data/lib/vapi_server_sdk/types/analytics_operation_column.rb +1 -0
  27. data/lib/vapi_server_sdk/types/analytics_operation_operation.rb +1 -0
  28. data/lib/vapi_server_sdk/types/analytics_query.rb +4 -3
  29. data/lib/vapi_server_sdk/types/analytics_query_table.rb +9 -0
  30. data/lib/vapi_server_sdk/types/api_request.rb +165 -0
  31. data/lib/vapi_server_sdk/types/api_request_method.rb +8 -0
  32. data/lib/vapi_server_sdk/types/api_request_mode.rb +10 -0
  33. data/lib/vapi_server_sdk/types/artifact.rb +12 -2
  34. data/lib/vapi_server_sdk/types/artifact_plan.rb +56 -8
  35. data/lib/vapi_server_sdk/types/assistant.rb +27 -13
  36. data/lib/vapi_server_sdk/types/assistant_hook_action_base.rb +47 -0
  37. data/lib/vapi_server_sdk/types/assistant_hook_filter.rb +72 -0
  38. data/lib/vapi_server_sdk/types/assistant_hooks.rb +82 -0
  39. data/lib/vapi_server_sdk/types/assistant_overrides.rb +28 -14
  40. data/lib/vapi_server_sdk/types/assistant_overrides_server_messages_item.rb +1 -0
  41. data/lib/vapi_server_sdk/types/assistant_server_messages_item.rb +1 -0
  42. data/lib/vapi_server_sdk/types/azure_credential_region.rb +4 -2
  43. data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb +1 -0
  44. data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb +4 -2
  45. data/lib/vapi_server_sdk/types/backoff_plan.rb +80 -0
  46. data/lib/vapi_server_sdk/types/bash_tool_with_tool_call.rb +175 -0
  47. data/lib/vapi_server_sdk/types/bash_tool_with_tool_call_messages_item.rb +120 -0
  48. data/lib/vapi_server_sdk/types/byo_phone_number.rb +10 -1
  49. data/lib/vapi_server_sdk/types/byo_phone_number_status.rb +10 -0
  50. data/lib/vapi_server_sdk/types/call_ended_reason.rb +10 -1
  51. data/lib/vapi_server_sdk/types/cartesia_experimental_controls.rb +69 -0
  52. data/lib/vapi_server_sdk/types/cartesia_experimental_controls_emotion.rb +26 -0
  53. data/lib/vapi_server_sdk/types/cartesia_experimental_controls_speed.rb +11 -0
  54. data/lib/vapi_server_sdk/types/cartesia_voice.rb +24 -10
  55. data/lib/vapi_server_sdk/types/chat_completion_message.rb +80 -0
  56. data/lib/vapi_server_sdk/types/chat_completion_message_metadata.rb +94 -0
  57. data/lib/vapi_server_sdk/types/chat_completions_dto.rb +84 -0
  58. data/lib/vapi_server_sdk/types/client_inbound_message_end_call.rb +47 -0
  59. data/lib/vapi_server_sdk/types/client_inbound_message_message.rb +13 -0
  60. data/lib/vapi_server_sdk/types/client_inbound_message_transfer.rb +13 -3
  61. data/lib/vapi_server_sdk/types/client_message_conversation_update.rb +15 -2
  62. data/lib/vapi_server_sdk/types/client_message_hang.rb +22 -4
  63. data/lib/vapi_server_sdk/types/client_message_language_change_detected.rb +15 -3
  64. data/lib/vapi_server_sdk/types/client_message_message.rb +165 -181
  65. data/lib/vapi_server_sdk/types/client_message_metadata.rb +15 -3
  66. data/lib/vapi_server_sdk/types/client_message_model_output.rb +15 -3
  67. data/lib/vapi_server_sdk/types/client_message_speech_update.rb +11 -2
  68. data/lib/vapi_server_sdk/types/client_message_tool_calls.rb +15 -2
  69. data/lib/vapi_server_sdk/types/client_message_tool_calls_result.rb +15 -3
  70. data/lib/vapi_server_sdk/types/client_message_tool_calls_tool_with_tool_call_list_item.rb +116 -77
  71. data/lib/vapi_server_sdk/types/client_message_transcript.rb +12 -2
  72. data/lib/vapi_server_sdk/types/client_message_transcript_type.rb +10 -0
  73. data/lib/vapi_server_sdk/types/client_message_transfer_update.rb +11 -1
  74. data/lib/vapi_server_sdk/types/client_message_user_interrupted.rb +14 -4
  75. data/lib/vapi_server_sdk/types/client_message_voice_input.rb +15 -3
  76. data/lib/vapi_server_sdk/types/client_message_workflow_node_started.rb +67 -0
  77. data/lib/vapi_server_sdk/types/compliance_plan.rb +77 -0
  78. data/lib/vapi_server_sdk/types/computer_tool_with_tool_call.rb +199 -0
  79. data/lib/vapi_server_sdk/types/computer_tool_with_tool_call_messages_item.rb +120 -0
  80. data/lib/vapi_server_sdk/types/create_assistant_dto.rb +28 -14
  81. data/lib/vapi_server_sdk/types/create_assistant_dto_server_messages_item.rb +1 -0
  82. data/lib/vapi_server_sdk/types/create_azure_credential_dto_region.rb +4 -2
  83. data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_models_item.rb +1 -0
  84. data/lib/vapi_server_sdk/types/create_azure_open_ai_credential_dto_region.rb +4 -2
  85. data/lib/vapi_server_sdk/types/create_custom_knowledge_base_dto.rb +2 -4
  86. data/lib/vapi_server_sdk/types/create_test_suite_test_voice_dto.rb +90 -0
  87. data/lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto.rb +34 -47
  88. data/lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto_create_plan.rb +97 -0
  89. data/lib/vapi_server_sdk/types/create_vapi_phone_number_dto.rb +12 -4
  90. data/lib/vapi_server_sdk/types/create_workflow_dto.rb +80 -0
  91. data/lib/vapi_server_sdk/types/create_workflow_dto_nodes_item.rb +133 -0
  92. data/lib/vapi_server_sdk/types/custom_knowledge_base.rb +2 -4
  93. data/lib/vapi_server_sdk/types/deep_seek_model.rb +4 -3
  94. data/lib/vapi_server_sdk/types/deep_seek_model_model.rb +9 -0
  95. data/lib/vapi_server_sdk/types/deepgram_transcriber.rb +28 -2
  96. data/lib/vapi_server_sdk/types/deepgram_voice.rb +22 -2
  97. data/lib/vapi_server_sdk/types/edge.rb +87 -0
  98. data/lib/vapi_server_sdk/types/edge_condition.rb +107 -0
  99. data/lib/vapi_server_sdk/types/failed_edge_condition.rb +47 -0
  100. data/lib/vapi_server_sdk/types/fallback_cartesia_voice.rb +24 -9
  101. data/lib/vapi_server_sdk/types/fallback_deepgram_voice.rb +17 -2
  102. data/lib/vapi_server_sdk/types/fallback_play_ht_voice_model.rb +1 -0
  103. data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_id_enum.rb +22 -20
  104. data/lib/vapi_server_sdk/types/fallback_rime_ai_voice_model.rb +1 -0
  105. data/lib/vapi_server_sdk/types/format_plan.rb +22 -2
  106. data/lib/vapi_server_sdk/types/format_plan_formatters_enabled_item.rb +22 -0
  107. data/lib/vapi_server_sdk/types/function_tool_with_tool_call.rb +1 -10
  108. data/lib/vapi_server_sdk/types/gather.rb +143 -0
  109. data/lib/vapi_server_sdk/types/ghl_tool_with_tool_call.rb +1 -9
  110. data/lib/vapi_server_sdk/types/google_model_model.rb +4 -0
  111. data/lib/vapi_server_sdk/types/groq_model_model.rb +1 -0
  112. data/lib/vapi_server_sdk/types/hangup.rb +67 -0
  113. data/lib/vapi_server_sdk/types/hook.rb +70 -0
  114. data/lib/vapi_server_sdk/types/hook_on.rb +9 -0
  115. data/lib/vapi_server_sdk/types/invite_user_dto.rb +11 -2
  116. data/lib/vapi_server_sdk/types/json_schema.rb +37 -2
  117. data/lib/vapi_server_sdk/types/log.rb +18 -18
  118. data/lib/vapi_server_sdk/types/logic_edge_condition.rb +55 -0
  119. data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb +1 -9
  120. data/lib/vapi_server_sdk/types/message_plan.rb +12 -2
  121. data/lib/vapi_server_sdk/types/open_ai_model.rb +1 -9
  122. data/lib/vapi_server_sdk/types/open_ai_model_fallback_models_item.rb +2 -0
  123. data/lib/vapi_server_sdk/types/open_ai_model_model.rb +2 -0
  124. data/lib/vapi_server_sdk/types/play_ht_voice_model.rb +1 -0
  125. data/lib/vapi_server_sdk/types/rime_ai_voice_id_enum.rb +22 -20
  126. data/lib/vapi_server_sdk/types/rime_ai_voice_model.rb +1 -0
  127. data/lib/vapi_server_sdk/types/say.rb +81 -0
  128. data/lib/vapi_server_sdk/types/say_hook.rb +81 -0
  129. data/lib/vapi_server_sdk/types/server.rb +17 -2
  130. data/lib/vapi_server_sdk/types/server_message_assistant_request.rb +12 -2
  131. data/lib/vapi_server_sdk/types/server_message_conversation_update.rb +12 -2
  132. data/lib/vapi_server_sdk/types/server_message_end_of_call_report.rb +11 -1
  133. data/lib/vapi_server_sdk/types/server_message_end_of_call_report_ended_reason.rb +10 -1
  134. data/lib/vapi_server_sdk/types/server_message_hang.rb +20 -2
  135. data/lib/vapi_server_sdk/types/server_message_knowledge_base_request.rb +14 -2
  136. data/lib/vapi_server_sdk/types/server_message_language_change_detected.rb +11 -1
  137. data/lib/vapi_server_sdk/types/server_message_message.rb +212 -237
  138. data/lib/vapi_server_sdk/types/server_message_model_output.rb +11 -1
  139. data/lib/vapi_server_sdk/types/server_message_phone_call_control.rb +18 -2
  140. data/lib/vapi_server_sdk/types/server_message_speech_update.rb +11 -1
  141. data/lib/vapi_server_sdk/types/server_message_status_update.rb +12 -2
  142. data/lib/vapi_server_sdk/types/server_message_status_update_ended_reason.rb +10 -1
  143. data/lib/vapi_server_sdk/types/server_message_tool_calls.rb +10 -2
  144. data/lib/vapi_server_sdk/types/server_message_tool_calls_tool_with_tool_call_list_item.rb +116 -77
  145. data/lib/vapi_server_sdk/types/server_message_transcript.rb +13 -2
  146. data/lib/vapi_server_sdk/types/server_message_transcript_type.rb +10 -0
  147. data/lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb +12 -2
  148. data/lib/vapi_server_sdk/types/server_message_transfer_update.rb +11 -1
  149. data/lib/vapi_server_sdk/types/server_message_user_interrupted.rb +12 -2
  150. data/lib/vapi_server_sdk/types/server_message_voice_input.rb +11 -1
  151. data/lib/vapi_server_sdk/types/server_message_voice_request.rb +50 -2
  152. data/lib/vapi_server_sdk/types/stop_speaking_plan.rb +27 -2
  153. data/lib/vapi_server_sdk/types/subscription.rb +44 -14
  154. data/lib/vapi_server_sdk/types/sync_voice_library_dto_providers_item.rb +1 -0
  155. data/lib/vapi_server_sdk/types/test_suite.rb +104 -0
  156. data/lib/vapi_server_sdk/types/test_suite_run.rb +127 -0
  157. data/lib/vapi_server_sdk/types/test_suite_run_scorer_ai.rb +80 -0
  158. data/lib/vapi_server_sdk/types/test_suite_run_scorer_ai_result.rb +9 -0
  159. data/lib/vapi_server_sdk/types/test_suite_run_status.rb +10 -0
  160. data/lib/vapi_server_sdk/types/test_suite_run_test_attempt.rb +75 -0
  161. data/lib/vapi_server_sdk/types/{analytics_query_dto.rb → test_suite_run_test_attempt_call.rb} +19 -17
  162. data/lib/vapi_server_sdk/types/test_suite_run_test_result.rb +75 -0
  163. data/lib/vapi_server_sdk/types/test_suite_runs_paginated_response.rb +75 -0
  164. data/lib/vapi_server_sdk/types/test_suite_test_scorer_ai.rb +65 -0
  165. data/lib/vapi_server_sdk/types/test_suite_test_voice.rb +132 -0
  166. data/lib/vapi_server_sdk/types/test_suite_tests_paginated_response.rb +75 -0
  167. data/lib/vapi_server_sdk/types/test_suites_paginated_response.rb +75 -0
  168. data/lib/vapi_server_sdk/types/text_editor_tool_with_tool_call.rb +175 -0
  169. data/lib/vapi_server_sdk/types/text_editor_tool_with_tool_call_messages_item.rb +121 -0
  170. data/lib/vapi_server_sdk/types/time_range_step.rb +1 -0
  171. data/lib/vapi_server_sdk/types/tool_message_start.rb +18 -2
  172. data/lib/vapi_server_sdk/types/transfer.rb +74 -0
  173. data/lib/vapi_server_sdk/types/transfer_assistant_hook_action.rb +75 -0
  174. data/lib/vapi_server_sdk/types/{buy_phone_number_dto_fallback_destination.rb → transfer_assistant_hook_action_destination.rb} +9 -12
  175. data/lib/vapi_server_sdk/types/transfer_destination_assistant.rb +46 -0
  176. data/lib/vapi_server_sdk/types/transfer_plan.rb +37 -1
  177. data/lib/vapi_server_sdk/types/transfer_plan_mode.rb +4 -0
  178. data/lib/vapi_server_sdk/types/trieve_knowledge_base.rb +35 -44
  179. data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_create_plan.rb → trieve_knowledge_base_chunk_plan.rb} +17 -11
  180. data/lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb +59 -0
  181. data/lib/vapi_server_sdk/types/trieve_knowledge_base_create_plan.rb +96 -0
  182. data/lib/vapi_server_sdk/types/trieve_knowledge_base_import.rb +55 -0
  183. data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_search_plan.rb → trieve_knowledge_base_search_plan.rb} +21 -12
  184. data/lib/vapi_server_sdk/types/{trieve_knowledge_base_vector_store_search_plan_search_type.rb → trieve_knowledge_base_search_plan_search_type.rb} +1 -1
  185. data/lib/vapi_server_sdk/types/twilio_phone_number.rb +11 -2
  186. data/lib/vapi_server_sdk/types/twilio_phone_number_status.rb +10 -0
  187. data/lib/vapi_server_sdk/types/update_azure_credential_dto_region.rb +4 -2
  188. data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_models_item.rb +1 -0
  189. data/lib/vapi_server_sdk/types/update_azure_open_ai_credential_dto_region.rb +4 -2
  190. data/lib/vapi_server_sdk/types/update_custom_knowledge_base_dto.rb +2 -4
  191. data/lib/vapi_server_sdk/types/update_test_suite_test_voice_dto.rb +90 -0
  192. data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto.rb +34 -47
  193. data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto_create_plan.rb +97 -0
  194. data/lib/vapi_server_sdk/types/vapi_model.rb +27 -1
  195. data/lib/vapi_server_sdk/types/vapi_phone_number.rb +29 -4
  196. data/lib/vapi_server_sdk/types/vapi_phone_number_status.rb +10 -0
  197. data/lib/vapi_server_sdk/types/vonage_phone_number.rb +11 -2
  198. data/lib/vapi_server_sdk/types/vonage_phone_number_status.rb +10 -0
  199. data/lib/vapi_server_sdk/types/workflow.rb +117 -0
  200. data/lib/vapi_server_sdk/types/workflow_nodes_item.rb +133 -0
  201. data/lib/vapi_server_sdk/types/xai_model.rb +4 -3
  202. data/lib/vapi_server_sdk/types/xai_model_model.rb +10 -0
  203. data/lib/vapi_server_sdk.rb +21 -0
  204. metadata +85 -11
  205. data/lib/vapi_server_sdk/types/buy_phone_number_dto.rb +0 -147
  206. data/lib/vapi_server_sdk/types/org_with_org_user.rb +0 -262
  207. data/lib/vapi_server_sdk/types/org_with_org_user_channel.rb +0 -10
  208. data/lib/vapi_server_sdk/types/org_with_org_user_role.rb +0 -9
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vapi_server_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - ''
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-01-14 00:00:00.000000000 Z
11
+ date: 2025-03-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: async-http-faraday
@@ -165,6 +165,7 @@ files:
165
165
  - lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_update_request.rb
166
166
  - lib/vapi_server_sdk/knowledge_bases/types/knowledge_bases_update_response.rb
167
167
  - lib/vapi_server_sdk/logs/client.rb
168
+ - lib/vapi_server_sdk/logs/types/logging_controller_logs_delete_query_request_type.rb
168
169
  - lib/vapi_server_sdk/logs/types/logs_get_request_sort_order.rb
169
170
  - lib/vapi_server_sdk/logs/types/logs_get_request_type.rb
170
171
  - lib/vapi_server_sdk/phone_numbers/client.rb
@@ -176,6 +177,15 @@ files:
176
177
  - lib/vapi_server_sdk/phone_numbers/types/phone_numbers_update_request.rb
177
178
  - lib/vapi_server_sdk/phone_numbers/types/phone_numbers_update_response.rb
178
179
  - lib/vapi_server_sdk/squads/client.rb
180
+ - lib/vapi_server_sdk/test_suite_runs/client.rb
181
+ - lib/vapi_server_sdk/test_suite_runs/types/test_suite_run_controller_find_all_paginated_request_sort_order.rb
182
+ - lib/vapi_server_sdk/test_suite_tests/client.rb
183
+ - lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_create_request.rb
184
+ - lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_find_all_paginated_request_sort_order.rb
185
+ - lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_remove_response.rb
186
+ - lib/vapi_server_sdk/test_suite_tests/types/test_suite_test_controller_update_request.rb
187
+ - lib/vapi_server_sdk/test_suites/client.rb
188
+ - lib/vapi_server_sdk/test_suites/types/test_suite_controller_find_all_paginated_request_sort_order.rb
179
189
  - lib/vapi_server_sdk/tools/client.rb
180
190
  - lib/vapi_server_sdk/tools/types/tools_create_request.rb
181
191
  - lib/vapi_server_sdk/tools/types/tools_create_response.rb
@@ -185,6 +195,7 @@ files:
185
195
  - lib/vapi_server_sdk/tools/types/tools_update_request.rb
186
196
  - lib/vapi_server_sdk/tools/types/tools_update_response.rb
187
197
  - lib/vapi_server_sdk/types/add_voice_to_provider_dto.rb
198
+ - lib/vapi_server_sdk/types/ai_edge_condition.rb
188
199
  - lib/vapi_server_sdk/types/analysis.rb
189
200
  - lib/vapi_server_sdk/types/analysis_cost.rb
190
201
  - lib/vapi_server_sdk/types/analysis_cost_analysis_type.rb
@@ -194,9 +205,9 @@ files:
194
205
  - lib/vapi_server_sdk/types/analytics_operation_column.rb
195
206
  - lib/vapi_server_sdk/types/analytics_operation_operation.rb
196
207
  - lib/vapi_server_sdk/types/analytics_query.rb
197
- - lib/vapi_server_sdk/types/analytics_query_dto.rb
198
208
  - lib/vapi_server_sdk/types/analytics_query_group_by_item.rb
199
209
  - lib/vapi_server_sdk/types/analytics_query_result.rb
210
+ - lib/vapi_server_sdk/types/analytics_query_table.rb
200
211
  - lib/vapi_server_sdk/types/anthropic_credential.rb
201
212
  - lib/vapi_server_sdk/types/anthropic_model.rb
202
213
  - lib/vapi_server_sdk/types/anthropic_model_model.rb
@@ -204,6 +215,9 @@ files:
204
215
  - lib/vapi_server_sdk/types/anyscale_credential.rb
205
216
  - lib/vapi_server_sdk/types/anyscale_model.rb
206
217
  - lib/vapi_server_sdk/types/anyscale_model_tools_item.rb
218
+ - lib/vapi_server_sdk/types/api_request.rb
219
+ - lib/vapi_server_sdk/types/api_request_method.rb
220
+ - lib/vapi_server_sdk/types/api_request_mode.rb
207
221
  - lib/vapi_server_sdk/types/artifact.rb
208
222
  - lib/vapi_server_sdk/types/artifact_messages_item.rb
209
223
  - lib/vapi_server_sdk/types/artifact_plan.rb
@@ -217,6 +231,9 @@ files:
217
231
  - lib/vapi_server_sdk/types/assistant_credentials_item.rb
218
232
  - lib/vapi_server_sdk/types/assistant_custom_endpointing_rule.rb
219
233
  - lib/vapi_server_sdk/types/assistant_first_message_mode.rb
234
+ - lib/vapi_server_sdk/types/assistant_hook_action_base.rb
235
+ - lib/vapi_server_sdk/types/assistant_hook_filter.rb
236
+ - lib/vapi_server_sdk/types/assistant_hooks.rb
220
237
  - lib/vapi_server_sdk/types/assistant_model.rb
221
238
  - lib/vapi_server_sdk/types/assistant_overrides.rb
222
239
  - lib/vapi_server_sdk/types/assistant_overrides_background_sound.rb
@@ -243,8 +260,11 @@ files:
243
260
  - lib/vapi_server_sdk/types/azure_voice.rb
244
261
  - lib/vapi_server_sdk/types/azure_voice_id.rb
245
262
  - lib/vapi_server_sdk/types/azure_voice_id_enum.rb
263
+ - lib/vapi_server_sdk/types/backoff_plan.rb
246
264
  - lib/vapi_server_sdk/types/bash_tool.rb
247
265
  - lib/vapi_server_sdk/types/bash_tool_messages_item.rb
266
+ - lib/vapi_server_sdk/types/bash_tool_with_tool_call.rb
267
+ - lib/vapi_server_sdk/types/bash_tool_with_tool_call_messages_item.rb
248
268
  - lib/vapi_server_sdk/types/block_complete_message.rb
249
269
  - lib/vapi_server_sdk/types/block_complete_message_conditions_item.rb
250
270
  - lib/vapi_server_sdk/types/block_start_message.rb
@@ -252,10 +272,9 @@ files:
252
272
  - lib/vapi_server_sdk/types/bot_message.rb
253
273
  - lib/vapi_server_sdk/types/both_custom_endpointing_rule.rb
254
274
  - lib/vapi_server_sdk/types/bucket_plan.rb
255
- - lib/vapi_server_sdk/types/buy_phone_number_dto.rb
256
- - lib/vapi_server_sdk/types/buy_phone_number_dto_fallback_destination.rb
257
275
  - lib/vapi_server_sdk/types/byo_phone_number.rb
258
276
  - lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb
277
+ - lib/vapi_server_sdk/types/byo_phone_number_status.rb
259
278
  - lib/vapi_server_sdk/types/byo_sip_trunk_credential.rb
260
279
  - lib/vapi_server_sdk/types/call.rb
261
280
  - lib/vapi_server_sdk/types/call_costs_item.rb
@@ -273,10 +292,16 @@ files:
273
292
  - lib/vapi_server_sdk/types/callback_step.rb
274
293
  - lib/vapi_server_sdk/types/callback_step_block.rb
275
294
  - lib/vapi_server_sdk/types/cartesia_credential.rb
295
+ - lib/vapi_server_sdk/types/cartesia_experimental_controls.rb
296
+ - lib/vapi_server_sdk/types/cartesia_experimental_controls_emotion.rb
297
+ - lib/vapi_server_sdk/types/cartesia_experimental_controls_speed.rb
276
298
  - lib/vapi_server_sdk/types/cartesia_voice.rb
277
299
  - lib/vapi_server_sdk/types/cartesia_voice_language.rb
278
300
  - lib/vapi_server_sdk/types/cartesia_voice_model.rb
279
301
  - lib/vapi_server_sdk/types/cerebras_credential.rb
302
+ - lib/vapi_server_sdk/types/chat_completion_message.rb
303
+ - lib/vapi_server_sdk/types/chat_completion_message_metadata.rb
304
+ - lib/vapi_server_sdk/types/chat_completions_dto.rb
280
305
  - lib/vapi_server_sdk/types/chat_dto.rb
281
306
  - lib/vapi_server_sdk/types/chat_service_response.rb
282
307
  - lib/vapi_server_sdk/types/chunk_plan.rb
@@ -284,6 +309,7 @@ files:
284
309
  - lib/vapi_server_sdk/types/client_inbound_message_add_message.rb
285
310
  - lib/vapi_server_sdk/types/client_inbound_message_control.rb
286
311
  - lib/vapi_server_sdk/types/client_inbound_message_control_control.rb
312
+ - lib/vapi_server_sdk/types/client_inbound_message_end_call.rb
287
313
  - lib/vapi_server_sdk/types/client_inbound_message_message.rb
288
314
  - lib/vapi_server_sdk/types/client_inbound_message_say.rb
289
315
  - lib/vapi_server_sdk/types/client_inbound_message_transfer.rb
@@ -305,15 +331,20 @@ files:
305
331
  - lib/vapi_server_sdk/types/client_message_transcript.rb
306
332
  - lib/vapi_server_sdk/types/client_message_transcript_role.rb
307
333
  - lib/vapi_server_sdk/types/client_message_transcript_transcript_type.rb
334
+ - lib/vapi_server_sdk/types/client_message_transcript_type.rb
308
335
  - lib/vapi_server_sdk/types/client_message_transfer_update.rb
309
336
  - lib/vapi_server_sdk/types/client_message_transfer_update_destination.rb
310
337
  - lib/vapi_server_sdk/types/client_message_user_interrupted.rb
311
338
  - lib/vapi_server_sdk/types/client_message_voice_input.rb
339
+ - lib/vapi_server_sdk/types/client_message_workflow_node_started.rb
312
340
  - lib/vapi_server_sdk/types/clone_voice_dto.rb
313
341
  - lib/vapi_server_sdk/types/cloudflare_credential.rb
314
342
  - lib/vapi_server_sdk/types/cloudflare_r_2_bucket_plan.rb
343
+ - lib/vapi_server_sdk/types/compliance_plan.rb
315
344
  - lib/vapi_server_sdk/types/computer_tool.rb
316
345
  - lib/vapi_server_sdk/types/computer_tool_messages_item.rb
346
+ - lib/vapi_server_sdk/types/computer_tool_with_tool_call.rb
347
+ - lib/vapi_server_sdk/types/computer_tool_with_tool_call_messages_item.rb
317
348
  - lib/vapi_server_sdk/types/condition.rb
318
349
  - lib/vapi_server_sdk/types/condition_operator.rb
319
350
  - lib/vapi_server_sdk/types/conversation_block.rb
@@ -390,6 +421,7 @@ files:
390
421
  - lib/vapi_server_sdk/types/create_smallest_ai_credential_dto.rb
391
422
  - lib/vapi_server_sdk/types/create_squad_dto.rb
392
423
  - lib/vapi_server_sdk/types/create_tavus_credential_dto.rb
424
+ - lib/vapi_server_sdk/types/create_test_suite_test_voice_dto.rb
393
425
  - lib/vapi_server_sdk/types/create_text_editor_tool_dto.rb
394
426
  - lib/vapi_server_sdk/types/create_text_editor_tool_dto_messages_item.rb
395
427
  - lib/vapi_server_sdk/types/create_together_ai_credential_dto.rb
@@ -407,6 +439,7 @@ files:
407
439
  - lib/vapi_server_sdk/types/create_transfer_call_tool_dto_destinations_item.rb
408
440
  - lib/vapi_server_sdk/types/create_transfer_call_tool_dto_messages_item.rb
409
441
  - lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto.rb
442
+ - lib/vapi_server_sdk/types/create_trieve_knowledge_base_dto_create_plan.rb
410
443
  - lib/vapi_server_sdk/types/create_twilio_credential_dto.rb
411
444
  - lib/vapi_server_sdk/types/create_twilio_phone_number_dto.rb
412
445
  - lib/vapi_server_sdk/types/create_twilio_phone_number_dto_fallback_destination.rb
@@ -422,6 +455,8 @@ files:
422
455
  - lib/vapi_server_sdk/types/create_workflow_block_dto.rb
423
456
  - lib/vapi_server_sdk/types/create_workflow_block_dto_messages_item.rb
424
457
  - lib/vapi_server_sdk/types/create_workflow_block_dto_steps_item.rb
458
+ - lib/vapi_server_sdk/types/create_workflow_dto.rb
459
+ - lib/vapi_server_sdk/types/create_workflow_dto_nodes_item.rb
425
460
  - lib/vapi_server_sdk/types/create_x_ai_credential_dto.rb
426
461
  - lib/vapi_server_sdk/types/custom_knowledge_base.rb
427
462
  - lib/vapi_server_sdk/types/custom_llm_credential.rb
@@ -437,6 +472,7 @@ files:
437
472
  - lib/vapi_server_sdk/types/deep_infra_model_tools_item.rb
438
473
  - lib/vapi_server_sdk/types/deep_seek_credential.rb
439
474
  - lib/vapi_server_sdk/types/deep_seek_model.rb
475
+ - lib/vapi_server_sdk/types/deep_seek_model_model.rb
440
476
  - lib/vapi_server_sdk/types/deep_seek_model_tools_item.rb
441
477
  - lib/vapi_server_sdk/types/deepgram_credential.rb
442
478
  - lib/vapi_server_sdk/types/deepgram_transcriber.rb
@@ -447,6 +483,8 @@ files:
447
483
  - lib/vapi_server_sdk/types/deepgram_voice_id_enum.rb
448
484
  - lib/vapi_server_sdk/types/dtmf_tool.rb
449
485
  - lib/vapi_server_sdk/types/dtmf_tool_messages_item.rb
486
+ - lib/vapi_server_sdk/types/edge.rb
487
+ - lib/vapi_server_sdk/types/edge_condition.rb
450
488
  - lib/vapi_server_sdk/types/eleven_labs_credential.rb
451
489
  - lib/vapi_server_sdk/types/eleven_labs_voice.rb
452
490
  - lib/vapi_server_sdk/types/eleven_labs_voice_id.rb
@@ -456,6 +494,7 @@ files:
456
494
  - lib/vapi_server_sdk/types/end_call_tool_messages_item.rb
457
495
  - lib/vapi_server_sdk/types/error.rb
458
496
  - lib/vapi_server_sdk/types/exact_replacement.rb
497
+ - lib/vapi_server_sdk/types/failed_edge_condition.rb
459
498
  - lib/vapi_server_sdk/types/fallback_azure_voice.rb
460
499
  - lib/vapi_server_sdk/types/fallback_azure_voice_id.rb
461
500
  - lib/vapi_server_sdk/types/fallback_azure_voice_voice_id.rb
@@ -498,12 +537,14 @@ files:
498
537
  - lib/vapi_server_sdk/types/file.rb
499
538
  - lib/vapi_server_sdk/types/file_status.rb
500
539
  - lib/vapi_server_sdk/types/format_plan.rb
540
+ - lib/vapi_server_sdk/types/format_plan_formatters_enabled_item.rb
501
541
  - lib/vapi_server_sdk/types/format_plan_replacements_item.rb
502
542
  - lib/vapi_server_sdk/types/function_tool.rb
503
543
  - lib/vapi_server_sdk/types/function_tool_messages_item.rb
504
544
  - lib/vapi_server_sdk/types/function_tool_provider_details.rb
505
545
  - lib/vapi_server_sdk/types/function_tool_with_tool_call.rb
506
546
  - lib/vapi_server_sdk/types/function_tool_with_tool_call_messages_item.rb
547
+ - lib/vapi_server_sdk/types/gather.rb
507
548
  - lib/vapi_server_sdk/types/gcp_credential.rb
508
549
  - lib/vapi_server_sdk/types/gcp_key.rb
509
550
  - lib/vapi_server_sdk/types/gemini_multimodal_live_prebuilt_voice_config.rb
@@ -533,6 +574,9 @@ files:
533
574
  - lib/vapi_server_sdk/types/groq_model_tools_item.rb
534
575
  - lib/vapi_server_sdk/types/handoff_step.rb
535
576
  - lib/vapi_server_sdk/types/handoff_step_block.rb
577
+ - lib/vapi_server_sdk/types/hangup.rb
578
+ - lib/vapi_server_sdk/types/hook.rb
579
+ - lib/vapi_server_sdk/types/hook_on.rb
536
580
  - lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb
537
581
  - lib/vapi_server_sdk/types/import_twilio_phone_number_dto_fallback_destination.rb
538
582
  - lib/vapi_server_sdk/types/import_vonage_phone_number_dto.rb
@@ -554,6 +598,7 @@ files:
554
598
  - lib/vapi_server_sdk/types/log_request_http_method.rb
555
599
  - lib/vapi_server_sdk/types/log_resource.rb
556
600
  - lib/vapi_server_sdk/types/log_type.rb
601
+ - lib/vapi_server_sdk/types/logic_edge_condition.rb
557
602
  - lib/vapi_server_sdk/types/logs_paginated_response.rb
558
603
  - lib/vapi_server_sdk/types/make_credential.rb
559
604
  - lib/vapi_server_sdk/types/make_tool.rb
@@ -590,9 +635,6 @@ files:
590
635
  - lib/vapi_server_sdk/types/org.rb
591
636
  - lib/vapi_server_sdk/types/org_channel.rb
592
637
  - lib/vapi_server_sdk/types/org_plan.rb
593
- - lib/vapi_server_sdk/types/org_with_org_user.rb
594
- - lib/vapi_server_sdk/types/org_with_org_user_channel.rb
595
- - lib/vapi_server_sdk/types/org_with_org_user_role.rb
596
638
  - lib/vapi_server_sdk/types/output_tool.rb
597
639
  - lib/vapi_server_sdk/types/output_tool_messages_item.rb
598
640
  - lib/vapi_server_sdk/types/pagination_meta.rb
@@ -621,6 +663,8 @@ files:
621
663
  - lib/vapi_server_sdk/types/rule_based_condition_operator.rb
622
664
  - lib/vapi_server_sdk/types/runpod_credential.rb
623
665
  - lib/vapi_server_sdk/types/s_3_credential.rb
666
+ - lib/vapi_server_sdk/types/say.rb
667
+ - lib/vapi_server_sdk/types/say_hook.rb
624
668
  - lib/vapi_server_sdk/types/sbc_configuration.rb
625
669
  - lib/vapi_server_sdk/types/server.rb
626
670
  - lib/vapi_server_sdk/types/server_message.rb
@@ -673,6 +717,7 @@ files:
673
717
  - lib/vapi_server_sdk/types/server_message_transcript_phone_number.rb
674
718
  - lib/vapi_server_sdk/types/server_message_transcript_role.rb
675
719
  - lib/vapi_server_sdk/types/server_message_transcript_transcript_type.rb
720
+ - lib/vapi_server_sdk/types/server_message_transcript_type.rb
676
721
  - lib/vapi_server_sdk/types/server_message_transfer_destination_request.rb
677
722
  - lib/vapi_server_sdk/types/server_message_transfer_destination_request_phone_number.rb
678
723
  - lib/vapi_server_sdk/types/server_message_transfer_update.rb
@@ -721,10 +766,25 @@ files:
721
766
  - lib/vapi_server_sdk/types/template_provider.rb
722
767
  - lib/vapi_server_sdk/types/template_provider_details.rb
723
768
  - lib/vapi_server_sdk/types/template_visibility.rb
769
+ - lib/vapi_server_sdk/types/test_suite.rb
770
+ - lib/vapi_server_sdk/types/test_suite_run.rb
771
+ - lib/vapi_server_sdk/types/test_suite_run_scorer_ai.rb
772
+ - lib/vapi_server_sdk/types/test_suite_run_scorer_ai_result.rb
773
+ - lib/vapi_server_sdk/types/test_suite_run_status.rb
774
+ - lib/vapi_server_sdk/types/test_suite_run_test_attempt.rb
775
+ - lib/vapi_server_sdk/types/test_suite_run_test_attempt_call.rb
776
+ - lib/vapi_server_sdk/types/test_suite_run_test_result.rb
777
+ - lib/vapi_server_sdk/types/test_suite_runs_paginated_response.rb
778
+ - lib/vapi_server_sdk/types/test_suite_test_scorer_ai.rb
779
+ - lib/vapi_server_sdk/types/test_suite_test_voice.rb
780
+ - lib/vapi_server_sdk/types/test_suite_tests_paginated_response.rb
781
+ - lib/vapi_server_sdk/types/test_suites_paginated_response.rb
724
782
  - lib/vapi_server_sdk/types/text_content.rb
725
783
  - lib/vapi_server_sdk/types/text_content_language.rb
726
784
  - lib/vapi_server_sdk/types/text_editor_tool.rb
727
785
  - lib/vapi_server_sdk/types/text_editor_tool_messages_item.rb
786
+ - lib/vapi_server_sdk/types/text_editor_tool_with_tool_call.rb
787
+ - lib/vapi_server_sdk/types/text_editor_tool_with_tool_call_messages_item.rb
728
788
  - lib/vapi_server_sdk/types/time_range.rb
729
789
  - lib/vapi_server_sdk/types/time_range_step.rb
730
790
  - lib/vapi_server_sdk/types/together_ai_credential.rb
@@ -752,6 +812,9 @@ files:
752
812
  - lib/vapi_server_sdk/types/transcriber_cost.rb
753
813
  - lib/vapi_server_sdk/types/transcript_plan.rb
754
814
  - lib/vapi_server_sdk/types/transcription_endpointing_plan.rb
815
+ - lib/vapi_server_sdk/types/transfer.rb
816
+ - lib/vapi_server_sdk/types/transfer_assistant_hook_action.rb
817
+ - lib/vapi_server_sdk/types/transfer_assistant_hook_action_destination.rb
755
818
  - lib/vapi_server_sdk/types/transfer_call_tool.rb
756
819
  - lib/vapi_server_sdk/types/transfer_call_tool_destinations_item.rb
757
820
  - lib/vapi_server_sdk/types/transfer_call_tool_messages_item.rb
@@ -774,12 +837,16 @@ files:
774
837
  - lib/vapi_server_sdk/types/transport_cost_provider.rb
775
838
  - lib/vapi_server_sdk/types/transport_provider.rb
776
839
  - lib/vapi_server_sdk/types/trieve_knowledge_base.rb
777
- - lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_create_plan.rb
778
- - lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_search_plan.rb
779
- - lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_search_plan_search_type.rb
840
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_chunk_plan.rb
841
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb
842
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_create_plan.rb
843
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_import.rb
844
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_search_plan.rb
845
+ - lib/vapi_server_sdk/types/trieve_knowledge_base_search_plan_search_type.rb
780
846
  - lib/vapi_server_sdk/types/twilio_credential.rb
781
847
  - lib/vapi_server_sdk/types/twilio_phone_number.rb
782
848
  - lib/vapi_server_sdk/types/twilio_phone_number_fallback_destination.rb
849
+ - lib/vapi_server_sdk/types/twilio_phone_number_status.rb
783
850
  - lib/vapi_server_sdk/types/twilio_voicemail_detection.rb
784
851
  - lib/vapi_server_sdk/types/twilio_voicemail_detection_voicemail_detection_types_item.rb
785
852
  - lib/vapi_server_sdk/types/update_anthropic_credential_dto.rb
@@ -841,6 +908,7 @@ files:
841
908
  - lib/vapi_server_sdk/types/update_s_3_credential_dto.rb
842
909
  - lib/vapi_server_sdk/types/update_smallest_ai_credential_dto.rb
843
910
  - lib/vapi_server_sdk/types/update_tavus_credential_dto.rb
911
+ - lib/vapi_server_sdk/types/update_test_suite_test_voice_dto.rb
844
912
  - lib/vapi_server_sdk/types/update_text_editor_tool_dto.rb
845
913
  - lib/vapi_server_sdk/types/update_text_editor_tool_dto_messages_item.rb
846
914
  - lib/vapi_server_sdk/types/update_together_ai_credential_dto.rb
@@ -858,6 +926,7 @@ files:
858
926
  - lib/vapi_server_sdk/types/update_transfer_call_tool_dto_destinations_item.rb
859
927
  - lib/vapi_server_sdk/types/update_transfer_call_tool_dto_messages_item.rb
860
928
  - lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto.rb
929
+ - lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto_create_plan.rb
861
930
  - lib/vapi_server_sdk/types/update_twilio_credential_dto.rb
862
931
  - lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb
863
932
  - lib/vapi_server_sdk/types/update_twilio_phone_number_dto_fallback_destination.rb
@@ -881,6 +950,7 @@ files:
881
950
  - lib/vapi_server_sdk/types/vapi_model_tools_item.rb
882
951
  - lib/vapi_server_sdk/types/vapi_phone_number.rb
883
952
  - lib/vapi_server_sdk/types/vapi_phone_number_fallback_destination.rb
953
+ - lib/vapi_server_sdk/types/vapi_phone_number_status.rb
884
954
  - lib/vapi_server_sdk/types/voice_cost.rb
885
955
  - lib/vapi_server_sdk/types/voice_library.rb
886
956
  - lib/vapi_server_sdk/types/voice_library_gender.rb
@@ -888,12 +958,16 @@ files:
888
958
  - lib/vapi_server_sdk/types/vonage_credential.rb
889
959
  - lib/vapi_server_sdk/types/vonage_phone_number.rb
890
960
  - lib/vapi_server_sdk/types/vonage_phone_number_fallback_destination.rb
961
+ - lib/vapi_server_sdk/types/vonage_phone_number_status.rb
891
962
  - lib/vapi_server_sdk/types/webhook_credential.rb
963
+ - lib/vapi_server_sdk/types/workflow.rb
892
964
  - lib/vapi_server_sdk/types/workflow_block.rb
893
965
  - lib/vapi_server_sdk/types/workflow_block_messages_item.rb
894
966
  - lib/vapi_server_sdk/types/workflow_block_steps_item.rb
967
+ - lib/vapi_server_sdk/types/workflow_nodes_item.rb
895
968
  - lib/vapi_server_sdk/types/x_ai_credential.rb
896
969
  - lib/vapi_server_sdk/types/xai_model.rb
970
+ - lib/vapi_server_sdk/types/xai_model_model.rb
897
971
  - lib/vapi_server_sdk/types/xai_model_tools_item.rb
898
972
  homepage: https://github.com/VapiAI/server-sdk-ruby
899
973
  licenses: []
@@ -1,147 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "buy_phone_number_dto_fallback_destination"
4
- require_relative "server"
5
- require "ostruct"
6
- require "json"
7
-
8
- module Vapi
9
- class BuyPhoneNumberDto
10
- # @return [Vapi::BuyPhoneNumberDtoFallbackDestination] This is the fallback destination an inbound call will be transferred to if:
11
- # 1. `assistantId` is not set
12
- # 2. `squadId` is not set
13
- # 3. and, `assistant-request` message to the `serverUrl` fails
14
- # If this is not set and above conditions are met, the inbound call is hung up
15
- # with an error message.
16
- attr_reader :fallback_destination
17
- # @return [String] This is the area code of the phone number to purchase.
18
- attr_reader :area_code
19
- # @return [String] This is the name of the phone number. This is just for your own reference.
20
- attr_reader :name
21
- # @return [String] This is the assistant that will be used for incoming calls to this phone number.
22
- # If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
23
- # to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
24
- # shape of the message and response that is expected.
25
- attr_reader :assistant_id
26
- # @return [String] This is the squad that will be used for incoming calls to this phone number.
27
- # If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
28
- # to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
29
- # shape of the message and response that is expected.
30
- attr_reader :squad_id
31
- # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
32
- # with their shape in ServerMessage schema.
33
- # The order of precedence is:
34
- # 1. assistant.server
35
- # 2. phoneNumber.server
36
- # 3. org.server
37
- attr_reader :server
38
- # @return [OpenStruct] Additional properties unmapped to the current class definition
39
- attr_reader :additional_properties
40
- # @return [Object]
41
- attr_reader :_field_set
42
- protected :_field_set
43
-
44
- OMIT = Object.new
45
-
46
- # @param fallback_destination [Vapi::BuyPhoneNumberDtoFallbackDestination] This is the fallback destination an inbound call will be transferred to if:
47
- # 1. `assistantId` is not set
48
- # 2. `squadId` is not set
49
- # 3. and, `assistant-request` message to the `serverUrl` fails
50
- # If this is not set and above conditions are met, the inbound call is hung up
51
- # with an error message.
52
- # @param area_code [String] This is the area code of the phone number to purchase.
53
- # @param name [String] This is the name of the phone number. This is just for your own reference.
54
- # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
55
- # If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
56
- # to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
57
- # shape of the message and response that is expected.
58
- # @param squad_id [String] This is the squad that will be used for incoming calls to this phone number.
59
- # If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
60
- # to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
61
- # shape of the message and response that is expected.
62
- # @param server [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
63
- # with their shape in ServerMessage schema.
64
- # The order of precedence is:
65
- # 1. assistant.server
66
- # 2. phoneNumber.server
67
- # 3. org.server
68
- # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
69
- # @return [Vapi::BuyPhoneNumberDto]
70
- def initialize(area_code:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT,
71
- server: OMIT, additional_properties: nil)
72
- @fallback_destination = fallback_destination if fallback_destination != OMIT
73
- @area_code = area_code
74
- @name = name if name != OMIT
75
- @assistant_id = assistant_id if assistant_id != OMIT
76
- @squad_id = squad_id if squad_id != OMIT
77
- @server = server if server != OMIT
78
- @additional_properties = additional_properties
79
- @_field_set = {
80
- "fallbackDestination": fallback_destination,
81
- "areaCode": area_code,
82
- "name": name,
83
- "assistantId": assistant_id,
84
- "squadId": squad_id,
85
- "server": server
86
- }.reject do |_k, v|
87
- v == OMIT
88
- end
89
- end
90
-
91
- # Deserialize a JSON object to an instance of BuyPhoneNumberDto
92
- #
93
- # @param json_object [String]
94
- # @return [Vapi::BuyPhoneNumberDto]
95
- def self.from_json(json_object:)
96
- struct = JSON.parse(json_object, object_class: OpenStruct)
97
- parsed_json = JSON.parse(json_object)
98
- if parsed_json["fallbackDestination"].nil?
99
- fallback_destination = nil
100
- else
101
- fallback_destination = parsed_json["fallbackDestination"].to_json
102
- fallback_destination = Vapi::BuyPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
103
- end
104
- area_code = parsed_json["areaCode"]
105
- name = parsed_json["name"]
106
- assistant_id = parsed_json["assistantId"]
107
- squad_id = parsed_json["squadId"]
108
- if parsed_json["server"].nil?
109
- server = nil
110
- else
111
- server = parsed_json["server"].to_json
112
- server = Vapi::Server.from_json(json_object: server)
113
- end
114
- new(
115
- fallback_destination: fallback_destination,
116
- area_code: area_code,
117
- name: name,
118
- assistant_id: assistant_id,
119
- squad_id: squad_id,
120
- server: server,
121
- additional_properties: struct
122
- )
123
- end
124
-
125
- # Serialize an instance of BuyPhoneNumberDto to a JSON object
126
- #
127
- # @return [String]
128
- def to_json(*_args)
129
- @_field_set&.to_json
130
- end
131
-
132
- # Leveraged for Union-type generation, validate_raw attempts to parse the given
133
- # hash and check each fields type against the current object's property
134
- # definitions.
135
- #
136
- # @param obj [Object]
137
- # @return [Void]
138
- def self.validate_raw(obj:)
139
- obj.fallback_destination.nil? || Vapi::BuyPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
140
- obj.area_code.is_a?(String) != false || raise("Passed value for field obj.area_code is not the expected type, validation failed.")
141
- obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
142
- obj.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
143
- obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
144
- obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
145
- end
146
- end
147
- end