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
@@ -38,13 +38,6 @@ module Vapi
38
38
  # specified value.
39
39
  # @param request_options [Vapi::RequestOptions]
40
40
  # @return [Array<Vapi::KnowledgeBases::KnowledgeBasesListResponseItem>]
41
- # @example
42
- # api = Vapi::Client.new(
43
- # base_url: "https://api.example.com",
44
- # environment: Vapi::Environment::DEFAULT,
45
- # token: "YOUR_AUTH_TOKEN"
46
- # )
47
- # api.knowledge_bases.list
48
41
  def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
49
42
  updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
50
43
  response = @request_client.conn.get do |req|
@@ -82,13 +75,6 @@ module Vapi
82
75
  # @param request [Vapi::KnowledgeBases::KnowledgeBasesCreateRequest]
83
76
  # @param request_options [Vapi::RequestOptions]
84
77
  # @return [Vapi::KnowledgeBases::KnowledgeBasesCreateResponse]
85
- # @example
86
- # api = Vapi::Client.new(
87
- # base_url: "https://api.example.com",
88
- # environment: Vapi::Environment::DEFAULT,
89
- # token: "YOUR_AUTH_TOKEN"
90
- # )
91
- # api.knowledge_bases.create
92
78
  def create(request:, request_options: nil)
93
79
  response = @request_client.conn.post do |req|
94
80
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -110,13 +96,6 @@ module Vapi
110
96
  # @param id [String]
111
97
  # @param request_options [Vapi::RequestOptions]
112
98
  # @return [Vapi::KnowledgeBases::KnowledgeBasesGetResponse]
113
- # @example
114
- # api = Vapi::Client.new(
115
- # base_url: "https://api.example.com",
116
- # environment: Vapi::Environment::DEFAULT,
117
- # token: "YOUR_AUTH_TOKEN"
118
- # )
119
- # api.knowledge_bases.get(id: "id")
120
99
  def get(id:, request_options: nil)
121
100
  response = @request_client.conn.get do |req|
122
101
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -140,13 +119,6 @@ module Vapi
140
119
  # @param id [String]
141
120
  # @param request_options [Vapi::RequestOptions]
142
121
  # @return [Vapi::KnowledgeBases::KnowledgeBasesDeleteResponse]
143
- # @example
144
- # api = Vapi::Client.new(
145
- # base_url: "https://api.example.com",
146
- # environment: Vapi::Environment::DEFAULT,
147
- # token: "YOUR_AUTH_TOKEN"
148
- # )
149
- # api.knowledge_bases.delete(id: "id")
150
122
  def delete(id:, request_options: nil)
151
123
  response = @request_client.conn.delete do |req|
152
124
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -171,13 +143,6 @@ module Vapi
171
143
  # @param request [Vapi::KnowledgeBases::KnowledgeBasesUpdateRequest]
172
144
  # @param request_options [Vapi::RequestOptions]
173
145
  # @return [Vapi::KnowledgeBases::KnowledgeBasesUpdateResponse]
174
- # @example
175
- # api = Vapi::Client.new(
176
- # base_url: "https://api.example.com",
177
- # environment: Vapi::Environment::DEFAULT,
178
- # token: "YOUR_AUTH_TOKEN"
179
- # )
180
- # api.knowledge_bases.update(id: "id")
181
146
  def update(id:, request:, request_options: nil)
182
147
  response = @request_client.conn.patch do |req|
183
148
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -222,13 +187,6 @@ module Vapi
222
187
  # specified value.
223
188
  # @param request_options [Vapi::RequestOptions]
224
189
  # @return [Array<Vapi::KnowledgeBases::KnowledgeBasesListResponseItem>]
225
- # @example
226
- # api = Vapi::Client.new(
227
- # base_url: "https://api.example.com",
228
- # environment: Vapi::Environment::DEFAULT,
229
- # token: "YOUR_AUTH_TOKEN"
230
- # )
231
- # api.knowledge_bases.list
232
190
  def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
233
191
  updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
234
192
  Async do
@@ -268,13 +226,6 @@ module Vapi
268
226
  # @param request [Vapi::KnowledgeBases::KnowledgeBasesCreateRequest]
269
227
  # @param request_options [Vapi::RequestOptions]
270
228
  # @return [Vapi::KnowledgeBases::KnowledgeBasesCreateResponse]
