revox 0.0.2

data/lib/revox/models/call_create_params.rb

@@ -0,0 +1,592 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Call#create
+    class CallCreateParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   The phone number to call in the E.164 format. Example: +1234567890
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute assistant
+      #   You can provide a custom assistant configuration here. If you don't provide an
+      #   assistant_id, this assistant object will be used for this call.
+      #
+      #   @return [Revox::Models::CallCreateParams::Assistant, nil]
+      optional :assistant, -> { Revox::CallCreateParams::Assistant }
+
+      # @!attribute assistant_id
+      #   The ID of the assistant to use for this call.
+      #
+      #   @return [String, nil]
+      optional :assistant_id, String
+
+      # @!attribute concurrency
+      #   Limit the number of concurrent calls for a given concurrency key.
+      #
+      #   @return [Revox::Models::CallCreateParams::Concurrency, nil]
+      optional :concurrency, -> { Revox::CallCreateParams::Concurrency }
+
+      # @!attribute force_now
+      #   The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+      #
+      #   @return [Boolean, nil]
+      optional :force_now, Revox::Internal::Type::Boolean
+
+      # @!attribute from_phone_number
+      #   The phone number to use for making the call (e.g., +1234567890). If not
+      #   provided, uses the default trunk.
+      #
+      #   @return [String, nil]
+      optional :from_phone_number, String
+
+      # @!attribute metadata
+      #   Metadata to store with the call.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Revox::Internal::Type::HashOf[String]
+
+      # @!attribute prompt_variables
+      #   Variables to interpolate into the prompt. Wether you use an assistant_id or an
+      #   assistant object, this will be used to interpolate the variables into the
+      #   prompt.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :prompt_variables, Revox::Internal::Type::HashOf[String]
+
+      # @!attribute scheduled_at
+      #   Schedule the call to start at a specific date and time (ISO 8601 format). If not
+      #   provided, the call will start immediately.
+      #
+      #   @return [Time, Object, nil]
+      optional :scheduled_at, union: -> { Revox::CallCreateParams::ScheduledAt }
+
+      # @!method initialize(phone_number:, assistant: nil, assistant_id: nil, concurrency: nil, force_now: nil, from_phone_number: nil, metadata: nil, prompt_variables: nil, scheduled_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::CallCreateParams} for more details.
+      #
+      #   @param phone_number [String] The phone number to call in the E.164 format. Example: +1234567890
+      #
+      #   @param assistant [Revox::Models::CallCreateParams::Assistant] You can provide a custom assistant configuration here. If you don't provide an a
+      #
+      #   @param assistant_id [String] The ID of the assistant to use for this call.
+      #
+      #   @param concurrency [Revox::Models::CallCreateParams::Concurrency] Limit the number of concurrent calls for a given concurrency key.
+      #
+      #   @param force_now [Boolean] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+      #
+      #   @param from_phone_number [String] The phone number to use for making the call (e.g., +1234567890). If not provided
+      #
+      #   @param metadata [Hash{Symbol=>String}] Metadata to store with the call.
+      #
+      #   @param prompt_variables [Hash{Symbol=>String}] Variables to interpolate into the prompt. Wether you use an assistant_id or an a
+      #
+      #   @param scheduled_at [Time, Object] Schedule the call to start at a specific date and time (ISO 8601 format). If not
+      #
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      class Assistant < Revox::Internal::Type::BaseModel
+        # @!attribute prompt
+        #   The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+        #
+        #   @return [String]
+        required :prompt, 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, in the street, or anywhere else you want.
+        #
+        #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil]
+        optional :background_sound,
+                 enum: -> {
+                   Revox::CallCreateParams::Assistant::BackgroundSound
+                 },
+                 nil?: true
+
+        # @!attribute calendly
+        #
+        #   @return [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
+        optional :calendly, -> { Revox::CallCreateParams::Assistant::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::CallCreateParams::Assistant::CallRetryConfig, nil]
+        optional :call_retry_config, -> { Revox::CallCreateParams::Assistant::CallRetryConfig }
+
+        # @!attribute end_of_call_sentence
+        #   Optional message to say when the agent decides to end the call.
+        #
+        #   @return [String, nil]
+        optional :end_of_call_sentence, String
+
+        # @!attribute faq_items
+        #   FAQ items to associate with this assistant. When provided, replaces all existing
+        #   FAQ items.
+        #
+        #   @return [Array<Revox::Models::CallCreateParams::Assistant::FaqItem>, nil]
+        optional :faq_items, -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::FaqItem] }
+
+        # @!attribute first_sentence
+        #   The first sentence to use for the call. This will be given to the LLM
+        #
+        #   @return [String, nil]
+        optional :first_sentence, String
+
+        # @!attribute first_sentence_delay_ms
+        #   Delay in milliseconds before speaking the first sentence. Default: 400.
+        #
+        #   @return [Integer, nil]
+        optional :first_sentence_delay_ms, Integer
+
+        # @!attribute first_sentence_mode
+        #   How the first sentence should be handled. "generated" means the LLM will
+        #   generate a response based on the first_sentence instruction. "static" means the
+        #   first_sentence will be spoken exactly as provided. "none" means the agent will
+        #   not speak first and will wait for the user.
+        #
+        #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::FirstSentenceMode, nil]
+        optional :first_sentence_mode, enum: -> { Revox::CallCreateParams::Assistant::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, nil]
+        optional :ivr_navigation_enabled, Revox::Internal::Type::Boolean
+
+        # @!attribute llm_model
+        #
+        #   @return [Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember1, nil]
+        optional :llm_model, union: -> { Revox::CallCreateParams::Assistant::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, nil]
+        optional :max_call_duration_secs, Float
+
+        # @!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::CallCreateParams::Assistant::StructuredOutputConfig>, nil]
+        optional :structured_output_config,
+                 -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::StructuredOutputConfig] }
+
+        # @!attribute transfer_phone_number
+        #   Phone number to transfer calls to when users request to speak to a human agent
+        #   in E.164 format (e.g. +1234567890).
+        #
+        #   @return [String, nil]
+        optional :transfer_phone_number, String, nil?: true
+
+        # @!attribute voice
+        #   The voice to use for the call. You can get the list of voices using the /voices
+        #   endpoint
+        #
+        #   @return [Revox::Models::CallCreateParams::Assistant::Voice, nil]
+        optional :voice, -> { Revox::CallCreateParams::Assistant::Voice }
+
+        # @!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]
+        optional :voicemail_message, String, nil?: true
+
+        # @!attribute webhook_url
+        #   The webhook URL to call when the call is completed.
+        #
+        #   @return [String, nil]
+        optional :webhook_url, String
+
+        # @!method initialize(prompt:, background_sound: nil, calendly: nil, call_retry_config: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, max_call_duration_secs: nil, structured_output_config: nil, transfer_phone_number: nil, voice: nil, voicemail_message: nil, webhook_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Revox::Models::CallCreateParams::Assistant} for more details.
+        #
+        #   You can provide a custom assistant configuration here. If you don't provide an
+        #   assistant_id, this assistant object will be used for this call.
+        #
+        #   @param prompt [String] The prompt to use for the call. This will be given to the LLM (gpt-4.1)
+        #
+        #   @param background_sound [Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
+        #
+        #   @param calendly [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
+        #
+        #   @param call_retry_config [Revox::Models::CallCreateParams::Assistant::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
+        #
+        #   @param end_of_call_sentence [String] Optional message to say when the agent decides to end the call.
+        #
+        #   @param faq_items [Array<Revox::Models::CallCreateParams::Assistant::FaqItem>] FAQ items to associate with this assistant. When provided, replaces all existing
+        #
+        #   @param first_sentence [String] The first sentence to use for the call. This will be given to the LLM
+        #
+        #   @param first_sentence_delay_ms [Integer] Delay in milliseconds before speaking the first sentence. Default: 400.
+        #
+        #   @param first_sentence_mode [Symbol, Revox::Models::CallCreateParams::Assistant::FirstSentenceMode] How the first sentence should be handled. "generated" means the LLM will generat
+        #
+        #   @param ivr_navigation_enabled [Boolean] Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and
+        #
+        #   @param llm_model [Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::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 structured_output_config [Array<Revox::Models::CallCreateParams::Assistant::StructuredOutputConfig>] 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 i
+        #
+        #   @param voice [Revox::Models::CallCreateParams::Assistant::Voice] The voice to use for the call. You can get the list of voices using the /voices
+        #
+        #   @param voicemail_message [String, nil] If set, when voicemail is detected the agent will speak this message then hang u
+        #
+        #   @param webhook_url [String] The webhook URL to call when the call is completed.
+
+        # The background sound to play during the call. Useful to give the impression that
+        # your AI agent is in an office, in the street, or anywhere else you want.
+        #
+        # @see Revox::Models::CallCreateParams::Assistant#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::CallCreateParams::Assistant#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::CallCreateParams::Assistant::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::CallCreateParams::Assistant#call_retry_config
+        class CallRetryConfig < Revox::Internal::Type::BaseModel
+          # @!attribute calling_windows
+          #
+          #   @return [Array<Revox::Models::CallCreateParams::Assistant::CallRetryConfig::CallingWindow>]
+          required :calling_windows,
+                   -> { Revox::Internal::Type::ArrayOf[Revox::CallCreateParams::Assistant::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::CallCreateParams::Assistant::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::CallCreateParams::Assistant::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::CallCreateParams::Assistant::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
+
+        class FaqItem < Revox::Internal::Type::BaseModel
+          # @!attribute answer
+          #
+          #   @return [String]
+          required :answer, String
+
+          # @!attribute question
+          #
+          #   @return [String]
+          required :question, String
+
+          # @!method initialize(answer:, question:)
+          #   @param answer [String]
+          #   @param question [String]
+        end
+
+        # How the first sentence should be handled. "generated" means the LLM will
+        # generate a response based on the first_sentence instruction. "static" means the
+        # first_sentence will be spoken exactly as provided. "none" means the agent will
+        # not speak first and will wait for the user.
+        #
+        # @see Revox::Models::CallCreateParams::Assistant#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::CallCreateParams::Assistant#llm_model
+        module LlmModel
+          extend Revox::Internal::Type::Union
+
+          variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember0 }
+
+          variant -> { Revox::CallCreateParams::Assistant::LlmModel::UnionMember1 }
+
+          class UnionMember0 < Revox::Internal::Type::BaseModel
+            # @!attribute name
+            #
+            #   @return [Symbol, Revox::Models::CallCreateParams::Assistant::LlmModel::UnionMember0::Name]
+            required :name, enum: -> { Revox::CallCreateParams::Assistant::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::CallCreateParams::Assistant::LlmModel::UnionMember0::Name]
+            #   @param type [Symbol, :"dedicated-instance"]
+
+            # @see Revox::Models::CallCreateParams::Assistant::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::CallCreateParams::Assistant::LlmModel::UnionMember0, Revox::Models::CallCreateParams::Assistant::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::CallCreateParams::Assistant::StructuredOutputConfig::Type]
+          required :type, enum: -> { Revox::CallCreateParams::Assistant::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::CallCreateParams::Assistant::StructuredOutputConfig::Type]
+          #   @param description [String]
+          #   @param enum_options [Array<String>]
+
+          # @see Revox::Models::CallCreateParams::Assistant::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::CallCreateParams::Assistant#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::CallCreateParams::Assistant::Voice::Provider]
+          required :provider, enum: -> { Revox::CallCreateParams::Assistant::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::CallCreateParams::Assistant::Voice} for more details.
+          #
+          #   The voice to use for the call. You can get the list of voices using the /voices
+          #   endpoint
+          #
+          #   @param id [String] The ID of the voice.
+          #
+          #   @param provider [Symbol, Revox::Models::CallCreateParams::Assistant::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::CallCreateParams::Assistant::Voice#provider
+          module Provider
+            extend Revox::Internal::Type::Enum
+
+            CARTESIA = :cartesia
+            ELEVENLABS = :elevenlabs
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      class Concurrency < Revox::Internal::Type::BaseModel
+        # @!attribute key
+        #   The key for which you want to limit the number of concurrent calls.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute max
+        #   The maximum number of concurrent calls to allow for the given concurrency key.
+        #
+        #   @return [Float]
+        required :max, Float
+
+        # @!method initialize(key:, max:)
+        #   Limit the number of concurrent calls for a given concurrency key.
+        #
+        #   @param key [String] The key for which you want to limit the number of concurrent calls.
+        #
+        #   @param max [Float] The maximum number of concurrent calls to allow for the given concurrency key.
+      end
+
+      # Schedule the call to start at a specific date and time (ISO 8601 format). If not
+      # provided, the call will start immediately.
+      module ScheduledAt
+        extend Revox::Internal::Type::Union
+
+        variant Time
+
+        variant Revox::Internal::Type::Unknown
+
+        # @!method self.variants
+        #   @return [Array(Time, Object)]
+      end
+    end
+  end
+end