telnyx 5.162.0 → 5.164.0

data/lib/telnyx/resources/dynamic_emergency_endpoints.rb

@@ -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.
       #
       # @overload create(callback_number:, caller_name:, dynamic_emergency_address_id:, request_options: {})
       #

data/lib/telnyx/resources/email_blocks/{import.rb → imports.rb}

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     class EmailBlocks
       # Async CSV import of competitor suppression lists.
-      class Import
+      class Imports
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::EmailBlocks::ImportCreateParams} for more details.
         #

data/lib/telnyx/resources/email_blocks.rb

@@ -5,8 +5,8 @@ module Telnyx
     # Recipient suppression records (`/v2/email_blocks`).
     class EmailBlocks
       # Async CSV import of competitor suppression lists.
-      # @return [Telnyx::Resources::EmailBlocks::Import]
-      attr_reader :import
+      # @return [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**
@@ -165,7 +165,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailBlockRetrieveEventsResponse]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::EmailBlockRetrieveEventsResponse>]
       #
       # @see Telnyx::Models::EmailBlockRetrieveEventsParams
       def retrieve_events(id, params = {})
@@ -175,6 +175,7 @@ module Telnyx
           method: :get,
           path: ["email_blocks/%1$s/events", id],
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+          page: Telnyx::Internal::DefaultFlatPagination,
           model: Telnyx::Models::EmailBlockRetrieveEventsResponse,
           options: options
         )
@@ -243,7 +244,7 @@ module Telnyx
       # @param client [Telnyx::Client]
       def initialize(client:)
         @client = client
-        @import = Telnyx::Resources::EmailBlocks::Import.new(client: client)
+        @imports = Telnyx::Resources::EmailBlocks::Imports.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/email_domains.rb

@@ -95,6 +95,9 @@ module Telnyx
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailDomainListParams} for more details.
+      #
       # Shared (`type: shared`) Telnyx-managed domains are included/readable for every
       # account, in addition to the account's own custom domains.
       #
@@ -104,13 +107,13 @@ module Telnyx
       #
       # @param filter_profile_id [String] Filter by profile UUID
       #
-      # @param filter_status [Symbol, Telnyx::Models::EmailDomainStatus]
+      # @param filter_status [Symbol, Telnyx::Models::EmailDomainStatus] Filter domains by verification status: pending, verifying, verified, failed, deg
       #
-      # @param filter_type [Symbol, Telnyx::Models::EmailDomainType]
+      # @param filter_type [Symbol, Telnyx::Models::EmailDomainType] Filter domains by type: custom, shared, or shared_inbound.
       #
-      # @param filter_usable_for_inbound [Boolean]
+      # @param filter_usable_for_inbound [Boolean] Filter domains by whether they can currently receive inbound email.
       #
-      # @param filter_usable_for_sending [Boolean]
+      # @param filter_usable_for_sending [Boolean] Filter domains by whether they can currently be used to send email.
       #
       # @param page_after [String] Cursor for records after the provided value (cursor pagination)
       #

data/lib/telnyx/resources/email_events.rb

@@ -26,7 +26,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailEventListResponse]
+      # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::EmailEventListResponse>]
       #
       # @see Telnyx::Models::EmailEventListParams
       def list(params = {})
@@ -36,6 +36,7 @@ module Telnyx
           method: :get,
           path: "email_events",
           query: query,
+          page: Telnyx::Internal::EmailCursorPagination,
           model: Telnyx::Models::EmailEventListResponse,
           options: options
         )

data/lib/telnyx/resources/email_inboxes/drafts.rb

@@ -17,7 +17,7 @@ module Telnyx
         #
         # @param inbox_id [String] Email inbox UUID.
         #
-        # @param attachments [Array<Object>]
+        # @param attachments [Array<Hash{Symbol=>Object}>]
         #
         # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>]
         #
@@ -35,7 +35,7 @@ module Telnyx
         #
         # @param labels [Array<String>]
         #
