vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/calls/client.rb

@@ -22,7 +22,11 @@ module Vapi
       @request_client = request_client
     end
 
+    # @param id [String] This is the unique identifier for the call.
     # @param assistant_id [String] This will return calls with the specified assistantId.
+    # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
+    #  number, use `phoneNumber` instead.
+    #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
     # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
     # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
     # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
@@ -45,8 +49,8 @@ module Vapi
     #    token: "YOUR_AUTH_TOKEN"
     #  )
     #  api.calls.list
-    def list(assistant_id: 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)
+    def list(id: nil, assistant_id: nil, phone_number_id: 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)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -57,7 +61,9 @@ module Vapi
         }.compact
         req.params = {
           **(request_options&.additional_query_parameters || {}),
+          "id": id,
           "assistantId": assistant_id,
+          "phoneNumberId": phone_number_id,
           "limit": limit,
           "createdAtGt": created_at_gt,
           "createdAtLt": created_at_lt,
@@ -88,6 +94,7 @@ module Vapi
     #   * :transcriber (Hash)
     #   * :model (Hash)
     #   * :voice (Hash)
+    #   * :first_message (String)
     #   * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
     #   * :hipaa_enabled (Boolean)
     #   * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
@@ -95,12 +102,11 @@ module Vapi
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
     #   * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
-    #   * :backchanneling_enabled (Boolean)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
     #   * :name (String)
-    #   * :first_message (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
     #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -113,8 +119,6 @@ module Vapi
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
     #   * :metadata (Hash{String => Object})
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
     #   * :analysis_plan (Hash)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
@@ -150,6 +154,7 @@ module Vapi
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
     #     * :smart_endpointing_enabled (Boolean)
+    #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
     #       * :on_no_punctuation_seconds (Float)
@@ -162,11 +167,17 @@ module Vapi
     #     * :listen_enabled (Boolean)
     #     * :control_enabled (Boolean)
     #   * :credential_ids (Array<String>)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.Request of type Vapi::AssistantOverrides, as a Hash
     #   * :transcriber (Hash)
     #   * :model (Hash)
     #   * :voice (Hash)
+    #   * :first_message (String)
     #   * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
     #   * :hipaa_enabled (Boolean)
     #   * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
@@ -174,13 +185,12 @@ module Vapi
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
     #   * :background_sound (Vapi::AssistantOverridesBackgroundSound)
-    #   * :backchanneling_enabled (Boolean)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::AssistantOverridesCredentialsItem>)
     #   * :variable_values (Hash{String => Object})
     #   * :name (String)
-    #   * :first_message (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
     #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -193,8 +203,6 @@ module Vapi
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
     #   * :metadata (Hash{String => Object})
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
     #   * :analysis_plan (Hash)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
@@ -230,6 +238,7 @@ module Vapi
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
     #     * :smart_endpointing_enabled (Boolean)
+    #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
     #       * :on_no_punctuation_seconds (Float)
@@ -242,6 +251,11 @@ module Vapi
     #     * :listen_enabled (Boolean)
     #     * :control_enabled (Boolean)
     #   * :credential_ids (Array<String>)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
     # @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
@@ -252,6 +266,7 @@ module Vapi
     #     * :transcriber (Hash)
     #     * :model (Hash)
     #     * :voice (Hash)
+    #     * :first_message (String)
     #     * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
     #     * :hipaa_enabled (Boolean)
     #     * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
@@ -259,13 +274,12 @@ module Vapi
     #     * :silence_timeout_seconds (Float)
     #     * :max_duration_seconds (Float)
     #     * :background_sound (Vapi::AssistantOverridesBackgroundSound)
-    #     * :backchanneling_enabled (Boolean)
     #     * :background_denoising_enabled (Boolean)
     #     * :model_output_in_messages_enabled (Boolean)
     #     * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #     * :credentials (Array<Vapi::AssistantOverridesCredentialsItem>)
     #     * :variable_values (Hash{String => Object})
     #     * :name (String)
-    #     * :first_message (String)
     #     * :voicemail_detection (Hash)
     #       * :provider (String)
     #       * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -278,8 +292,6 @@ module Vapi
     #     * :end_call_message (String)
     #     * :end_call_phrases (Array<String>)
     #     * :metadata (Hash{String => Object})
-    #     * :server_url (String)
-    #     * :server_url_secret (String)
     #     * :analysis_plan (Hash)
     #       * :summary_plan (Hash)
     #         * :messages (Array<Hash{String => Object}>)
@@ -315,6 +327,7 @@ module Vapi
     #     * :start_speaking_plan (Hash)
     #       * :wait_seconds (Float)
     #       * :smart_endpointing_enabled (Boolean)
+    #       * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #       * :transcription_endpointing_plan (Hash)
     #         * :on_punctuation_seconds (Float)
     #         * :on_no_punctuation_seconds (Float)
@@ -327,6 +340,11 @@ module Vapi
     #       * :listen_enabled (Boolean)
     #       * :control_enabled (Boolean)
     #     * :credential_ids (Array<String>)
+    #     * :server (Hash)
+    #       * :timeout_seconds (Float)
+    #       * :url (String)
+    #       * :secret (String)
+    #       * :headers (Hash{String => Object})
     # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
     #  number, use `phoneNumber` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -340,8 +358,11 @@ module Vapi
     #   * :name (String)
     #   * :assistant_id (String)
     #   * :squad_id (String)
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param customer_id [String] This is the customer that will be called. To call a transient customer , use
     #  `customer` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -493,7 +514,11 @@ module Vapi
       @request_client = request_client
     end
 
+    # @param id [String] This is the unique identifier for the call.
     # @param assistant_id [String] This will return calls with the specified assistantId.
+    # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
+    #  number, use `phoneNumber` instead.
+    #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
     # @param limit [Float] This is the maximum number of items to return. Defaults to 100.
     # @param created_at_gt [DateTime] This will return items where the createdAt is greater than the specified value.
     # @param created_at_lt [DateTime] This will return items where the createdAt is less than the specified value.
@@ -516,8 +541,8 @@ module Vapi
     #    token: "YOUR_AUTH_TOKEN"
     #  )
     #  api.calls.list
-    def list(assistant_id: 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)
+    def list(id: nil, assistant_id: nil, phone_number_id: 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)
       Async do
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -529,7 +554,9 @@ module Vapi
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
+            "id": id,
             "assistantId": assistant_id,
+            "phoneNumberId": phone_number_id,
             "limit": limit,
             "createdAtGt": created_at_gt,
             "createdAtLt": created_at_lt,
@@ -561,6 +588,7 @@ module Vapi
     #   * :transcriber (Hash)
     #   * :model (Hash)
     #   * :voice (Hash)
+    #   * :first_message (String)
     #   * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
     #   * :hipaa_enabled (Boolean)
     #   * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
@@ -568,12 +596,11 @@ module Vapi
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
     #   * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
-    #   * :backchanneling_enabled (Boolean)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
     #   * :name (String)
-    #   * :first_message (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
     #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -586,8 +613,6 @@ module Vapi
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
     #   * :metadata (Hash{String => Object})
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
     #   * :analysis_plan (Hash)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
@@ -623,6 +648,7 @@ module Vapi
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
     #     * :smart_endpointing_enabled (Boolean)
+    #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
     #       * :on_no_punctuation_seconds (Float)
@@ -635,11 +661,17 @@ module Vapi
     #     * :listen_enabled (Boolean)
     #     * :control_enabled (Boolean)
     #   * :credential_ids (Array<String>)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param assistant_overrides [Hash] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.Request of type Vapi::AssistantOverrides, as a Hash
     #   * :transcriber (Hash)
     #   * :model (Hash)
     #   * :voice (Hash)
+    #   * :first_message (String)
     #   * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
     #   * :hipaa_enabled (Boolean)
     #   * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
@@ -647,13 +679,12 @@ module Vapi
     #   * :silence_timeout_seconds (Float)
     #   * :max_duration_seconds (Float)
     #   * :background_sound (Vapi::AssistantOverridesBackgroundSound)
-    #   * :backchanneling_enabled (Boolean)
     #   * :background_denoising_enabled (Boolean)
     #   * :model_output_in_messages_enabled (Boolean)
     #   * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #   * :credentials (Array<Vapi::AssistantOverridesCredentialsItem>)
     #   * :variable_values (Hash{String => Object})
     #   * :name (String)
-    #   * :first_message (String)
     #   * :voicemail_detection (Hash)
     #     * :provider (String)
     #     * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -666,8 +697,6 @@ module Vapi
     #   * :end_call_message (String)
     #   * :end_call_phrases (Array<String>)
     #   * :metadata (Hash{String => Object})
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
     #   * :analysis_plan (Hash)
     #     * :summary_plan (Hash)
     #       * :messages (Array<Hash{String => Object}>)
@@ -703,6 +732,7 @@ module Vapi
     #   * :start_speaking_plan (Hash)
     #     * :wait_seconds (Float)
     #     * :smart_endpointing_enabled (Boolean)
+    #     * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #     * :transcription_endpointing_plan (Hash)
     #       * :on_punctuation_seconds (Float)
     #       * :on_no_punctuation_seconds (Float)
@@ -715,6 +745,11 @@ module Vapi
     #     * :listen_enabled (Boolean)
     #     * :control_enabled (Boolean)
     #   * :credential_ids (Array<String>)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
     # @param squad [Hash] This is a squad that will be used for the call. To use an existing squad, use
@@ -725,6 +760,7 @@ module Vapi
     #     * :transcriber (Hash)
     #     * :model (Hash)
     #     * :voice (Hash)
+    #     * :first_message (String)
     #     * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
     #     * :hipaa_enabled (Boolean)
     #     * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
@@ -732,13 +768,12 @@ module Vapi
     #     * :silence_timeout_seconds (Float)
     #     * :max_duration_seconds (Float)
     #     * :background_sound (Vapi::AssistantOverridesBackgroundSound)
-    #     * :backchanneling_enabled (Boolean)
     #     * :background_denoising_enabled (Boolean)
     #     * :model_output_in_messages_enabled (Boolean)
     #     * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
+    #     * :credentials (Array<Vapi::AssistantOverridesCredentialsItem>)
     #     * :variable_values (Hash{String => Object})
     #     * :name (String)
-    #     * :first_message (String)
     #     * :voicemail_detection (Hash)
     #       * :provider (String)
     #       * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
@@ -751,8 +786,6 @@ module Vapi
     #     * :end_call_message (String)
     #     * :end_call_phrases (Array<String>)
     #     * :metadata (Hash{String => Object})
-    #     * :server_url (String)
-    #     * :server_url_secret (String)
     #     * :analysis_plan (Hash)
     #       * :summary_plan (Hash)
     #         * :messages (Array<Hash{String => Object}>)
@@ -788,6 +821,7 @@ module Vapi
     #     * :start_speaking_plan (Hash)
     #       * :wait_seconds (Float)
     #       * :smart_endpointing_enabled (Boolean)
+    #       * :custom_endpointing_rules (Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>)
     #       * :transcription_endpointing_plan (Hash)
     #         * :on_punctuation_seconds (Float)
     #         * :on_no_punctuation_seconds (Float)
@@ -800,6 +834,11 @@ module Vapi
     #       * :listen_enabled (Boolean)
     #       * :control_enabled (Boolean)
     #     * :credential_ids (Array<String>)
+    #     * :server (Hash)
+    #       * :timeout_seconds (Float)
+    #       * :url (String)
+    #       * :secret (String)
+    #       * :headers (Hash{String => Object})
     # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
     #  number, use `phoneNumber` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -813,8 +852,11 @@ module Vapi
     #   * :name (String)
     #   * :assistant_id (String)
     #   * :squad_id (String)
-    #   * :server_url (String)
-    #   * :server_url_secret (String)
+    #   * :server (Hash)
+    #     * :timeout_seconds (Float)
+    #     * :url (String)
+    #     * :secret (String)
+    #     * :headers (Hash{String => Object})
     # @param customer_id [String] This is the customer that will be called. To call a transient customer , use
     #  `customer` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.