telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/call_conversation_created_webhook_event.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallConversationCreatedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   A conversation has been created for the call. Use the conversation ID to
+      #   correlate subsequent conversation events.
+      #
+      #   @return [Telnyx::Models::CallConversationCreatedWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::CallConversationCreatedWebhookEvent::Data }
+
+      # @!method initialize(data: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::CallConversationCreatedWebhookEvent} for more details.
+      #
+      #   @param data [Telnyx::Models::CallConversationCreatedWebhookEvent::Data] A conversation has been created for the call. Use the conversation ID to correla
+
+      # @see Telnyx::Models::CallConversationCreatedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the event.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   Timestamp when the event was created in the system.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute event_type
+        #   The type of event being delivered.
+        #
+        #   @return [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::CallConversationCreatedWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
+        #
+        #   @return [Time, nil]
+        optional :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::CallConversationCreatedWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id: nil, created_at: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   A conversation has been created for the call. Use the conversation ID to
+        #   correlate subsequent conversation events.
+        #
+        #   @param id [String] Unique identifier for the event.
+        #
+        #   @param created_at [Time] Timestamp when the event was created in the system.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::EventType] The type of event being delivered.
+        #
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
+        #
+        #   @param payload [Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::RecordType] Identifies the type of the resource.
+
+        # The type of event being delivered.
+        #
+        # @see Telnyx::Models::CallConversationCreatedWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_CONVERSATION_CREATED = :"call.conversation.created"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::CallConversationCreatedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute call_control_id
+          #   Call ID used to issue commands via Call Control API.
+          #
+          #   @return [String, nil]
+          optional :call_control_id, String
+
+          # @!attribute call_leg_id
+          #   ID that is unique to the call leg.
+          #
+          #   @return [String, nil]
+          optional :call_leg_id, String
+
+          # @!attribute call_session_id
+          #   ID that is unique to the call session (group of related call legs).
+          #
+          #   @return [String, nil]
+          optional :call_session_id, String
+
+          # @!attribute calling_party_type
+          #   The type of calling party connection.
+          #
+          #   @return [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType, nil]
+          optional :calling_party_type,
+                   enum: -> { Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType }
+
+          # @!attribute client_state
+          #   Base64-encoded state received from a command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute conversation_id
+          #   Unique identifier of the conversation created for this call.
+          #
+          #   @return [String, nil]
+          optional :conversation_id, String
+
+          # @!attribute from
+          #   The caller's number or identifier.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute to
+          #   The callee's number or SIP address.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, from: nil, to: nil)
+          #   @param call_control_id [String] Call ID used to issue commands via Call Control API.
+          #
+          #   @param call_leg_id [String] ID that is unique to the call leg.
+          #
+          #   @param call_session_id [String] ID that is unique to the call session (group of related call legs).
+          #
+          #   @param calling_party_type [Symbol, Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType] The type of calling party connection.
+          #
+          #   @param client_state [String] Base64-encoded state received from a command.
+          #
+          #   @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @param conversation_id [String] Unique identifier of the conversation created for this call.
+          #
+          #   @param from [String] The caller's number or identifier.
+          #
+          #   @param to [String] The callee's number or SIP address.
+
+          # The type of calling party connection.
+          #
+          # @see Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload#calling_party_type
+          module CallingPartyType
+            extend Telnyx::Internal::Type::Enum
+
+            PSTN = :pstn
+            SIP = :sip
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifies the type of the resource.
+        #
+        # @see Telnyx::Models::CallConversationCreatedWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/call_conversation_ended.rb

@@ -131,6 +131,18 @@ module Telnyx
         #   @return [String, nil]
         optional :llm_model, String
 
+        # @!attribute messages
+        #   The conversation transcript, in order. By default it contains only `user` and
+        #   `assistant` text turns. When the assistant's
+        #   `telephony_settings.conversation_ended_full_history` is `true`, it contains the
+        #   full conversation history, including assistant tool calls, tool results, and
+        #   `system` and `developer` entries. Redacted when data retention is disabled for
+        #   the account.
+        #
+        #   @return [Array<Telnyx::Models::CallConversationEnded::Payload::Message>, nil]
+        optional :messages,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallConversationEnded::Payload::Message] }
+
         # @!attribute reason
         #   Reason the conversation ended. For Conversation Relay, `customer_disconnect`
         #   indicates that the customer WebSocket disconnected.
@@ -168,7 +180,7 @@ module Telnyx
         #   @return [String, nil]
         optional :tts_voice_id, String
 
-        # @!method initialize(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, duration_sec: nil, from: nil, llm_model: nil, reason: nil, stt_model: nil, to: nil, tts_model_id: nil, tts_provider: nil, tts_voice_id: nil)
+        # @!method initialize(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, duration_sec: nil, from: nil, llm_model: nil, messages: nil, reason: nil, stt_model: nil, to: nil, tts_model_id: nil, tts_provider: nil, tts_voice_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::CallConversationEnded::Payload} for more details.
         #
