telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/resources/dynamic_emergency_addresses.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Dynamic emergency address operations
     class DynamicEmergencyAddresses
-      # Creates a dynamic emergency address.
+      # Creates a dynamic emergency address, the validated physical location used when
+      # provisioning dynamic emergency endpoints.
       sig do
         params(
           administrative_area: String,

data/rbi/telnyx/resources/dynamic_emergency_endpoints.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Dynamic Emergency Endpoints
     class DynamicEmergencyEndpoints
-      # Creates a dynamic emergency endpoints.
+      # Creates a dynamic emergency endpoint, associating a callback number and location
+      # with a device for emergency calling.
       sig do
         params(
           callback_number: String,

data/rbi/telnyx/resources/email_blocks/{import.rbi → imports.rbi}

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     class EmailBlocks
       # Async CSV import of competitor suppression lists.
-      class Import
+      class Imports
         # Accepts `multipart/form-data` with a `file` field (the CSV) and an optional
         # `block_ttl_days` (integer >0, default 30). Validates:
         #

data/rbi/telnyx/resources/email_blocks.rbi

@@ -5,8 +5,8 @@ module Telnyx
     # Recipient suppression records (`/v2/email_blocks`).
     class EmailBlocks
       # Async CSV import of competitor suppression lists.
-      sig { returns(Telnyx::Resources::EmailBlocks::Import) }
-      attr_reader :import
+      sig { returns(Telnyx::Resources::EmailBlocks::Imports) }
+      attr_reader :imports
 
       # Creates a suppression with `reason: manual_block` and `source: manual`.
       # Caller-supplied `reason` / `source` are **ignored**; `scope` is **derived**
@@ -131,7 +131,11 @@ module Telnyx
           page_number: Integer,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailBlockRetrieveEventsResponse)
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::EmailBlockRetrieveEventsResponse
+          ]
+        )
       end
       def retrieve_events(
         # Resource UUID. Malformed UUIDs are treated as not-found (not 400).

data/rbi/telnyx/resources/email_domains.rbi

@@ -97,9 +97,14 @@ module Telnyx
         filter_domain: nil,
         # Filter by profile UUID
         filter_profile_id: nil,
+        # Filter domains by verification status: pending, verifying, verified, failed,
+        # degraded, or suspended.
         filter_status: nil,
+        # Filter domains by type: custom, shared, or shared_inbound.
         filter_type: nil,
+        # Filter domains by whether they can currently receive inbound email.
         filter_usable_for_inbound: nil,
+        # Filter domains by whether they can currently be used to send email.
         filter_usable_for_sending: nil,
         # Cursor for records after the provided value (cursor pagination)
         page_after: nil,

data/rbi/telnyx/resources/email_events.rbi

@@ -15,7 +15,11 @@ module Telnyx
           page_size: Integer,
           to: Time,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailEventListResponse)
