telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/models/oauth_oauth_pagination_meta.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class OAuthOAuthPaginationMeta < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::OAuthOAuthPaginationMeta, Telnyx::Internal::AnyHash)
+        end
+
+      # Current page number
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Number of items per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Total number of pages
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :total_pages
+
+      sig { params(total_pages: Integer).void }
+      attr_writer :total_pages
+
+      # Total number of results
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :total_results
+
+      sig { params(total_results: Integer).void }
+      attr_writer :total_results
+
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Current page number
+        page_number: nil,
+        # Number of items per page
+        page_size: nil,
+        # Total number of pages
+        total_pages: nil,
+        # Total number of results
+        total_results: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page_number: Integer,
+            page_size: Integer,
+            total_pages: Integer,
+            total_results: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/phone_number_detailed.rbi

@@ -42,7 +42,7 @@ module Telnyx
       # enabled/disabled.
       sig do
         returns(
-          T.nilable(Telnyx::PhoneNumberDetailed::EmergencyStatus::TaggedSymbol)
+          T.nilable(Telnyx::PhoneNumberDetailed::EmergencyStatus::OrSymbol)
         )
       end
       attr_reader :emergency_status
@@ -61,9 +61,7 @@ module Telnyx
       # feature has an additional per-number monthly cost associated with it.
       sig do
         returns(
-          T.nilable(
-            Telnyx::PhoneNumberDetailed::InboundCallScreening::TaggedSymbol
-          )
+          T.nilable(Telnyx::PhoneNumberDetailed::InboundCallScreening::OrSymbol)
         )
       end
       attr_reader :inbound_call_screening
@@ -103,9 +101,7 @@ module Telnyx
       # The phone number's type. Note: For numbers purchased prior to July 2023 or when
       # fetching a number's details immediately after a purchase completes, the legacy
       # values `tollfree`, `shortcode` or `longcode` may be returned instead.
-      sig do
-        returns(Telnyx::PhoneNumberDetailed::PhoneNumberType::TaggedSymbol)
-      end
+      sig { returns(Telnyx::PhoneNumberDetailed::PhoneNumberType::OrSymbol) }
       attr_accessor :phone_number_type
 
       # ISO 8601 formatted date indicating when the resource was purchased.
@@ -117,7 +113,7 @@ module Telnyx
       attr_accessor :record_type
 
       # The phone number's current status.
-      sig { returns(Telnyx::PhoneNumberDetailed::Status::TaggedSymbol) }
+      sig { returns(Telnyx::PhoneNumberDetailed::Status::OrSymbol) }
       attr_accessor :status
 
       # ISO 8601 formatted date indicating when the phone number was first activated
@@ -183,9 +179,7 @@ module Telnyx
       # Indicates if the phone number was purchased or ported in. For some numbers this
       # information may not be available.
       sig do
-        returns(
-          T.nilable(Telnyx::PhoneNumberDetailed::SourceType::TaggedSymbol)
-        )
+        returns(T.nilable(Telnyx::PhoneNumberDetailed::SourceType::OrSymbol))
       end
       attr_accessor :source_type
 
@@ -334,10 +328,10 @@ module Telnyx
             external_pin: T.nilable(String),
             phone_number: String,
             phone_number_type:
-              Telnyx::PhoneNumberDetailed::PhoneNumberType::TaggedSymbol,
+              Telnyx::PhoneNumberDetailed::PhoneNumberType::OrSymbol,
             purchased_at: String,
             record_type: String,
-            status: Telnyx::PhoneNumberDetailed::Status::TaggedSymbol,
+            status: Telnyx::PhoneNumberDetailed::Status::OrSymbol,
             tags: T::Array[String],
             activated_at: T.nilable(Time),
             billing_group_id: T.nilable(String),
@@ -351,14 +345,14 @@ module Telnyx
             emergency_address_id: T.nilable(String),
             emergency_enabled: T::Boolean,
             emergency_status:
-              Telnyx::PhoneNumberDetailed::EmergencyStatus::TaggedSymbol,
+              Telnyx::PhoneNumberDetailed::EmergencyStatus::OrSymbol,
             hd_voice_enabled: T::Boolean,
             inbound_call_screening:
