telnyx 5.158.0 → 5.160.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/offset_meta.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class OffsetMeta < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::OffsetMeta, Telnyx::Internal::AnyHash) }
+
+      sig { returns(Integer) }
+      attr_accessor :page_number
+
+      sig { returns(Integer) }
+      attr_accessor :page_size
+
+      sig { returns(Integer) }
+      attr_accessor :total_pages
+
+      sig { returns(Integer) }
+      attr_accessor :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(page_number:, page_size:, total_pages:, total_results:)
+      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/action_change_bundle_status_params.rbi

@@ -23,13 +23,13 @@ module Telnyx
         # the number from a bundle, this must be null. You cannot assign a number from one
         # bundle to another directly. You must first remove it from a bundle, and then
         # assign it to a new bundle.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :bundle_id
 
         sig do
           params(
             id: String,
-            bundle_id: String,
+            bundle_id: T.nilable(String),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -49,7 +49,7 @@ module Telnyx
           override.returns(
             {
               id: String,
-              bundle_id: String,
+              bundle_id: T.nilable(String),
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/pricing/pricing_pagination_meta.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    PricingPaginationMeta = Pricing::PricingPaginationMeta
+
+    module Pricing
+      class PricingPaginationMeta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Pricing::PricingPaginationMeta,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :page_number
+
+        sig { returns(Integer) }
+        attr_accessor :page_size
+
+        sig { returns(Integer) }
+        attr_accessor :total_pages
+
+        sig { returns(Integer) }
+        attr_accessor :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(page_number:, page_size:, total_pages:, total_results:)
+        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
+end

data/rbi/telnyx/models/pricing/pricing_tier.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    PricingTier = Pricing::PricingTier
+
+    module Pricing
+      class PricingTier < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Pricing::PricingTier, Telnyx::Internal::AnyHash)
+          end
+
+        # Upper bound of the tier (exclusive). Null means no upper limit.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max
+
+        # Lower bound of the tier (inclusive).
+        sig { returns(Integer) }
+        attr_accessor :min
+
+        # Rate for this tier. Numeric for standard products, string for inference
+        # products.
+        sig { returns(Telnyx::Pricing::PricingTier::Rate::Variants) }
+        attr_accessor :rate
+
+        sig do
+          params(
+            max: T.nilable(Integer),
+            min: Integer,
+            rate: Telnyx::Pricing::PricingTier::Rate::Variants
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Upper bound of the tier (exclusive). Null means no upper limit.
+          max:,
+          # Lower bound of the tier (inclusive).
+          min:,
+          # Rate for this tier. Numeric for standard products, string for inference
+          # products.
+          rate:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              max: T.nilable(Integer),
+              min: Integer,
+              rate: Telnyx::Pricing::PricingTier::Rate::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Rate for this tier. Numeric for standard products, string for inference
+        # products.
+        module Rate
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(Float, String) }
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Pricing::PricingTier::Rate::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pricing/product_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Pricing
+      class ProductListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Pricing::ProductListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Page number (1-based).
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Number of items per page (max 100).
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Page number (1-based).
+          page_number: nil,
+          # Number of items per page (max 100).
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/pricing/product_list_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Pricing
+      class ProductListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Pricing::ProductListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Human-readable description of the product.
+        sig { returns(String) }
+        attr_accessor :description
+
+        # Display name of the product.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Product identifier used in the per-product pricing endpoint.
+        sig { returns(String) }
+        attr_accessor :slug
+
+        sig do
+          params(description: String, name: String, slug: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Human-readable description of the product.
+          description:,
+          # Display name of the product.
+          name:,
+          # Product identifier used in the per-product pricing endpoint.
+          slug:
+        )
+        end
+
+        sig do
+          override.returns({ description: String, name: String, slug: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Pricing
+      class ProductRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Pricing::ProductRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        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
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Number of items per page (max 100).
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            slug: String,
+            filter_country_iso: T.nilable(String),
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          slug:,
+          filter_country_iso: nil,
+          # Page number (1-based).
+          page_number: nil,
+          # Number of items per page (max 100).
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              slug: String,
+              filter_country_iso: T.nilable(String),
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end