telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/inbound_message.rb

@@ -2,243 +2,21 @@
 
 module Telnyx
   module Models
-    class InboundMessage < Telnyx::Internal::Type::BaseModel
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute attachments
-      #
-      #   @return [Array<Hash{Symbol=>Object}>]
-      required :attachments,
-               Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
-
-      # @!attribute bcc
-      #
-      #   @return [Array<Telnyx::Models::InboundMessage::Bcc>]
-      required :bcc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Bcc] }
-
-      # @!attribute cc
-      #
-      #   @return [Array<Telnyx::Models::InboundMessage::Cc>]
-      required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Cc] }
-
-      # @!attribute created_at
-      #
-      #   @return [Time]
-      required :created_at, Time
-
+    class InboundMessage < Telnyx::Models::EmailInboxes::ThreadMessage
       # @!attribute direction
       #
-      #   @return [Symbol, Telnyx::Models::InboundMessage::Direction]
-      required :direction, enum: -> { Telnyx::InboundMessage::Direction }
-
-      # @!attribute from
-      #
-      #   @return [Telnyx::Models::InboundMessage::From]
-      required :from, -> { Telnyx::InboundMessage::From }
-
-      # @!attribute has_quoted_text
-      #   Whether conservative plain-text extraction detected a quoted tail. False does
-      #   not prove that the source contains no quoted content.
-      #
-      #   @return [Boolean]
-      required :has_quoted_text, Telnyx::Internal::Type::Boolean
-
-      # @!attribute headers
-      #
-      #   @return [Hash{Symbol=>Object}]
-      required :headers, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-      # @!attribute html_body_url
-      #   URL for an offloaded HTML body. Null means the body is not offloaded to a URL;
-      #   an inline HTML body may still exist but is not returned on list reads.
-      #   `reply_text` and `has_quoted_text` are computed from the inline plain-text body
-      #   when present.
-      #
-      #   @return [String, nil]
-      required :html_body_url, String, nil?: true
-
-      # @!attribute in_reply_to
-      #
-      #   @return [String, nil]
-      required :in_reply_to, String, nil?: true
-
-      # @!attribute inbox_id
-      #
-      #   @return [String]
-      required :inbox_id, String
-
-      # @!attribute inline_files
-      #
-      #   @return [Array<Hash{Symbol=>Object}>]
-      required :inline_files,
-               Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
-
-      # @!attribute message_id
-      #   RFC Message-ID header.
-      #
-      #   @return [String]
-      required :message_id, String
-
-      # @!attribute read_at
-      #
-      #   @return [Time, nil]
-      required :read_at, Time, nil?: true
-
-      # @!attribute received_at
-      #
-      #   @return [Time]
-      required :received_at, Time
-
-      # @!attribute record_type
-      #
-      #   @return [Symbol, Telnyx::Models::InboundMessage::RecordType]
-      required :record_type, enum: -> { Telnyx::InboundMessage::RecordType }
-
-      # @!attribute references
-      #   Ordered RFC Message-ID values from the References header.
-      #
-      #   @return [Array<String>]
-      required :references, Telnyx::Internal::Type::ArrayOf[String]
-
-      # @!attribute reply_text
-      #   Conservatively extracted new-reply content from the available plain-text body.
-      #   Null means no plain-text body was available because it was absent or offloaded;
-      #   HTML bodies are not parsed.
-      #
-      #   @return [String, nil]
-      required :reply_text, String, nil?: true
-
-      # @!attribute reply_to
-      #
-      #   @return [Array<Telnyx::Models::InboundMessage::ReplyTo>]
-      required :reply_to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::ReplyTo] }
+      #   @return [Symbol, Telnyx::Models::InboundMessage::Direction, nil]
+      optional :direction, enum: -> { Telnyx::InboundMessage::Direction }
 
       # @!attribute status
       #
-      #   @return [Symbol, Telnyx::Models::InboundMessage::Status]
-      required :status, enum: -> { Telnyx::InboundMessage::Status }
+      #   @return [Symbol, Telnyx::Models::InboundMessage::Status, nil]
+      optional :status, enum: -> { Telnyx::InboundMessage::Status }
 