271
- # @example
272
- # api = Vapi::Client.new(
273
- # base_url: "https://api.example.com",
274
- # environment: Vapi::Environment::DEFAULT,
275
- # token: "YOUR_AUTH_TOKEN"
276
- # )
277
- # api.knowledge_bases.create
278
229
  def create(request:, request_options: nil)
279
230
  Async do
280
231
  response = @request_client.conn.post do |req|
@@ -298,13 +249,6 @@ module Vapi
298
249
  # @param id [String]
299
250
  # @param request_options [Vapi::RequestOptions]
300
251
  # @return [Vapi::KnowledgeBases::KnowledgeBasesGetResponse]
301
- # @example
302
- # api = Vapi::Client.new(
303
- # base_url: "https://api.example.com",
304
- # environment: Vapi::Environment::DEFAULT,
305
- # token: "YOUR_AUTH_TOKEN"
306
- # )
307
- # api.knowledge_bases.get(id: "id")
308
252
  def get(id:, request_options: nil)
309
253
  Async do
310
254
  response = @request_client.conn.get do |req|
@@ -330,13 +274,6 @@ module Vapi
330
274
  # @param id [String]
331
275
  # @param request_options [Vapi::RequestOptions]
332
276
  # @return [Vapi::KnowledgeBases::KnowledgeBasesDeleteResponse]
333
- # @example
334
- # api = Vapi::Client.new(
335
- # base_url: "https://api.example.com",
336
- # environment: Vapi::Environment::DEFAULT,
337
- # token: "YOUR_AUTH_TOKEN"
338
- # )
339
- # api.knowledge_bases.delete(id: "id")
340
277
  def delete(id:, request_options: nil)
341
278
  Async do
342
279
  response = @request_client.conn.delete do |req|
@@ -363,13 +300,6 @@ module Vapi
363
300
  # @param request [Vapi::KnowledgeBases::KnowledgeBasesUpdateRequest]
364
301
  # @param request_options [Vapi::RequestOptions]
365
302
  # @return [Vapi::KnowledgeBases::KnowledgeBasesUpdateResponse]
366
- # @example
367
- # api = Vapi::Client.new(
368
- # base_url: "https://api.example.com",
369
- # environment: Vapi::Environment::DEFAULT,
370
- # token: "YOUR_AUTH_TOKEN"
371
- # )
372
- # api.knowledge_bases.update(id: "id")
373
303
  def update(id:, request:, request_options: nil)
374
304
  Async do
375
305
  response = @request_client.conn.patch do |req|
@@ -5,6 +5,7 @@ require_relative "types/logs_get_request_type"
5
5
  require_relative "types/logs_get_request_sort_order"
6
6
  require "date"
7
7
  require_relative "../types/logs_paginated_response"
8
+ require_relative "types/logging_controller_logs_delete_query_request_type"
8
9
  require "async"
9
10
 
10
11
  module Vapi
@@ -18,7 +19,6 @@ module Vapi
18
19
  @request_client = request_client
19
20
  end
20
21
 
21
- # @param org_id [String] This is the unique identifier for the org that this log belongs to.
22
22
  # @param type [Vapi::Logs::LogsGetRequestType] This is the type of the log.
23
23
  # @param webhook_type [String] This is the type of the webhook, given the log is from a webhook.
24
24
  # @param assistant_id [String] This is the ID of the assistant.
@@ -27,7 +27,7 @@ module Vapi
27
27
  # @param squad_id [String] This is the ID of the squad.
28
28
  # @param call_id [String] This is the ID of the call.
29
29
  # @param page [Float] This is the page number to return. Defaults to 1.
30
- # @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'ASC'.
30
+ # @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'DESC'.
31
31
  # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
32
32
  # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
33
33
  # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
@@ -43,15 +43,8 @@ module Vapi
43
43
  # specified value.
44
44
  # @param request_options [Vapi::RequestOptions]
45
45
  # @return [Vapi::LogsPaginatedResponse]
46
- # @example
47
- # api = Vapi::Client.new(
48
- # base_url: "https://api.example.com",
49
- # environment: Vapi::Environment::DEFAULT,
50
- # token: "YOUR_AUTH_TOKEN"
51
- # )
52
- # api.logs.get
53
- def get(org_id: nil, type: nil, webhook_type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
54
- squad_id: nil, call_id: nil, page: nil, sort_order: nil, limit: nil, created_at_gt: nil, created_at_lt: nil, 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)
46
+ def get(type: nil, webhook_type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil, squad_id: nil,
47
+ call_id: nil, page: nil, sort_order: nil, limit: nil, created_at_gt: nil, created_at_lt: nil, 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)
55
48
  response = @request_client.conn.get do |req|