-        # @param metadata [Object]
+        # @param metadata [Hash{Symbol=>Object}]
         #
         # @param reply_to [String]
         #
@@ -107,7 +107,7 @@ module Telnyx
         #
         # @param inbox_id [String] Path param: Email inbox UUID.
         #
-        # @param attachments [Array<Object>] Body param
+        # @param attachments [Array<Hash{Symbol=>Object}>] Body param
         #
         # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
         #
@@ -125,7 +125,7 @@ module Telnyx
         #
         # @param labels [Array<String>] Body param
         #
-        # @param metadata [Object] Body param
+        # @param metadata [Hash{Symbol=>Object}] Body param
         #
         # @param reply_to [String] Body param
         #
@@ -174,7 +174,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::EmailInboxes::DraftListResponse]
+        # @return [Telnyx::Internal::EmailBracketCursorPagination<Telnyx::Models::EmailInboxes::EmailDraft>]
         #
         # @see Telnyx::Models::EmailInboxes::DraftListParams
         def list(inbox_id, params = {})
@@ -188,7 +188,8 @@ module Telnyx
               page_after: "page[after]",
               page_size: "page[size]"
             ),
-            model: Telnyx::Models::EmailInboxes::DraftListResponse,
+            page: Telnyx::Internal::EmailBracketCursorPagination,
+            model: Telnyx::EmailInboxes::EmailDraft,
             options: options
           )
         end
@@ -229,7 +230,7 @@ module Telnyx
         #
         # @param inbox_id [String] Path param: Email inbox UUID.
         #
-        # @param attachments [Array<Object>] Body param
+        # @param attachments [Array<Hash{Symbol=>Object}>] Body param
         #
         # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
         #
@@ -247,7 +248,7 @@ module Telnyx
         #
         # @param labels [Array<String>] Body param
         #
-        # @param metadata [Object] Body param
+        # @param metadata [Hash{Symbol=>Object}] Body param
         #
         # @param reply_to [String] Body param
         #

data/lib/telnyx/resources/email_inboxes/messages/actions.rb

@@ -26,11 +26,11 @@ module Telnyx
           #
           # @param inbox_id [String] Path param: Email inbox UUID.
           #
-          # @param to [String, Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] Body param: One recipient or a non-empty recipient array. Each recipient may be
+          # @param to [String, Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::InboxRecipientAddress, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress>] Body param: One recipient or a non-empty recipient array. Each recipient may be
           #
-          # @param bcc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] Body param: One recipient or a recipient array. Each recipient may be an email s
+          # @param bcc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::InboxRecipientAddress, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress>] Body param: One recipient or a recipient array. Each recipient may be an email s
           #
-          # @param cc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] Body param: One recipient or a recipient array. Each recipient may be an email s
+          # @param cc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::InboxRecipientAddress, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::InboxRecipientAddress>] Body param: One recipient or a recipient array. Each recipient may be an email s
           #
           # @param html [String] Body param: Optional HTML note prepended to the generated forwarded-message bloc
           #

data/lib/telnyx/resources/email_inboxes/messages.rb

@@ -14,9 +14,6 @@ module Telnyx
         # @return [Telnyx::Resources::EmailInboxes::Messages::Labels]
         attr_reader :labels
 
-        # Some parameter documentations has been truncated, see
-        # {Telnyx::Models::EmailInboxes::MessageUpdateParams} for more details.
-        #
         # Updates the explicit read state of an account-scoped inbound message. Set
         # `read_at` to `true` to mark the message read at the server's current time, to an
         # ISO 8601 timestamp to use that timestamp, or to `null` to mark the message
@@ -28,7 +25,7 @@ module Telnyx
         #
         # @param inbox_id [String] Path param: Email inbox UUID.
         #