@@ -194,6 +206,8 @@ module Telnyx
         #
         #   @param llm_model [String] The large language model used during the conversation.
         #
+        #   @param messages [Array<Telnyx::Models::CallConversationEnded::Payload::Message>] The conversation transcript, in order. By default it contains only `user` and `a
+        #
         #   @param reason [String, nil] Reason the conversation ended. For Conversation Relay, `customer_disconnect` ind
         #
         #   @param stt_model [String] The speech-to-text model used in the conversation.
@@ -218,6 +232,143 @@ module Telnyx
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        class Message < Telnyx::Internal::Type::BaseModel
+          # @!attribute content
+          #   The text of the message. For a tool result, the tool output. May be absent on an
+          #   assistant message that only contains `tool_calls`.
+          #
+          #   @return [String, nil]
+          optional :content, String
+
+          # @!attribute role
+          #   The author of the message. `tool`, `system`, and `developer` only appear when
+          #   `conversation_ended_full_history` is enabled. `system` and `developer` entries
+          #   are informational (for example idle check-ins, voicemail prompts,
+          #   participant-left notices, or messages added through the API); their wording is
+          #   not a stable contract.
+          #
+          #   @return [Symbol, Telnyx::Models::CallConversationEnded::Payload::Message::Role, nil]
+          optional :role, enum: -> { Telnyx::CallConversationEnded::Payload::Message::Role }
+
+          # @!attribute timestamp
+          #   ISO 8601 datetime of when the message was added to the conversation.
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!attribute tool_call_id
+          #   The `id` of the tool call this message answers. Only present on `tool` messages
+          #   when `conversation_ended_full_history` is enabled.
+          #
+          #   @return [String, nil]
+          optional :tool_call_id, String
+
+          # @!attribute tool_calls
+          #   Tools the assistant called in this turn. Only present on `assistant` messages
+          #   when `conversation_ended_full_history` is enabled.
+          #
+          #   @return [Array<Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall>, nil]
+          optional :tool_calls,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallConversationEnded::Payload::Message::ToolCall] }
+
+          # @!method initialize(content: nil, role: nil, timestamp: nil, tool_call_id: nil, tool_calls: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallConversationEnded::Payload::Message} for more details.
+          #
+          #   @param content [String] The text of the message. For a tool result, the tool output. May be absent on an
+          #
+          #   @param role [Symbol, Telnyx::Models::CallConversationEnded::Payload::Message::Role] The author of the message. `tool`, `system`, and `developer` only appear when `c
+          #
+          #   @param timestamp [Time] ISO 8601 datetime of when the message was added to the conversation.
+          #
+          #   @param tool_call_id [String] The `id` of the tool call this message answers. Only present on `tool` messages
+          #
+          #   @param tool_calls [Array<Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall>] Tools the assistant called in this turn. Only present on `assistant` messages wh
+
+          # The author of the message. `tool`, `system`, and `developer` only appear when
+          # `conversation_ended_full_history` is enabled. `system` and `developer` entries
+          # are informational (for example idle check-ins, voicemail prompts,
+          # participant-left notices, or messages added through the API); their wording is
+          # not a stable contract.
+          #
+          # @see Telnyx::Models::CallConversationEnded::Payload::Message#role
+          module Role
+            extend Telnyx::Internal::Type::Enum
+
+            USER = :user
+            ASSISTANT = :assistant
+            TOOL = :tool
+            SYSTEM = :system
+            DEVELOPER = :developer
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class ToolCall < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifier of the tool call, referenced by the matching tool result's
+            #   `tool_call_id`.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute function
+            #
+            #   @return [Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::Function, nil]
+            optional :function, -> { Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function }
+
+            # @!attribute type
+            #   The type of tool call.
+            #
+            #   @return [Symbol, Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::Type, nil]
+            optional :type, enum: -> { Telnyx::CallConversationEnded::Payload::Message::ToolCall::Type }
+
+            # @!method initialize(id: nil, function: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall} for more
+            #   details.
+            #
+            #   @param id [String] Identifier of the tool call, referenced by the matching tool result's `tool_call
+            #
+            #   @param function [Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::Function]
+            #
+            #   @param type [Symbol, Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::Type] The type of tool call.
+
+            # @see Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall#function
+            class Function < Telnyx::Internal::Type::BaseModel
+              # @!attribute arguments
+              #   The arguments passed to the tool, as a JSON-encoded string.
+              #
+              #   @return [String, nil]
+              optional :arguments, String
+
+              # @!attribute name
+              #   The name of the tool that was called.
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!method initialize(arguments: nil, name: nil)
+              #   @param arguments [String] The arguments passed to the tool, as a JSON-encoded string.
+              #
+              #   @param name [String] The name of the tool that was called.
+            end
+
+            # The type of tool call.
+            #
+            # @see Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              FUNCTION = :function
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
 
       # Identifies the type of the resource.

