telnyx 5.83.0 → 5.85.0

data/rbi/telnyx/models/call_hold_webhook_event.rbi

@@ -0,0 +1,297 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class CallHoldWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::CallHoldWebhookEvent, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Telnyx::CallHoldWebhookEvent::Data)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::CallHoldWebhookEvent::Data::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::CallHoldWebhookEvent::Data::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig { override.returns({ data: Telnyx::CallHoldWebhookEvent::Data }) }
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::CallHoldWebhookEvent::Data, Telnyx::Internal::AnyHash)
+          end
+
+        # Identifies the type of resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The type of event being delivered.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallHoldWebhookEvent::Data::EventType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :event_type
+
+        sig do
+          params(
+            event_type: Telnyx::CallHoldWebhookEvent::Data::EventType::OrSymbol
+          ).void
+        end
+        attr_writer :event_type
+
+        # ISO 8601 datetime of when the event occurred.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :occurred_at
+
+        sig { params(occurred_at: Time).void }
+        attr_writer :occurred_at
+
+        sig { returns(T.nilable(Telnyx::CallHoldWebhookEvent::Data::Payload)) }
+        attr_reader :payload
+
+        sig do
+          params(
+            payload: Telnyx::CallHoldWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        # Identifies the type of the resource.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallHoldWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::CallHoldWebhookEvent::Data::RecordType::OrSymbol
+          ).void
+        end
+        attr_writer :record_type
+
+        sig do
+          params(
+            id: String,
+            event_type: Telnyx::CallHoldWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload: Telnyx::CallHoldWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::CallHoldWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the type of resource.
+          id: nil,
+          # The type of event being delivered.
+          event_type: nil,
+          # ISO 8601 datetime of when the event occurred.
+          occurred_at: nil,
+          payload: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_type:
+                Telnyx::CallHoldWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload: Telnyx::CallHoldWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::CallHoldWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of event being delivered.
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::CallHoldWebhookEvent::Data::EventType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CALL_HOLD =
+            T.let(
+              :"call.hold",
+              Telnyx::CallHoldWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallHoldWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallHoldWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Call ID used to issue commands via Call Control API.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_control_id
+
+          sig { params(call_control_id: String).void }
+          attr_writer :call_control_id
+
+          # ID that is unique to the call and can be used to correlate webhook events.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_leg_id
+
+          sig { params(call_leg_id: String).void }
+          attr_writer :call_leg_id
+
+          # ID that is unique to the call session and can be used to correlate webhook
+          # events. Call session is a group of related call legs that logically belong to
+          # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_session_id
+
+          sig { params(call_session_id: String).void }
+          attr_writer :call_session_id
+
+          # State received from a command.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_state
+
+          sig { params(client_state: String).void }
+          attr_writer :client_state
+
+          # Call Control App ID (formerly Telnyx connection ID) used in the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :connection_id
+
+          sig { params(connection_id: String).void }
+          attr_writer :connection_id
+
+          # Number or SIP URI placing the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :from
+
+          sig { params(from: String).void }
+          attr_writer :from
+
+          # Destination number or SIP URI of the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          sig do
+            params(
+              call_control_id: String,
+              call_leg_id: String,
+              call_session_id: String,
+              client_state: String,
+              connection_id: String,
+              from: String,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Call ID used to issue commands via Call Control API.
+            call_control_id: nil,
+            # ID that is unique to the call and can be used to correlate webhook events.
+            call_leg_id: nil,
+            # ID that is unique to the call session and can be used to correlate webhook
+            # events. Call session is a group of related call legs that logically belong to
+            # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+            call_session_id: nil,
+            # State received from a command.
+            client_state: nil,
+            # Call Control App ID (formerly Telnyx connection ID) used in the call.
+            connection_id: nil,
+            # Number or SIP URI placing the call.
+            from: nil,
+            # Destination number or SIP URI of the call.
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_id: String,
+                call_leg_id: String,
+                call_session_id: String,
+                client_state: String,
+                connection_id: String,
+                from: String,
+                to: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Identifies the type of the resource.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::CallHoldWebhookEvent::Data::RecordType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::CallHoldWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallHoldWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_unhold_webhook_event.rbi

@@ -0,0 +1,304 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class CallUnholdWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::CallUnholdWebhookEvent, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Telnyx::CallUnholdWebhookEvent::Data)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::CallUnholdWebhookEvent::Data::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::CallUnholdWebhookEvent::Data::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data: nil)
+      end
+
+      sig { override.returns({ data: Telnyx::CallUnholdWebhookEvent::Data }) }
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallUnholdWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the type of resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The type of event being delivered.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallUnholdWebhookEvent::Data::EventType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :event_type
+
+        sig do
+          params(
+            event_type:
+              Telnyx::CallUnholdWebhookEvent::Data::EventType::OrSymbol
+          ).void
+        end
+        attr_writer :event_type
+
+        # ISO 8601 datetime of when the event occurred.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :occurred_at
+
+        sig { params(occurred_at: Time).void }
+        attr_writer :occurred_at
+
+        sig do
+          returns(T.nilable(Telnyx::CallUnholdWebhookEvent::Data::Payload))
+        end
+        attr_reader :payload
+
+        sig do
+          params(
+            payload: Telnyx::CallUnholdWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        # Identifies the type of the resource.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallUnholdWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::CallUnholdWebhookEvent::Data::RecordType::OrSymbol
+          ).void
+        end
+        attr_writer :record_type
+
+        sig do
+          params(
+            id: String,
+            event_type:
+              Telnyx::CallUnholdWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload: Telnyx::CallUnholdWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::CallUnholdWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the type of resource.
+          id: nil,
+          # The type of event being delivered.
+          event_type: nil,
+          # ISO 8601 datetime of when the event occurred.
+          occurred_at: nil,
+          payload: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_type:
+                Telnyx::CallUnholdWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload: Telnyx::CallUnholdWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::CallUnholdWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of event being delivered.
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::CallUnholdWebhookEvent::Data::EventType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CALL_UNHOLD =
+            T.let(
+              :"call.unhold",
+              Telnyx::CallUnholdWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallUnholdWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallUnholdWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Call ID used to issue commands via Call Control API.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_control_id
+
+          sig { params(call_control_id: String).void }
+          attr_writer :call_control_id
+
+          # ID that is unique to the call and can be used to correlate webhook events.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_leg_id
+
+          sig { params(call_leg_id: String).void }
+          attr_writer :call_leg_id
+
+          # ID that is unique to the call session and can be used to correlate webhook
+          # events. Call session is a group of related call legs that logically belong to
+          # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_session_id
+
+          sig { params(call_session_id: String).void }
+          attr_writer :call_session_id
+
+          # State received from a command.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_state
+
+          sig { params(client_state: String).void }
+          attr_writer :client_state
+
+          # Call Control App ID (formerly Telnyx connection ID) used in the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :connection_id
+
+          sig { params(connection_id: String).void }
+          attr_writer :connection_id
+
+          # Number or SIP URI placing the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :from
+
+          sig { params(from: String).void }
+          attr_writer :from
+
+          # Destination number or SIP URI of the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          sig do
+            params(
+              call_control_id: String,
+              call_leg_id: String,
+              call_session_id: String,
+              client_state: String,
+              connection_id: String,
+              from: String,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Call ID used to issue commands via Call Control API.
+            call_control_id: nil,
+            # ID that is unique to the call and can be used to correlate webhook events.
+            call_leg_id: nil,
+            # ID that is unique to the call session and can be used to correlate webhook
+            # events. Call session is a group of related call legs that logically belong to
+            # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+            call_session_id: nil,
+            # State received from a command.
+            client_state: nil,
+            # Call Control App ID (formerly Telnyx connection ID) used in the call.
+            connection_id: nil,
+            # Number or SIP URI placing the call.
+            from: nil,
+            # Destination number or SIP URI of the call.
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_id: String,
+                call_leg_id: String,
+                call_session_id: String,
+                client_state: String,
+                connection_id: String,
+                from: String,
+                to: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Identifies the type of the resource.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::CallUnholdWebhookEvent::Data::RecordType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::CallUnholdWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallUnholdWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi

@@ -24,6 +24,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -46,6 +47,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,

data/rbi/telnyx/models/unwrap_webhook_event.rbi

@@ -24,6 +24,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -46,6 +47,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,

data/rbi/telnyx/models.rbi

@@ -233,6 +233,8 @@ module Telnyx
 
   CallHangupWebhookEvent = Telnyx::Models::CallHangupWebhookEvent
 
+  CallHoldWebhookEvent = Telnyx::Models::CallHoldWebhookEvent
+
   CallInitiated = Telnyx::Models::CallInitiated
 
   CallInitiatedWebhookEvent = Telnyx::Models::CallInitiatedWebhookEvent
@@ -340,6 +342,8 @@ module Telnyx
   CallStreamingStoppedWebhookEvent =
     Telnyx::Models::CallStreamingStoppedWebhookEvent
 
+  CallUnholdWebhookEvent = Telnyx::Models::CallUnholdWebhookEvent
+
   CampaignStatusUpdate = Telnyx::Models::CampaignStatusUpdate
 
   ChannelZoneListParams = Telnyx::Models::ChannelZoneListParams

data/rbi/telnyx/resources/calls/actions.rbi

@@ -45,6 +45,7 @@ module Telnyx
         # **Expected Webhooks:**
         #
         # - `call.answered`
+        # - `call.hold` and `call.unhold` if the call is held/unheld
         # - `call.deepfake_detection.result` if `deepfake_detection` was enabled
         # - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
         #   error occurred

data/rbi/telnyx/resources/calls.rbi

@@ -15,6 +15,7 @@ module Telnyx
       #
       # - `call.initiated`
       # - `call.answered` or `call.hangup`
+      # - `call.hold` and `call.unhold` if the call is held/unheld
       # - `call.machine.detection.ended` if `answering_machine_detection` was requested
       # - `call.machine.greeting.ended` if `answering_machine_detection` was requested
       #   to detect the end of machine greeting

data/rbi/telnyx/resources/webhooks.rbi

@@ -22,6 +22,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -44,6 +45,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,
@@ -102,6 +104,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -124,6 +127,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,