-        # @param read_at [Boolean, Time, Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt, nil] Body param: Set to `true` for server time, an ISO 8601 timestamp for an explicit
+        # @param read_at [Boolean, Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt::ServerReadTime, Time] Body param
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -83,7 +80,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::EmailInboxes::MessageListResponse]
+        # @return [Telnyx::Internal::EmailBracketCursorPagination<Telnyx::Models::InboundMessage>]
         #
         # @see Telnyx::Models::EmailInboxes::MessageListParams
         def list(inbox_id, params = {})
@@ -104,7 +101,8 @@ module Telnyx
               page_after: "page[after]",
               page_size: "page[size]"
             ),
-            model: Telnyx::Models::EmailInboxes::MessageListResponse,
+            page: Telnyx::Internal::EmailBracketCursorPagination,
+            model: Telnyx::InboundMessage,
             options: options
           )
         end
@@ -125,7 +123,7 @@ module Telnyx
         #
         # @param inbox_id [String] Path param: Email inbox UUID.
         #
-        # @param attachments [Array<Object>] Body param
+        # @param attachments [Array<Hash{Symbol=>Object}>] Body param
         #
         # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
         #
@@ -143,7 +141,7 @@ module Telnyx
         #
         # @param labels [Array<String>] Body param
         #
-        # @param metadata [Object] Body param
+        # @param metadata [Hash{Symbol=>Object}] Body param
         #
         # @param reply_to [String] Body param
         #

data/lib/telnyx/resources/email_inboxes/threads.rb

@@ -65,7 +65,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::EmailInboxes::InboundThreadListResponse]
+        # @return [Telnyx::Internal::EmailBracketCursorPagination<Telnyx::Models::EmailInboxes::InboundThread>]
         #
         # @see Telnyx::Models::EmailInboxes::ThreadListParams
         def list(inbox_id, params = {})
@@ -79,7 +79,8 @@ module Telnyx
               page_after: "page[after]",
               page_size: "page[size]"
             ),
-            model: Telnyx::EmailInboxes::InboundThreadListResponse,
+            page: Telnyx::Internal::EmailBracketCursorPagination,
+            model: Telnyx::EmailInboxes::InboundThread,
             options: options
           )
         end

data/lib/telnyx/resources/email_inboxes.rb

@@ -85,7 +85,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailInboxListResponse]
+      # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::EmailInbox>]
       #
       # @see Telnyx::Models::EmailInboxListParams
       def list(params = {})
@@ -95,7 +95,8 @@ module Telnyx
           method: :get,
           path: "email_inboxes",
           query: query,
-          model: Telnyx::Models::EmailInboxListResponse,
+          page: Telnyx::Internal::EmailCursorPagination,
+          model: Telnyx::EmailInbox,
           options: options
         )
       end

data/lib/telnyx/resources/email_messages/recipients.rb

@@ -57,7 +57,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::EmailMessages::RecipientListResponse]
+        # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::EmailMessages::EmailRecipient>]
         #
         # @see Telnyx::Models::EmailMessages::RecipientListParams
         def list(email_id, params = {})
@@ -67,7 +67,8 @@ module Telnyx
             method: :get,
             path: ["email_messages/%1$s/recipients", email_id],
             query: query,
-            model: Telnyx::Models::EmailMessages::RecipientListResponse,
+            page: Telnyx::Internal::EmailCursorPagination,
+            model: Telnyx::EmailMessages::EmailRecipient,
             options: options
           )
         end

data/lib/telnyx/resources/email_messages.rb

@@ -130,7 +130,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailMessageListResponse]
+      # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::EmailInboxes::EmailMessage>]
       #
       # @see Telnyx::Models::EmailMessageListParams
       def list(params = {})
@@ -140,7 +140,8 @@ module Telnyx
           method: :get,
           path: "email_messages",
           query: query,
-          model: Telnyx::Models::EmailMessageListResponse,
+          page: Telnyx::Internal::EmailCursorPagination,
+          model: Telnyx::EmailInboxes::EmailMessage,
           options: options
         )
       end
@@ -267,7 +268,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailMessageRetrieveEventsResponse]
+      # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::MessageEvent>]
       #
       # @see Telnyx::Models::EmailMessageRetrieveEventsParams
       def retrieve_events(email_id, params = {})