+        ).returns(
+          Telnyx::Internal::EmailCursorPagination[
+            Telnyx::Models::EmailEventListResponse
+          ]
+        )
       end
       def list(
         # Filter events for a specific email message UUID. Invalid UUID values are

data/rbi/telnyx/resources/email_inboxes/drafts.rbi

@@ -15,7 +15,7 @@ module Telnyx
         sig do
           params(
             inbox_id: String,
-            attachments: T::Array[T.anything],
+            attachments: T::Array[T::Hash[Symbol, T.anything]],
             bcc:
               T::Array[
                 T.any(String, Telnyx::EmailInboxes::EmailAddress::OrHash)
@@ -30,7 +30,7 @@ module Telnyx
             html: String,
             html_body: String,
             labels: T::Array[String],
-            metadata: T.anything,
+            metadata: T::Hash[Symbol, T.anything],
             reply_to: String,
             subject: String,
             tags: T::Array[String],
@@ -97,7 +97,7 @@ module Telnyx
           params(
             draft_id: String,
             inbox_id: String,
-            attachments: T::Array[T.anything],
+            attachments: T::Array[T::Hash[Symbol, T.anything]],
             bcc:
               T::Array[
                 T.any(String, Telnyx::EmailInboxes::EmailAddress::OrHash)
@@ -112,7 +112,7 @@ module Telnyx
             html: String,
             html_body: String,
             labels: T::Array[String],
-            metadata: T.anything,
+            metadata: T::Hash[Symbol, T.anything],
             reply_to: String,
             subject: String,
             tags: T::Array[String],
@@ -176,7 +176,11 @@ module Telnyx
             page_after: String,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::EmailInboxes::DraftListResponse)
+          ).returns(
+            Telnyx::Internal::EmailBracketCursorPagination[
+              Telnyx::EmailInboxes::EmailDraft
+            ]
+          )
         end
         def list(
           # Email inbox UUID.
@@ -214,7 +218,7 @@ module Telnyx
           params(
             draft_id: String,
             inbox_id: String,
-            attachments: T::Array[T.anything],
+            attachments: T::Array[T::Hash[Symbol, T.anything]],
             bcc:
               T::Array[
                 T.any(String, Telnyx::EmailInboxes::EmailAddress::OrHash)
@@ -229,7 +233,7 @@ module Telnyx
             html: String,
             html_body: String,
             labels: T::Array[String],
-            metadata: T.anything,
+            metadata: T::Hash[Symbol, T.anything],
             reply_to: String,
             subject: String,
             tags: T::Array[String],

data/rbi/telnyx/resources/email_inboxes/messages/actions.rbi

@@ -23,33 +23,33 @@ module Telnyx
               to:
                 T.any(
                   String,
-                  Telnyx::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1::OrHash,
+                  Telnyx::EmailInboxes::Messages::ActionForwardParams::To::InboxRecipientAddress::OrHash,
                   T::Array[
                     T.any(
                       String,
-                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1::OrHash
+                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress::OrHash
                     )
                   ]
                 ),
               bcc:
                 T.any(
                   String,
-                  Telnyx::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1::OrHash,
+                  Telnyx::EmailInboxes::Messages::InboxActionRecipientInput::InboxRecipientAddress::OrHash,
                   T::Array[
                     T.any(
                       String,
-                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1::OrHash
+                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress::OrHash
                     )
                   ]
                 ),
               cc:
                 T.any(
                   String,
-                  Telnyx::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1::OrHash,
+                  Telnyx::EmailInboxes::Messages::InboxActionRecipientInput::InboxRecipientAddress::OrHash,
                   T::Array[
                     T.any(
                       String,
-                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1::OrHash
+                      Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress::OrHash
                     )
                   ]
                 ),

data/rbi/telnyx/resources/email_inboxes/messages.rbi

@@ -23,11 +23,9 @@ module Telnyx
             message_id: String,
             inbox_id: String,
             read_at:
-              T.nilable(
-                T.any(
-                  Telnyx::EmailInboxes::MessageUpdateParams::ReadAt::OrBoolean,
-                  Time
-                )
+              T.any(
+                Telnyx::EmailInboxes::MessageUpdateParams::ReadAt::ServerReadTime::OrBoolean,
+                Time
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::EmailInboxes::MessageUpdateResponse)
@@ -37,8 +35,7 @@ module Telnyx
           message_id,
           # Path param: Email inbox UUID.
           inbox_id:,
-          # Body param: Set to `true` for server time, an ISO 8601 timestamp for an explicit
-          # read time, or `null` to mark unread.
+          # Body param
           read_at:,
           request_options: {}
         )
@@ -61,7 +58,11 @@ module Telnyx
             page_after: String,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::EmailInboxes::MessageListResponse)
+          ).returns(
+            Telnyx::Internal::EmailBracketCursorPagination[
+              Telnyx::InboundMessage
+            ]
+          )
         end
         def list(
           # Email inbox UUID.
@@ -106,7 +107,7 @@ module Telnyx
           params(
             message_id: String,
             inbox_id: String,
-            attachments: T::Array[T.anything],
+            attachments: T::Array[T::Hash[Symbol, T.anything]],
             bcc:
               T::Array[
                 T.any(String, Telnyx::EmailInboxes::EmailAddress::OrHash)
@@ -121,7 +122,7 @@ module Telnyx
             html: String,
             html_body: String,
             labels: T::Array[String],
-            metadata: T.anything,
+            metadata: T::Hash[Symbol, T.anything],
             reply_to: String,
             subject: String,
             tags: T::Array[String],

data/rbi/telnyx/resources/email_inboxes/threads.rbi

@@ -44,7 +44,11 @@ module Telnyx
             page_after: String,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::EmailInboxes::InboundThreadListResponse)
+          ).returns(
+            Telnyx::Internal::EmailBracketCursorPagination[
+              Telnyx::EmailInboxes::InboundThread
+            ]
+          )
         end
         def list(
           # Email inbox UUID.

data/rbi/telnyx/resources/email_inboxes.rbi

@@ -68,7 +68,7 @@ module Telnyx
           page_cursor: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailInboxListResponse)
+        ).returns(Telnyx::Internal::EmailCursorPagination[Telnyx::EmailInbox])
       end
       def list(
         # Opaque cursor returned by the previous inbox page.

data/rbi/telnyx/resources/email_messages/recipients.rbi

@@ -38,7 +38,11 @@ module Telnyx
             status:
               Telnyx::EmailMessages::RecipientListParams::Status::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::EmailMessages::RecipientListResponse)
+          ).returns(
+            Telnyx::Internal::EmailCursorPagination[
+              Telnyx::EmailMessages::EmailRecipient
+            ]
+          )
         end
         def list(
           # Email message UUID.

data/rbi/telnyx/resources/email_messages.rbi

@@ -180,7 +180,11 @@ module Telnyx
           page_cursor: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailMessageListResponse)
+        ).returns(
+          Telnyx::Internal::EmailCursorPagination[
+            Telnyx::EmailInboxes::EmailMessage
+          ]
+        )
       end
       def list(
         # Opaque URL-safe Base64 cursor returned by a previous list response.
@@ -276,7 +280,7 @@ module Telnyx
           page_cursor: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailMessageRetrieveEventsResponse)
+        ).returns(Telnyx::Internal::EmailCursorPagination[Telnyx::MessageEvent])
       end
       def retrieve_events(
         # Email message UUID.

data/rbi/telnyx/resources/email_templates.rbi

@@ -56,7 +56,8 @@ module Telnyx
       )
       end
 
-      # Updates one or more template fields.
+      # Updates one or more fields of the specified email template and returns the
+      # updated template.
       sig do
         params(
           id: String,
@@ -89,7 +90,9 @@ module Telnyx
           page_cursor: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Models::EmailTemplateListResponse)
+        ).returns(
+          Telnyx::Internal::EmailCursorPagination[Telnyx::EmailTemplate]
+        )
       end
       def list(
         # Opaque URL-safe Base64 cursor returned by a previous list response.

data/rbi/telnyx/resources/email_threads.rbi

@@ -45,7 +45,11 @@ module Telnyx
           page_after: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::EmailInboxes::InboundThreadListResponse)