-              Telnyx::PhoneNumberDetailed::InboundCallScreening::TaggedSymbol,
+              Telnyx::PhoneNumberDetailed::InboundCallScreening::OrSymbol,
             messaging_profile_id: T.nilable(String),
             messaging_profile_name: T.nilable(String),
             source_type:
-              T.nilable(Telnyx::PhoneNumberDetailed::SourceType::TaggedSymbol),
+              T.nilable(Telnyx::PhoneNumberDetailed::SourceType::OrSymbol),
             t38_fax_gateway_enabled: T::Boolean,
             updated_at: String
           }

data/rbi/telnyx/models/phone_number_retrieve_response.rbi

@@ -11,21 +11,21 @@ module Telnyx
           )
         end
 
-      sig { returns(T.nilable(Telnyx::PhoneNumberDetailed)) }
+      sig { returns(T.nilable(Telnyx::NumbersPhoneNumberDetailed)) }
       attr_reader :data
 
-      sig { params(data: Telnyx::PhoneNumberDetailed::OrHash).void }
+      sig { params(data: Telnyx::NumbersPhoneNumberDetailed::OrHash).void }
       attr_writer :data
 
       sig do
-        params(data: Telnyx::PhoneNumberDetailed::OrHash).returns(
+        params(data: Telnyx::NumbersPhoneNumberDetailed::OrHash).returns(
           T.attached_class
         )
       end
       def self.new(data: nil)
       end
 
-      sig { override.returns({ data: Telnyx::PhoneNumberDetailed }) }
+      sig { override.returns({ data: Telnyx::NumbersPhoneNumberDetailed }) }
       def to_hash
       end
     end

data/rbi/telnyx/models/phone_number_update_response.rbi

@@ -11,21 +11,21 @@ module Telnyx
           )
         end
 
-      sig { returns(T.nilable(Telnyx::PhoneNumberDetailed)) }
+      sig { returns(T.nilable(Telnyx::NumbersPhoneNumberDetailed)) }
       attr_reader :data
 
-      sig { params(data: Telnyx::PhoneNumberDetailed::OrHash).void }
+      sig { params(data: Telnyx::NumbersPhoneNumberDetailed::OrHash).void }
       attr_writer :data
 
       sig do