@@ -277,7 +278,8 @@ module Telnyx
           method: :get,
           path: ["email_messages/%1$s/events", email_id],
           query: query,
-          model: Telnyx::Models::EmailMessageRetrieveEventsResponse,
+          page: Telnyx::Internal::EmailCursorPagination,
+          model: Telnyx::MessageEvent,
           options: options
         )
       end

data/lib/telnyx/resources/email_templates.rb

@@ -62,7 +62,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.
       #
       # @overload update(id, html_body: nil, name: nil, subject: nil, text_body: nil, variables: nil, request_options: {})
       #
@@ -107,7 +108,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailTemplateListResponse]
+      # @return [Telnyx::Internal::EmailCursorPagination<Telnyx::Models::EmailTemplate>]
       #
       # @see Telnyx::Models::EmailTemplateListParams
       def list(params = {})
@@ -117,7 +118,8 @@ module Telnyx
           method: :get,
           path: "email_templates",
           query: query,
-          model: Telnyx::Models::EmailTemplateListResponse,
+          page: Telnyx::Internal::EmailCursorPagination,
+          model: Telnyx::EmailTemplate,
           options: options
         )
       end

data/lib/telnyx/resources/email_threads.rb

@@ -60,7 +60,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::EmailInboxes::InboundThreadListResponse]
+      # @return [Telnyx::Internal::EmailBracketCursorPagination<Telnyx::Models::EmailInboxes::InboundThread>]
       #
       # @see Telnyx::Models::EmailThreadListParams
       def list(params = {})
@@ -75,7 +75,8 @@ module Telnyx
             page_after: "page[after]",
             page_size: "page[size]"
           ),
-          model: Telnyx::EmailInboxes::InboundThreadListResponse,
+          page: Telnyx::Internal::EmailBracketCursorPagination,
+          model: Telnyx::EmailInboxes::InboundThread,
           options: options
         )
       end

data/lib/telnyx/resources/email_unsubscribe_groups.rb

@@ -121,7 +121,7 @@ module Telnyx
       #
       # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
       #
-      # @param force [Symbol, Boolean, Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force] Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+      # @param force [Symbol, Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force::ForceString, Boolean] Force-delete a group with active suppressions. Only `"true"` (string) or `true`
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/enterprises.rb

@@ -32,7 +32,7 @@ module Telnyx
       #
       # @overload create(billing_address:, billing_contact:, country_code:, doing_business_as:, fein:, industry:, jurisdiction_of_incorporation:, legal_name:, number_of_employees:, organization_contact:, organization_legal_type:, organization_physical_address:, organization_type:, website:, corporate_registration_number: nil, customer_reference: nil, dun_bradstreet_number: nil, primary_business_domain_sic_code: nil, professional_license_number: nil, role_type: nil, request_options: {})
       #
-      # @param billing_address [Telnyx::Models::BillingAddress]
+      # @param billing_address [Telnyx::Models::PhysicalAddress]
       #
       # @param billing_contact [Telnyx::Models::BillingContact]
       #
@@ -119,7 +119,7 @@ module Telnyx
       #
       # @param enterprise_id [String] The enterprise id. Lowercase UUID.
       #
-      # @param billing_address [Telnyx::Models::BillingAddress]
+      # @param billing_address [Telnyx::Models::PhysicalAddress]
       #
       # @param billing_contact [Telnyx::Models::BillingContact]
       #

data/lib/telnyx/resources/faxes.rb

@@ -83,7 +83,7 @@ module Telnyx
         )
       end
 
-      # Retrieve the details of a single fax.
+      # Returns the details of a single fax, including its current status.
       #
       # @overload retrieve(id, request_options: {})
       #

data/lib/telnyx/resources/fqdn_connections.rb

@@ -11,7 +11,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::FqdnConnectionCreateParams} for more details.
       #
