telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/messages/rc_send_params.rb

@@ -53,7 +53,12 @@ module Telnyx
         #   @return [String, nil]
         optional :webhook_url, String
 
-        # @!method initialize(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(agent_id:, agent_message:, messaging_profile_id:, to:, mms_fallback: nil, sms_fallback: nil, type: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
         #   @param agent_id [String] RCS Agent ID
         #
         #   @param agent_message [Telnyx::Models::RcsAgentMessage]
@@ -70,6 +75,8 @@ module Telnyx
         #
         #   @param webhook_url [String] The URL where webhooks related to this message will be sent.
         #
+        #   @param idempotency_key [String]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         class MmsFallback < Telnyx::Internal::Type::BaseModel

data/lib/telnyx/models/messaging_inbound_message_payload.rb

@@ -274,11 +274,20 @@ module Telnyx
         optional :foreign_id, String
 
         # @!attribute from
-        #   WhatsApp sender in E.164 format.
+        #   WhatsApp sender in E.164 format. Empty when the user hides their phone number;
+        #   `from_user_id` then identifies the sender.
         #
         #   @return [String, nil]
         optional :from, String
 
+        # @!attribute from_user_id
+        #   Business-scoped user ID (BSUID) of the WhatsApp sender when Meta provides one,
+        #   for example `US.13491208655302741918`. When `from` is empty, pass this value as
+        #   `to` to reply.
+        #
+        #   @return [String, nil]
+        optional :from_user_id, String
+
         # @!attribute location
         #   Location shared in an RCS message.
         #
@@ -322,7 +331,7 @@ module Telnyx
         #   @return [Telnyx::Models::MessagingInboundMessagePayload::Body::UserFile, nil]
         optional :user_file, -> { Telnyx::MessagingInboundMessagePayload::Body::UserFile }
 
-        # @!method initialize(id: nil, edit: nil, foreign_id: nil, from: nil, location: nil, revoke: nil, suggestion_response: nil, text: nil, timestamp: nil, type: nil, user_file: nil)
+        # @!method initialize(id: nil, edit: nil, foreign_id: nil, from: nil, from_user_id: nil, location: nil, revoke: nil, suggestion_response: nil, text: nil, timestamp: nil, type: nil, user_file: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::MessagingInboundMessagePayload::Body} for more details.
         #
@@ -336,7 +345,9 @@ module Telnyx
         #
         #   @param foreign_id [String] Meta WhatsApp message identifier for this webhook event.
         #
-        #   @param from [String] WhatsApp sender in E.164 format.
+        #   @param from [String] WhatsApp sender in E.164 format. Empty when the user hides their phone number; `
+        #
+        #   @param from_user_id [String] Business-scoped user ID (BSUID) of the WhatsApp sender when Meta provides one, f
         #
         #   @param location [Telnyx::Models::MessagingInboundMessagePayload::Body::Location] Location shared in an RCS message.
         #

data/lib/telnyx/models/messaging_messaging_profile.rb

@@ -50,6 +50,12 @@ module Telnyx
       #   @return [String, nil]
       optional :health_webhook_url, String, nil?: true
 
+      # @!attribute mm7_metadata
+      #   MM7 settings for inbound messages
+      #
+      #   @return [Telnyx::Models::Mm7Metadata, nil]
+      optional :mm7_metadata, -> { Telnyx::Mm7Metadata }, nil?: true
+
       # @!attribute mms_fall_back_to_sms
       #   enables SMS fallback for MMS messages.
       #
@@ -195,7 +201,7 @@ module Telnyx
         optional :updated_at, Time
       end
 
-      # @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
+      # @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mm7_metadata: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingMessagingProfile} for more details.
       #
@@ -217,6 +223,8 @@ module Telnyx
       #
       #   @param health_webhook_url [String, nil] DEPRECATED: health check url service checking
       #
+      #   @param mm7_metadata [Telnyx::Models::Mm7Metadata, nil] MM7 settings for inbound messages
+      #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
       #
       #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.

data/lib/telnyx/models/messaging_outbound_message_payload.rb

@@ -10,7 +10,8 @@ module Telnyx
       optional :id, String
 
       # @!attribute body
-      #   RCS webhook message body. Text messages use the text property.
+      #   Message body for RCS and WhatsApp. RCS text messages use the text property.
+      #   WhatsApp messages contain the `whatsapp_message` object from the send request.
       #
       #   @return [Telnyx::Models::MessagingOutboundMessagePayload::Body, nil]
       optional :body, -> { Telnyx::MessagingOutboundMessagePayload::Body }
