telnyx 5.102.1 → 5.103.0

data/rbi/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rbi

@@ -32,6 +32,41 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :telnyx_end_user_target
 
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt
+                ]
+              )
+            )
+          end
+          attr_reader :call_attempts
+
+          sig do
+            params(
+              call_attempts:
+                T::Array[
+                  Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt::OrHash
+                ]
+            ).void
+          end
+          attr_writer :call_attempts
+
+          # Duration of the call in seconds
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :call_duration
+
+          sig { params(call_duration: Integer).void }
+          attr_writer :call_duration
+
+          # Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_status
+
+          sig { params(call_status: String).void }
+          attr_writer :call_status
+
           sig { returns(T.nilable(String)) }
           attr_reader :conversation_id
 
@@ -67,6 +102,13 @@ module Telnyx
           sig { params(created_at: Time).void }
           attr_writer :created_at
 
+          # Date time at which call was sent
+          sig { returns(T.nilable(Time)) }
+          attr_reader :dispatched_at
+
+          sig { params(dispatched_at: Time).void }
+          attr_writer :dispatched_at
+
           # A map of dynamic variable names to values. These variables can be referenced in
           # the assistant's instructions and messages using {{variable_name}} syntax.
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -81,6 +123,14 @@ module Telnyx
           sig { params(errors: T::Array[String]).void }
           attr_writer :errors
 
+          # Configure number of retries on client errors: busy, no-answer, failed, canceled
+          # (caller hung up before the callee answered)
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_retries_client_errors
+
+          sig { params(max_retries_client_errors: Integer).void }
+          attr_writer :max_retries_client_errors
+
           sig { returns(T.nilable(Integer)) }
           attr_reader :retry_attempts
 
@@ -93,6 +143,12 @@ module Telnyx
           sig { params(retry_count: Integer).void }
           attr_writer :retry_count
 
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :retry_interval_secs
+
+          sig { params(retry_interval_secs: Integer).void }
+          attr_writer :retry_interval_secs
+
           sig { returns(T.nilable(String)) }
           attr_reader :scheduled_event_id
 
@@ -119,6 +175,12 @@ module Telnyx
               telnyx_conversation_channel:
                 Telnyx::AI::Assistants::ConversationChannelType::OrSymbol,
               telnyx_end_user_target: String,
+              call_attempts:
+                T::Array[
+                  Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt::OrHash
+                ],
+              call_duration: Integer,
+              call_status: String,
               conversation_id: String,
               conversation_metadata:
                 T::Hash[
@@ -126,10 +188,13 @@ module Telnyx
                   Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::ConversationMetadata::Variants
                 ],
               created_at: Time,
+              dispatched_at: Time,
               dynamic_variables: T::Hash[Symbol, String],
               errors: T::Array[String],
+              max_retries_client_errors: Integer,
               retry_attempts: Integer,
               retry_count: Integer,
+              retry_interval_secs: Integer,
               scheduled_event_id: String,
               status: Telnyx::AI::Assistants::EventStatus::OrSymbol
             ).returns(T.attached_class)
@@ -140,15 +205,26 @@ module Telnyx
             telnyx_agent_target:,
             telnyx_conversation_channel:,
             telnyx_end_user_target:,
+            call_attempts: nil,
+            # Duration of the call in seconds
+            call_duration: nil,
+            # Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+            call_status: nil,
             conversation_id: nil,
             conversation_metadata: nil,
             created_at: nil,
+            # Date time at which call was sent
+            dispatched_at: nil,
             # A map of dynamic variable names to values. These variables can be referenced in
             # the assistant's instructions and messages using {{variable_name}} syntax.
             dynamic_variables: nil,
             errors: nil,
+            # Configure number of retries on client errors: busy, no-answer, failed, canceled
+            # (caller hung up before the callee answered)
+            max_retries_client_errors: nil,
             retry_attempts: nil,
             retry_count: nil,
+            retry_interval_secs: nil,
             scheduled_event_id: nil,
             status: nil
           )
@@ -163,6 +239,12 @@ module Telnyx
                 telnyx_conversation_channel:
                   Telnyx::AI::Assistants::ConversationChannelType::TaggedSymbol,
                 telnyx_end_user_target: String,