-      # Creates a FQDN connection.
+      # Creates a new FQDN-based SIP connection. FQDN connections authenticate by your
+      # registered domain names rather than static IP addresses.
       #
       # @overload create(connection_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, microsoft_teams_sbc: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
@@ -206,7 +207,7 @@ module Telnyx
         )
       end
 
-      # Deletes an FQDN connection.
+      # Permanently deletes the specified FQDN connection from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/fqdns.rb

@@ -7,7 +7,7 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::FqdnCreateParams} for more details.
       #
-      # Create a new FQDN object.
+      # Creates a new FQDN record and attaches it to the specified connection.
       #
       # @overload create(connection_id:, dns_record_type:, fqdn:, port: nil, request_options: {})
       #
@@ -58,7 +58,7 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::FqdnUpdateParams} for more details.
       #
-      # Update the details of a specific FQDN.
+      # Updates the details of the specified FQDN record and returns the updated FQDN.
       #
       # @overload update(id, connection_id: nil, dns_record_type: nil, fqdn: nil, port: nil, request_options: {})
       #
@@ -120,7 +120,7 @@ module Telnyx
         )
       end
 
-      # Delete an FQDN.
+      # Permanently deletes the specified FQDN record from its connection.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/global_ip_allowed_ports.rb

@@ -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.
       #
       # @overload list(request_options: {})
       #

data/lib/telnyx/resources/global_ip_assignments.rb

@@ -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.
       #
       # @overload create(request_options: {})
       #
@@ -22,7 +24,8 @@ module Telnyx
         )
       end
 
-      # Retrieve a Global IP assignment.
+      # Returns the details of a single Global IP assignment, including the Global IP
+      # and WireGuard peer it links.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -42,7 +45,8 @@ module Telnyx
         )
       end
 
-      # Update a Global IP assignment.
+      # Updates the specified Global IP assignment with the provided fields and returns
+      # the updated assignment.
       #
       # @overload update(global_ip_assignment_id, global_ip_assignment_update_request:, request_options: {})
       #
@@ -66,7 +70,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.
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
@@ -90,7 +95,8 @@ module Telnyx
         )
       end
 
-      # Delete a Global IP assignment.
+      # Deletes the specified Global IP assignment, detaching the Global IP from its
+      # WireGuard peer.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/global_ip_health_check_types.rb

@@ -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.
       #
       # @overload list(request_options: {})
       #

data/lib/telnyx/resources/global_ip_health_checks.rb

@@ -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.
       #
       # @overload create(global_ip_id: nil, health_check_params: nil, health_check_type: nil, request_options: {})
       #
@@ -30,7 +32,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.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +53,8 @@ module Telnyx
         )
       end
 
-      # List all Global IP health checks.
+      # Returns a paginated list of the Global IP health checks configured on your
+      # account.
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
@@ -74,7 +78,8 @@ module Telnyx
         )
       end
 
-      # Delete a Global IP health check.
+      # Deletes the specified Global IP health check so it no longer monitors the Global
+      # IP's assignments.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/global_ip_protocols.rb

@@ -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.
       #
       # @overload list(request_options: {})
       #

data/lib/telnyx/resources/global_ips.rb

@@ -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.
       #
       # @overload create(description: nil, name: nil, ports: nil, request_options: {})
       #
@@ -30,7 +32,8 @@ module Telnyx
         )
       end
 
-      # Retrieve a Global IP.
+      # Returns the details of a single Global IP, including its address and current
+      # configuration.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +53,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.
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
@@ -74,7 +78,7 @@ module Telnyx
         )
       end
 
-      # Delete a Global IP.
+      # Deletes the specified Global IP and releases its address back to Telnyx.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/invoices.rb

@@ -28,7 +28,7 @@ module Telnyx
         )
       end
 
-      # Retrieve a paginated list of invoices.
+      # Returns a paginated list of your invoices, with support for sorting.
       #
       # @overload list(page_number: nil, page_size: nil, sort: nil, request_options: {})
       #