revox 0.0.2

data/lib/revox/models/assistant_retrieve_response.rb

@@ -0,0 +1,518 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Assistants#retrieve
+    class AssistantRetrieveResponse < Revox::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute background_sound
+      #   The background sound to play during the call. Useful to give the impression that
+      #   your AI agent is in an office.
+      #
+      #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::BackgroundSound, nil]
+      required :background_sound,
+               enum: -> { Revox::Models::AssistantRetrieveResponse::BackgroundSound },
+               nil?: true
+
+      # @!attribute calendly
+      #
+      #   @return [Revox::Models::AssistantRetrieveResponse::Calendly, nil]
+      required :calendly, -> { Revox::Models::AssistantRetrieveResponse::Calendly }, nil?: true
+
+      # @!attribute call_retry_config
+      #   Configuration for call retry behavior including time windows, delays, and max
+      #   iterations. If not provided, defaults will be used.
+      #
+      #   @return [Revox::Models::AssistantRetrieveResponse::CallRetryConfig, nil]
+      required :call_retry_config, -> { Revox::Models::AssistantRetrieveResponse::CallRetryConfig }, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Object]
+      required :created_at, Revox::Internal::Type::Unknown
+
+      # @!attribute end_of_call_sentence
+      #
+      #   @return [String, nil]
+      required :end_of_call_sentence, String, nil?: true
+
+      # @!attribute first_sentence
+      #
+      #   @return [String, nil]
+      required :first_sentence, String, nil?: true
+
+      # @!attribute first_sentence_delay_ms
+      #   Delay in milliseconds before speaking the first sentence. Default: 400.
+      #
+      #   @return [Integer]
+      required :first_sentence_delay_ms, Integer
+
+      # @!attribute first_sentence_mode
+      #
+      #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::FirstSentenceMode]
+      required :first_sentence_mode, enum: -> { Revox::Models::AssistantRetrieveResponse::FirstSentenceMode }
+
+      # @!attribute ivr_navigation_enabled
+      #   Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+      #   skip turns to navigate phone menus.
+      #
+      #   @return [Boolean]
+      required :ivr_navigation_enabled, Revox::Internal::Type::Boolean
+
+      # @!attribute llm_model
+      #
+      #   @return [Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0, Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember1]
+      required :llm_model, union: -> { Revox::Models::AssistantRetrieveResponse::LlmModel }
+
+      # @!attribute max_call_duration_secs
+      #   The maximum duration of the call in seconds. This is the maximum time the call
+      #   will be allowed to run.
+      #
+      #   @return [Float]
+      required :max_call_duration_secs, Float
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute organization_id
+      #
+      #   @return [String]
+      required :organization_id, String
+
+      # @!attribute prompt
+      #
+      #   @return [String]
+      required :prompt, String
+
+      # @!attribute structured_output_config
+      #   The structured output config to use for the call. This is used to extract the
+      #   data from the call (like email, name, company name, etc.).
+      #
+      #   @return [Array<Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig>, nil]
+      required :structured_output_config,
+               -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig] },
+               nil?: true
+
+      # @!attribute transfer_phone_number
+      #   Phone number to transfer calls to when users request to speak to a human agent.
+      #
+      #   @return [String, nil]
+      required :transfer_phone_number, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Object]
+      required :updated_at, Revox::Internal::Type::Unknown
+
+      # @!attribute voice
+      #
+      #   @return [Revox::Models::AssistantRetrieveResponse::Voice, nil]
+      required :voice, -> { Revox::Models::AssistantRetrieveResponse::Voice }, nil?: true
+
+      # @!attribute voicemail_message
+      #   If set, when voicemail is detected the agent will speak this message then hang
+      #   up; if null, hang up immediately.
+      #
+      #   @return [String, nil]
+      required :voicemail_message, String, nil?: true
+
+      # @!attribute webhook_url
+      #   The webhook URL to call when the call is completed.
+      #
+      #   @return [String, nil]
+      required :webhook_url, String, nil?: true
+
+      # @!attribute faq_items
+      #
+      #   @return [Array<Revox::Models::AssistantRetrieveResponse::FaqItem>, nil]
+      optional :faq_items,
+               -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantRetrieveResponse::FaqItem] }
+
+      # @!attribute pending_faq_count
+      #
+      #   @return [Float, nil]
+      optional :pending_faq_count, Float
+
+      # @!method initialize(id:, background_sound:, calendly:, call_retry_config:, created_at:, end_of_call_sentence:, first_sentence:, first_sentence_delay_ms:, first_sentence_mode:, ivr_navigation_enabled:, llm_model:, max_call_duration_secs:, name:, organization_id:, prompt:, structured_output_config:, transfer_phone_number:, updated_at:, voice:, voicemail_message:, webhook_url:, faq_items: nil, pending_faq_count: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::AssistantRetrieveResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param background_sound [Symbol, Revox::Models::AssistantRetrieveResponse::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
+      #
+      #   @param calendly [Revox::Models::AssistantRetrieveResponse::Calendly, nil]
+      #
+      #   @param call_retry_config [Revox::Models::AssistantRetrieveResponse::CallRetryConfig, nil] Configuration for call retry behavior including time windows, delays, and max it
+      #
+      #   @param created_at [Object]
+      #
+      #   @param end_of_call_sentence [String, nil]
+      #
+      #   @param first_sentence [String, nil]
+      #
+      #   @param first_sentence_delay_ms [Integer] Delay in milliseconds before speaking the first sentence. Default: 400.
+      #
+      #   @param first_sentence_mode [Symbol, Revox::Models::AssistantRetrieveResponse::FirstSentenceMode]
+      #
+      #   @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+      #
+      #   @param llm_model [Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0, Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember1]
+      #
+      #   @param max_call_duration_secs [Float] The maximum duration of the call in seconds. This is the maximum time the call w
+      #
+      #   @param name [String]
+      #
+      #   @param organization_id [String]
+      #
+      #   @param prompt [String]
+      #
+      #   @param structured_output_config [Array<Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig>, nil] The structured output config to use for the call. This is used to extract the da
+      #
+      #   @param transfer_phone_number [String, nil] Phone number to transfer calls to when users request to speak to a human agent.
+      #
+      #   @param updated_at [Object]
+      #
+      #   @param voice [Revox::Models::AssistantRetrieveResponse::Voice, nil]
+      #
+      #   @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
+      #
+      #   @param webhook_url [String, nil] The webhook URL to call when the call is completed.
+      #
+      #   @param faq_items [Array<Revox::Models::AssistantRetrieveResponse::FaqItem>]
+      #
+      #   @param pending_faq_count [Float]
+
+      # The background sound to play during the call. Useful to give the impression that
+      # your AI agent is in an office.
+      #
+      # @see Revox::Models::AssistantRetrieveResponse#background_sound
+      module BackgroundSound
+        extend Revox::Internal::Type::Enum
+
+        AUDIO_OFFICE_OGG = :"audio/office.ogg"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Revox::Models::AssistantRetrieveResponse#calendly
+      class Calendly < Revox::Internal::Type::BaseModel
+        # @!attribute connection_id
+        #   The connection ID representing the link between your Calendly account and Revox.
+        #
+        #   @return [String]
+        required :connection_id, String
+
+        # @!attribute event_type_id
+        #   The event type ID representing the event type to schedule. (eg:
+        #   https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
+        #
+        #   @return [String]
+        required :event_type_id, String
+
+        # @!method initialize(connection_id:, event_type_id:)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::AssistantRetrieveResponse::Calendly} for more details.
+        #
+        #   @param connection_id [String] The connection ID representing the link between your Calendly account and Revox.
+        #
+        #   @param event_type_id [String] The event type ID representing the event type to schedule. (eg: https://api.cale
+      end
+
+      # @see Revox::Models::AssistantRetrieveResponse#call_retry_config
+      class CallRetryConfig < Revox::Internal::Type::BaseModel
+        # @!attribute calling_windows
+        #
+        #   @return [Array<Revox::Models::AssistantRetrieveResponse::CallRetryConfig::CallingWindow>]
+        required :calling_windows,
+                 -> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantRetrieveResponse::CallRetryConfig::CallingWindow] }
+
+        # @!attribute max_retry_attempts
+        #   Maximum number of call retry attempts. Default: 3.
+        #
+        #   @return [Integer]
+        required :max_retry_attempts, Integer
+
+        # @!attribute timezone
+        #   Optional IANA timezone identifier to override the automatic timezone detection
+        #   from phone number. If not provided, timezone is determined from the recipient's
+        #   phone number country code. Examples: 'America/New_York', 'Europe/Paris'.
+        #
+        #   @return [String, nil]
+        optional :timezone, String, nil?: true
+
+        # @!method initialize(calling_windows:, max_retry_attempts:, timezone: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::AssistantRetrieveResponse::CallRetryConfig} for more details.
+        #
+        #   Configuration for call retry behavior including time windows, delays, and max
+        #   iterations. If not provided, defaults will be used.
+        #
+        #   @param calling_windows [Array<Revox::Models::AssistantRetrieveResponse::CallRetryConfig::CallingWindow>]
+        #
+        #   @param max_retry_attempts [Integer] Maximum number of call retry attempts. Default: 3.
+        #
+        #   @param timezone [String, nil] Optional IANA timezone identifier to override the automatic timezone detection f
+
+        class CallingWindow < Revox::Internal::Type::BaseModel
+          # @!attribute calling_window_end_time
+          #   End time for the calling window in the recipient's timezone (or
+          #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
+          #   Examples: '17:00', '6pm'. Default: '18:00'.
+          #
+          #   @return [String]
+          required :calling_window_end_time, String
+
+          # @!attribute calling_window_start_time
+          #   Start time for the calling window in the recipient's timezone (or
+          #   timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour).
+          #   Examples: '09:00', '10am'. Default: '10:00'.
+          #
+          #   @return [String]
+          required :calling_window_start_time, String
+
+          # @!attribute retry_delay_seconds
+          #   Delay between retry attempts in seconds. Default: 7200 (2 hours).
+          #
+          #   @return [Integer]
+          required :retry_delay_seconds, Integer
+
+          # @!method initialize(calling_window_end_time:, calling_window_start_time:, retry_delay_seconds:)
+          #   Some parameter documentations has been truncated, see
+          #   {Revox::Models::AssistantRetrieveResponse::CallRetryConfig::CallingWindow} for
+          #   more details.
+          #
+          #   @param calling_window_end_time [String] End time for the calling window in the recipient's timezone (or timezone_overrid
+          #
+          #   @param calling_window_start_time [String] Start time for the calling window in the recipient's timezone (or timezone_overr
+          #
+          #   @param retry_delay_seconds [Integer] Delay between retry attempts in seconds. Default: 7200 (2 hours).
+        end
+      end
+
+      # @see Revox::Models::AssistantRetrieveResponse#first_sentence_mode
+      module FirstSentenceMode
+        extend Revox::Internal::Type::Enum
+
+        GENERATED = :generated
+        STATIC = :static
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Revox::Models::AssistantRetrieveResponse#llm_model
+      module LlmModel
+        extend Revox::Internal::Type::Union
+
+        variant -> { Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0 }
+
+        variant -> { Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember1 }
+
+        class UnionMember0 < Revox::Internal::Type::BaseModel
+          # @!attribute name
+          #
+          #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0::Name]
+          required :name, enum: -> { Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0::Name }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :"dedicated-instance"]
+          required :type, const: :"dedicated-instance"
+
+          # @!method initialize(name:, type: :"dedicated-instance")
+          #   @param name [Symbol, Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0::Name]
+          #   @param type [Symbol, :"dedicated-instance"]
+
+          # @see Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0#name
+          module Name
+            extend Revox::Internal::Type::Enum
+
+            GPT_4_1 = :"gpt-4.1"
+            MINISTRAL_3_8B_INSTRUCT = :"ministral-3-8b-instruct"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class UnionMember1 < Revox::Internal::Type::BaseModel
+          # @!attribute openrouter_model_id
+          #   The model ID to use from OpenRouter. eg: openai/gpt-4.1
+          #
+          #   @return [String]
+          required :openrouter_model_id, String
+
+          # @!attribute openrouter_provider
+          #   The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
+          #
+          #   @return [String]
+          required :openrouter_provider, String
+
+          # @!attribute type
+          #   Use a model from OpenRouter.
+          #
+          #   @return [Symbol, :openrouter]
+          required :type, const: :openrouter
+
+          # @!method initialize(openrouter_model_id:, openrouter_provider:, type: :openrouter)
+          #   @param openrouter_model_id [String] The model ID to use from OpenRouter. eg: openai/gpt-4.1
+          #
+          #   @param openrouter_provider [String] The provider to use from OpenRouter. eg: nebius, openai, azure, etc.
+          #
+          #   @param type [Symbol, :openrouter] Use a model from OpenRouter.
+        end
+
+        # @!method self.variants
+        #   @return [Array(Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0, Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember1)]
+      end
+
+      class StructuredOutputConfig < Revox::Internal::Type::BaseModel
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute required
+        #
+        #   @return [Boolean]
+        required :required, Revox::Internal::Type::Boolean
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig::Type]
+        required :type, enum: -> { Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig::Type }
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute enum_options
+        #
+        #   @return [Array<String>, nil]
+        optional :enum_options, Revox::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(name:, required:, type:, description: nil, enum_options: nil)
+        #   @param name [String]
+        #   @param required [Boolean]
+        #   @param type [Symbol, Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig::Type]
+        #   @param description [String]
+        #   @param enum_options [Array<String>]
+
+        # @see Revox::Models::AssistantRetrieveResponse::StructuredOutputConfig#type
+        module Type
+          extend Revox::Internal::Type::Enum
+
+          STRING = :string
+          NUMBER = :number
+          BOOLEAN = :boolean
+          ENUM = :enum
+          DATE = :date
+          DATETIME = :datetime
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Revox::Models::AssistantRetrieveResponse#voice
+      class Voice < Revox::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the voice.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute provider
+        #   The provider of the voice.
+        #
+        #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::Voice::Provider]
+        required :provider, enum: -> { Revox::Models::AssistantRetrieveResponse::Voice::Provider }
+
+        # @!attribute speed
+        #   The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
+        #   0.7–1.2. Default is 1.0.
+        #
+        #   @return [Float, nil]
+        optional :speed, Float
+
+        # @!method initialize(id:, provider:, speed: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::AssistantRetrieveResponse::Voice} for more details.
+        #
+        #   @param id [String] The ID of the voice.
+        #
+        #   @param provider [Symbol, Revox::Models::AssistantRetrieveResponse::Voice::Provider] The provider of the voice.
+        #
+        #   @param speed [Float] The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs
+
+        # The provider of the voice.
+        #
+        # @see Revox::Models::AssistantRetrieveResponse::Voice#provider
+        module Provider
+          extend Revox::Internal::Type::Enum
+
+          CARTESIA = :cartesia
+          ELEVENLABS = :elevenlabs
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class FaqItem < Revox::Internal::Type::BaseModel
+        # @!attribute answer
+        #
+        #   @return [String]
+        required :answer, String
+
+        # @!attribute question
+        #
+        #   @return [String]
+        required :question, String
+
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute needs_human_answer
+        #
+        #   @return [Boolean, nil]
+        optional :needs_human_answer, Revox::Internal::Type::Boolean
+
+        # @!attribute source
+        #
+        #   @return [Symbol, Revox::Models::AssistantRetrieveResponse::FaqItem::Source, nil]
+        optional :source, enum: -> { Revox::Models::AssistantRetrieveResponse::FaqItem::Source }
+
+        # @!method initialize(answer:, question:, id: nil, needs_human_answer: nil, source: nil)
+        #   @param answer [String]
+        #   @param question [String]
+        #   @param id [String]
+        #   @param needs_human_answer [Boolean]
+        #   @param source [Symbol, Revox::Models::AssistantRetrieveResponse::FaqItem::Source]
+
+        # @see Revox::Models::AssistantRetrieveResponse::FaqItem#source
+        module Source
+          extend Revox::Internal::Type::Enum
+
+          HUMAN = :human
+          AI = :ai
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end