@@ -20,6 +21,14 @@ module Telnyx
       #   @return [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>, nil]
       optional :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingOutboundMessagePayload::Cc] }
 
+      # @!attribute child_message_id
+      #   Identifies the next chunk when server-side SMS chunking
+      #   (`auto_chunk_long_messages` on the messaging profile) split this message. Always
+      #   present; null on non-chunked messages and on the final chunk.
+      #
+      #   @return [String, nil]
+      optional :child_message_id, String, nil?: true
+
       # @!attribute completed_at
       #   ISO 8601 formatted date indicating when the message was finalized.
       #
@@ -85,6 +94,15 @@ module Telnyx
       #   @return [String, nil]
       optional :organization_id, String
 
+      # @!attribute parent_message_id
+      #   Identifies the original request's message when server-side SMS chunking
+      #   (`auto_chunk_long_messages` on the messaging profile) split it into chunks. The
+      #   first chunk's ID is the original request's message ID. Always present; null when
+      #   this message is not part of a chunked send.
+      #
+      #   @return [String, nil]
+      optional :parent_message_id, String, nil?: true
+
       # @!attribute parts
       #   Number of parts into which the message's body must be split.
       #
@@ -148,6 +166,19 @@ module Telnyx
       #   @return [String, nil]
       optional :tcr_campaign_registered, String, nil?: true
 
+      # @!attribute template_id
+      #   Telnyx ID of the WhatsApp template used by the message, when known.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute template_name
+      #   Name of the WhatsApp template used by the message. Present for WhatsApp template
+      #   messages.
+      #
+      #   @return [String, nil]
+      optional :template_name, String
+
       # @!attribute text
       #   Message body (i.e., content) as a non-empty string.
       #
@@ -196,16 +227,18 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
+      # @!method initialize(id: nil, body: nil, cc: nil, child_message_id: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parent_message_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, template_id: nil, template_name: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingOutboundMessagePayload} for more details.
       #
       #   @param id [String] Identifies the type of resource.
       #
-      #   @param body [Telnyx::Models::MessagingOutboundMessagePayload::Body] RCS webhook message body. Text messages use the text property.
+      #   @param body [Telnyx::Models::MessagingOutboundMessagePayload::Body] Message body for RCS and WhatsApp. RCS text messages use the text property. What
       #
       #   @param cc [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>]
       #
+      #   @param child_message_id [String, nil] Identifies the next chunk when server-side SMS chunking (`auto_chunk_long_messag
+      #
       #   @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
       #
       #   @param cost [Telnyx::Models::MessagingOutboundMessagePayload::Cost, nil]
@@ -228,6 +261,8 @@ module Telnyx
       #
       #   @param organization_id [String] The id of the organization the messaging profile belongs to.
       #
+      #   @param parent_message_id [String, nil] Identifies the original request's message when server-side SMS chunking (`auto_c
+      #
       #   @param parts [Integer] Number of parts into which the message's body must be split.
       #
       #   @param received_at [Time] ISO 8601 formatted date indicating when the message request was received.
@@ -248,6 +283,10 @@ module Telnyx
       #
       #   @param tcr_campaign_registered [String, nil] The registration status of the TCR campaign.
       #
+      #   @param template_id [String] Telnyx ID of the WhatsApp template used by the message, when known.
+      #
+      #   @param template_name [String] Name of the WhatsApp template used by the message. Present for WhatsApp template
+      #
       #   @param text [String] Message body (i.e., content) as a non-empty string.
       #
       #   @param to [Array<Telnyx::Models::MessagingOutboundMessagePayload::To>]
@@ -271,7 +310,8 @@ module Telnyx
         optional :text, String
 
         # @!method initialize(text: nil)
-        #   RCS webhook message body. Text messages use the text property.
+        #   Message body for RCS and WhatsApp. RCS text messages use the text property.
+        #   WhatsApp messages contain the `whatsapp_message` object from the send request.
         #
         #   @param text [String] RCS text message.
       end
@@ -628,6 +668,7 @@ module Telnyx
         SMS = :SMS
         MMS = :MMS
         RCS = :RCS
+        WHATSAPP = :WHATSAPP
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/messaging_profile_create_params.rb

@@ -67,6 +67,12 @@ module Telnyx
       #   @return [String, nil]
       optional :health_webhook_url, String, nil?: true
 
+      # @!attribute mm7_metadata
+      #   MM7 settings for inbound messages
+      #
+      #   @return [Telnyx::Models::Mm7Metadata, nil]
+      optional :mm7_metadata, -> { Telnyx::Mm7Metadata }, nil?: true
+
       # @!attribute mms_fall_back_to_sms
       #   enables SMS fallback for MMS messages.
       #