-      # @!attribute subject
-      #
-      #   @return [String, nil]
-      required :subject, String, nil?: true
-
-      # @!attribute text_body_url
-      #   URL for an offloaded plain-text body. Null means the body is not offloaded to a
-      #   URL; an inline plain-text body may still exist but is not returned on list
-      #   reads. `reply_text` and `has_quoted_text` are computed from the inline
-      #   plain-text body when present.
-      #
-      #   @return [String, nil]
-      required :text_body_url, String, nil?: true
-
-      # @!attribute thread_id
-      #
-      #   @return [String]
-      required :thread_id, String
-
-      # @!attribute to
-      #
-      #   @return [Array<Telnyx::Models::InboundMessage::To>]
-      required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::To] }
-
-      # @!attribute updated_at
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!method initialize(id:, attachments:, bcc:, cc:, created_at:, direction:, from:, has_quoted_text:, headers:, html_body_url:, in_reply_to:, inbox_id:, inline_files:, message_id:, read_at:, received_at:, record_type:, references:, reply_text:, reply_to:, status:, subject:, text_body_url:, thread_id:, to:, updated_at:)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::InboundMessage} for more details.
-      #
-      #   @param id [String]
-      #
-      #   @param attachments [Array<Hash{Symbol=>Object}>]
-      #
-      #   @param bcc [Array<Telnyx::Models::InboundMessage::Bcc>]
-      #
-      #   @param cc [Array<Telnyx::Models::InboundMessage::Cc>]
-      #
-      #   @param created_at [Time]
-      #
+      # @!method initialize(direction: nil, status: nil)
       #   @param direction [Symbol, Telnyx::Models::InboundMessage::Direction]
-      #
-      #   @param from [Telnyx::Models::InboundMessage::From]
-      #
-      #   @param has_quoted_text [Boolean] Whether conservative plain-text extraction detected a quoted tail. False does no
-      #
-      #   @param headers [Hash{Symbol=>Object}]
-      #
-      #   @param html_body_url [String, nil] URL for an offloaded HTML body. Null means the body is not offloaded to a URL; a
-      #
-      #   @param in_reply_to [String, nil]
-      #
-      #   @param inbox_id [String]
-      #
-      #   @param inline_files [Array<Hash{Symbol=>Object}>]
-      #
-      #   @param message_id [String] RFC Message-ID header.
-      #
-      #   @param read_at [Time, nil]
-      #
-      #   @param received_at [Time]
-      #
-      #   @param record_type [Symbol, Telnyx::Models::InboundMessage::RecordType]
-      #
-      #   @param references [Array<String>] Ordered RFC Message-ID values from the References header.
-      #
-      #   @param reply_text [String, nil] Conservatively extracted new-reply content from the available plain-text body. N
-      #
-      #   @param reply_to [Array<Telnyx::Models::InboundMessage::ReplyTo>]
-      #
       #   @param status [Symbol, Telnyx::Models::InboundMessage::Status]
-      #
-      #   @param subject [String, nil]
-      #
-      #   @param text_body_url [String, nil] URL for an offloaded plain-text body. Null means the body is not offloaded to a
-      #
-      #   @param thread_id [String]
-      #
-      #   @param to [Array<Telnyx::Models::InboundMessage::To>]
-      #
-      #   @param updated_at [Time]
-
-      class Bcc < Telnyx::Internal::Type::BaseModel
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
 
-        # @!method initialize(email:, name: nil)
-        #   @param email [String]
-        #   @param name [String]
-      end
-
-      class Cc < Telnyx::Internal::Type::BaseModel
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!method initialize(email:, name: nil)
-        #   @param email [String]
-        #   @param name [String]
-      end
-
-      # @see Telnyx::Models::InboundMessage#direction
       module Direction
         extend Telnyx::Internal::Type::Enum
 
@@ -248,50 +26,6 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # @see Telnyx::Models::InboundMessage#from
-      class From < Telnyx::Internal::Type::BaseModel
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!method initialize(email:, name: nil)
-        #   @param email [String]
-        #   @param name [String]
-      end
-
-      # @see Telnyx::Models::InboundMessage#record_type
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
-
-        EMAIL_MESSAGE = :email_message
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class ReplyTo < Telnyx::Internal::Type::BaseModel
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!method initialize(email:, name: nil)
-        #   @param email [String]
-        #   @param name [String]
-      end
-
-      # @see Telnyx::Models::InboundMessage#status
       module Status
         extend Telnyx::Internal::Type::Enum
 
@@ -300,22 +34,6 @@ module Telnyx
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class To < Telnyx::Internal::Type::BaseModel
-        # @!attribute email
-        #
-        #   @return [String]
-        required :email, String
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!method initialize(email:, name: nil)
-        #   @param email [String]
-        #   @param name [String]
-      end
     end
   end
 end

data/lib/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rb

@@ -10,7 +10,23 @@ module Telnyx
             extend Telnyx::Internal::Type::RequestParameters::Converter
             include Telnyx::Internal::Type::RequestParameters
 
-            # @!method initialize(request_options: {})
+            # @!attribute page
+            #   Page number to retrieve (1-based).
+            #
+            #   @return [Integer, nil]
+            optional :page, Integer
+
+            # @!attribute per_page
+            #   Filter results by per page.
+            #
+            #   @return [Integer, nil]
+            optional :per_page, Integer
+
+            # @!method initialize(page: nil, per_page: nil, request_options: {})
+            #   @param page [Integer] Page number to retrieve (1-based).
+            #
+            #   @param per_page [Integer] Filter results by per page.
+            #
             #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
           end
         end

