Class: Vapi::AsyncSquadsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/squads/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vapi::AsyncSquadsClient

Parameters:



518
519
520
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 518

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vapi::AsyncRequestClient (readonly)

Returns:



514
515
516
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 514

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ Vapi::Squad

Parameters:

  • request (Hash) —

    Request of type Vapi::CreateSquadDto, as a Hash

    • :name (String)

    • :members (Array<Vapi::SquadMemberDto>)

    • :members_overrides (Hash)

      • :transcriber (Hash)

      • :model (Hash)

      • :voice (Hash)

      • :first_message (String)

      • :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)

      • :hipaa_enabled (Boolean)

      • :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)

      • :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)

      • :silence_timeout_seconds (Float)

      • :max_duration_seconds (Float)

      • :background_sound (Vapi::AssistantOverridesBackgroundSound)

      • :background_denoising_enabled (Boolean)

      • :model_output_in_messages_enabled (Boolean)

      • :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)

      • :credentials (Array<Vapi::AssistantOverridesCredentialsItem>)

      • :variable_values (Hash=> Object)

      • :name (String)

      • :voicemail_detection (Hash)

        • :provider (String)

        • :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)

        • :enabled (Boolean)

        • :machine_detection_timeout (Float)

        • :machine_detection_speech_threshold (Float)

        • :machine_detection_speech_end_threshold (Float)

        • :machine_detection_silence_timeout (Float)

      • :voicemail_message (String)

      • :end_call_message (String)

      • :end_call_phrases (Array<String>)

      • :metadata (Hash=> Object)

      • :analysis_plan (Hash)

        • :summary_plan (Hash)

          • :messages (Array<Hash=> Object>)

          • :enabled (Boolean)

          • :timeout_seconds (Float)

        • :structured_data_plan (Hash)

          • :messages (Array<Hash=> Object>)

          • :enabled (Boolean)

          • :schema (Hash)

            • :type (Vapi::JsonSchemaType)

            • :items (Hash=> Object)

            • :properties (Hash=> Object)

            • :description (String)

            • :required (Array<String>)

            • :enum (Array<String>)

          • :timeout_seconds (Float)

        • :success_evaluation_plan (Hash)

          • :rubric (Vapi::SuccessEvaluationPlanRubric)

          • :messages (Array<Hash=> Object>)

          • :enabled (Boolean)

          • :timeout_seconds (Float)

      • :artifact_plan (Hash)

        • :recording_enabled (Boolean)

        • :video_recording_enabled (Boolean)

        • :transcript_plan (Hash)

          • :enabled (Boolean)

          • :assistant_name (String)

          • :user_name (String)

        • :recording_path (String)

      • :message_plan (Hash)

        • :idle_messages (Array<String>)

        • :idle_message_max_spoken_count (Float)

        • :idle_timeout_seconds (Float)

      • :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)

          • :on_number_seconds (Float)

      • :stop_speaking_plan (Hash)

        • :num_words (Float)

        • :voice_seconds (Float)

        • :backoff_seconds (Float)

      • :monitor_plan (Hash)

        • :listen_enabled (Boolean)

        • :control_enabled (Boolean)

      • :credential_ids (Array<String>)

      • :server (Hash)

        • :timeout_seconds (Float)

        • :url (String)

        • :secret (String)

        • :headers (Hash=> Object)

  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 662

def create(request:, request_options: nil)
  Async do
    response = @request_client.conn.post 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?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/squad"
    end
    Vapi::Squad.from_json(json_object: response.body)
  end
end

#delete(id:, request_options: nil) ⇒ Vapi::Squad

Parameters:

Returns:



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 710

def delete(id:, request_options: nil)
  Async do
    response = @request_client.conn.delete 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?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
    end
    Vapi::Squad.from_json(json_object: response.body)
  end
end

#get(id:, request_options: nil) ⇒ Vapi::Squad

Parameters:

Returns:



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 685