+        ).returns(
+          Telnyx::Internal::EmailBracketCursorPagination[
+            Telnyx::EmailInboxes::InboundThread
+          ]
+        )
       end
       def list(
         # Restrict results to one or more inboxes. Repeat the parameter

data/rbi/telnyx/resources/email_unsubscribe_groups.rbi

@@ -86,7 +86,7 @@ module Telnyx
           id: String,
           force:
             T.any(
-              Telnyx::EmailUnsubscribeGroupDeleteParams::Force::OrSymbol,
+              Telnyx::EmailUnsubscribeGroupDeleteParams::Force::ForceString::OrSymbol,
               T::Boolean
             ),
           request_options: Telnyx::RequestOptions::OrHash

data/rbi/telnyx/resources/enterprises.rbi

@@ -28,7 +28,7 @@ module Telnyx
       #   your account.
       sig do
         params(
-          billing_address: Telnyx::BillingAddress::OrHash,
+          billing_address: Telnyx::PhysicalAddress::OrHash,
           billing_contact: Telnyx::BillingContact::OrHash,
           country_code: String,
           doing_business_as: String,
@@ -132,7 +132,7 @@ module Telnyx
       sig do
         params(
           enterprise_id: String,
-          billing_address: Telnyx::BillingAddress::OrHash,
+          billing_address: Telnyx::PhysicalAddress::OrHash,
           billing_contact: Telnyx::BillingContact::OrHash,
           corporate_registration_number: T.nilable(String),
           customer_reference: String,

data/rbi/telnyx/resources/faxes.rbi

@@ -101,7 +101,7 @@ module Telnyx
       )
       end
 
-      # Retrieve the details of a single fax.
+      # Returns the details of a single fax, including its current status.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/fqdn_connections.rbi

@@ -8,7 +8,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::FqdnConnections::FqdnAuthentication) }
       attr_reader :fqdn_authentication
 