-        params(data: Telnyx::PhoneNumberDetailed::OrHash).returns(
+        params(data: Telnyx::NumbersPhoneNumberDetailed::OrHash).returns(
           T.attached_class
         )
       end
       def self.new(data: nil)
       end
 
-      sig { override.returns({ data: Telnyx::PhoneNumberDetailed }) }
+      sig { override.returns({ data: Telnyx::NumbersPhoneNumberDetailed }) }
       def to_hash
       end
     end

data/rbi/telnyx/models/phone_numbers/voicemail_pref_response.rbi

@@ -19,6 +19,26 @@ module Telnyx
         sig { params(enabled: T::Boolean).void }
         attr_writer :enabled
 
+        # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+        # `default` to play the standard system greeting, or to `custom_greeting` to play
+        # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+        # must reference an audio file already uploaded to your account through the Media
+        # Storage API.
+        sig do
+          returns(
+            T.nilable(Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting)
+          )
+        end
+        attr_reader :greeting
+
+        sig do
+          params(
+            greeting:
+              Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::OrHash
+          ).void
+        end
+        attr_writer :greeting
+
         # The pin used for the voicemail.
         sig { returns(T.nilable(String)) }
         attr_reader :pin
@@ -27,19 +47,146 @@ module Telnyx
         attr_writer :pin
 
         sig do
-          params(enabled: T::Boolean, pin: String).returns(T.attached_class)
+          params(
+            enabled: T::Boolean,
+            greeting:
+              Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::OrHash,
+            pin: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # Whether voicemail is enabled.
           enabled: nil,
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          greeting: nil,
           # The pin used for the voicemail.
           pin: nil
         )
         end
 
-        sig { override.returns({ enabled: T::Boolean, pin: String }) }
+        sig do
+          override.returns(
+            {
+              enabled: T::Boolean,
+              greeting: Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting,
+              pin: String
+            }
+          )
+        end
         def to_hash
         end
+
+        class Greeting < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the media file to play as the greeting. Required when `mode` is
+          # `custom_greeting`; ignored when `mode` is `default`. The value must match the
+          # `media_name` of a file you previously uploaded with the Media Storage API
+          # (`POST /v2/media`).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :media_name
+
+          # The greeting mode. `default` plays the standard system greeting.
+          # `custom_greeting` plays the audio referenced by `media_name`.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :mode
+
+          sig do
+            params(
+              mode:
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::OrSymbol
+            ).void
+          end
+          attr_writer :mode
+
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          sig do
+            params(
+              media_name: T.nilable(String),
+              mode:
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the media file to play as the greeting. Required when `mode` is
+            # `custom_greeting`; ignored when `mode` is `default`. The value must match the
+            # `media_name` of a file you previously uploaded with the Media Storage API
+            # (`POST /v2/media`).
+            media_name: nil,
+            # The greeting mode. `default` plays the standard system greeting.
+            # `custom_greeting` plays the audio referenced by `media_name`.
+            mode: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                media_name: T.nilable(String),
+                mode:
+                  Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The greeting mode. `default` plays the standard system greeting.
+          # `custom_greeting` plays the audio referenced by `media_name`.
+          module Mode
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DEFAULT =
+              T.let(
+                :default,
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::TaggedSymbol
+              )
+            CUSTOM_GREETING =
+              T.let(
+                :custom_greeting,
+                Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::PhoneNumbers::VoicemailPrefResponse::Greeting::Mode::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/phone_numbers/voicemail_request.rbi

@@ -19,6 +19,23 @@ module Telnyx
         sig { params(enabled: T::Boolean).void }
         attr_writer :enabled
 
+        # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+        # `default` to play the standard system greeting, or to `custom_greeting` to play
+        # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+        # must reference an audio file already uploaded to your account through the Media
+        # Storage API.
+        sig do
+          returns(T.nilable(Telnyx::PhoneNumbers::VoicemailRequest::Greeting))
+        end
+        attr_reader :greeting
+
+        sig do
+          params(
+            greeting: Telnyx::PhoneNumbers::VoicemailRequest::Greeting::OrHash
+          ).void
+        end
+        attr_writer :greeting
+
         # The pin used for voicemail
         sig { returns(T.nilable(String)) }
         attr_reader :pin
@@ -27,19 +44,145 @@ module Telnyx
         attr_writer :pin
 
         sig do
-          params(enabled: T::Boolean, pin: String).returns(T.attached_class)
+          params(
+            enabled: T::Boolean,
+            greeting: Telnyx::PhoneNumbers::VoicemailRequest::Greeting::OrHash,
+            pin: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # Whether voicemail is enabled.
           enabled: nil,
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          greeting: nil,
           # The pin used for voicemail
           pin: nil
         )
         end
 
-        sig { override.returns({ enabled: T::Boolean, pin: String }) }
+        sig do
+          override.returns(
+            {
+              enabled: T::Boolean,
+              greeting: Telnyx::PhoneNumbers::VoicemailRequest::Greeting,
+              pin: String
+            }
+          )
+        end
         def to_hash
         end
+
+        class Greeting < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the media file to play as the greeting. Required when `mode` is
+          # `custom_greeting`; ignored when `mode` is `default`. The value must match the
+          # `media_name` of a file you previously uploaded with the Media Storage API
+          # (`POST /v2/media`).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :media_name
+
+          # The greeting mode. `default` plays the standard system greeting.
+          # `custom_greeting` plays the audio referenced by `media_name`.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::OrSymbol
+              )
+            )
+          end
+          attr_reader :mode
+
+          sig do
+            params(
+              mode:
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::OrSymbol
+            ).void
+          end
+          attr_writer :mode
+
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          sig do
+            params(
+              media_name: T.nilable(String),
+              mode:
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the media file to play as the greeting. Required when `mode` is
+            # `custom_greeting`; ignored when `mode` is `default`. The value must match the
+            # `media_name` of a file you previously uploaded with the Media Storage API
+            # (`POST /v2/media`).
+            media_name: nil,
+            # The greeting mode. `default` plays the standard system greeting.
+            # `custom_greeting` plays the audio referenced by `media_name`.
+            mode: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                media_name: T.nilable(String),
+                mode:
+                  Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The greeting mode. `default` plays the standard system greeting.
+          # `custom_greeting` plays the audio referenced by `media_name`.
+          module Mode
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DEFAULT =
+              T.let(
+                :default,
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::TaggedSymbol
+              )
+            CUSTOM_GREETING =
+              T.let(
+                :custom_greeting,
+                Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::PhoneNumbers::VoicemailRequest::Greeting::Mode::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/pricing/product_retrieve_params.rbi

@@ -18,6 +18,9 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :slug
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filter_country_iso
+
         # Page number (1-based).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_number
@@ -35,6 +38,7 @@ module Telnyx
         sig do
           params(
             slug: String,
+            filter_country_iso: T.nilable(String),
             page_number: Integer,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
@@ -42,6 +46,7 @@ module Telnyx
         end
         def self.new(
           slug:,
+          filter_country_iso: nil,
           # Page number (1-based).
           page_number: nil,
           # Number of items per page (max 100).
@@ -54,6 +59,7 @@ module Telnyx
           override.returns(
             {
               slug: String,
+              filter_country_iso: T.nilable(String),
               page_number: Integer,
               page_size: Integer,
               request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/private_wireless_gateway_status.rbi

@@ -9,7 +9,7 @@ module Telnyx
         end
 
       # This attribute is an
-      # [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
+      # [error code](https://developers.telnyx.com/docs/development/api-fundamentals/api-errors)
       # related to the failure reason.
       sig { returns(T.nilable(String)) }
       attr_accessor :error_code
@@ -50,7 +50,7 @@ module Telnyx
       end
       def self.new(
         # This attribute is an
-        # [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
+        # [error code](https://developers.telnyx.com/docs/development/api-fundamentals/api-errors)
         # related to the failure reason.
         error_code: nil,
         # This attribute provides a human-readable explanation of why a failure happened.

data/rbi/telnyx/models/rcs/agent_campaign_configuration.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentCampaignConfiguration < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Rcs::AgentCampaignConfiguration,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :company_overview
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :additional_information
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_overview
+
+        sig { returns(T.nilable(Telnyx::Rcs::AgentConsentConfiguration)) }
+        attr_reader :consent_settings
+
+        sig do
+          params(
+            consent_settings:
+              T.nilable(Telnyx::Rcs::AgentConsentConfiguration::OrHash)
+          ).void
+        end
+        attr_writer :consent_settings
+
+        sig { returns(T.nilable(T::Array[Telnyx::Rcs::AgentInteraction])) }
+        attr_reader :interactions
+
+        sig do
+          params(
+            interactions: T::Array[Telnyx::Rcs::AgentInteraction::OrHash]
+          ).void
+        end
+        attr_writer :interactions
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :message_examples
+
+        sig { params(message_examples: T::Array[String]).void }
+        attr_writer :message_examples
+
+        sig do
+          params(
+            company_overview: String,
+            additional_information: T.nilable(String),
+            agent_overview: T.nilable(String),
+            consent_settings:
+              T.nilable(Telnyx::Rcs::AgentConsentConfiguration::OrHash),
+            interactions: T::Array[Telnyx::Rcs::AgentInteraction::OrHash],
+            message_examples: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          company_overview:,
+          additional_information: nil,
+          agent_overview: nil,
+          consent_settings: nil,
+          interactions: nil,
+          message_examples: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              company_overview: String,
+              additional_information: T.nilable(String),
+              agent_overview: T.nilable(String),
+              consent_settings:
+                T.nilable(Telnyx::Rcs::AgentConsentConfiguration),
+              interactions: T::Array[Telnyx::Rcs::AgentInteraction],
+              message_examples: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end