@@ -141,7 +147,7 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mm7_metadata: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileCreateParams} for more details.
       #
@@ -163,6 +169,8 @@ module Telnyx
       #
       #   @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
       #
+      #   @param mm7_metadata [Telnyx::Models::Mm7Metadata, nil] MM7 settings for inbound messages
+      #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
       #
       #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.

data/lib/telnyx/models/messaging_profile_features.rb

@@ -12,7 +12,20 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :ai_opt_out_detection_enabled, Telnyx::Internal::Type::Boolean
 
-      # @!method initialize(ai_opt_out_detection_enabled: nil)
+      # @!attribute auto_chunk_long_messages
+      #   Enables server-side chunking of outbound SMS. When enabled, an outbound message
+      #   that exceeds the maximum number of segments allowed for its destination (10
+      #   segments by default; some aggregators accept up to 25) is automatically split
+      #   into multiple child messages, each within the segment limit, and sent
+      #   sequentially in order. Splitting is encoding-aware: GSM-7 bodies split at
+      #   153-character boundaries and UCS-2 bodies at 134-byte (67-character) boundaries.
+      #   When disabled (the default), messages exceeding the segment limit are rejected
+      #   with an error.
+      #
+      #   @return [Boolean, nil]
+      optional :auto_chunk_long_messages, Telnyx::Internal::Type::Boolean
+
+      # @!method initialize(ai_opt_out_detection_enabled: nil, auto_chunk_long_messages: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileFeatures} for more details.
       #
@@ -21,6 +34,8 @@ module Telnyx
       #   preserved for forward compatibility with rolling deployments.
       #
       #   @param ai_opt_out_detection_enabled [Boolean] Enables AI detection of inbound opt-out messages that do not follow the standard
+      #
+      #   @param auto_chunk_long_messages [Boolean] Enables server-side chunking of outbound SMS. When enabled, an outbound message
     end
   end
 end

data/lib/telnyx/models/messaging_profile_update_params.rb

@@ -52,6 +52,12 @@ module Telnyx
       #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
       optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
 
+      # @!attribute mm7_metadata
+      #   MM7 settings for inbound messages
+      #
+      #   @return [Telnyx::Models::Mm7Metadata, nil]
+      optional :mm7_metadata, -> { Telnyx::Mm7Metadata }, nil?: true
+
       # @!attribute mms_fall_back_to_sms
       #   enables SMS fallback for MMS messages.
       #
@@ -159,7 +165,7 @@ module Telnyx
       #   @return [Array<String>, nil]
       optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
+      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mm7_metadata: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileUpdateParams} for more details.
       #
@@ -177,6 +183,8 @@ module Telnyx
       #
       #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
       #
+      #   @param mm7_metadata [Telnyx::Models::Mm7Metadata, nil] MM7 settings for inbound messages
+      #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
       #
       #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.

data/lib/telnyx/models/mm7_metadata.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class Mm7Metadata < Telnyx::Internal::Type::BaseModel
+      # @!attribute mm7_failover_webhook_url
+      #   Failover webhook URL to receive inbound MM7 traffic
+      #
+      #   @return [String, nil]
+      optional :mm7_failover_webhook_url, String
+
+      # @!attribute mm7_webhook_url
+      #   Webhook URL to receive inbound MM7 traffic
+      #
+      #   @return [String, nil]
+      optional :mm7_webhook_url, String
+
+      # @!method initialize(mm7_failover_webhook_url: nil, mm7_webhook_url: nil)
+      #   MM7 settings for inbound messages
+      #
+      #   @param mm7_failover_webhook_url [String] Failover webhook URL to receive inbound MM7 traffic
+      #
+      #   @param mm7_webhook_url [String] Webhook URL to receive inbound MM7 traffic
+    end
+  end
+end

data/lib/telnyx/models/model_metadata.rb

@@ -72,6 +72,13 @@ module Telnyx
       #   @return [String, nil]
       optional :base_model, String, nil?: true
 
+      # @!attribute beta
+      #   Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
+      #   the label is removed once the model is established.
+      #
+      #   @return [Boolean, nil]
+      optional :beta, Telnyx::Internal::Type::Boolean
+
       # @!attribute description
       #   Short, human-readable summary of what the model is best suited for.
       #
@@ -156,7 +163,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, service_tiers: nil, task: nil)
+      # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, beta: 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.
       #
@@ -186,6 +193,8 @@ module Telnyx
       #
       #   @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
       #