data/lib/telnyx/models/call_conversation_start_failed_webhook_event.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallConversationStartFailedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   The AI assistant requested for the call could not be started, so no conversation
+      #   was created. No `call.conversation.created` or `call.conversation.ended` is sent
+      #   for this attempt.
+      #
+      #   @return [Telnyx::Models::CallConversationStartFailedWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::CallConversationStartFailedWebhookEvent::Data }
+
+      # @!method initialize(data: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::CallConversationStartFailedWebhookEvent} for more details.
+      #
+      #   @param data [Telnyx::Models::CallConversationStartFailedWebhookEvent::Data] The AI assistant requested for the call could not be started, so no conversation
+
+      # @see Telnyx::Models::CallConversationStartFailedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the event.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   Timestamp when the event was created in the system.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute event_type
+        #   The type of event being delivered.
+        #
+        #   @return [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::CallConversationStartFailedWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
+        #
+        #   @return [Time, nil]
+        optional :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::CallConversationStartFailedWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::CallConversationStartFailedWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id: nil, created_at: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   The AI assistant requested for the call could not be started, so no conversation
+        #   was created. No `call.conversation.created` or `call.conversation.ended` is sent
+        #   for this attempt.
+        #
+        #   @param id [String] Unique identifier for the event.
+        #
+        #   @param created_at [Time] Timestamp when the event was created in the system.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::EventType] The type of event being delivered.
+        #
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
+        #
+        #   @param payload [Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::RecordType] Identifies the type of the resource.
+
+        # The type of event being delivered.
+        #
+        # @see Telnyx::Models::CallConversationStartFailedWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_CONVERSATION_START_FAILED = :"call.conversation.start_failed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::CallConversationStartFailedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute assistant_id
+          #   Identifier of the AI assistant that failed to start.
+          #
+          #   @return [String, nil]
+          optional :assistant_id, String
+
+          # @!attribute call_control_id
+          #   Call ID used to issue commands via Call Control API.
+          #
+          #   @return [String, nil]
+          optional :call_control_id, String
+
+          # @!attribute call_leg_id
+          #   ID that is unique to the call leg.
+          #
+          #   @return [String, nil]
+          optional :call_leg_id, String
+
+          # @!attribute call_session_id
+          #   ID that is unique to the call session (group of related call legs).
+          #
+          #   @return [String, nil]
+          optional :call_session_id, String
+
+          # @!attribute calling_party_type
+          #   The type of calling party connection.
+          #
+          #   @return [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload::CallingPartyType, nil]
+          optional :calling_party_type,
+                   enum: -> { Telnyx::CallConversationStartFailedWebhookEvent::Data::Payload::CallingPartyType }
+
+          # @!attribute client_state
+          #   Base64-encoded state received from a command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute from
+          #   The caller's number or identifier.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute reason
+          #   Why the conversation could not be started. `invalid_request`: the assistant
+          #   request was rejected, for example because the assistant ID does not exist.
+          #   `service_error`: the assistant could not be started because of an error on the
+          #   Telnyx side.
+          #
+          #   @return [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload::Reason, nil]
+          optional :reason, enum: -> { Telnyx::CallConversationStartFailedWebhookEvent::Data::Payload::Reason }
+
+          # @!attribute to
+          #   The callee's number or SIP address.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, from: nil, reason: nil, to: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload} for
+          #   more details.
+          #
+          #   @param assistant_id [String] Identifier of the AI assistant that failed to start.
+          #
+          #   @param call_control_id [String] Call ID used to issue commands via Call Control API.
+          #
+          #   @param call_leg_id [String] ID that is unique to the call leg.
+          #
+          #   @param call_session_id [String] ID that is unique to the call session (group of related call legs).
+          #
+          #   @param calling_party_type [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload::CallingPartyType] The type of calling party connection.
+          #
+          #   @param client_state [String] Base64-encoded state received from a command.
+          #
+          #   @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
+          #
+          #   @param from [String] The caller's number or identifier.
+          #
+          #   @param reason [Symbol, Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload::Reason] Why the conversation could not be started. `invalid_request`: the assistant requ
+          #
+          #   @param to [String] The callee's number or SIP address.
+
+          # The type of calling party connection.
+          #
+          # @see Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload#calling_party_type
+          module CallingPartyType
+            extend Telnyx::Internal::Type::Enum
+
+            PSTN = :pstn
+            SIP = :sip
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Why the conversation could not be started. `invalid_request`: the assistant
+          # request was rejected, for example because the assistant ID does not exist.
+          # `service_error`: the assistant could not be started because of an error on the
+          # Telnyx side.
+          #
+          # @see Telnyx::Models::CallConversationStartFailedWebhookEvent::Data::Payload#reason
+          module Reason
+            extend Telnyx::Internal::Type::Enum
+
+            INVALID_REQUEST = :invalid_request
+            SERVICE_ERROR = :service_error
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifies the type of the resource.
+        #
+        # @see Telnyx::Models::CallConversationStartFailedWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end