telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/models/artifact_completed_webhook_event.rbi

@@ -0,0 +1,283 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ArtifactCompletedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::ArtifactCompletedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Unique event id; deduplicate deliveries on it.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Completed artifact, including its generated content.
+      sig { returns(Telnyx::ArtifactCompletedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::ArtifactCompletedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # Event type.
+      sig do
+        returns(Telnyx::ArtifactCompletedWebhookEvent::Event::TaggedSymbol)
+      end
+      attr_accessor :event
+
+      # When the event occurred.
+      sig { returns(Time) }
+      attr_accessor :occurred_at
+
+      # Envelope version.
+      sig { returns(String) }
+      attr_accessor :version
+
+      sig do
+        params(
+          id: String,
+          data: Telnyx::ArtifactCompletedWebhookEvent::Data::OrHash,
+          event: Telnyx::ArtifactCompletedWebhookEvent::Event::OrSymbol,
+          occurred_at: Time,
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique event id; deduplicate deliveries on it.
+        id:,
+        # Completed artifact, including its generated content.
+        data:,
+        # Event type.
+        event:,
+        # When the event occurred.
+        occurred_at:,
+        # Envelope version.
+        version:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            data: Telnyx::ArtifactCompletedWebhookEvent::Data,
+            event: Telnyx::ArtifactCompletedWebhookEvent::Event::TaggedSymbol,
+            occurred_at: Time,
+            version: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::ArtifactCompletedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Id of the completed artifact.
+        sig { returns(String) }
+        attr_accessor :artifact_id
+
+        # Generated artifact content.
+        sig { returns(Telnyx::ArtifactCompletedWebhookEvent::Data::Content) }
+        attr_reader :content
+
+        sig do
+          params(
+            content:
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Content::OrHash
+          ).void
+        end
+        attr_writer :content
+
+        # Model that generated the artifact.
+        sig do
+          returns(Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance)
+        end
+        attr_reader :model_provenance
+
+        sig do
+          params(
+            model_provenance:
+              Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance::OrHash
+          ).void
+        end
+        attr_writer :model_provenance
+
+        # The meeting session this event belongs to.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # Type of the completed artifact.
+        sig do
+          returns(
+            Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # Completed artifact, including its generated content.
+        sig do
+          params(
+            artifact_id: String,
+            content:
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Content::OrHash,
+            model_provenance:
+              Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance::OrHash,
+            session_id: String,
+            type: Telnyx::ArtifactCompletedWebhookEvent::Data::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Id of the completed artifact.
+          artifact_id:,
+          # Generated artifact content.
+          content:,
+          # Model that generated the artifact.
+          model_provenance:,
+          # The meeting session this event belongs to.
+          session_id:,
+          # Type of the completed artifact.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              artifact_id: String,
+              content: Telnyx::ArtifactCompletedWebhookEvent::Data::Content,
+              model_provenance:
+                Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance,
+              session_id: String,
+              type:
+                Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Content < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::ArtifactCompletedWebhookEvent::Data::Content,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Generated artifact text.
+          sig { returns(String) }
+          attr_accessor :text
+
+          # Generated artifact content.
+          sig { params(text: String).returns(T.attached_class) }
+          def self.new(
+            # Generated artifact text.
+            text:
+          )
+          end
+
+          sig { override.returns({ text: String }) }
+          def to_hash
+          end
+        end
+
+        class ModelProvenance < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :model
+
+          sig { returns(String) }
+          attr_accessor :provider
+
+          # Model that generated the artifact.
+          sig do
+            params(model: String, provider: String).returns(T.attached_class)
+          end
+          def self.new(model:, provider:)
+          end
+
+          sig { override.returns({ model: String, provider: String }) }
+          def to_hash
+          end
+        end
+
+        # Type of the completed artifact.
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::ArtifactCompletedWebhookEvent::Data::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUMMARY =
+            T.let(
+              :summary,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          ACTION_ITEMS =
+            T.let(
+              :action_items,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Event type.
+      module Event
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::ArtifactCompletedWebhookEvent::Event)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ARTIFACT_COMPLETED =
+          T.let(
+            :"artifact.completed",
+            Telnyx::ArtifactCompletedWebhookEvent::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::ArtifactCompletedWebhookEvent::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/artifact_failed_webhook_event.rbi

@@ -0,0 +1,185 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ArtifactFailedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::ArtifactFailedWebhookEvent, Telnyx::Internal::AnyHash)
+        end
+
+      # Unique event id; deduplicate deliveries on it.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Failed artifact reference and reason.
+      sig { returns(Telnyx::ArtifactFailedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::ArtifactFailedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # Event type.
+      sig { returns(Telnyx::ArtifactFailedWebhookEvent::Event::TaggedSymbol) }
+      attr_accessor :event
+
+      # When the event occurred.
+      sig { returns(Time) }
+      attr_accessor :occurred_at
+
+      # Envelope version.
+      sig { returns(String) }
+      attr_accessor :version
+
+      sig do
+        params(
+          id: String,
+          data: Telnyx::ArtifactFailedWebhookEvent::Data::OrHash,
+          event: Telnyx::ArtifactFailedWebhookEvent::Event::OrSymbol,
+          occurred_at: Time,
+          version: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique event id; deduplicate deliveries on it.
+        id:,
+        # Failed artifact reference and reason.
+        data:,
+        # Event type.
+        event:,
+        # When the event occurred.
+        occurred_at:,
+        # Envelope version.
+        version:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            data: Telnyx::ArtifactFailedWebhookEvent::Data,
+            event: Telnyx::ArtifactFailedWebhookEvent::Event::TaggedSymbol,
+            occurred_at: Time,
+            version: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::ArtifactFailedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Id of the failed artifact.
+        sig { returns(String) }
+        attr_accessor :artifact_id
+
+        # The meeting session this event belongs to.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # Type of the failed artifact.
+        sig do
+          returns(Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol)
+        end
+        attr_accessor :type
+
+        # Failed artifact reference and reason.
+        sig do
+          params(
+            artifact_id: String,
+            session_id: String,
+            type: Telnyx::ArtifactFailedWebhookEvent::Data::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Id of the failed artifact.
+          artifact_id:,
+          # The meeting session this event belongs to.
+          session_id:,
+          # Type of the failed artifact.
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              artifact_id: String,
+              session_id: String,
+              type: Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Type of the failed artifact.
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::ArtifactFailedWebhookEvent::Data::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUMMARY =
+            T.let(
+              :summary,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          ACTION_ITEMS =
+            T.let(
+              :action_items,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Event type.
+      module Event
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::ArtifactFailedWebhookEvent::Event)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ARTIFACT_FAILED =
+          T.let(
+            :"artifact.failed",
+            Telnyx::ArtifactFailedWebhookEvent::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::ArtifactFailedWebhookEvent::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_dial_params.rbi

@@ -667,14 +667,14 @@ module Telnyx
       end
       attr_writer :webhook_url_method
 
-      # A map of event types to webhook URLs. When an event of the specified type
-      # occurs, the webhook URL associated with that event type will be called instead
-      # of the default webhook URL. Events not mapped here will use the default webhook
-      # URL.
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      # A map of event types to arrays of webhook URLs. When an event of the specified
+      # type occurs, the webhook URLs associated with that event type will be called
+      # instead of the default webhook URL. Events not mapped here will use the default
+      # webhook URL.
+      sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
       attr_reader :webhook_urls
 
-      sig { params(webhook_urls: T::Hash[Symbol, String]).void }
+      sig { params(webhook_urls: T::Hash[Symbol, T::Array[String]]).void }
       attr_writer :webhook_urls
 
       # HTTP request method to invoke `webhook_urls`.
@@ -768,7 +768,7 @@ module Telnyx
           webhook_url: String,
           webhook_url_method:
             Telnyx::CallDialParams::WebhookURLMethod::OrSymbol,
-          webhook_urls: T::Hash[Symbol, String],
+          webhook_urls: T::Hash[Symbol, T::Array[String]],
           webhook_urls_method:
             Telnyx::CallDialParams::WebhookURLsMethod::OrSymbol,
           request_options: Telnyx::RequestOptions::OrHash
@@ -1010,10 +1010,10 @@ module Telnyx
         webhook_url: nil,
         # HTTP request type used for `webhook_url`.
         webhook_url_method: nil,
-        # A map of event types to webhook URLs. When an event of the specified type
-        # occurs, the webhook URL associated with that event type will be called instead
-        # of the default webhook URL. Events not mapped here will use the default webhook
-        # URL.
+        # A map of event types to arrays of webhook URLs. When an event of the specified
+        # type occurs, the webhook URLs associated with that event type will be called
+        # instead of the default webhook URL. Events not mapped here will use the default
+        # webhook URL.
         webhook_urls: nil,
         # HTTP request method to invoke `webhook_urls`.
         webhook_urls_method: nil,
@@ -1095,7 +1095,7 @@ module Telnyx
             webhook_url: String,
             webhook_url_method:
               Telnyx::CallDialParams::WebhookURLMethod::OrSymbol,
-            webhook_urls: T::Hash[Symbol, String],
+            webhook_urls: T::Hash[Symbol, T::Array[String]],
             webhook_urls_method:
               Telnyx::CallDialParams::WebhookURLsMethod::OrSymbol,
             request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/calls/action_answer_params.rbi

@@ -387,13 +387,14 @@ module Telnyx
         end
         attr_writer :webhook_url_method
 
-        # A map of event types to webhook URLs. When an event of the specified type
-        # occurs, the webhook URL associated with that event type will be called instead
-        # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
-        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        # A map of event types to arrays of webhook URLs. When an event of the specified
+        # type occurs, the webhook URLs associated with that event type will be called
+        # instead of `webhook_url`. Events not mapped here will use the default
+        # `webhook_url`.
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
         attr_reader :webhook_urls
 
-        sig { params(webhook_urls: T::Hash[Symbol, String]).void }
+        sig { params(webhook_urls: T::Hash[Symbol, T::Array[String]]).void }
         attr_writer :webhook_urls
 
         # HTTP request method to invoke `webhook_urls`.
@@ -464,7 +465,7 @@ module Telnyx
             webhook_url: String,
             webhook_url_method:
               Telnyx::Calls::ActionAnswerParams::WebhookURLMethod::OrSymbol,
-            webhook_urls: T::Hash[Symbol, String],
+            webhook_urls: T::Hash[Symbol, T::Array[String]],
             webhook_urls_method:
               Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
@@ -562,9 +563,10 @@ module Telnyx
           webhook_url: nil,
           # HTTP request type used for `webhook_url`.
           webhook_url_method: nil,
-          # A map of event types to webhook URLs. When an event of the specified type
-          # occurs, the webhook URL associated with that event type will be called instead
-          # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
+          # A map of event types to arrays of webhook URLs. When an event of the specified
+          # type occurs, the webhook URLs associated with that event type will be called
+          # instead of `webhook_url`. Events not mapped here will use the default
+          # `webhook_url`.
           webhook_urls: nil,
           # HTTP request method to invoke `webhook_urls`.
           webhook_urls_method: nil,
@@ -622,7 +624,7 @@ module Telnyx
               webhook_url: String,
               webhook_url_method:
                 Telnyx::Calls::ActionAnswerParams::WebhookURLMethod::OrSymbol,
-              webhook_urls: T::Hash[Symbol, String],
+              webhook_urls: T::Hash[Symbol, T::Array[String]],
               webhook_urls_method:
                 Telnyx::Calls::ActionAnswerParams::WebhookURLsMethod::OrSymbol,
               request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/calls/action_transfer_params.rbi

@@ -508,13 +508,14 @@ module Telnyx
         end
         attr_writer :webhook_url_method
 
-        # A map of event types to webhook URLs. When an event of the specified type
-        # occurs, the webhook URL associated with that event type will be called instead
-        # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
-        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        # A map of event types to arrays of webhook URLs. When an event of the specified
+        # type occurs, the webhook URLs associated with that event type will be called
+        # instead of `webhook_url`. Events not mapped here will use the default
+        # `webhook_url`.
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
         attr_reader :webhook_urls
 
-        sig { params(webhook_urls: T::Hash[Symbol, String]).void }
+        sig { params(webhook_urls: T::Hash[Symbol, T::Array[String]]).void }
         attr_writer :webhook_urls
 
         # HTTP request method to invoke `webhook_urls`.
@@ -590,7 +591,7 @@ module Telnyx
             webhook_url: String,
             webhook_url_method:
               Telnyx::Calls::ActionTransferParams::WebhookURLMethod::OrSymbol,
-            webhook_urls: T::Hash[Symbol, String],
+            webhook_urls: T::Hash[Symbol, T::Array[String]],
             webhook_urls_method:
               Telnyx::Calls::ActionTransferParams::WebhookURLsMethod::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
@@ -751,9 +752,10 @@ module Telnyx
           webhook_url: nil,
           # HTTP request type used for `webhook_url`.
           webhook_url_method: nil,
-          # A map of event types to webhook URLs. When an event of the specified type
-          # occurs, the webhook URL associated with that event type will be called instead
-          # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
+          # A map of event types to arrays of webhook URLs. When an event of the specified
+          # type occurs, the webhook URLs associated with that event type will be called
+          # instead of `webhook_url`. Events not mapped here will use the default
+          # `webhook_url`.
           webhook_urls: nil,
           # HTTP request method to invoke `webhook_urls`.
           webhook_urls_method: nil,
@@ -818,7 +820,7 @@ module Telnyx
               webhook_url: String,
               webhook_url_method:
                 Telnyx::Calls::ActionTransferParams::WebhookURLMethod::OrSymbol,
-              webhook_urls: T::Hash[Symbol, String],
+              webhook_urls: T::Hash[Symbol, T::Array[String]],
               webhook_urls_method:
                 Telnyx::Calls::ActionTransferParams::WebhookURLsMethod::OrSymbol,
               request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/credential_connection.rbi

@@ -50,6 +50,15 @@ module Telnyx
       sig { params(connection_name: String).void }
       attr_writer :connection_name
 
+      # Whether conversation persistence is enabled for this connection. When enabled,
+      # calls handled by the connection are transcribed, stored, and indexed. Defaults
+      # to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :conversation_persistence
+
+      sig { params(conversation_persistence: T::Boolean).void }
+      attr_writer :conversation_persistence
+
       # ISO-8601 formatted date indicating when the resource was created.
       sig { returns(T.nilable(String)) }
       attr_reader :created_at
@@ -263,6 +272,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           created_at: String,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
@@ -305,6 +315,10 @@ module Telnyx
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # ISO-8601 formatted date indicating when the resource was created.
         created_at: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
@@ -386,6 +400,7 @@ module Telnyx
             android_push_credential_id: T.nilable(String),
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
+            conversation_persistence: T::Boolean,
             created_at: String,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::TaggedSymbol,