+      #   @param beta [Boolean] Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
+      #
       #   @param description [String, nil] Short, human-readable summary of what the model is best suited for.
       #
       #   @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f

data/lib/telnyx/models/netapps_cursor_pagination_meta.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class NetappsCursorPaginationMeta < Telnyx::Internal::Type::BaseModel
+      # @!attribute cursors
+      #   Opaque cursors. Absent keys mean there is no such page.
+      #
+      #   @return [Telnyx::Models::NetappsCursorPaginationMeta::Cursors, nil]
+      optional :cursors, -> { Telnyx::NetappsCursorPaginationMeta::Cursors }
+
+      # @!attribute next_
+      #   The path of the next page, with the same query parameters. Absent on the last
+      #   page.
+      #
+      #   @return [String, nil]
+      optional :next_, String, api_name: :next
+
+      # @!attribute previous
+      #   The path of the previous page. Present when the request used `page[after]`.
+      #
+      #   @return [String, nil]
+      optional :previous, String
+
+      # @!method initialize(cursors: nil, next_: nil, previous: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::NetappsCursorPaginationMeta} for more details.
+      #
+      #   @param cursors [Telnyx::Models::NetappsCursorPaginationMeta::Cursors] Opaque cursors. Absent keys mean there is no such page.
+      #
+      #   @param next_ [String] The path of the next page, with the same query parameters. Absent on the last pa
+      #
+      #   @param previous [String] The path of the previous page. Present when the request used `page[after]`.
+
+      # @see Telnyx::Models::NetappsCursorPaginationMeta#cursors
+      class Cursors < Telnyx::Internal::Type::BaseModel
+        # @!attribute after
+        #   Pass as `page[after]` to fetch the next page. Absent on the last page.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute before
+        #   The cursor of the previous page. Present when the request used `page[after]`.
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!method initialize(after: nil, before: nil)
+        #   Opaque cursors. Absent keys mean there is no such page.
+        #
+        #   @param after [String] Pass as `page[after]` to fetch the next page. Absent on the last page.
+        #
+        #   @param before [String] The cursor of the previous page. Present when the request used `page[after]`.
+      end
+    end
+  end
+end