data/lib/telnyx/models/legacy/reporting/usage_reports/telco_data_usage_report_response.rb

@@ -5,6 +5,7 @@ module Telnyx
     module Legacy
       module Reporting
         module UsageReports
+          # @see Telnyx::Resources::Legacy::Reporting::UsageReports::NumberLookup#list
           class TelcoDataUsageReportResponse < Telnyx::Internal::Type::BaseModel
             # @!attribute id
             #   Unique identifier for the report

data/lib/telnyx/models/message_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class MessageEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute occurred_at
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Telnyx::Models::EmailEventType]
+      required :type, enum: -> { Telnyx::EmailEventType }
+
+      # @!attribute payload
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!method initialize(occurred_at:, type:, payload: nil)
+      #   @param occurred_at [Time]
+      #   @param type [Symbol, Telnyx::Models::EmailEventType]
+      #   @param payload [Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/messaging_10dlc/phone_number_campaign.rb

@@ -48,6 +48,12 @@ module Telnyx
         #   @return [String, nil]
         optional :failure_reasons, String, api_name: :failureReasons
 
+        # @!attribute non_tmobile_number_mapping_status
+        #   The assignment status of the number towards other carriers.
+        #
+        #   @return [String, nil]
+        optional :non_tmobile_number_mapping_status, String, api_name: :nonTmobileNumberMappingStatus
+
         # @!attribute tcr_brand_id
         #   TCR's alphanumeric ID for the brand.
         #
@@ -66,7 +72,13 @@ module Telnyx
         #   @return [String, nil]
         optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId
 
-        # @!method initialize(campaign_id:, created_at:, phone_number:, updated_at:, assignment_status: nil, brand_id: nil, failure_reasons: nil, tcr_brand_id: nil, tcr_campaign_id: nil, telnyx_campaign_id: nil)
+        # @!attribute tmobile_number_mapping_status
+        #   The T-Mobile assignment status of the number.
+        #
+        #   @return [String, nil]
+        optional :tmobile_number_mapping_status, String, api_name: :tmobileNumberMappingStatus
+
+        # @!method initialize(campaign_id:, created_at:, phone_number:, updated_at:, assignment_status: nil, brand_id: nil, failure_reasons: nil, non_tmobile_number_mapping_status: nil, tcr_brand_id: nil, tcr_campaign_id: nil, telnyx_campaign_id: nil, tmobile_number_mapping_status: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Messaging10dlc::PhoneNumberCampaign} for more details.
         #
@@ -84,11 +96,15 @@ module Telnyx
         #
         #   @param failure_reasons [String] Extra info about a failure to assign/unassign a number. Relevant only if the ass
         #
+        #   @param non_tmobile_number_mapping_status [String] The assignment status of the number towards other carriers.
+        #
         #   @param tcr_brand_id [String] TCR's alphanumeric ID for the brand.
         #
         #   @param tcr_campaign_id [String] TCR's alphanumeric ID for the campaign.
         #
         #   @param telnyx_campaign_id [String] Campaign ID. Empty if the number is associated to a shared campaign.
+        #
+        #   @param tmobile_number_mapping_status [String] The T-Mobile assignment status of the number.
 
         # The assignment status of the number.
         #

data/lib/telnyx/models/model_metadata.rb

@@ -135,6 +135,14 @@ module Telnyx
       #   @return [Array<String>, nil]
       optional :regions, Telnyx::Internal::Type::ArrayOf[String]
 
+      # @!attribute service_tiers
+      #   Service tiers supported by this Telnyx-hosted model. Use one of these values as
+      #   `service_tier` in Chat Completions or Responses requests. This field is omitted
+      #   for externally hosted models.
+      #
+      #   @return [Array<Symbol, Telnyx::Models::ModelMetadata::ServiceTier>, nil]
+      optional :service_tiers, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::ModelMetadata::ServiceTier] }
+
       # @!attribute task
       #   Primary task the model is intended for, e.g. `text-generation`,
       #   `audio-text-to-text`, `feature-extraction` (embeddings).
@@ -142,7 +150,7 @@ module Telnyx
       #   @return [String, nil]
       optional :task, String
 
-      # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, task: nil)
+      # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, service_tiers: nil, task: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::ModelMetadata} for more details.
       #
@@ -190,6 +198,8 @@ module Telnyx
       #
       #   @param regions [Array<String>] Public region names where the model is currently deployed (e.g. `us-central-1`,
       #
