telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/models/sim_cards/wireless_sim_card_action.rbi

@@ -0,0 +1,328 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module SimCards
+      class WirelessSimCardAction < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::SimCards::WirelessSimCardAction,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(T.nilable(Telnyx::SimCards::WirelessSimCardAction::Status))
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Telnyx::SimCards::WirelessSimCardAction::Status::OrHash
+          ).void
+        end
+        attr_writer :status
+
+        # Identifies the resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The operation type. It can be one of the following: <br/>
+        #
+        # <ul>
+        #  <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li>
+        #  <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li>
+        #  <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li>
+        #  <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li>
+        #  <li><code>enable_voice</code> - enable voice calling on the SIM card</li>
+        #  <li><code>disable_voice</code> - disable voice calling on the SIM card</li>
+        #  </ul>
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :action_type
+
+        sig do
+          params(
+            action_type:
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::OrSymbol
+          ).void
+        end
+        attr_writer :action_type
+
+        # ISO 8601 formatted date-time indicating when the resource was created.
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        # A JSON object representation of the action params.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :settings
+
+        # The related SIM card identifier.
+        sig { returns(T.nilable(String)) }
+        attr_reader :sim_card_id
+
+        sig { params(sim_card_id: String).void }
+        attr_writer :sim_card_id
+
+        # ISO 8601 formatted date-time indicating when the resource was updated.
+        sig { returns(T.nilable(String)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: String).void }
+        attr_writer :updated_at
+
+        # This object represents a SIM card action. It allows tracking the current status
+        # of an operation that impacts the SIM card.
+        sig do
+          params(
+            id: String,
+            action_type:
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::OrSymbol,
+            created_at: String,
+            record_type: String,
+            settings: T.nilable(T::Hash[Symbol, T.anything]),
+            sim_card_id: String,
+            status: Telnyx::SimCards::WirelessSimCardAction::Status::OrHash,
+            updated_at: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the resource.
+          id: nil,
+          # The operation type. It can be one of the following: <br/>
+          #
+          # <ul>
+          #  <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li>
+          #  <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li>
+          #  <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li>
+          #  <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li>
+          #  <li><code>enable_voice</code> - enable voice calling on the SIM card</li>
+          #  <li><code>disable_voice</code> - disable voice calling on the SIM card</li>
+          #  </ul>
+          action_type: nil,
+          # ISO 8601 formatted date-time indicating when the resource was created.
+          created_at: nil,
+          record_type: nil,
+          # A JSON object representation of the action params.
+          settings: nil,
+          # The related SIM card identifier.
+          sim_card_id: nil,
+          status: nil,
+          # ISO 8601 formatted date-time indicating when the resource was updated.
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              action_type:
+                Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol,
+              created_at: String,
+              record_type: String,
+              settings: T.nilable(T::Hash[Symbol, T.anything]),
+              sim_card_id: String,
+              status: Telnyx::SimCards::WirelessSimCardAction::Status,
+              updated_at: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The operation type. It can be one of the following: <br/>
+        #
+        # <ul>
+        #  <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li>
+        #  <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li>
+        #  <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li>
+        #  <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li>
+        #  <li><code>enable_voice</code> - enable voice calling on the SIM card</li>
+        #  <li><code>disable_voice</code> - disable voice calling on the SIM card</li>
+        #  </ul>
+        module ActionType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::SimCards::WirelessSimCardAction::ActionType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ENABLE =
+            T.let(
+              :enable,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          ENABLE_STANDBY_SIM_CARD =
+            T.let(
+              :enable_standby_sim_card,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          DISABLE =
+            T.let(
+              :disable,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          SET_STANDBY =
+            T.let(
+              :set_standby,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          ENABLE_VOICE =
+            T.let(
+              :enable_voice,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+          DISABLE_VOICE =
+            T.let(
+              :disable_voice,
+              Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::SimCards::WirelessSimCardAction::ActionType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Status < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::SimCards::WirelessSimCardAction::Status,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # It describes why the SIM card action is in the current status. This will be
+          # <code>null</code> for self-explanatory statuses, such as
+          # <code>in-progress</code> and <code>completed</code> but will include further
+          # information on statuses like <code>interrupted</code> and <code>failed</code>.
+          sig { returns(T.nilable(String)) }
+          attr_reader :reason
+
+          sig { params(reason: String).void }
+          attr_writer :reason
+
+          # The current status of the SIM card action.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :value
+
+          sig do
+            params(
+              value:
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::OrSymbol
+            ).void
+          end
+          attr_writer :value
+
+          sig do
+            params(
+              reason: String,
+              value:
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # It describes why the SIM card action is in the current status. This will be
+            # <code>null</code> for self-explanatory statuses, such as
+            # <code>in-progress</code> and <code>completed</code> but will include further
+            # information on statuses like <code>interrupted</code> and <code>failed</code>.
+            reason: nil,
+            # The current status of the SIM card action.
+            value: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                reason: String,
+                value:
+                  Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current status of the SIM card action.
+          module Value
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::SimCards::WirelessSimCardAction::Status::Value
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IN_PROGRESS =
+              T.let(
+                :"in-progress",
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              )
+            INTERRUPTED =
+              T.let(
+                :interrupted,
+                Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::SimCards::WirelessSimCardAction::Status::Value::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi

@@ -15,7 +15,8 @@ module Telnyx
         end
 
       # The kind of credential to look up. `uac_external_credential` is keyed by
-      # `connection_id`; `telephony_credential` is keyed by `username`.
+      # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+      # keyed by `username`.
       sig do
         returns(
           Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol
@@ -31,8 +32,8 @@ module Telnyx
       sig { params(connection_id: String).void }
       attr_writer :connection_id
 
-      # SIP username of the telephony credential to look up. Required when
-      # `credential_type` is `telephony_credential`.
+      # SIP username to look up. Required when `credential_type` is
+      # `telephony_credential` or `sip_credential_connection`.
       sig { returns(T.nilable(String)) }
       attr_reader :username
 
@@ -50,13 +51,14 @@ module Telnyx
       end
       def self.new(
         # The kind of credential to look up. `uac_external_credential` is keyed by
-        # `connection_id`; `telephony_credential` is keyed by `username`.
+        # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+        # keyed by `username`.
         credential_type:,
         # Identifier of the UAC connection to look up. Required when `credential_type` is
         # `uac_external_credential`.
         connection_id: nil,
-        # SIP username of the telephony credential to look up. Required when
-        # `credential_type` is `telephony_credential`.
+        # SIP username to look up. Required when `credential_type` is
+        # `telephony_credential` or `sip_credential_connection`.
         username: nil,
         request_options: {}
       )
@@ -77,7 +79,8 @@ module Telnyx
       end
 
       # The kind of credential to look up. `uac_external_credential` is keyed by
-      # `connection_id`; `telephony_credential` is keyed by `username`.
+      # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+      # keyed by `username`.
       module CredentialType
         extend Telnyx::Internal::Type::Enum
 
@@ -100,6 +103,11 @@ module Telnyx
             :telephony_credential,
             Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
           )
+        SIP_CREDENTIAL_CONNECTION =
+          T.let(
+            :sip_credential_connection,
+            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi

@@ -52,10 +52,7 @@ module Telnyx
 
       # SIP response from the last registration attempt.
       sig { returns(T.nilable(String)) }
-      attr_reader :last_registration_response
-
-      sig { params(last_registration_response: String).void }
-      attr_writer :last_registration_response
+      attr_accessor :last_registration_response
 
       # True if the endpoint is currently registered.
       sig { returns(T.nilable(T::Boolean)) }
@@ -65,7 +62,10 @@ module Telnyx
       attr_writer :registered
 
       # Detailed registration information reported by the registrar. The populated
-      # fields depend on `credential_type`.
+      # fields depend on `credential_type`: UAC external credentials report
+      # `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
+      # telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
+      # `transport`, and `last_modified`. All types report `expires`.
       sig do
         returns(
           T.nilable(
@@ -108,7 +108,7 @@ module Telnyx
           credential_type:
             Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::OrSymbol,
           credential_username: String,
-          last_registration_response: String,
+          last_registration_response: T.nilable(String),
           registered: T::Boolean,
           sip_registration_details:
             Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails::OrHash,
@@ -130,7 +130,10 @@ module Telnyx
         # True if the endpoint is currently registered.
         registered: nil,
         # Detailed registration information reported by the registrar. The populated
-        # fields depend on `credential_type`.
+        # fields depend on `credential_type`: UAC external credentials report
+        # `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
+        # telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
+        # `transport`, and `last_modified`. All types report `expires`.
         sip_registration_details: nil,
         # Human-readable registration status derived from the registrar state.
         sip_registration_status: nil
@@ -145,7 +148,7 @@ module Telnyx
             credential_type:
               Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol,
             credential_username: String,
-            last_registration_response: String,
+            last_registration_response: T.nilable(String),
             registered: T::Boolean,
             sip_registration_details:
               Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails,
@@ -180,6 +183,11 @@ module Telnyx
             :telephony_credential,
             Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
           )
+        SIP_CREDENTIAL_CONNECTION =
+          T.let(
+            :sip_credential_connection,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -201,7 +209,7 @@ module Telnyx
             )
           end
 
-        # Number of authentication retries on the last attempt.
+        # Number of authentication retries on the last attempt (uac_external_credential).
         sig { returns(T.nilable(Integer)) }
         attr_reader :auth_retries
 
@@ -215,63 +223,61 @@ module Telnyx
         sig { params(expires: Integer).void }
         attr_writer :expires
 
-        # Count of consecutive registration failures.
+        # Count of consecutive registration failures (uac_external_credential).
         sig { returns(T.nilable(Integer)) }
         attr_reader :failures
 
         sig { params(failures: Integer).void }
         attr_writer :failures
 
-        # Timestamp when the registration row was last modified (telephony_credential).
+        # Timestamp when the registration was last modified (telephony_credential and
+        # sip_credential_connection).
         sig { returns(T.nilable(String)) }
         attr_reader :last_modified
 
         sig { params(last_modified: String).void }
         attr_writer :last_modified
 
-        # Unix timestamp of the next scheduled registration action.
+        # Unix timestamp of the next scheduled registration action
+        # (uac_external_credential).
         sig { returns(T.nilable(Integer)) }
         attr_reader :next_action_at
 
         sig { params(next_action_at: Integer).void }
         attr_writer :next_action_at
 
-        # Registrar node handling the registration (telephony_credential).
-        sig { returns(T.nilable(String)) }
-        attr_reader :node
-
-        sig { params(node: String).void }
-        attr_writer :node
-
-        # SIP URI user@host of the registered contact.
+        # SIP URI user@host of the registered contact (uac_external_credential).
         sig { returns(T.nilable(String)) }
         attr_reader :sip_uri_user_host
 
         sig { params(sip_uri_user_host: String).void }
         attr_writer :sip_uri_user_host
 
-        # Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential).
+        # Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
+        # sip_credential_connection).
         sig { returns(T.nilable(String)) }
         attr_reader :transport
 
         sig { params(transport: String).void }
         attr_writer :transport
 
-        # IP address of the registered user agent (telephony_credential).
+        # IP address of the registered user agent (telephony_credential and
+        # sip_credential_connection).
         sig { returns(T.nilable(String)) }
         attr_reader :ua_ip
 
         sig { params(ua_ip: String).void }
         attr_writer :ua_ip
 
-        # Port of the registered user agent (telephony_credential).
+        # Port of the registered user agent (telephony_credential and
+        # sip_credential_connection).
         sig { returns(T.nilable(Integer)) }
         attr_reader :ua_port
 
         sig { params(ua_port: Integer).void }
         attr_writer :ua_port
 
-        # Registration uptime reported by the registrar.
+        # Registration uptime reported by the registrar (uac_external_credential).
         sig { returns(T.nilable(Integer)) }
         attr_reader :uptime
 
@@ -279,7 +285,10 @@ module Telnyx
         attr_writer :uptime
 
         # Detailed registration information reported by the registrar. The populated
-        # fields depend on `credential_type`.
+        # fields depend on `credential_type`: UAC external credentials report
+        # `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
+        # telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
+        # `transport`, and `last_modified`. All types report `expires`.
         sig do
           params(
             auth_retries: Integer,
@@ -287,7 +296,6 @@ module Telnyx
             failures: Integer,
             last_modified: String,
             next_action_at: Integer,
-            node: String,
             sip_uri_user_host: String,
             transport: String,
             ua_ip: String,
@@ -296,27 +304,30 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # Number of authentication retries on the last attempt.
+          # Number of authentication retries on the last attempt (uac_external_credential).
           auth_retries: nil,
           # Unix timestamp when the current registration expires.
           expires: nil,
-          # Count of consecutive registration failures.
+          # Count of consecutive registration failures (uac_external_credential).
           failures: nil,
-          # Timestamp when the registration row was last modified (telephony_credential).
+          # Timestamp when the registration was last modified (telephony_credential and
+          # sip_credential_connection).
           last_modified: nil,
-          # Unix timestamp of the next scheduled registration action.
+          # Unix timestamp of the next scheduled registration action
+          # (uac_external_credential).
           next_action_at: nil,
-          # Registrar node handling the registration (telephony_credential).
-          node: nil,
-          # SIP URI user@host of the registered contact.
+          # SIP URI user@host of the registered contact (uac_external_credential).
           sip_uri_user_host: nil,
-          # Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential).
+          # Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
+          # sip_credential_connection).
           transport: nil,
-          # IP address of the registered user agent (telephony_credential).
+          # IP address of the registered user agent (telephony_credential and
+          # sip_credential_connection).
           ua_ip: nil,
-          # Port of the registered user agent (telephony_credential).
+          # Port of the registered user agent (telephony_credential and
+          # sip_credential_connection).
           ua_port: nil,
-          # Registration uptime reported by the registrar.
+          # Registration uptime reported by the registrar (uac_external_credential).
           uptime: nil
         )
         end
@@ -329,7 +340,6 @@ module Telnyx
               failures: Integer,
               last_modified: String,
               next_action_at: Integer,
-              node: String,
               sip_uri_user_host: String,
               transport: String,
               ua_ip: String,

data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi

@@ -62,6 +62,11 @@ module Telnyx
             )
           end
 
+        # Whether this model runs on Telnyx-hosted infrastructure (`true`) or is provided
+        # by a third-party vendor (`false`).
+        sig { returns(T::Boolean) }
+        attr_accessor :hosted
+
         # Provider-scoped model name.
         sig { returns(String) }
         attr_accessor :model
@@ -86,6 +91,7 @@ module Telnyx
         # entry in `service_types` describes one surface and the languages accepted on it.
         sig do
           params(
+            hosted: T::Boolean,
             model: String,
             provider: String,
             service_types:
@@ -95,6 +101,9 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # Whether this model runs on Telnyx-hosted infrastructure (`true`) or is provided
+          # by a third-party vendor (`false`).
+          hosted:,
           # Provider-scoped model name.
           model:,
           # STT provider name.
@@ -109,6 +118,7 @@ module Telnyx
         sig do
           override.returns(
             {
+              hosted: T::Boolean,
               model: String,
               provider: String,
               service_types: