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
data/lib/vapi_server_sdk/calls/client.rb CHANGED
@@ -42,13 +42,6 @@ module Vapi
42
42
  # specified value.
43
43
  # @param request_options [Vapi::RequestOptions]
44
44
  # @return [Array<Vapi::Call>]
45
- # @example
46
- # api = Vapi::Client.new(
47
- # base_url: "https://api.example.com",
48
- # environment: Vapi::Environment::DEFAULT,
49
- # token: "YOUR_AUTH_TOKEN"
50
- # )
51
- # api.calls.list
52
45
  def list(id: nil, assistant_id: nil, phone_number_id: nil, limit: nil, created_at_gt: nil, created_at_lt: nil,
53
46
  created_at_ge: nil, created_at_le: nil, updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
54
47
  response = @request_client.conn.get do |req|
@@ -96,7 +89,6 @@ module Vapi
96
89
  # * :voice (Hash)
97
90
  # * :first_message (String)
98
91
  # * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
99
- # * :hipaa_enabled (Boolean)
100
92
  # * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
101
93
  # * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
102
94
  # * :silence_timeout_seconds (Float)
@@ -118,6 +110,9 @@ module Vapi
118
110
  # * :voicemail_message (String)
119
111
  # * :end_call_message (String)
120
112
  # * :end_call_phrases (Array<String>)
113
+ # * :compliance_plan (Hash)
114
+ # * :hipaa_enabled (Boolean)
115
+ # * :pci_enabled (Boolean)
121
116
  # * :metadata (Hash{String => Object})
122
117
  # * :analysis_plan (Hash)
123
118
  # * :summary_plan (Hash)
@@ -133,6 +128,10 @@ module Vapi
133
128
  # * :properties (Hash{String => Object})
134
129
  # * :description (String)
135
130
  # * :required (Array<String>)
131
+ # * :regex (String)
132
+ # * :value (String)
133
+ # * :target (String)
134
+ # * :enum (Array<String>)
136
135
  # * :timeout_seconds (Float)
137
136
  # * :success_evaluation_plan (Hash)
138
137
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -142,6 +141,8 @@ module Vapi
142
141
  # * :artifact_plan (Hash)
143
142
  # * :recording_enabled (Boolean)
144
143
  # * :video_recording_enabled (Boolean)
144
+ # * :pcap_enabled (Boolean)
145
+ # * :pcap_s_3_path_prefix (String)
145
146
  # * :transcript_plan (Hash)
146
147
  # * :enabled (Boolean)
147
148
  # * :assistant_name (String)
@@ -151,6 +152,7 @@ module Vapi
151
152
  # * :idle_messages (Array<String>)
152
153
  # * :idle_message_max_spoken_count (Float)
153
154
  # * :idle_timeout_seconds (Float)
155
+ # * :silence_timeout_message (String)
154
156
  # * :start_speaking_plan (Hash)
155
157
  # * :wait_seconds (Float)
156
158
  # * :smart_endpointing_enabled (Boolean)
@@ -163,6 +165,8 @@ module Vapi
163
165
  # * :num_words (Float)
164
166
  # * :voice_seconds (Float)
165
167
  # * :backoff_seconds (Float)
168
+ # * :acknowledgement_phrases (Array<String>)
169
+ # * :interruption_phrases (Array<String>)
166
170
  # * :monitor_plan (Hash)
167
171
  # * :listen_enabled (Boolean)
168
172
  # * :control_enabled (Boolean)
@@ -172,6 +176,11 @@ module Vapi
172
176
  # * :url (String)
173
177
  # * :secret (String)
174
178
  # * :headers (Hash{String => Object})
179
+ # * :backoff_plan (Hash)
180
+ # * :max_retries (Float)
181
+ # * :type (Hash{String => Object})
182
+ # * :base_delay_seconds (Float)
183
+ # * :hooks (Array<Vapi::AssistantHooks>)
175
184
  # @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
176
185
  # template variables.Request of type Vapi::AssistantOverrides, as a Hash
177
186
  # * :transcriber (Hash)
@@ -179,7 +188,6 @@ module Vapi
179
188
  # * :voice (Hash)
180
189
  # * :first_message (String)
181
190
  # * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
182
- # * :hipaa_enabled (Boolean)
183
191
  # * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
184
192
  # * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
185
193
  # * :silence_timeout_seconds (Float)
@@ -202,6 +210,9 @@ module Vapi
202
210
  # * :voicemail_message (String)
203
211
  # * :end_call_message (String)
204
212
  # * :end_call_phrases (Array<String>)
213
+ # * :compliance_plan (Hash)
214
+ # * :hipaa_enabled (Boolean)
215
+ # * :pci_enabled (Boolean)
205
216
  # * :metadata (Hash{String => Object})
206
217
  # * :analysis_plan (Hash)
207
218
  # * :summary_plan (Hash)
@@ -217,6 +228,10 @@ module Vapi
217
228
  # * :properties (Hash{String => Object})
218
229
  # * :description (String)
219
230
  # * :required (Array<String>)
231
+ # * :regex (String)
232
+ # * :value (String)
233
+ # * :target (String)
234
+ # * :enum (Array<String>)
220
235
  # * :timeout_seconds (Float)
221
236
  # * :success_evaluation_plan (Hash)
222
237
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -226,6 +241,8 @@ module Vapi
226
241
  # * :artifact_plan (Hash)
227
242
  # * :recording_enabled (Boolean)
228
243
  # * :video_recording_enabled (Boolean)
244
+ # * :pcap_enabled (Boolean)
245
+ # * :pcap_s_3_path_prefix (String)
229
246
  # * :transcript_plan (Hash)
230
247
  # * :enabled (Boolean)
231
248
  # * :assistant_name (String)
@@ -235,6 +252,7 @@ module Vapi
235
252
  # * :idle_messages (Array<String>)
236
253
  # * :idle_message_max_spoken_count (Float)
237
254
  # * :idle_timeout_seconds (Float)
255
+ # * :silence_timeout_message (String)
238
256
  # * :start_speaking_plan (Hash)
239
257
  # * :wait_seconds (Float)
240
258
  # * :smart_endpointing_enabled (Boolean)
@@ -247,6 +265,8 @@ module Vapi
247
265
  # * :num_words (Float)
248
266
  # * :voice_seconds (Float)
249
267
  # * :backoff_seconds (Float)
268
+ # * :acknowledgement_phrases (Array<String>)
269
+ # * :interruption_phrases (Array<String>)
250
270
  # * :monitor_plan (Hash)
251
271
  # * :listen_enabled (Boolean)
252
272
  # * :control_enabled (Boolean)
@@ -256,6 +276,11 @@ module Vapi
256
276
  # * :url (String)
257
277
  # * :secret (String)
258
278
  # * :headers (Hash{String => Object})
279
+ # * :backoff_plan (Hash)
280
+ # * :max_retries (Float)
281
+ # * :type (Hash{String => Object})
282
+ # * :base_delay_seconds (Float)
283
+ # * :hooks (Array<Vapi::AssistantHooks>)
259
284
  # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
260
285
  # `squad` instead.
261
286
  # @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
@@ -268,7 +293,6 @@ module Vapi
268
293
  # * :voice (Hash)
269
294
  # * :first_message (String)
270
295
  # * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
271
- # * :hipaa_enabled (Boolean)
272
296
  # * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
273
297
  # * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
274
298
  # * :silence_timeout_seconds (Float)
@@ -291,6 +315,9 @@ module Vapi
291
315
  # * :voicemail_message (String)
292
316
  # * :end_call_message (String)
293
317
  # * :end_call_phrases (Array<String>)
318
+ # * :compliance_plan (Hash)
319
+ # * :hipaa_enabled (Boolean)
320
+ # * :pci_enabled (Boolean)
294
321
  # * :metadata (Hash{String => Object})
295
322
  # * :analysis_plan (Hash)
296
323
  # * :summary_plan (Hash)
@@ -306,6 +333,10 @@ module Vapi
306
333
  # * :properties (Hash{String => Object})
307
334
  # * :description (String)
308
335
  # * :required (Array<String>)
336
+ # * :regex (String)
337
+ # * :value (String)
338
+ # * :target (String)
339
+ # * :enum (Array<String>)
309
340
  # * :timeout_seconds (Float)
310
341
  # * :success_evaluation_plan (Hash)
311
342
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -315,6 +346,8 @@ module Vapi
315
346
  # * :artifact_plan (Hash)
316
347
  # * :recording_enabled (Boolean)
317
348
  # * :video_recording_enabled (Boolean)
349
+ # * :pcap_enabled (Boolean)
350
+ # * :pcap_s_3_path_prefix (String)
318
351
  # * :transcript_plan (Hash)
319
352
  # * :enabled (Boolean)
320
353
  # * :assistant_name (String)
@@ -324,6 +357,7 @@ module Vapi
324
357
  # * :idle_messages (Array<String>)
325
358
  # * :idle_message_max_spoken_count (Float)
326
359
  # * :idle_timeout_seconds (Float)
360
+ # * :silence_timeout_message (String)
327
361
  # * :start_speaking_plan (Hash)
328
362
  # * :wait_seconds (Float)
329
363
  # * :smart_endpointing_enabled (Boolean)
@@ -336,6 +370,8 @@ module Vapi
336
370
  # * :num_words (Float)
337
371
  # * :voice_seconds (Float)
338
372
  # * :backoff_seconds (Float)
373
+ # * :acknowledgement_phrases (Array<String>)
374
+ # * :interruption_phrases (Array<String>)
339
375
  # * :monitor_plan (Hash)
340
376
  # * :listen_enabled (Boolean)
341
377
  # * :control_enabled (Boolean)
@@ -345,6 +381,11 @@ module Vapi
345
381
  # * :url (String)
346
382
  # * :secret (String)
347
383
  # * :headers (Hash{String => Object})
384
+ # * :backoff_plan (Hash)
385
+ # * :max_retries (Float)
386
+ # * :type (Hash{String => Object})
387
+ # * :base_delay_seconds (Float)
388
+ # * :hooks (Array<Vapi::AssistantHooks>)
348
389
  # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
349
390
  # number, use `phoneNumber` instead.
350
391
  # Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -363,6 +404,10 @@ module Vapi
363
404
  # * :url (String)
364
405
  # * :secret (String)
365
406
  # * :headers (Hash{String => Object})
407
+ # * :backoff_plan (Hash)
408
+ # * :max_retries (Float)
409
+ # * :type (Hash{String => Object})
410
+ # * :base_delay_seconds (Float)
366
411
  # @param customer_id [String] This is the customer that will be called. To call a transient customer , use
367
412
  # `customer` instead.
368
413
  # Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -376,13 +421,6 @@ module Vapi
376
421
  # * :name (String)
377
422
  # @param request_options [Vapi::RequestOptions]
378
423
  # @return [Vapi::Call]
379
- # @example
380
- # api = Vapi::Client.new(
381
- # base_url: "https://api.example.com",
382
- # environment: Vapi::Environment::DEFAULT,
383
- # token: "YOUR_AUTH_TOKEN"
384
- # )
385
- # api.calls.create
386
424
  def create(name: nil, assistant_id: nil, assistant: nil, assistant_overrides: nil, squad_id: nil, squad: nil,
387
425
  phone_number_id: nil, phone_number: nil, customer_id: nil, customer: nil, request_options: nil)
388
426
  response = @request_client.conn.post do |req|
@@ -417,13 +455,6 @@ module Vapi
417
455
  # @param id [String]
418
456
  # @param request_options [Vapi::RequestOptions]
419
457
  # @return [Vapi::Call]
420
- # @example
421
- # api = Vapi::Client.new(
422
- # base_url: "https://api.example.com",
423
- # environment: Vapi::Environment::DEFAULT,
424
- # token: "YOUR_AUTH_TOKEN"
425
- # )
426
- # api.calls.get(id: "id")
427
458
  def get(id:, request_options: nil)
428
459
  response = @request_client.conn.get do |req|
429
460
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -447,13 +478,6 @@ module Vapi
447
478
  # @param id [String]
448
479
  # @param request_options [Vapi::RequestOptions]
449
480
  # @return [Vapi::Call]
450
- # @example
451
- # api = Vapi::Client.new(
452
- # base_url: "https://api.example.com",
453
- # environment: Vapi::Environment::DEFAULT,
454
- # token: "YOUR_AUTH_TOKEN"
455
- # )
456
- # api.calls.delete(id: "id")
457
481
  def delete(id:, request_options: nil)
458
482
  response = @request_client.conn.delete do |req|
459
483
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -478,13 +502,6 @@ module Vapi
478
502
  # @param name [String] This is the name of the call. This is just for your own reference.
479
503
  # @param request_options [Vapi::RequestOptions]
480
504
  # @return [Vapi::Call]
481
- # @example
482
- # api = Vapi::Client.new(
483
- # base_url: "https://api.example.com",
484
- # environment: Vapi::Environment::DEFAULT,
485
- # token: "YOUR_AUTH_TOKEN"
486
- # )
487
- # api.calls.update(id: "id")
488
505
  def update(id:, name: nil, request_options: nil)
489
506
  response = @request_client.conn.patch do |req|
490
507
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -534,13 +551,6 @@ module Vapi
534
551
  # specified value.
535
552
  # @param request_options [Vapi::RequestOptions]
536
553
  # @return [Array<Vapi::Call>]
537
- # @example
538
- # api = Vapi::Client.new(
539
- # base_url: "https://api.example.com",
540
- # environment: Vapi::Environment::DEFAULT,
541
- # token: "YOUR_AUTH_TOKEN"
542
- # )
543
- # api.calls.list
544
554
  def list(id: nil, assistant_id: nil, phone_number_id: nil, limit: nil, created_at_gt: nil, created_at_lt: nil,
545
555
  created_at_ge: nil, created_at_le: nil, updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
546
556
  Async do
@@ -590,7 +600,6 @@ module Vapi
590
600
  # * :voice (Hash)
591
601
  # * :first_message (String)
592
602
  # * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
593
- # * :hipaa_enabled (Boolean)
594
603
  # * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
595
604
  # * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
596
605
  # * :silence_timeout_seconds (Float)
@@ -612,6 +621,9 @@ module Vapi
612
621
  # * :voicemail_message (String)
613
622
  # * :end_call_message (String)
614
623
  # * :end_call_phrases (Array<String>)
624
+ # * :compliance_plan (Hash)
625
+ # * :hipaa_enabled (Boolean)
626
+ # * :pci_enabled (Boolean)
615
627
  # * :metadata (Hash{String => Object})
616
628
  # * :analysis_plan (Hash)
617
629
  # * :summary_plan (Hash)
@@ -627,6 +639,10 @@ module Vapi
627
639
  # * :properties (Hash{String => Object})
628
640
  # * :description (String)
629
641
  # * :required (Array<String>)
642
+ # * :regex (String)
643
+ # * :value (String)
644
+ # * :target (String)
645
+ # * :enum (Array<String>)
630
646
  # * :timeout_seconds (Float)
631
647
  # * :success_evaluation_plan (Hash)
632
648
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -636,6 +652,8 @@ module Vapi
636
652
  # * :artifact_plan (Hash)
637
653
  # * :recording_enabled (Boolean)
638
654
  # * :video_recording_enabled (Boolean)
655
+ # * :pcap_enabled (Boolean)
656
+ # * :pcap_s_3_path_prefix (String)
639
657
  # * :transcript_plan (Hash)
640
658
  # * :enabled (Boolean)
641
659
  # * :assistant_name (String)
@@ -645,6 +663,7 @@ module Vapi
645
663
  # * :idle_messages (Array<String>)
646
664
  # * :idle_message_max_spoken_count (Float)
647
665
  # * :idle_timeout_seconds (Float)
666
+ # * :silence_timeout_message (String)
648
667
  # * :start_speaking_plan (Hash)
649
668
  # * :wait_seconds (Float)
650
669
  # * :smart_endpointing_enabled (Boolean)
@@ -657,6 +676,8 @@ module Vapi
657
676
  # * :num_words (Float)
658
677
  # * :voice_seconds (Float)
659
678
  # * :backoff_seconds (Float)
679
+ # * :acknowledgement_phrases (Array<String>)
680
+ # * :interruption_phrases (Array<String>)
660
681
  # * :monitor_plan (Hash)
661
682
  # * :listen_enabled (Boolean)
662
683
  # * :control_enabled (Boolean)
@@ -666,6 +687,11 @@ module Vapi
666
687
  # * :url (String)
667
688
  # * :secret (String)
668
689
  # * :headers (Hash{String => Object})
690
+ # * :backoff_plan (Hash)
691
+ # * :max_retries (Float)
692
+ # * :type (Hash{String => Object})
693
+ # * :base_delay_seconds (Float)
694
+ # * :hooks (Array<Vapi::AssistantHooks>)
669
695
  # @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
670
696
  # template variables.Request of type Vapi::AssistantOverrides, as a Hash
671
697
  # * :transcriber (Hash)
@@ -673,7 +699,6 @@ module Vapi
673
699
  # * :voice (Hash)
674
700
  # * :first_message (String)
675
701
  # * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
676
- # * :hipaa_enabled (Boolean)
677
702
  # * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
678
703
  # * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
679
704
  # * :silence_timeout_seconds (Float)
@@ -696,6 +721,9 @@ module Vapi
696
721
  # * :voicemail_message (String)
697
722
  # * :end_call_message (String)
698
723
  # * :end_call_phrases (Array<String>)
724
+ # * :compliance_plan (Hash)
725
+ # * :hipaa_enabled (Boolean)
726
+ # * :pci_enabled (Boolean)
699
727
  # * :metadata (Hash{String => Object})
700
728
  # * :analysis_plan (Hash)
701
729
  # * :summary_plan (Hash)
@@ -711,6 +739,10 @@ module Vapi
711
739
  # * :properties (Hash{String => Object})
712
740
  # * :description (String)
713
741
  # * :required (Array<String>)
742
+ # * :regex (String)
743
+ # * :value (String)
744
+ # * :target (String)
745
+ # * :enum (Array<String>)
714
746
  # * :timeout_seconds (Float)
715
747
  # * :success_evaluation_plan (Hash)
716
748
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -720,6 +752,8 @@ module Vapi
720
752
  # * :artifact_plan (Hash)
721
753
  # * :recording_enabled (Boolean)
722
754
  # * :video_recording_enabled (Boolean)
755
+ # * :pcap_enabled (Boolean)
756
+ # * :pcap_s_3_path_prefix (String)
723
757
  # * :transcript_plan (Hash)
724
758
  # * :enabled (Boolean)
725
759
  # * :assistant_name (String)
@@ -729,6 +763,7 @@ module Vapi
729
763
  # * :idle_messages (Array<String>)
730
764
  # * :idle_message_max_spoken_count (Float)
731
765
  # * :idle_timeout_seconds (Float)
766
+ # * :silence_timeout_message (String)
732
767
  # * :start_speaking_plan (Hash)
733
768
  # * :wait_seconds (Float)
734
769
  # * :smart_endpointing_enabled (Boolean)
@@ -741,6 +776,8 @@ module Vapi
741
776
  # * :num_words (Float)
742
777
  # * :voice_seconds (Float)
743
778
  # * :backoff_seconds (Float)
779
+ # * :acknowledgement_phrases (Array<String>)
780
+ # * :interruption_phrases (Array<String>)
744
781
  # * :monitor_plan (Hash)
745
782
  # * :listen_enabled (Boolean)
746
783
  # * :control_enabled (Boolean)
@@ -750,6 +787,11 @@ module Vapi
750
787
  # * :url (String)
751
788
  # * :secret (String)
752
789
  # * :headers (Hash{String => Object})
790
+ # * :backoff_plan (Hash)
791
+ # * :max_retries (Float)
792
+ # * :type (Hash{String => Object})
793
+ # * :base_delay_seconds (Float)
794
+ # * :hooks (Array<Vapi::AssistantHooks>)
753
795
  # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
754
796
  # `squad` instead.
755
797
  # @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
@@ -762,7 +804,6 @@ module Vapi
762
804
  # * :voice (Hash)
763
805
  # * :first_message (String)
764
806
  # * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
765
- # * :hipaa_enabled (Boolean)
766
807
  # * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
767
808
  # * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
768
809
  # * :silence_timeout_seconds (Float)
@@ -785,6 +826,9 @@ module Vapi
785
826
  # * :voicemail_message (String)
786
827
  # * :end_call_message (String)
787
828
  # * :end_call_phrases (Array<String>)
829
+ # * :compliance_plan (Hash)
830
+ # * :hipaa_enabled (Boolean)
831
+ # * :pci_enabled (Boolean)
788
832
  # * :metadata (Hash{String => Object})
789
833
  # * :analysis_plan (Hash)
790
834
  # * :summary_plan (Hash)
@@ -800,6 +844,10 @@ module Vapi
800
844
  # * :properties (Hash{String => Object})
801
845
  # * :description (String)
802
846
  # * :required (Array<String>)
847
+ # * :regex (String)
848
+ # * :value (String)
849
+ # * :target (String)
850
+ # * :enum (Array<String>)
803
851
  # * :timeout_seconds (Float)
804
852
  # * :success_evaluation_plan (Hash)
805
853
  # * :rubric (Vapi::SuccessEvaluationPlanRubric)
@@ -809,6 +857,8 @@ module Vapi
809
857
  # * :artifact_plan (Hash)
810
858
  # * :recording_enabled (Boolean)
811
859
  # * :video_recording_enabled (Boolean)
860
+ # * :pcap_enabled (Boolean)
861
+ # * :pcap_s_3_path_prefix (String)
812
862
  # * :transcript_plan (Hash)
813
863
  # * :enabled (Boolean)
814
864
  # * :assistant_name (String)
@@ -818,6 +868,7 @@ module Vapi
818
868
  # * :idle_messages (Array<String>)
819
869
  # * :idle_message_max_spoken_count (Float)
820
870
  # * :idle_timeout_seconds (Float)
871
+ # * :silence_timeout_message (String)
821
872
  # * :start_speaking_plan (Hash)
822
873
  # * :wait_seconds (Float)
823
874
  # * :smart_endpointing_enabled (Boolean)
@@ -830,6 +881,8 @@ module Vapi
830
881
  # * :num_words (Float)
831
882
  # * :voice_seconds (Float)
832
883
  # * :backoff_seconds (Float)
884
+ # * :acknowledgement_phrases (Array<String>)
885
+ # * :interruption_phrases (Array<String>)
833
886
  # * :monitor_plan (Hash)
834
887
  # * :listen_enabled (Boolean)
835
888
  # * :control_enabled (Boolean)
@@ -839,6 +892,11 @@ module Vapi
839
892
  # * :url (String)
840
893
  # * :secret (String)
841
894
  # * :headers (Hash{String => Object})
895
+ # * :backoff_plan (Hash)
896
+ # * :max_retries (Float)
897
+ # * :type (Hash{String => Object})
898
+ # * :base_delay_seconds (Float)
899
+ # * :hooks (Array<Vapi::AssistantHooks>)
842
900
  # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
843
901
  # number, use `phoneNumber` instead.
844
902
  # Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -857,6 +915,10 @@ module Vapi
857
915
  # * :url (String)
858
916
  # * :secret (String)
859
917
  # * :headers (Hash{String => Object})
918
+ # * :backoff_plan (Hash)
919
+ # * :max_retries (Float)
920
+ # * :type (Hash{String => Object})
921
+ # * :base_delay_seconds (Float)
860
922
  # @param customer_id [String] This is the customer that will be called. To call a transient customer , use
861
923
  # `customer` instead.
862
924
  # Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -870,13 +932,6 @@ module Vapi
870
932
  # * :name (String)
871
933
  # @param request_options [Vapi::RequestOptions]
872
934
  # @return [Vapi::Call]
873
- # @example
874
- # api = Vapi::Client.new(
875
- # base_url: "https://api.example.com",
876
- # environment: Vapi::Environment::DEFAULT,
877
- # token: "YOUR_AUTH_TOKEN"
878
- # )
879
- # api.calls.create
880
935
  def create(name: nil, assistant_id: nil, assistant: nil, assistant_overrides: nil, squad_id: nil, squad: nil,
881
936
  phone_number_id: nil, phone_number: nil, customer_id: nil, customer: nil, request_options: nil)
882
937
  Async do
@@ -913,13 +968,6 @@ module Vapi
913
968
  # @param id [String]
914
969
  # @param request_options [Vapi::RequestOptions]
915
970
  # @return [Vapi::Call]
916
- # @example
917
- # api = Vapi::Client.new(
918
- # base_url: "https://api.example.com",
919
- # environment: Vapi::Environment::DEFAULT,
920
- # token: "YOUR_AUTH_TOKEN"
921
- # )
922
- # api.calls.get(id: "id")
923
971
  def get(id:, request_options: nil)
924
972
  Async do
925
973
  response = @request_client.conn.get do |req|
@@ -945,13 +993,6 @@ module Vapi
945
993
  # @param id [String]
946
994
  # @param request_options [Vapi::RequestOptions]
947
995
  # @return [Vapi::Call]
948
- # @example
949
- # api = Vapi::Client.new(
950
- # base_url: "https://api.example.com",
951
- # environment: Vapi::Environment::DEFAULT,
952
- # token: "YOUR_AUTH_TOKEN"
953
- # )
954
- # api.calls.delete(id: "id")
955
996
  def delete(id:, request_options: nil)
956
997
  Async do
957
998
  response = @request_client.conn.delete do |req|
@@ -978,13 +1019,6 @@ module Vapi
978
1019
  # @param name [String] This is the name of the call. This is just for your own reference.
979
1020
  # @param request_options [Vapi::RequestOptions]
980
1021
  # @return [Vapi::Call]
981
- # @example
982
- # api = Vapi::Client.new(
983
- # base_url: "https://api.example.com",
984
- # environment: Vapi::Environment::DEFAULT,
985
- # token: "YOUR_AUTH_TOKEN"
986
- # )
987
- # api.calls.update(id: "id")
988
1022
  def update(id:, name: nil, request_options: nil)
989
1023
  Async do
990
1024
  response = @request_client.conn.patch do |req|
data/lib/vapi_server_sdk/files/client.rb CHANGED
@@ -19,13 +19,6 @@ module Vapi
19
19
 
20
20
  # @param request_options [Vapi::RequestOptions]
21
21
  # @return [Array<Vapi::File>]
22
- # @example
23
- # api = Vapi::Client.new(
24
- # base_url: "https://api.example.com",
25
- # environment: Vapi::Environment::DEFAULT,
26
- # token: "YOUR_AUTH_TOKEN"
27
- # )
28
- # api.files.list
29
22
  def list(request_options: nil)
30
23
  response = @request_client.conn.get do |req|
31
24
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -53,13 +46,6 @@ module Vapi
53
46
  # @param file [String, IO]
54
47
  # @param request_options [Vapi::RequestOptions]
55
48
  # @return [Vapi::File]
56
- # @example
57
- # api = Vapi::Client.new(
58
- # base_url: "https://api.example.com",
59
- # environment: Vapi::Environment::DEFAULT,
60
- # token: "YOUR_AUTH_TOKEN"
61
- # )
62
- # api.files.create(file: my_file.txt)
63
49
  def create(file:, request_options: nil)
64
50
  response = @request_client.conn.post do |req|
65
51
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -84,13 +70,6 @@ module Vapi
84
70
  # @param id [String]
85
71
  # @param request_options [Vapi::RequestOptions]
86
72
  # @return [Vapi::File]
87
- # @example
88
- # api = Vapi::Client.new(
89
- # base_url: "https://api.example.com",
90
- # environment: Vapi::Environment::DEFAULT,
91
- # token: "YOUR_AUTH_TOKEN"
92
- # )
93
- # api.files.get(id: "id")
94
73
  def get(id:, request_options: nil)
95
74
  response = @request_client.conn.get do |req|
96
75
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -114,13 +93,6 @@ module Vapi
114
93
  # @param id [String]
115
94
  # @param request_options [Vapi::RequestOptions]
116
95
  # @return [Vapi::File]
117
- # @example
118
- # api = Vapi::Client.new(
119
- # base_url: "https://api.example.com",
120
- # environment: Vapi::Environment::DEFAULT,
121
- # token: "YOUR_AUTH_TOKEN"
122
- # )
123
- # api.files.delete(id: "id")
124
96
  def delete(id:, request_options: nil)
125
97
  response = @request_client.conn.delete do |req|
126
98
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -145,13 +117,6 @@ module Vapi
145
117
  # @param name [String] This is the name of the file. This is just for your own reference.
146
118
  # @param request_options [Vapi::RequestOptions]
147
119
  # @return [Vapi::File]
148
- # @example
149
- # api = Vapi::Client.new(
150
- # base_url: "https://api.example.com",
151
- # environment: Vapi::Environment::DEFAULT,
152
- # token: "YOUR_AUTH_TOKEN"
153
- # )
154
- # api.files.update(id: "id")
155
120
  def update(id:, name: nil, request_options: nil)
156
121
  response = @request_client.conn.patch do |req|
157
122
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -183,13 +148,6 @@ module Vapi
183
148
 
184
149
  # @param request_options [Vapi::RequestOptions]
185
150
  # @return [Array<Vapi::File>]
186
- # @example
187
- # api = Vapi::Client.new(
188
- # base_url: "https://api.example.com",
189
- # environment: Vapi::Environment::DEFAULT,
190
- # token: "YOUR_AUTH_TOKEN"
191
- # )
192
- # api.files.list
193
151
  def list(request_options: nil)
194
152
  Async do
195
153
  response = @request_client.conn.get do |req|
@@ -219,13 +177,6 @@ module Vapi
219
177
  # @param file [String, IO]
220
178
  # @param request_options [Vapi::RequestOptions]
221
179
  # @return [Vapi::File]
222
- # @example
223
- # api = Vapi::Client.new(
224
- # base_url: "https://api.example.com",
225
- # environment: Vapi::Environment::DEFAULT,
226
- # token: "YOUR_AUTH_TOKEN"
227
- # )
228
- # api.files.create(file: my_file.txt)
229
180
  def create(file:, request_options: nil)
230
181
  Async do
231
182
  response = @request_client.conn.post do |req|
@@ -252,13 +203,6 @@ module Vapi
252
203
  # @param id [String]
253
204
  # @param request_options [Vapi::RequestOptions]
254
205
  # @return [Vapi::File]
255
- # @example
256
- # api = Vapi::Client.new(
257
- # base_url: "https://api.example.com",
258
- # environment: Vapi::Environment::DEFAULT,
259
- # token: "YOUR_AUTH_TOKEN"
260
- # )
261
- # api.files.get(id: "id")
262
206
  def get(id:, request_options: nil)
263
207
  Async do
264
208
  response = @request_client.conn.get do |req|
@@ -284,13 +228,6 @@ module Vapi
284
228
  # @param id [String]
285
229
  # @param request_options [Vapi::RequestOptions]
286
230
  # @return [Vapi::File]
287
- # @example
288
- # api = Vapi::Client.new(
289
- # base_url: "https://api.example.com",
290
- # environment: Vapi::Environment::DEFAULT,
291
- # token: "YOUR_AUTH_TOKEN"
292
- # )
293
- # api.files.delete(id: "id")
294
231
  def delete(id:, request_options: nil)
295
232
  Async do
296
233
  response = @request_client.conn.delete do |req|
@@ -317,13 +254,6 @@ module Vapi
317
254
  # @param name [String] This is the name of the file. This is just for your own reference.
318
255
  # @param request_options [Vapi::RequestOptions]
319
256
  # @return [Vapi::File]
320
- # @example
321
- # api = Vapi::Client.new(
322
- # base_url: "https://api.example.com",
323
- # environment: Vapi::Environment::DEFAULT,
324
- # token: "YOUR_AUTH_TOKEN"
325
- # )
326
- # api.files.update(id: "id")
327
257
  def update(id:, name: nil, request_options: nil)
328
258
  Async do
329
259
  response = @request_client.conn.patch do |req|