56
49
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
57
50
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -62,7 +55,6 @@ module Vapi
62
55
  }.compact
63
56
  req.params = {
64
57
  **(request_options&.additional_query_parameters || {}),
65
- "orgId": org_id,
66
58
  "type": type,
67
59
  "webhookType": webhook_type,
68
60
  "assistantId": assistant_id,
@@ -90,22 +82,15 @@ module Vapi
90
82
  Vapi::LogsPaginatedResponse.from_json(json_object: response.body)
91
83
  end
92
84
 
93
- # @param org_id [String] This is the unique identifier for the org that this log belongs to.
94
- # @param assistant_id [String] This is the ID of the assistant.
85
+ # @param type [Vapi::Logs::LoggingControllerLogsDeleteQueryRequestType] This is the type of the log.
86
+ # @param assistant_id [String]
95
87
  # @param phone_number_id [String] This is the ID of the phone number.
96
88
  # @param customer_id [String] This is the ID of the customer.
97
89
  # @param squad_id [String] This is the ID of the squad.
98
90
  # @param call_id [String] This is the ID of the call.
99
91
  # @param request_options [Vapi::RequestOptions]
100
92
  # @return [Void]
101
- # @example
102
- # api = Vapi::Client.new(
103
- # base_url: "https://api.example.com",
104
- # environment: Vapi::Environment::DEFAULT,
105
- # token: "YOUR_AUTH_TOKEN"
106
- # )
107
- # api.logs.logging_controller_logs_delete_query
108
- def logging_controller_logs_delete_query(org_id: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
93
+ def logging_controller_logs_delete_query(type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
109
94
  squad_id: nil, call_id: nil, request_options: nil)
110
95
  @request_client.conn.delete do |req|
111
96
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -117,7 +102,7 @@ module Vapi
117
102
  }.compact
118
103
  req.params = {
119
104
  **(request_options&.additional_query_parameters || {}),
120
- "orgId": org_id,
105
+ "type": type,
121
106
  "assistantId": assistant_id,
122
107
  "phoneNumberId": phone_number_id,
123
108
  "customerId": customer_id,
@@ -142,7 +127,6 @@ module Vapi
142
127
  @request_client = request_client
143
128
  end
144
129
 
145
- # @param org_id [String] This is the unique identifier for the org that this log belongs to.
146
130
  # @param type [Vapi::Logs::LogsGetRequestType] This is the type of the log.
147
131
  # @param webhook_type [String] This is the type of the webhook, given the log is from a webhook.
148
132
  # @param assistant_id [String] This is the ID of the assistant.
@@ -151,7 +135,7 @@ module Vapi
151
135
  # @param squad_id [String] This is the ID of the squad.
152
136
  # @param call_id [String] This is the ID of the call.
153
137
  # @param page [Float] This is the page number to return. Defaults to 1.
154
- # @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'ASC'.
138
+ # @param sort_order [Vapi::Logs::LogsGetRequestSortOrder] This is the sort order for pagination. Defaults to 'DESC'.
155
139
  # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
156
140
  # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
157
141
  # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
@@ -167,15 +151,8 @@ module Vapi
167
151
  # specified value.
168
152
  # @param request_options [Vapi::RequestOptions]
169
153
  # @return [Vapi::LogsPaginatedResponse]
170
- # @example
171
- # api = Vapi::Client.new(
172
- # base_url: "https://api.example.com",
173
- # environment: Vapi::Environment::DEFAULT,
174
- # token: "YOUR_AUTH_TOKEN"
175
- # )
176
- # api.logs.get
177
- def get(org_id: nil, type: nil, webhook_type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
178
- squad_id: nil, call_id: nil, page: nil, sort_order: nil, limit: nil, created_at_gt: nil, created_at_lt: nil, 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)
154
+ def get(type: nil, webhook_type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil, squad_id: nil,
155
+ call_id: nil, page: nil, sort_order: nil, limit: nil, created_at_gt: nil, created_at_lt: nil, 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)
179
156
  Async do
180
157
  response = @request_client.conn.get do |req|
181
158
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -187,7 +164,6 @@ module Vapi
187
164
  }.compact
188
165
  req.params = {
189
166
  **(request_options&.additional_query_parameters || {}),
190
- "orgId": org_id,
191
167
  "type": type,
192
168
  "webhookType": webhook_type,
193
169
  "assistantId": assistant_id,
@@ -216,22 +192,15 @@ module Vapi
216
192
  end
217
193
  end
218
194
 
219
- # @param org_id [String] This is the unique identifier for the org that this log belongs to.
220
- # @param assistant_id [String] This is the ID of the assistant.
195
+ # @param type [Vapi::Logs::LoggingControllerLogsDeleteQueryRequestType] This is the type of the log.
196
+ # @param assistant_id [String]
221
197
  # @param phone_number_id [String] This is the ID of the phone number.
222
198
  # @param customer_id [String] This is the ID of the customer.
223
199
  # @param squad_id [String] This is the ID of the squad.
224
200
  # @param call_id [String] This is the ID of the call.
225
201
  # @param request_options [Vapi::RequestOptions]
226
202
  # @return [Void]
227
- # @example
228
- # api = Vapi::Client.new(
229
- # base_url: "https://api.example.com",
230
- # environment: Vapi::Environment::DEFAULT,
231
- # token: "YOUR_AUTH_TOKEN"
232
- # )
233
- # api.logs.logging_controller_logs_delete_query
234
- def logging_controller_logs_delete_query(org_id: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
203
+ def logging_controller_logs_delete_query(type: nil, assistant_id: nil, phone_number_id: nil, customer_id: nil,
235
204
  squad_id: nil, call_id: nil, request_options: nil)
236
205
  Async do
237
206
  @request_client.conn.delete do |req|
@@ -244,7 +213,7 @@ module Vapi
244
213
  }.compact
245
214
  req.params = {
246
215
  **(request_options&.additional_query_parameters || {}),
247
- "orgId": org_id,
216
+ "type": type,
248
217
  "assistantId": assistant_id,
249
218
  "phoneNumberId": phone_number_id,
250
219
  "customerId": customer_id,
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Vapi
4
+ class Logs
5
+ class LoggingControllerLogsDeleteQueryRequestType
6
+ API = "API"
7
+ WEBHOOK = "Webhook"
8
+ CALL = "Call"
9
+ PROVIDER = "Provider"
10
+ end
11
+ end
12
+ end
@@ -38,13 +38,6 @@ module Vapi
38
38
  # specified value.
39
39
  # @param request_options [Vapi::RequestOptions]
40
40
  # @return [Array<Vapi::PhoneNumbers::PhoneNumbersListResponseItem>]
41
- # @example
42
- # api = Vapi::Client.new(
43
- # base_url: "https://api.example.com",
44
- # environment: Vapi::Environment::DEFAULT,
45
- # token: "YOUR_AUTH_TOKEN"
46
- # )
47
- # api.phone_numbers.list
48
41
  def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
49
42
  updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
50
43
  response = @request_client.conn.get do |req|
@@ -82,13 +75,6 @@ module Vapi
82
75
  # @param request [Vapi::PhoneNumbers::PhoneNumbersCreateRequest]
83
76
  # @param request_options [Vapi::RequestOptions]
84
77
  # @return [Vapi::PhoneNumbers::PhoneNumbersCreateResponse]
85
- # @example
86
- # api = Vapi::Client.new(
87
- # base_url: "https://api.example.com",
88
- # environment: Vapi::Environment::DEFAULT,
89
- # token: "YOUR_AUTH_TOKEN"
90
- # )
91
- # api.phone_numbers.create
92
78
  def create(request:, request_options: nil)
93
79
  response = @request_client.conn.post do |req|
94
80
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -110,13 +96,6 @@ module Vapi
110
96
  # @param id [String]
111
97
  # @param request_options [Vapi::RequestOptions]
112
98
  # @return [Vapi::PhoneNumbers::PhoneNumbersGetResponse]
113
- # @example
114
- # api = Vapi::Client.new(
115
- # base_url: "https://api.example.com",
116
- # environment: Vapi::Environment::DEFAULT,
117
- # token: "YOUR_AUTH_TOKEN"
118
- # )
119
- # api.phone_numbers.get(id: "id")
120
99
  def get(id:, request_options: nil)
121
100
  response = @request_client.conn.get do |req|
122
101
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -140,13 +119,6 @@ module Vapi
140
119
  # @param id [String]
141
120
  # @param request_options [Vapi::RequestOptions]
142
121
  # @return [Vapi::PhoneNumbers::PhoneNumbersDeleteResponse]
143
- # @example
144
- # api = Vapi::Client.new(
145
- # base_url: "https://api.example.com",
146
- # environment: Vapi::Environment::DEFAULT,
147
- # token: "YOUR_AUTH_TOKEN"
148
- # )
149
- # api.phone_numbers.delete(id: "id")
150
122
  def delete(id:, request_options: nil)
151
123
  response = @request_client.conn.delete do |req|
152
124
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -171,13 +143,6 @@ module Vapi
171
143
  # @param request [Vapi::PhoneNumbers::PhoneNumbersUpdateRequest]
172
144
  # @param request_options [Vapi::RequestOptions]
173
145
  # @return [Vapi::PhoneNumbers::PhoneNumbersUpdateResponse]
174
- # @example
175
- # api = Vapi::Client.new(
176
- # base_url: "https://api.example.com",
177
- # environment: Vapi::Environment::DEFAULT,
178
- # token: "YOUR_AUTH_TOKEN"
179
- # )
180
- # api.phone_numbers.update(id: "id")
181
146
  def update(id:, request:, request_options: nil)
182
147
  response = @request_client.conn.patch do |req|
183
148
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -222,13 +187,6 @@ module Vapi
222
187
  # specified value.
223
188
  # @param request_options [Vapi::RequestOptions]
224
189
  # @return [Array<Vapi::PhoneNumbers::PhoneNumbersListResponseItem>]
225
- # @example
226
- # api = Vapi::Client.new(
227
- # base_url: "https://api.example.com",
228
- # environment: Vapi::Environment::DEFAULT,
229
- # token: "YOUR_AUTH_TOKEN"
230
- # )
231
- # api.phone_numbers.list
232
190
  def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
233
191
  updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
234
192
  Async do
@@ -268,13 +226,6 @@ module Vapi
268
226
  # @param request [Vapi::PhoneNumbers::PhoneNumbersCreateRequest]
269
227
  # @param request_options [Vapi::RequestOptions]
270
228
  # @return [Vapi::PhoneNumbers::PhoneNumbersCreateResponse]
271
- # @example
272
- # api = Vapi::Client.new(
273
- # base_url: "https://api.example.com",
274
- # environment: Vapi::Environment::DEFAULT,
275
- # token: "YOUR_AUTH_TOKEN"
276
- # )
277
- # api.phone_numbers.create
278
229
  def create(request:, request_options: nil)
279
230
  Async do
280
231
  response = @request_client.conn.post do |req|
@@ -298,13 +249,6 @@ module Vapi
298
249
  # @param id [String]
299
250
  # @param request_options [Vapi::RequestOptions]
300
251
  # @return [Vapi::PhoneNumbers::PhoneNumbersGetResponse]
301
- # @example
302
- # api = Vapi::Client.new(
303
- # base_url: "https://api.example.com",
304
- # environment: Vapi::Environment::DEFAULT,
305
- # token: "YOUR_AUTH_TOKEN"
306
- # )
307
- # api.phone_numbers.get(id: "id")
308
252
  def get(id:, request_options: nil)
309
253
  Async do
310
254
  response = @request_client.conn.get do |req|
@@ -330,13 +274,6 @@ module Vapi
330
274
  # @param id [String]
331
275
  # @param request_options [Vapi::RequestOptions]
332
276
  # @return [Vapi::PhoneNumbers::PhoneNumbersDeleteResponse]
333
- # @example
334
- # api = Vapi::Client.new(
335
- # base_url: "https://api.example.com",
336
- # environment: Vapi::Environment::DEFAULT,
337
- # token: "YOUR_AUTH_TOKEN"
338
- # )
339
- # api.phone_numbers.delete(id: "id")
340
277
  def delete(id:, request_options: nil)
341
278
  Async do
342
279
  response = @request_client.conn.delete do |req|
@@ -363,13 +300,6 @@ module Vapi
363
300
  # @param request [Vapi::PhoneNumbers::PhoneNumbersUpdateRequest]
364
301
  # @param request_options [Vapi::RequestOptions]
365
302
  # @return [Vapi::PhoneNumbers::PhoneNumbersUpdateResponse]
366
- # @example
367
- # api = Vapi::Client.new(
368
- # base_url: "https://api.example.com",
369
- # environment: Vapi::Environment::DEFAULT,
370
- # token: "YOUR_AUTH_TOKEN"
371
- # )
372
- # api.phone_numbers.update(id: "id")
373
303
  def update(id:, request:, request_options: nil)
374
304
  Async do
375
305
  response = @request_client.conn.patch do |req|