+      #   @param service_tiers [Array<Symbol, Telnyx::Models::ModelMetadata::ServiceTier>] Service tiers supported by this Telnyx-hosted model. Use one of these values as
+      #
       #   @param task [String] Primary task the model is intended for, e.g. `text-generation`, `audio-text-to-t
 
       # Billing tier the model belongs to. Used together with `pricing` to determine
@@ -207,6 +217,17 @@ module Telnyx
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      module ServiceTier
+        extend Telnyx::Internal::Type::Enum
+
+        DEFAULT = :default
+        PRIORITY = :priority
+        FLEX = :flex
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/telnyx/models/offset_meta.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class OffsetMeta < Telnyx::Internal::Type::BaseModel
+      # @!attribute page_number
+      #
+      #   @return [Integer]
+      required :page_number, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute total_pages
+      #
+      #   @return [Integer]
+      required :total_pages, Integer
+
+      # @!attribute total_results
+      #
+      #   @return [Integer]
+      required :total_results, Integer
+
+      # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+      #   @param page_number [Integer]
+      #   @param page_size [Integer]
+      #   @param total_pages [Integer]
+      #   @param total_results [Integer]
+    end
+  end
+end

data/lib/telnyx/models/phone_numbers/action_change_bundle_status_params.rb

@@ -20,8 +20,8 @@ module Telnyx
         #   bundle to another directly. You must first remove it from a bundle, and then
         #   assign it to a new bundle.
         #
-        #   @return [String]
-        required :bundle_id, String
+        #   @return [String, nil]
+        required :bundle_id, String, nil?: true
 
         # @!method initialize(id:, bundle_id:, request_options: {})
         #   Some parameter documentations has been truncated, see
@@ -29,7 +29,7 @@ module Telnyx
         #
         #   @param id [String]
         #
-        #   @param bundle_id [String] The new bundle_id setting for the number. If you are assigning the number to a b
+        #   @param bundle_id [String, nil] The new bundle_id setting for the number. If you are assigning the number to a b
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/telnyx/models/pricing/pricing_pagination_meta.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      class PricingPaginationMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_number
+        #
+        #   @return [Integer]
+        required :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!attribute total_results
+        #
+        #   @return [Integer]
+        required :total_results, Integer
+
+        # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param total_pages [Integer]
+        #   @param total_results [Integer]
+      end
+    end
+
+    PricingPaginationMeta = Pricing::PricingPaginationMeta
+  end
+end

data/lib/telnyx/models/pricing/pricing_tier.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      class PricingTier < Telnyx::Internal::Type::BaseModel
+        # @!attribute max
+        #   Upper bound of the tier (exclusive). Null means no upper limit.
+        #
+        #   @return [Integer, nil]
+        required :max, Integer, nil?: true
+
+        # @!attribute min
+        #   Lower bound of the tier (inclusive).
+        #
+        #   @return [Integer]
+        required :min, Integer
+
+        # @!attribute rate
+        #   Rate for this tier. Numeric for standard products, string for inference
+        #   products.
+        #
+        #   @return [Float, String]
+        required :rate, union: -> { Telnyx::Pricing::PricingTier::Rate }
+
+        # @!method initialize(max:, min:, rate:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Pricing::PricingTier} for more details.
+        #
+        #   @param max [Integer, nil] Upper bound of the tier (exclusive). Null means no upper limit.
+        #
+        #   @param min [Integer] Lower bound of the tier (inclusive).
+        #
+        #   @param rate [Float, String] Rate for this tier. Numeric for standard products, string for inference products
+
+        # Rate for this tier. Numeric for standard products, string for inference
+        # products.
+        #
+        # @see Telnyx::Models::Pricing::PricingTier#rate
+        module Rate
+          extend Telnyx::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+      end
+    end
+
+    PricingTier = Pricing::PricingTier
+  end
+end

data/lib/telnyx/models/pricing/product_list_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      # @see Telnyx::Resources::Pricing::Products#list
+      class ProductListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute page_number
+        #   Page number (1-based).
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of items per page (max 100).
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+        #   @param page_number [Integer] Page number (1-based).
+        #
+        #   @param page_size [Integer] Number of items per page (max 100).
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/pricing/product_list_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      # @see Telnyx::Resources::Pricing::Products#list
+      class ProductListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute description
+        #   Human-readable description of the product.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   Display name of the product.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute slug
+        #   Product identifier used in the per-product pricing endpoint.
+        #
+        #   @return [String]
+        required :slug, String
+
+        # @!method initialize(description:, name:, slug:)
+        #   @param description [String] Human-readable description of the product.
+        #
+        #   @param name [String] Display name of the product.
+        #
+        #   @param slug [String] Product identifier used in the per-product pricing endpoint.
+      end
+    end
+  end
+end