-      # Creates a FQDN connection.
+      # Creates a new FQDN-based SIP connection. FQDN connections authenticate by your
+      # registered domain names rather than static IP addresses.
       sig do
         params(
           connection_name: String,
@@ -272,7 +273,7 @@ module Telnyx
       )
       end
 
-      # Deletes an FQDN connection.
+      # Permanently deletes the specified FQDN connection from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/fqdns.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # FQDN operations
     class Fqdns
-      # Create a new FQDN object.
+      # Creates a new FQDN record and attaches it to the specified connection.
       sig do
         params(
           connection_id: String,
@@ -44,7 +44,7 @@ module Telnyx
       )
       end
 
-      # Update the details of a specific FQDN.
+      # Updates the details of the specified FQDN record and returns the updated FQDN.
       sig do
         params(
           id: String,
@@ -92,7 +92,7 @@ module Telnyx
       )
       end
 
-      # Delete an FQDN.
+      # Permanently deletes the specified FQDN record from its connection.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/global_ip_allowed_ports.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAllowedPorts
-      # List all Global IP Allowed Ports
+      # Returns the ports allowed for Global IP traffic, for use when configuring Global
+      # IP resources.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::GlobalIPAllowedPortListResponse

data/rbi/telnyx/resources/global_ip_assignments.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignments
-      # Create a Global IP assignment.
+      # Assigns a Global IP to a WireGuard peer so traffic destined for the IP is
+      # delivered over that peer's tunnel. Assignment is asynchronous, so the request is
+      # accepted and completes in the background.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::GlobalIPAssignmentCreateResponse
@@ -13,7 +15,8 @@ module Telnyx
       def create(request_options: {})
       end
 
-      # Retrieve a Global IP assignment.
+      # Returns the details of a single Global IP assignment, including the Global IP
+      # and WireGuard peer it links.
       sig do
         params(
           id: String,
@@ -27,7 +30,8 @@ module Telnyx
       )
       end
 
-      # Update a Global IP assignment.
+      # Updates the specified Global IP assignment with the provided fields and returns
+      # the updated assignment.
       sig do
         params(
           global_ip_assignment_id: String,
@@ -44,7 +48,8 @@ module Telnyx
       )
       end
 
