telnyx 5.170.0 → 5.171.0

data/sig/telnyx/models/sip_registration_status_list_response.rbs

@@ -0,0 +1,195 @@
+module Telnyx
+  module Models
+    type sip_registration_status_list_response =
+      {
+        connection_id: String,
+        connection_name: String,
+        credential_type: Telnyx::Models::SipRegistrationStatusListResponse::credential_type,
+        credential_username: String,
+        last_registration_response: String?,
+        registered: bool,
+        sip_registration_details: Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails,
+        sip_registration_status: Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status
+      }
+
+    class SipRegistrationStatusListResponse < Telnyx::Internal::Type::BaseModel
+      attr_reader connection_id: String?
+
+      def connection_id=: (String) -> String
+
+      attr_reader connection_name: String?
+
+      def connection_name=: (String) -> String
+
+      attr_reader credential_type: Telnyx::Models::SipRegistrationStatusListResponse::credential_type?
+
+      def credential_type=: (
+        Telnyx::Models::SipRegistrationStatusListResponse::credential_type
+      ) -> Telnyx::Models::SipRegistrationStatusListResponse::credential_type
+
+      attr_reader credential_username: String?
+
+      def credential_username=: (String) -> String
+
+      attr_accessor last_registration_response: String?
+
+      attr_reader registered: bool?
+
+      def registered=: (bool) -> bool
+
+      attr_reader sip_registration_details: Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails?
+
+      def sip_registration_details=: (
+        Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails
+      ) -> Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails
+
+      attr_reader sip_registration_status: Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status?
+
+      def sip_registration_status=: (
+        Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status
+      ) -> Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status
+
+      def initialize: (
+        ?connection_id: String,
+        ?connection_name: String,
+        ?credential_type: Telnyx::Models::SipRegistrationStatusListResponse::credential_type,
+        ?credential_username: String,
+        ?last_registration_response: String?,
+        ?registered: bool,
+        ?sip_registration_details: Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails,
+        ?sip_registration_status: Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status
+      ) -> void
+
+      def to_hash: -> {
+        connection_id: String,
+        connection_name: String,
+        credential_type: Telnyx::Models::SipRegistrationStatusListResponse::credential_type,
+        credential_username: String,
+        last_registration_response: String?,
+        registered: bool,
+        sip_registration_details: Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails,
+        sip_registration_status: Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status
+      }
+
+      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::SipRegistrationStatusListResponse::credential_type]
+      end
+
+      type sip_registration_details =
+        {
+          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
+        }
+
+      class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
+        attr_reader auth_retries: Integer?
+
+        def auth_retries=: (Integer) -> Integer
+
+        attr_reader expires: Integer?
+
+        def expires=: (Integer) -> Integer
+
+        attr_reader failures: Integer?
+
+        def failures=: (Integer) -> Integer
+
+        attr_reader last_modified: String?
+
+        def last_modified=: (String) -> String
+
+        attr_reader next_action_at: Integer?
+
+        def next_action_at=: (Integer) -> Integer
+
+        attr_reader sip_uri_user_host: String?
+
+        def sip_uri_user_host=: (String) -> String
+
+        attr_reader transport: String?
+
+        def transport=: (String) -> String
+
+        attr_reader ua_ip: String?
+
+        def ua_ip=: (String) -> String
+
+        attr_reader ua_port: Integer?
+
+        def ua_port=: (Integer) -> Integer
+
+        attr_reader uptime: Integer?
+
+        def uptime=: (Integer) -> Integer
+
+        def initialize: (
+          ?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
+        ) -> void
+
+        def to_hash: -> {
+          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
+
+      type sip_registration_status =
+        :unregistering
+        | :connection_disabled
+        | :standby
+        | :failed
+        | :trying
+        | :registered
+        | :unknown
+
+      module SipRegistrationStatus
+        extend Telnyx::Internal::Type::Enum
+
+        UNREGISTERING: :unregistering
+        CONNECTION_DISABLED: :connection_disabled
+        STANDBY: :standby
+        FAILED: :failed
+        TRYING: :trying
+        REGISTERED: :registered
+        UNKNOWN: :unknown
+
+        def self?.values: -> ::Array[Telnyx::Models::SipRegistrationStatusListResponse::sip_registration_status]
+      end
+    end
+  end
+end

data/sig/telnyx/models/spend_limit.rbs

@@ -0,0 +1,208 @@
+module Telnyx
+  module Models
+    type spend_limit =
+      {
+        block: Telnyx::SpendLimit::Block?,
+        blocked: bool,
+        effective_limit_usd: String?,
+        limit: Telnyx::SpendLimit::Limit?,
+        period: Telnyx::Models::spend_limit_period,
+        period_end: Date,
+        period_start: Date,
+        product: String,
+        product_name: String,
+        record_type: String,
+        spend_error: String?,
+        spend_usd: String?,
+        evaluation: Telnyx::SpendLimit::Evaluation
+      }
+
+    class SpendLimit < Telnyx::Internal::Type::BaseModel
+      attr_accessor block: Telnyx::SpendLimit::Block?
+
+      attr_accessor blocked: bool
+
+      attr_accessor effective_limit_usd: String?
+
+      attr_accessor limit: Telnyx::SpendLimit::Limit?
+
+      attr_accessor period: Telnyx::Models::spend_limit_period
+
+      attr_accessor period_end: Date
+
+      attr_accessor period_start: Date
+
+      attr_accessor product: String
+
+      attr_accessor product_name: String
+
+      attr_accessor record_type: String
+
+      attr_accessor spend_error: String?
+
+      attr_accessor spend_usd: String?
+
+      attr_reader evaluation: Telnyx::SpendLimit::Evaluation?
+
+      def evaluation=: (
+        Telnyx::SpendLimit::Evaluation
+      ) -> Telnyx::SpendLimit::Evaluation
+
+      def initialize: (
+        block: Telnyx::SpendLimit::Block?,
+        blocked: bool,
+        effective_limit_usd: String?,
+        limit: Telnyx::SpendLimit::Limit?,
+        period: Telnyx::Models::spend_limit_period,
+        period_end: Date,
+        period_start: Date,
+        product: String,
+        product_name: String,
+        record_type: String,
+        spend_error: String?,
+        spend_usd: String?,
+        ?evaluation: Telnyx::SpendLimit::Evaluation
+      ) -> void
+
+      def to_hash: -> {
+        block: Telnyx::SpendLimit::Block?,
+        blocked: bool,
+        effective_limit_usd: String?,
+        limit: Telnyx::SpendLimit::Limit?,
+        period: Telnyx::Models::spend_limit_period,
+        period_end: Date,
+        period_start: Date,
+        product: String,
+        product_name: String,
+        record_type: String,
+        spend_error: String?,
+        spend_usd: String?,
+        evaluation: Telnyx::SpendLimit::Evaluation
+      }
+
+      type block =
+        {
+          blocked_until: Date,
+          detected_at: Time,
+          limit_usd: String,
+          spend_usd: String
+        }
+
+      class Block < Telnyx::Internal::Type::BaseModel
+        attr_accessor blocked_until: Date
+
+        attr_accessor detected_at: Time
+
+        attr_accessor limit_usd: String
+
+        attr_accessor spend_usd: String
+
+        def initialize: (
+          blocked_until: Date,
+          detected_at: Time,
+          limit_usd: String,
+          spend_usd: String
+        ) -> void
+
+        def to_hash: -> {
+          blocked_until: Date,
+          detected_at: Time,
+          limit_usd: String,
+          spend_usd: String
+        }
+      end
+
+      type limit =
+        {
+          amount: String?,
+          origin: Telnyx::Models::SpendLimit::Limit::origin,
+          unlimited: bool,
+          updated_at: Time
+        }
+
+      class Limit < Telnyx::Internal::Type::BaseModel
+        attr_accessor amount: String?
+
+        attr_accessor origin: Telnyx::Models::SpendLimit::Limit::origin
+
+        attr_accessor unlimited: bool
+
+        attr_accessor updated_at: Time
+
+        def initialize: (
+          amount: String?,
+          origin: Telnyx::Models::SpendLimit::Limit::origin,
+          unlimited: bool,
+          updated_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          amount: String?,
+          origin: Telnyx::Models::SpendLimit::Limit::origin,
+          unlimited: bool,
+          updated_at: Time
+        }
+
+        type origin = :self_service | :operator
+
+        module Origin
+          extend Telnyx::Internal::Type::Enum
+
+          SELF_SERVICE: :self_service
+          OPERATOR: :operator
+
+          def self?.values: -> ::Array[Telnyx::Models::SpendLimit::Limit::origin]
+        end
+      end
+
+      type evaluation =
+        {
+          blocked_now: bool,
+          evaluation_deferred: bool,
+          released: bool,
+          spend_usd: String?,
+          still_blocked_other_period: bool,
+          still_over_limit: bool,
+          note: String
+        }
+
+      class Evaluation < Telnyx::Internal::Type::BaseModel
+        attr_accessor blocked_now: bool
+
+        attr_accessor evaluation_deferred: bool
+
+        attr_accessor released: bool
+
+        attr_accessor spend_usd: String?
+
+        attr_accessor still_blocked_other_period: bool
+
+        attr_accessor still_over_limit: bool
+
+        attr_reader note: String?
+
+        def note=: (String) -> String
+
+        def initialize: (
+          blocked_now: bool,
+          evaluation_deferred: bool,
+          released: bool,
+          spend_usd: String?,
+          still_blocked_other_period: bool,
+          still_over_limit: bool,
+          ?note: String
+        ) -> void
+
+        def to_hash: -> {
+          blocked_now: bool,
+          evaluation_deferred: bool,
+          released: bool,
+          spend_usd: String?,
+          still_blocked_other_period: bool,
+          still_over_limit: bool,
+          note: String
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_create_params.rbs

@@ -0,0 +1,139 @@
+module Telnyx
+  module Models
+    type spend_limit_create_params =
+      { body: Telnyx::Models::SpendLimitCreateParams::body }
+      & Telnyx::Internal::Type::request_parameters
+
+    class SpendLimitCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor body: Telnyx::Models::SpendLimitCreateParams::body
+
+      def initialize: (
+        body: Telnyx::Models::SpendLimitCreateParams::body,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        body: Telnyx::Models::SpendLimitCreateParams::body,
+        request_options: Telnyx::RequestOptions
+      }
+
+      type body =
+        Telnyx::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount
+        | Telnyx::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited
+
+      module Body
+        extend Telnyx::Internal::Type::Union
+
+        type create_spend_limit_with_amount =
+          {
+            amount: Float,
+            product: String,
+            period: Telnyx::Models::spend_limit_period,
+            reason: String,
+            unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited
+          }
+
+        class CreateSpendLimitWithAmount < Telnyx::Internal::Type::BaseModel
+          attr_accessor amount: Float
+
+          attr_accessor product: String
+
+          attr_reader period: Telnyx::Models::spend_limit_period?
+
+          def period=: (
+            Telnyx::Models::spend_limit_period
+          ) -> Telnyx::Models::spend_limit_period
+
+          attr_reader reason: String?
+
+          def reason=: (String) -> String
+
+          attr_reader unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited?
+
+          def unlimited=: (
+            Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited
+          ) -> Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited
+
+          def initialize: (
+            amount: Float,
+            product: String,
+            ?period: Telnyx::Models::spend_limit_period,
+            ?reason: String,
+            ?unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited
+          ) -> void
+
+          def to_hash: -> {
+            amount: Float,
+            product: String,
+            period: Telnyx::Models::spend_limit_period,
+            reason: String,
+            unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited
+          }
+
+          type unlimited = false
+
+          module Unlimited
+            extend Telnyx::Internal::Type::Enum
+
+            FALSE: false
+
+            def self?.values: -> ::Array[Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount::unlimited]
+          end
+        end
+
+        type create_spend_limit_unlimited =
+          {
+            product: String,
+            unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited::unlimited,
+            period: Telnyx::Models::spend_limit_period,
+            reason: String
+          }
+
+        class CreateSpendLimitUnlimited < Telnyx::Internal::Type::BaseModel
+          attr_accessor product: String
+
+          attr_accessor unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited::unlimited
+
+          attr_reader period: Telnyx::Models::spend_limit_period?
+
+          def period=: (
+            Telnyx::Models::spend_limit_period
+          ) -> Telnyx::Models::spend_limit_period
+
+          attr_reader reason: String?
+
+          def reason=: (String) -> String
+
+          def initialize: (
+            product: String,
+            unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited::unlimited,
+            ?period: Telnyx::Models::spend_limit_period,
+            ?reason: String
+          ) -> void
+
+          def to_hash: -> {
+            product: String,
+            unlimited: Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited::unlimited,
+            period: Telnyx::Models::spend_limit_period,
+            reason: String
+          }
+
+          type unlimited = true
+
+          module Unlimited
+            extend Telnyx::Internal::Type::Enum
+
+            TRUE: true
+
+            def self?.values: -> ::Array[Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited::unlimited]
+          end
+        end
+
+        def self?.variants: -> ::Array[Telnyx::Models::SpendLimitCreateParams::body]
+      end
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_delete_params.rbs

@@ -0,0 +1,42 @@
+module Telnyx
+  module Models
+    type spend_limit_delete_params =
+      {
+        product: String,
+        period: Telnyx::Models::spend_limit_period,
+        reason: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class SpendLimitDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor product: String
+
+      attr_reader period: Telnyx::Models::spend_limit_period?
+
+      def period=: (
+        Telnyx::Models::spend_limit_period
+      ) -> Telnyx::Models::spend_limit_period
+
+      attr_reader reason: String?
+
+      def reason=: (String) -> String
+
+      def initialize: (
+        product: String,
+        ?period: Telnyx::Models::spend_limit_period,
+        ?reason: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        product: String,
+        period: Telnyx::Models::spend_limit_period,
+        reason: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_list_params.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    type spend_limit_list_params =
+      {  } & Telnyx::Internal::Type::request_parameters
+
+    class SpendLimitListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Telnyx::request_opts) -> void
+
+      def to_hash: -> { request_options: Telnyx::RequestOptions }
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_list_response.rbs

@@ -0,0 +1,69 @@
+module Telnyx
+  module Models
+    type spend_limit_list_response =
+      {
+        data: ::Array[Telnyx::SpendLimit],
+        meta: Telnyx::Models::SpendLimitListResponse::Meta
+      }
+
+    class SpendLimitListResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::SpendLimit]
+
+      attr_reader meta: Telnyx::Models::SpendLimitListResponse::Meta?
+
+      def meta=: (
+        Telnyx::Models::SpendLimitListResponse::Meta
+      ) -> Telnyx::Models::SpendLimitListResponse::Meta
+
+      def initialize: (
+        data: ::Array[Telnyx::SpendLimit],
+        ?meta: Telnyx::Models::SpendLimitListResponse::Meta
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[Telnyx::SpendLimit],
+        meta: Telnyx::Models::SpendLimitListResponse::Meta
+      }
+
+      type meta =
+        {
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        }
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_reader page_number: Integer?
+
+        def page_number=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader total_pages: Integer?
+
+        def total_pages=: (Integer) -> Integer
+
+        attr_reader total_results: Integer?
+
+        def total_results=: (Integer) -> Integer
+
+        def initialize: (
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?total_pages: Integer,
+          ?total_results: Integer
+        ) -> void
+
+        def to_hash: -> {
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_period.rbs

@@ -0,0 +1,14 @@
+module Telnyx
+  module Models
+    type spend_limit_period = :daily | :monthly
+
+    module SpendLimitPeriod
+      extend Telnyx::Internal::Type::Enum
+
+      DAILY: :daily
+      MONTHLY: :monthly
+
+      def self?.values: -> ::Array[Telnyx::Models::spend_limit_period]
+    end
+  end
+end

data/sig/telnyx/models/spend_limit_response.rbs

@@ -0,0 +1,13 @@
+module Telnyx
+  module Models
+    type spend_limit_response = { data: Telnyx::SpendLimit }
+
+    class SpendLimitResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::SpendLimit
+
+      def initialize: (data: Telnyx::SpendLimit) -> void
+
+      def to_hash: -> { data: Telnyx::SpendLimit }
+    end
+  end
+end