data/lib/telnyx/models/network_route.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class NetworkRoute < Telnyx::Internal::Type::BaseModel
+      # @!attribute cidr
+      #   The IPv4 CIDR the route covers.
+      #
+      #   @return [String, nil]
+      optional :cidr, String
+
+      # @!attribute network_id
+      #   The id of the Network the route belongs to.
+      #
+      #   @return [String, nil]
+      optional :network_id, String
+
+      # @!attribute next_hop
+      #   Where the Network sends traffic for the route's CIDR.
+      #
+      #   @return [Telnyx::Models::NetworkRoute::NextHop, nil]
+      optional :next_hop, -> { Telnyx::NetworkRoute::NextHop }
+
+      response_only do
+        # @!attribute id
+        #   Identifies the resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date-time indicating when the resource was created.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute origin
+        #   `static` for a route added with `POST /network_routes`, `attachment` for a route
+        #   that another resource installed and removes.
+        #
+        #   @return [Symbol, Telnyx::Models::NetworkRoute::Origin, nil]
+        optional :origin, enum: -> { Telnyx::NetworkRoute::Origin }
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute status
+        #   `pending` until Telnyx installs the route on the Network, then `active`.
+        #   `inactive` while a tunnel next hop has no connected process. `failed` (Preview,
+        #   not reported yet) when Telnyx could not install the route.
+        #
+        #   @return [Symbol, Telnyx::Models::NetworkRoute::Status, nil]
+        optional :status, enum: -> { Telnyx::NetworkRoute::Status }
+      end
+
+      # @!method initialize(id: nil, cidr: nil, created_at: nil, network_id: nil, next_hop: nil, origin: nil, record_type: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::NetworkRoute} for more details.
+      #
+      #   @param id [String] Identifies the resource.
+      #
+      #   @param cidr [String] The IPv4 CIDR the route covers.
+      #
+      #   @param created_at [Time] ISO 8601 formatted date-time indicating when the resource was created.
+      #
+      #   @param network_id [String] The id of the Network the route belongs to.
+      #
+      #   @param next_hop [Telnyx::Models::NetworkRoute::NextHop] Where the Network sends traffic for the route's CIDR.
+      #
+      #   @param origin [Symbol, Telnyx::Models::NetworkRoute::Origin] `static` for a route added with `POST /network_routes`, `attachment` for a route
+      #
+      #   @param record_type [String] Identifies the type of the resource.
+      #
+      #   @param status [Symbol, Telnyx::Models::NetworkRoute::Status] `pending` until Telnyx installs the route on the Network, then `active`. `inacti
+
+      # @see Telnyx::Models::NetworkRoute#next_hop
+      class NextHop < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   The id of the tunnel or attachment.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute type
+        #   The type of the next hop. Routes added with `POST /network_routes` use `tunnel`.
+        #   Routes that attachments install carry the attachment's type.
+        #
+        #   @return [Symbol, Telnyx::Models::NetworkRoute::NextHop::Type]
+        required :type, enum: -> { Telnyx::NetworkRoute::NextHop::Type }
+
+        # @!method initialize(id:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::NetworkRoute::NextHop} for more details.
+        #
+        #   Where the Network sends traffic for the route's CIDR.
+        #
+        #   @param id [String] The id of the tunnel or attachment.
+        #
+        #   @param type [Symbol, Telnyx::Models::NetworkRoute::NextHop::Type] The type of the next hop. Routes added with `POST /network_routes` use `tunnel`.
+
+        # The type of the next hop. Routes added with `POST /network_routes` use `tunnel`.
+        # Routes that attachments install carry the attachment's type.
+        #
+        # @see Telnyx::Models::NetworkRoute::NextHop#type
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TUNNEL = :tunnel
+          WIREGUARD_PEER = :wireguard_peer
+          WIREGUARD_INTERFACE = :wireguard_interface
+          PRIVATE_WIRELESS_GATEWAY = :private_wireless_gateway
+          VIRTUAL_CROSS_CONNECT = :virtual_cross_connect
+          IPSEC_TUNNEL = :ipsec_tunnel
+          PUBLIC_INTERNET_GATEWAY = :public_internet_gateway
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # `static` for a route added with `POST /network_routes`, `attachment` for a route
+      # that another resource installed and removes.
+      #
+      # @see Telnyx::Models::NetworkRoute#origin
+      module Origin
+        extend Telnyx::Internal::Type::Enum
+
+        STATIC = :static
+        ATTACHMENT = :attachment
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # `pending` until Telnyx installs the route on the Network, then `active`.
+      # `inactive` while a tunnel next hop has no connected process. `failed` (Preview,
+      # not reported yet) when Telnyx could not install the route.
+      #
+      # @see Telnyx::Models::NetworkRoute#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        PENDING = :pending
+        ACTIVE = :active
+        INACTIVE = :inactive
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/network_route_create_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::NetworkRoutes#create
+    class NetworkRouteCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute cidr
+      #   The IPv4 subnet to route, such as a subnet behind the tunnel. It must be a
+      #   canonical CIDR. Default, loopback, link-local, multicast, and shared address
+      #   space (`100.64.0.0/10`) ranges are rejected. So are ranges that overlap the
+      #   Tailscale Subnet Router ranges, `172.27.254.0/24` and `198.18.0.0/20`, or a
+      #   subnet already on the Network.
+      #
+      #   @return [String]
+      required :cidr, String
+
+      # @!attribute network_id
+      #   The id of the Network to add the route to.
+      #
+      #   @return [String]
+      required :network_id, String
+
+      # @!attribute next_hop
+      #   Where the Network sends traffic for `cidr`.
+      #
+      #   @return [Telnyx::Models::NetworkRouteCreateParams::NextHop]
+      required :next_hop, -> { Telnyx::NetworkRouteCreateParams::NextHop }
+
+      # @!method initialize(cidr:, network_id:, next_hop:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::NetworkRouteCreateParams} for more details.
+      #
+      #   @param cidr [String] The IPv4 subnet to route, such as a subnet behind the tunnel. It must be a canon
+      #
+      #   @param network_id [String] The id of the Network to add the route to.
+      #
+      #   @param next_hop [Telnyx::Models::NetworkRouteCreateParams::NextHop] Where the Network sends traffic for `cidr`.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class NextHop < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   The id of the tunnel.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute type
+        #   The type of the next hop.
+        #
+        #   @return [Symbol, Telnyx::Models::NetworkRouteCreateParams::NextHop::Type]
+        required :type, enum: -> { Telnyx::NetworkRouteCreateParams::NextHop::Type }
+
+        # @!method initialize(id:, type:)
+        #   Where the Network sends traffic for `cidr`.
+        #
+        #   @param id [String] The id of the tunnel.
+        #
+        #   @param type [Symbol, Telnyx::Models::NetworkRouteCreateParams::NextHop::Type] The type of the next hop.
+
+        # The type of the next hop.
+        #
+        # @see Telnyx::Models::NetworkRouteCreateParams::NextHop#type
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TUNNEL = :tunnel
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end