telnyx 5.164.0 → 5.166.0

data/lib/telnyx/resources/sip_registration_status.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Resources
-    # UAC connection operations
-    class SipRegistrationStatus
-      # Some parameter documentations has been truncated, see
-      # {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
-      #
-      # Returns the live SIP registration status for a Telnyx endpoint: whether it is
-      # currently registered, when the current registration expires, and the last
-      # response Telnyx received from the registrar.
-      #
-      # The endpoint supports three credential types, selected with the
-      # `credential_type` query parameter. Each type is keyed by a different identifier:
-      #
-      # | `credential_type`           | Keyed by        | Use case                                                                   |
-      # | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-      # | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-      # | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-      # | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-      #
-      # The authenticated account is taken from your API key; you can only read the
-      # registration status of connections and credentials your account owns.
-      #
-      # @overload retrieve(credential_type:, connection_id: nil, username: nil, request_options: {})
-      #
-      # @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. `uac_external_credential` is keyed by `connec
-      #
-      # @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
-      #
-      # @param username [String] SIP username to look up. Required when `credential_type` is `telephony_credentia
-      #
-      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Telnyx::Models::SipRegistrationStatusRetrieveResponse]
-      #
-      # @see Telnyx::Models::SipRegistrationStatusRetrieveParams
-      def retrieve(params)
-        parsed, options = Telnyx::SipRegistrationStatusRetrieveParams.dump_request(params)
-        query = Telnyx::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "sip_registration_status",
-          query: query,
-          model: Telnyx::Models::SipRegistrationStatusRetrieveResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Telnyx::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi

@@ -1,124 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    class SipRegistrationStatusRetrieveParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            Telnyx::SipRegistrationStatusRetrieveParams,
-            Telnyx::Internal::AnyHash
-          )
-        end
-
-      # The kind of credential to look up. `uac_external_credential` is keyed by
-      # `connection_id`; `telephony_credential` and `sip_credential_connection` are
-      # keyed by `username`.
-      sig do
-        returns(
-          Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol
-        )
-      end
-      attr_accessor :credential_type
-
-      # Identifier of the UAC connection to look up. Required when `credential_type` is
-      # `uac_external_credential`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :connection_id
-
-      sig { params(connection_id: String).void }
-      attr_writer :connection_id
-
-      # SIP username to look up. Required when `credential_type` is
-      # `telephony_credential` or `sip_credential_connection`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :username
-
-      sig { params(username: String).void }
-      attr_writer :username
-
-      sig do
-        params(
-          credential_type:
-            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
-          connection_id: String,
-          username: String,
-          request_options: Telnyx::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The kind of credential to look up. `uac_external_credential` is keyed by
-        # `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 to look up. Required when `credential_type` is
-        # `telephony_credential` or `sip_credential_connection`.
-        username: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            credential_type:
-              Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
-            connection_id: String,
-            username: String,
-            request_options: Telnyx::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The kind of credential to look up. `uac_external_credential` is keyed by
-      # `connection_id`; `telephony_credential` and `sip_credential_connection` are
-      # keyed by `username`.
-      module CredentialType
-        extend Telnyx::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Telnyx::SipRegistrationStatusRetrieveParams::CredentialType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        UAC_EXTERNAL_CREDENTIAL =
-          T.let(
-            :uac_external_credential,
-            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
-          )
-        TELEPHONY_CREDENTIAL =
-          T.let(
-            :telephony_credential,
-            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
-          )
-        SIP_CREDENTIAL_CONNECTION =
-          T.let(
-            :sip_credential_connection,
-            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi

@@ -1,416 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    class SipRegistrationStatusRetrieveResponse < Telnyx::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse,
-            Telnyx::Internal::AnyHash
-          )
-        end
-
-      # Identifier of the connection associated with the credential.
-      sig { returns(T.nilable(String)) }
-      attr_reader :connection_id
-
-      sig { params(connection_id: String).void }
-      attr_writer :connection_id
-
-      # Human-readable connection name.
-      sig { returns(T.nilable(String)) }
-      attr_reader :connection_name
-
-      sig { params(connection_name: String).void }
-      attr_writer :connection_name
-
-      # The credential type that was looked up.
-      sig do
-        returns(
-          T.nilable(
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
-          )
-        )
-      end
-      attr_reader :credential_type
-
-      sig do
-        params(
-          credential_type:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::OrSymbol
-        ).void
-      end
-      attr_writer :credential_type
-
-      # SIP username used for the registration.
-      sig { returns(T.nilable(String)) }
-      attr_reader :credential_username
-
-      sig { params(credential_username: String).void }
-      attr_writer :credential_username
-
-      # SIP response from the last registration attempt.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :last_registration_response
-
-      # True if the endpoint is currently registered.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :registered
-
-      sig { params(registered: T::Boolean).void }
-      attr_writer :registered
-
-      # Detailed registration information reported by the registrar. The populated
-      # 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(
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails
-          )
-        )
-      end
-      attr_reader :sip_registration_details
-
-      sig do
-        params(
-          sip_registration_details:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails::OrHash
-        ).void
-      end
-      attr_writer :sip_registration_details
-
-      # Human-readable registration status derived from the registrar state.
-      sig do
-        returns(
-          T.nilable(
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        )
-      end
-      attr_reader :sip_registration_status
-
-      sig do
-        params(
-          sip_registration_status:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::OrSymbol
-        ).void
-      end
-      attr_writer :sip_registration_status
-
-      sig do
-        params(
-          connection_id: String,
-          connection_name: String,
-          credential_type:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::OrSymbol,
-          credential_username: String,
-          last_registration_response: T.nilable(String),
-          registered: T::Boolean,
-          sip_registration_details:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails::OrHash,
-          sip_registration_status:
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::OrSymbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Identifier of the connection associated with the credential.
-        connection_id: nil,
-        # Human-readable connection name.
-        connection_name: nil,
-        # The credential type that was looked up.
-        credential_type: nil,
-        # SIP username used for the registration.
-        credential_username: nil,
-        # SIP response from the last registration attempt.
-        last_registration_response: nil,
-        # True if the endpoint is currently registered.
-        registered: nil,
-        # Detailed registration information reported by the registrar. The populated
-        # 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
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            connection_id: String,
-            connection_name: String,
-            credential_type:
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol,
-            credential_username: String,
-            last_registration_response: T.nilable(String),
-            registered: T::Boolean,
-            sip_registration_details:
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails,
-            sip_registration_status:
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The credential type that was looked up.
-      module CredentialType
-        extend Telnyx::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        UAC_EXTERNAL_CREDENTIAL =
-          T.let(
-            :uac_external_credential,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
-          )
-        TELEPHONY_CREDENTIAL =
-          T.let(
-            :telephony_credential,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
-          )
-        SIP_CREDENTIAL_CONNECTION =
-          T.let(
-            :sip_credential_connection,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Number of authentication retries on the last attempt (uac_external_credential).
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :auth_retries
-
-        sig { params(auth_retries: Integer).void }
-        attr_writer :auth_retries
-
-        # Unix timestamp when the current registration expires.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :expires
-
-        sig { params(expires: Integer).void }
-        attr_writer :expires
-
-        # 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 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
-        # (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
-
-        # 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 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 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 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 (uac_external_credential).
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :uptime
-
-        sig { params(uptime: Integer).void }
-        attr_writer :uptime
-
-        # Detailed registration information reported by the registrar. The populated
-        # 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,
-            expires: Integer,
-            failures: Integer,
-            last_modified: String,
-            next_action_at: Integer,
-            sip_uri_user_host: String,
-            transport: String,
-            ua_ip: String,
-            ua_port: Integer,
-            uptime: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # 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 (uac_external_credential).
-          failures: nil,
-          # Timestamp when the registration was last modified (telephony_credential and
-          # sip_credential_connection).
-          last_modified: nil,
-          # Unix timestamp of the next scheduled registration action
-          # (uac_external_credential).
-          next_action_at: nil,
-          # 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 and
-          # sip_credential_connection).
-          transport: nil,
-          # IP address of the registered user agent (telephony_credential and
-          # sip_credential_connection).
-          ua_ip: nil,
-          # Port of the registered user agent (telephony_credential and
-          # sip_credential_connection).
-          ua_port: nil,
-          # Registration uptime reported by the registrar (uac_external_credential).
-          uptime: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              auth_retries: Integer,
-              expires: Integer,
-              failures: Integer,
-              last_modified: String,
-              next_action_at: Integer,
-              sip_uri_user_host: String,
-              transport: String,
-              ua_ip: String,
-              ua_port: Integer,
-              uptime: Integer
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # Human-readable registration status derived from the registrar state.
-      module SipRegistrationStatus
-        extend Telnyx::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        UNREGISTERING =
-          T.let(
-            :unregistering,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        CONNECTION_DISABLED =
-          T.let(
-            :connection_disabled,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        STANDBY =
-          T.let(
-            :standby,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        FAILED =
-          T.let(
-            :failed,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        TRYING =
-          T.let(
-            :trying,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        REGISTERED =
-          T.let(
-            :registered,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-        UNKNOWN =
-          T.let(
-            :unknown,
-            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/resources/sip_registration_status.rbi

@@ -1,52 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Resources
-    # UAC connection operations
-    class SipRegistrationStatus
-      # Returns the live SIP registration status for a Telnyx endpoint: whether it is
-      # currently registered, when the current registration expires, and the last
-      # response Telnyx received from the registrar.
-      #
-      # The endpoint supports three credential types, selected with the
-      # `credential_type` query parameter. Each type is keyed by a different identifier:
-      #
-      # | `credential_type`           | Keyed by        | Use case                                                                   |
-      # | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-      # | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-      # | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-      # | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-      #
-      # The authenticated account is taken from your API key; you can only read the
-      # registration status of connections and credentials your account owns.
-      sig do
-        params(
-          credential_type:
-            Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
-          connection_id: String,
-          username: String,
-          request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::SipRegistrationStatusRetrieveResponse)
-      end
-      def retrieve(
-        # The kind of credential to look up. `uac_external_credential` is keyed by
-        # `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 to look up. Required when `credential_type` is
-        # `telephony_credential` or `sip_credential_connection`.
-        username: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Telnyx::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs

@@ -1,55 +0,0 @@
-module Telnyx
-  module Models
-    type sip_registration_status_retrieve_params =
-      {
-        credential_type: Telnyx::Models::SipRegistrationStatusRetrieveParams::credential_type,
-        connection_id: String,
-        username: String
-      }
-      & Telnyx::Internal::Type::request_parameters
-
-    class SipRegistrationStatusRetrieveParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      attr_accessor credential_type: Telnyx::Models::SipRegistrationStatusRetrieveParams::credential_type
-
-      attr_reader connection_id: String?
-
-      def connection_id=: (String) -> String
-
-      attr_reader username: String?
-
-      def username=: (String) -> String
-
-      def initialize: (
-        credential_type: Telnyx::Models::SipRegistrationStatusRetrieveParams::credential_type,
-        ?connection_id: String,
-        ?username: String,
-        ?request_options: Telnyx::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        credential_type: Telnyx::Models::SipRegistrationStatusRetrieveParams::credential_type,
-        connection_id: String,
-        username: String,
-        request_options: Telnyx::RequestOptions
-      }
-
-      type credential_type =
-        :uac_external_credential
-        | :telephony_credential
-        | :sip_credential_connection
-
-      module CredentialType
-        extend Telnyx::Internal::Type::Enum
-
-        UAC_EXTERNAL_CREDENTIAL: :uac_external_credential
-        TELEPHONY_CREDENTIAL: :telephony_credential
-        SIP_CREDENTIAL_CONNECTION: :sip_credential_connection
-
-        def self?.values: -> ::Array[Telnyx::Models::SipRegistrationStatusRetrieveParams::credential_type]
-      end
-    end
-  end
-end