-      # List all Global IP assignments.
+      # Returns a paginated list of your Global IP assignments, the links between Global
+      # IPs and the WireGuard peers that receive their traffic.
       sig do
         params(
           page_number: Integer,
@@ -57,7 +62,8 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a Global IP assignment.
+      # Deletes the specified Global IP assignment, detaching the Global IP from its
+      # WireGuard peer.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/global_ip_health_check_types.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPHealthCheckTypes
-      # List all Global IP Health check types.
+      # Returns the health check types available for Global IPs, for use when creating
+      # Global IP health checks.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::GlobalIPHealthCheckTypeListResponse

data/rbi/telnyx/resources/global_ip_health_checks.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPHealthChecks
-      # Create a Global IP health check.
+      # Creates a health check for a Global IP to monitor the health of its assignments.
+      # Creation is asynchronous, so the request is accepted and the health check
+      # becomes active once provisioning completes.
       sig do
         params(
           global_ip_id: String,
@@ -24,7 +26,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a Global IP health check.
+      # Returns the details of a single Global IP health check, including its type and
+      # configuration.
       sig do
         params(
           id: String,
@@ -38,7 +41,8 @@ module Telnyx
       )
       end
 
-      # List all Global IP health checks.
+      # Returns a paginated list of the Global IP health checks configured on your
+      # account.
       sig do
         params(
           page_number: Integer,
@@ -51,7 +55,8 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a Global IP health check.
+      # Deletes the specified Global IP health check so it no longer monitors the Global
+      # IP's assignments.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/global_ip_protocols.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPProtocols
-      # List all Global IP Protocols
+      # Returns the network protocols supported for Global IP traffic, for use when
+      # configuring Global IP resources.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::GlobalIPProtocolListResponse

data/rbi/telnyx/resources/global_ips.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPs
-      # Create a Global IP.
+      # Requests creation of a new Global IP, a static IP address announced from the
+      # Telnyx network. Provisioning is asynchronous, so the request is accepted and the
+      # Global IP becomes available once provisioning completes.
       sig do
         params(
           description: String,
@@ -24,7 +26,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a Global IP.
+      # Returns the details of a single Global IP, including its address and current
+      # configuration.
       sig do
         params(
           id: String,
@@ -38,7 +41,8 @@ module Telnyx
       )
       end
 
-      # List all Global IPs.
+      # Returns a paginated list of the Global IPs on your account, including each IP's
+      # address and configuration.
       sig do
         params(
           page_number: Integer,
@@ -49,7 +53,7 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a Global IP.
+      # Deletes the specified Global IP and releases its address back to Telnyx.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/invoices.rbi

@@ -20,7 +20,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a paginated list of invoices.
+      # Returns a paginated list of your invoices, with support for sorting.
       sig do
         params(
           page_number: Integer,

data/rbi/telnyx/resources/ip_connections.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # IP connection operations
     class IPConnections
-      # Creates an IP connection.
+      # Creates a new IP-based SIP connection, which authenticates traffic by source IP
+      # address.
       sig do
         params(
           active: T::Boolean,
@@ -228,7 +229,8 @@ module Telnyx
       )
       end
 
-      # Returns a list of your IP connections.
+      # Returns a paginated list of your IP-based SIP connections, with support for
+      # filtering and sorting.
       sig do
         params(
           filter: Telnyx::IPConnectionListParams::Filter::OrHash,
@@ -264,7 +266,7 @@ module Telnyx
       )
       end
 
-      # Deletes an existing IP connection.
+      # Permanently deletes the specified IP connection from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/ips.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # IP operations
     class IPs
-      # Create a new IP object.
+      # Creates a new IP record for use with IP-based connections, associating an IP
+      # address with the specified connection.
       sig do
         params(
           ip_address: String,
@@ -38,7 +39,7 @@ module Telnyx
       )
       end
 
-      # Update the details of a specific IP.
+      # Updates the details of the specified IP record and returns the updated IP.
       sig do
         params(
           id: String,
@@ -80,7 +81,7 @@ module Telnyx
       )
       end
 
-      # Delete an IP.
+      # Permanently deletes the specified IP record from its connection.
       sig do
         params(
           id: String,