def get(id:, 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?
      req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
    end
    Vapi::Squad.from_json(json_object: response.body)
  end
end

#list(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) ⇒ Array<Vapi::Squad>

Parameters:

  • limit (Float) (defaults to: nil) —

    This is the maximum number of items to return. Defaults to 100.

  • created_at_gt (DateTime) (defaults to: nil) —

    This will return items where the createdAt is greater than the specified value.

  • created_at_lt (DateTime) (defaults to: nil) —

    This will return items where the createdAt is less than the specified value.

  • created_at_ge (DateTime) (defaults to: nil) —

    This will return items where the createdAt is greater than or equal to the specified value.

  • created_at_le (DateTime) (defaults to: nil) —

    This will return items where the createdAt is less than or equal to the specified value.

  • updated_at_gt (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is greater than the specified value.

  • updated_at_lt (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is less than the specified value.

  • updated_at_ge (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is greater than or equal to the specified value.

  • updated_at_le (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is less than or equal to the specified value.

  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 537

def list(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?
      req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "limit": limit,
        "createdAtGt": created_at_gt,
        "createdAtLt": created_at_lt,
        "createdAtGe": created_at_ge,
        "createdAtLe": created_at_le,
        "updatedAtGt": updated_at_gt,
        "updatedAtLt": updated_at_lt,
        "updatedAtGe": updated_at_ge,
        "updatedAtLe": updated_at_le
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/squad"
    end
    parsed_json = JSON.parse(response.body)
    parsed_json&.map do |item|
      item = item.to_json
      Vapi::Squad.from_json(json_object: item)
    end
  end
end

#update(id:, members:, name: nil, members_overrides: nil, request_options: nil) ⇒ Vapi::Squad

Parameters:

  • id (String)
  • name (String) (defaults to: nil) —

    This is the name of the squad.

  • members (Array<Hash>) —

    This is the list of assistants that make up the squad. The call will start with the first assistant in the list.Request of type Array<Vapi::SquadMemberDto>, as a Hash

    * :assistant_id (String)
* :assistant (Hash)
  * :transcriber (Hash)
  * :model (Hash)
  * :voice (Hash)
  * :first_message (String)
  * :first_message_mode (Vapi::CreateAssistantDtoFirstMessageMode)
  * :hipaa_enabled (Boolean)
  * :client_messages (Array<Vapi::CreateAssistantDtoClientMessagesItem>)
  * :server_messages (Array<Vapi::CreateAssistantDtoServerMessagesItem>)
  * :silence_timeout_seconds (Float)
  * :max_duration_seconds (Float)
  * :background_sound (Vapi::CreateAssistantDtoBackgroundSound)
  * :background_denoising_enabled (Boolean)
  * :model_output_in_messages_enabled (Boolean)
  * :transport_configurations (Array<Vapi::TransportConfigurationTwilio>)
  * :credentials (Array<Vapi::CreateAssistantDtoCredentialsItem>)
  * :name (String)
  * :voicemail_detection (Hash)
    * :provider (String)
    * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
    * :enabled (Boolean)
    * :machine_detection_timeout (Float)
    * :machine_detection_speech_threshold (Float)
    * :machine_detection_speech_end_threshold (Float)
    * :machine_detection_silence_timeout (Float)
  * :voicemail_message (String)
  * :end_call_message (String)
  * :end_call_phrases (Array<String>)
  * :metadata (Hash{String => Object})
  * :analysis_plan (Hash)
    * :summary_plan (Hash)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :timeout_seconds (Float)
    * :structured_data_plan (Hash)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :schema (Hash)
        * :type (Vapi::JsonSchemaType)
        * :items (Hash{String => Object})
        * :properties (Hash{String => Object})
        * :description (String)
        * :required (Array<String>)
        * :enum (Array<String>)
      * :timeout_seconds (Float)
    * :success_evaluation_plan (Hash)
      * :rubric (Vapi::SuccessEvaluationPlanRubric)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :timeout_seconds (Float)
  * :artifact_plan (Hash)
    * :recording_enabled (Boolean)
    * :video_recording_enabled (Boolean)
    * :transcript_plan (Hash)
      * :enabled (Boolean)
      * :assistant_name (String)
      * :user_name (String)
    * :recording_path (String)
  * :message_plan (Hash)
    * :idle_messages (Array<String>)
    * :idle_message_max_spoken_count (Float)
    * :idle_timeout_seconds (Float)
  * :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)
      * :on_number_seconds (Float)
  * :stop_speaking_plan (Hash)
    * :num_words (Float)
    * :voice_seconds (Float)
    * :backoff_seconds (Float)
  * :monitor_plan (Hash)
    * :listen_enabled (Boolean)
    * :control_enabled (Boolean)
  * :credential_ids (Array<String>)
  * :server (Hash)
    * :timeout_seconds (Float)
    * :url (String)
    * :secret (String)
    * :headers (Hash{String => Object})
* :assistant_overrides (Hash)
  * :transcriber (Hash)
  * :model (Hash)
  * :voice (Hash)
  * :first_message (String)
  * :first_message_mode (Vapi::AssistantOverridesFirstMessageMode)
  * :hipaa_enabled (Boolean)
  * :client_messages (Array<Vapi::AssistantOverridesClientMessagesItem>)
  * :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
  * :silence_timeout_seconds (Float)
  * :max_duration_seconds (Float)
  * :background_sound (Vapi::AssistantOverridesBackgroundSound)
  * :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)
  * :voicemail_detection (Hash)
    * :provider (String)
    * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
    * :enabled (Boolean)
    * :machine_detection_timeout (Float)
    * :machine_detection_speech_threshold (Float)
    * :machine_detection_speech_end_threshold (Float)
    * :machine_detection_silence_timeout (Float)
  * :voicemail_message (String)
  * :end_call_message (String)
  * :end_call_phrases (Array<String>)
  * :metadata (Hash{String => Object})
  * :analysis_plan (Hash)
    * :summary_plan (Hash)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :timeout_seconds (Float)
    * :structured_data_plan (Hash)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :schema (Hash)
        * :type (Vapi::JsonSchemaType)
        * :items (Hash{String => Object})
        * :properties (Hash{String => Object})
        * :description (String)
        * :required (Array<String>)
        * :enum (Array<String>)
      * :timeout_seconds (Float)
    * :success_evaluation_plan (Hash)
      * :rubric (Vapi::SuccessEvaluationPlanRubric)
      * :messages (Array<Hash{String => Object}>)
      * :enabled (Boolean)
      * :timeout_seconds (Float)
  * :artifact_plan (Hash)
    * :recording_enabled (Boolean)
    * :video_recording_enabled (Boolean)
    * :transcript_plan (Hash)
      * :enabled (Boolean)
      * :assistant_name (String)
      * :user_name (String)
    * :recording_path (String)
  * :message_plan (Hash)
    * :idle_messages (Array<String>)
    * :idle_message_max_spoken_count (Float)
    * :idle_timeout_seconds (Float)
  * :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)
      * :on_number_seconds (Float)
  * :stop_speaking_plan (Hash)
    * :num_words (Float)
    * :voice_seconds (Float)
    * :backoff_seconds (Float)
  * :monitor_plan (Hash)
    * :listen_enabled (Boolean)
    * :control_enabled (Boolean)
  * :credential_ids (Array<String>)
  * :server (Hash)
    * :timeout_seconds (Float)
    * :url (String)
    * :secret (String)
    * :headers (Hash{String => Object})
* :assistant_destinations (Array<Vapi::TransferDestinationAssistant>)
  • members_overrides (Hash) (defaults to: nil) —

    This can be used to override all the assistants’ settings and provide values for their template variables. Both membersOverrides and members[n].assistantOverrides can be used together. First, members[n].assistantOverrides is applied. Then, membersOverrides is applied as a global override.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>)
* :server_messages (Array<Vapi::AssistantOverridesServerMessagesItem>)
* :silence_timeout_seconds (Float)
* :max_duration_seconds (Float)
* :background_sound (Vapi::AssistantOverridesBackgroundSound)
* :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)
* :voicemail_detection (Hash)
  * :provider (String)
  * :voicemail_detection_types (Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>)
  * :enabled (Boolean)
  * :machine_detection_timeout (Float)
  * :machine_detection_speech_threshold (Float)
  * :machine_detection_speech_end_threshold (Float)
  * :machine_detection_silence_timeout (Float)
* :voicemail_message (String)
* :end_call_message (String)
* :end_call_phrases (Array<String>)
* :metadata (Hash{String => Object})
* :analysis_plan (Hash)
  * :summary_plan (Hash)
    * :messages (Array<Hash{String => Object}>)
    * :enabled (Boolean)
    * :timeout_seconds (Float)
  * :structured_data_plan (Hash)
    * :messages (Array<Hash{String => Object}>)
    * :enabled (Boolean)
    * :schema (Hash)
      * :type (Vapi::JsonSchemaType)
      * :items (Hash{String => Object})
      * :properties (Hash{String => Object})
      * :description (String)
      * :required (Array<String>)
      * :enum (Array<String>)
    * :timeout_seconds (Float)
  * :success_evaluation_plan (Hash)
    * :rubric (Vapi::SuccessEvaluationPlanRubric)
    * :messages (Array<Hash{String => Object}>)
    * :enabled (Boolean)
    * :timeout_seconds (Float)
* :artifact_plan (Hash)
  * :recording_enabled (Boolean)
  * :video_recording_enabled (Boolean)
  * :transcript_plan (Hash)
    * :enabled (Boolean)
    * :assistant_name (String)
    * :user_name (String)
  * :recording_path (String)
* :message_plan (Hash)
  * :idle_messages (Array<String>)
  * :idle_message_max_spoken_count (Float)
  * :idle_timeout_seconds (Float)
* :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)
    * :on_number_seconds (Float)
* :stop_speaking_plan (Hash)
  * :num_words (Float)
  * :voice_seconds (Float)
  * :backoff_seconds (Float)
* :monitor_plan (Hash)
  * :listen_enabled (Boolean)
  * :control_enabled (Boolean)
* :credential_ids (Array<String>)
* :server (Hash)
  * :timeout_seconds (Float)
  * :url (String)
  * :secret (String)
  * :headers (Hash{String => Object})
  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/vapi_server_sdk/squads/client.rb', line 995

def update(id:, members:, name: nil, members_overrides: nil, request_options: nil)
  Async do
    response = @request_client.conn.patch 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?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      unless request_options.nil? || request_options&.additional_query_parameters.nil?
        req.params = { **(request_options&.additional_query_parameters || {}) }.compact
      end
      req.body = {
        **(request_options&.additional_body_parameters || {}),
        name: name,
        members: members,
        membersOverrides: members_overrides
      }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/squad/#{id}"
    end
    Vapi::Squad.from_json(json_object: response.body)
  end
end