+                call_attempts:
+                  T::Array[
+                    Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt
+                  ],
+                call_duration: Integer,
+                call_status: String,
                 conversation_id: String,
                 conversation_metadata:
                   T::Hash[
@@ -170,10 +252,13 @@ module Telnyx
                     Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::ConversationMetadata::Variants
                   ],
                 created_at: Time,
+                dispatched_at: Time,
                 dynamic_variables: T::Hash[Symbol, String],
                 errors: T::Array[String],
+                max_retries_client_errors: Integer,
                 retry_attempts: Integer,
                 retry_count: Integer,
+                retry_interval_secs: Integer,
                 scheduled_event_id: String,
                 status: Telnyx::AI::Assistants::EventStatus::TaggedSymbol
               }
@@ -182,6 +267,74 @@ module Telnyx
           def to_hash
           end
 
+          class CallAttempt < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :attempt_number
+
+            sig { returns(Time) }
+            attr_accessor :attempted_at
+
+            # Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+            sig { returns(String) }
+            attr_accessor :call_status
+
+            # Duration of the call in seconds
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :call_duration
+
+            sig { params(call_duration: Integer).void }
+            attr_writer :call_duration
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :telnyx_call_control_id
+
+            sig { params(telnyx_call_control_id: String).void }
+            attr_writer :telnyx_call_control_id
+
+            # One row in `call_attempts` — captures the terminal outcome of a single dispatch.
+            sig do
+              params(
+                attempt_number: Integer,
+                attempted_at: Time,
+                call_status: String,
+                call_duration: Integer,
+                telnyx_call_control_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              attempt_number:,
+              attempted_at:,
+              # Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+              call_status:,
+              # Duration of the call in seconds
+              call_duration: nil,
+              telnyx_call_control_id: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  attempt_number: Integer,
+                  attempted_at: Time,
+                  call_status: String,
+                  call_duration: Integer,
+                  telnyx_call_control_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
           module ConversationMetadata
             extend Telnyx::Internal::Type::Union
 

data/rbi/telnyx/models/ai/assistants/update_assistant.rbi

@@ -110,12 +110,21 @@ module Telnyx
           # integrations is at `/ai/integrations`; the user's connected integrations are at
           # `/ai/integrations/connections`. Each item references a catalog integration by
           # `integration_id`.
-          sig { returns(T.nilable(T::Array[Telnyx::AI::AssistantIntegration])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[Telnyx::AI::Assistants::UpdateAssistant::Integration]
+              )
+            )
+          end
           attr_reader :integrations
 
           sig do
             params(
-              integrations: T::Array[Telnyx::AI::AssistantIntegration::OrHash]
+              integrations:
+                T::Array[
+                  Telnyx::AI::Assistants::UpdateAssistant::Integration::OrHash
+                ]
             ).void
           end
           attr_writer :integrations
@@ -128,7 +137,9 @@ module Telnyx
           # `eager_eot_threshold`).
           sig do
             returns(
-              T.nilable(Telnyx::AI::InferenceEmbeddingInterruptionSettings)
+              T.nilable(
+                Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings
+              )
             )
           end
           attr_reader :interruption_settings
@@ -136,7 +147,7 @@ module Telnyx
           sig do
             params(
               interruption_settings:
-                Telnyx::AI::InferenceEmbeddingInterruptionSettings::OrHash
+                Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::OrHash
             ).void
           end
           attr_writer :interruption_settings
@@ -155,12 +166,21 @@ module Telnyx
 
           # MCP servers attached to the assistant. Create MCP servers with
           # `/ai/mcp_servers`, then reference them by `id` here.
-          sig { returns(T.nilable(T::Array[Telnyx::AI::AssistantMcpServer])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[Telnyx::AI::Assistants::UpdateAssistant::McpServer]
+              )
+            )
+          end
           attr_reader :mcp_servers
 
           sig do
             params(
-              mcp_servers: T::Array[Telnyx::AI::AssistantMcpServer::OrHash]
+              mcp_servers:
+                T::Array[
+                  Telnyx::AI::Assistants::UpdateAssistant::McpServer::OrHash
+                ]
             ).void
           end
           attr_writer :mcp_servers
@@ -343,11 +363,17 @@ module Telnyx
               greeting: String,
               insight_settings: Telnyx::AI::InsightSettings::OrHash,
               instructions: String,
-              integrations: T::Array[Telnyx::AI::AssistantIntegration::OrHash],
+              integrations:
+                T::Array[
+                  Telnyx::AI::Assistants::UpdateAssistant::Integration::OrHash
+                ],
               interruption_settings:
-                Telnyx::AI::InferenceEmbeddingInterruptionSettings::OrHash,
+                Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::OrHash,
               llm_api_key_ref: String,
-              mcp_servers: T::Array[Telnyx::AI::AssistantMcpServer::OrHash],
+              mcp_servers:
+                T::Array[
+                  Telnyx::AI::Assistants::UpdateAssistant::McpServer::OrHash
+                ],
               messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
               model: String,
               name: String,
@@ -484,11 +510,15 @@ module Telnyx
                 greeting: String,
                 insight_settings: Telnyx::AI::InsightSettings,
                 instructions: String,
-                integrations: T::Array[Telnyx::AI::AssistantIntegration],
+                integrations:
+                  T::Array[
+                    Telnyx::AI::Assistants::UpdateAssistant::Integration
+                  ],
                 interruption_settings:
-                  Telnyx::AI::InferenceEmbeddingInterruptionSettings,
+                  Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings,
                 llm_api_key_ref: String,
-                mcp_servers: T::Array[Telnyx::AI::AssistantMcpServer],
+                mcp_servers:
+                  T::Array[Telnyx::AI::Assistants::UpdateAssistant::McpServer],
                 messaging_settings: Telnyx::AI::MessagingSettings,
                 model: String,
                 name: String,
@@ -523,6 +553,319 @@ module Telnyx
           end
           def to_hash
           end
+
+          class Integration < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::Integration,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Catalog integration ID to attach. This is the `id` from the integrations catalog
+            # at `/ai/integrations` (the same value also appears as `integration_id` on
+            # entries returned by `/ai/integrations/connections`). It is **not** the
+            # connection-level `id` from `/ai/integrations/connections`.
+            sig { returns(String) }
+            attr_accessor :integration_id
+
+            # Optional per-assistant allowlist of integration tool names. When omitted or
+            # empty, all tools allowed by the connected integration are available to the
+            # assistant.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :allowed_list
+
+            sig { params(allowed_list: T::Array[String]).void }
+            attr_writer :allowed_list
+
+            # Reference to a connected integration attached to an assistant. Discover
+            # available integrations with `/ai/integrations` and connected integrations with
+            # `/ai/integrations/connections`.
+            sig do
+              params(
+                integration_id: String,
+                allowed_list: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Catalog integration ID to attach. This is the `id` from the integrations catalog
+              # at `/ai/integrations` (the same value also appears as `integration_id` on
+              # entries returned by `/ai/integrations/connections`). It is **not** the
+              # connection-level `id` from `/ai/integrations/connections`.
+              integration_id:,
+              # Optional per-assistant allowlist of integration tool names. When omitted or
+              # empty, all tools allowed by the connected integration are available to the
+              # assistant.
+              allowed_list: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { integration_id: String, allowed_list: T::Array[String] }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Whether users can interrupt the assistant while it is speaking.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enable
+
+            sig { params(enable: T::Boolean).void }
+            attr_writer :enable
+
+            # Controls when the assistant starts speaking after the user stops. These
+            # thresholds primarily apply to non turn-taking transcription models. For
+            # turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+            # transcription end-of-turn settings under `transcription.settings` instead.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan
+                )
+              )
+            end
+            attr_reader :start_speaking_plan
+
+            sig do
+              params(
+                start_speaking_plan:
+                  Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::OrHash
+              ).void
+            end
+            attr_writer :start_speaking_plan
+
+            # Settings for interruptions and how the assistant decides the user has finished
+            # speaking. These timings are most relevant when using non turn-taking
+            # transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
+            # behavior is controlled by the transcription end-of-turn settings under
+            # `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
+            # `eager_eot_threshold`).
+            sig do
+              params(
+                enable: T::Boolean,
+                start_speaking_plan:
+                  Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Whether users can interrupt the assistant while it is speaking.
+              enable: nil,
+              # Controls when the assistant starts speaking after the user stops. These
+              # thresholds primarily apply to non turn-taking transcription models. For
+              # turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+              # transcription end-of-turn settings under `transcription.settings` instead.
+              start_speaking_plan: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  enable: T::Boolean,
+                  start_speaking_plan:
+                    Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Endpointing thresholds used to decide when the user has finished speaking.
+              # Applies to non turn-taking transcription models. For `deepgram/flux`, use
+              # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+              # `eager_eot_threshold`.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan
+                  )
+                )
+              end
+              attr_reader :transcription_endpointing_plan
+
+              sig do
+                params(
+                  transcription_endpointing_plan:
+                    Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan::OrHash
+                ).void
+              end
+              attr_writer :transcription_endpointing_plan
+
+              # Minimum seconds to wait before the assistant starts speaking.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :wait_seconds
+
+              sig { params(wait_seconds: Float).void }
+              attr_writer :wait_seconds
+
+              # Controls when the assistant starts speaking after the user stops. These
+              # thresholds primarily apply to non turn-taking transcription models. For
+              # turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+              # transcription end-of-turn settings under `transcription.settings` instead.
+              sig do
+                params(
+                  transcription_endpointing_plan:
+                    Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan::OrHash,
+                  wait_seconds: Float
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Endpointing thresholds used to decide when the user has finished speaking.
+                # Applies to non turn-taking transcription models. For `deepgram/flux`, use
+                # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+                # `eager_eot_threshold`.
+                transcription_endpointing_plan: nil,
+                # Minimum seconds to wait before the assistant starts speaking.
+                wait_seconds: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    transcription_endpointing_plan:
+                      Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan,
+                    wait_seconds: Float
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                # Seconds to wait after the transcript ends without punctuation.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :on_no_punctuation_seconds
+
+                sig { params(on_no_punctuation_seconds: Float).void }
+                attr_writer :on_no_punctuation_seconds
+
+                # Seconds to wait after the transcript ends with a number.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :on_number_seconds
+
+                sig { params(on_number_seconds: Float).void }
+                attr_writer :on_number_seconds
+
+                # Seconds to wait after the transcript ends with punctuation.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :on_punctuation_seconds
+
+                sig { params(on_punctuation_seconds: Float).void }
+                attr_writer :on_punctuation_seconds
+
+                # Endpointing thresholds used to decide when the user has finished speaking.
+                # Applies to non turn-taking transcription models. For `deepgram/flux`, use
+                # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+                # `eager_eot_threshold`.
+                sig do
+                  params(
+                    on_no_punctuation_seconds: Float,
+                    on_number_seconds: Float,
+                    on_punctuation_seconds: Float
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  # Seconds to wait after the transcript ends without punctuation.
+                  on_no_punctuation_seconds: nil,
+                  # Seconds to wait after the transcript ends with a number.
+                  on_number_seconds: nil,
+                  # Seconds to wait after the transcript ends with punctuation.
+                  on_punctuation_seconds: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      on_no_punctuation_seconds: Float,
+                      on_number_seconds: Float,
+                      on_punctuation_seconds: Float
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+          end
+
+          class McpServer < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::McpServer,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # ID of the MCP server to attach. This must be the `id` of an MCP server returned
+            # by the `/ai/mcp_servers` endpoints.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+            # uses the MCP server's configured `allowed_tools`.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :allowed_tools
+
+            sig { params(allowed_tools: T::Array[String]).void }
+            attr_writer :allowed_tools
+
+            # Reference to an MCP server attached to an assistant. Create and manage MCP
+            # servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
+            # ID.
+            sig do
+              params(id: String, allowed_tools: T::Array[String]).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # ID of the MCP server to attach. This must be the `id` of an MCP server returned
+              # by the `/ai/mcp_servers` endpoints.
+              id:,
+              # Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+              # uses the MCP server's configured `allowed_tools`.
+              allowed_tools: nil
+            )
+            end
+
+            sig do
+              override.returns({ id: String, allowed_tools: T::Array[String] })
+            end
+            def to_hash
+            end
+          end
         end
       end
     end