telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/dir_update_params.rb

@@ -26,6 +26,17 @@ module Telnyx
       #   @return [String, nil]
       optional :authorizer_name, String
 
+      # @!attribute bpo_authorizations
+      #   Optional. Replace this DIR's authorized BPO (Business Process Outsourcer)
+      #   accounts with these, each with its signed Letter of Authorization. The supplied
+      #   list replaces the current one: a BPO left out has its authorization removed, and
+      #   a new BPO (or a changed Letter of Authorization) is created `pending` admin
+      #   review. Send an empty list to clear all authorizations; omit the field to leave
+      #   them unchanged. Editing this list does not re-vet the DIR. Maximum 10.
+      #
+      #   @return [Array<Telnyx::Models::BpoAuthorizationInput>, nil]
+      optional :bpo_authorizations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::BpoAuthorizationInput] }
+
       # @!attribute call_reasons
       #   1–10 reasons your business calls customers. Validate phrasing against
       #   `POST /call_reasons/validate`.
@@ -82,7 +93,15 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :reselling, Telnyx::Internal::Type::Boolean
 
-      # @!method initialize(dir_id:, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, display_name: nil, documents: nil, logo_url: nil, reselling: nil, request_options: {})
+      # @!attribute webhook_url
+      #   Optional `https://` URL that receives webhook notifications when this DIR's
+      #   compliance review completes. Send `null` to clear. Changing only this field on a
+      #   `verified` DIR does not re-vet it. Maximum 2048 characters.
+      #
+      #   @return [String, nil]
+      optional :webhook_url, String, nil?: true
+
+      # @!method initialize(dir_id:, authorizer_email: nil, authorizer_name: nil, bpo_authorizations: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, display_name: nil, documents: nil, logo_url: nil, reselling: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::DirUpdateParams} for more details.
       #
@@ -92,6 +111,8 @@ module Telnyx
       #
       #   @param authorizer_name [String] Name of the person at your enterprise authorizing this DIR. Must be a real indiv
       #
+      #   @param bpo_authorizations [Array<Telnyx::Models::BpoAuthorizationInput>] Optional. Replace this DIR's authorized BPO (Business Process Outsourcer) accoun
+      #
       #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
       #
       #   @param certify_brand_is_accurate [Boolean] Certification that the DIR information is accurate. Must be `true` for the DIR t
@@ -108,6 +129,8 @@ module Telnyx
       #
       #   @param reselling [Boolean] Set to true if your organization places calls on behalf of other enterprises (BP
       #
+      #   @param webhook_url [String, nil] Optional `https://` URL that receives webhook notifications when this DIR's comp
+      #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/telnyx/models/doc_reqs_requirement.rb

@@ -133,7 +133,10 @@ module Telnyx
         extend Telnyx::Internal::Type::Enum
 
         LOCAL = :local
+        MOBILE = :mobile
+        MULTIPURPOSE = :multipurpose
         NATIONAL = :national
+        SHARED_COST = :shared_cost
         TOLL_FREE = :toll_free
 
         # @!method self.values

data/lib/telnyx/models/document.rb

@@ -19,6 +19,7 @@ module Telnyx
       required :document_type, enum: -> { Telnyx::Document::DocumentType }
 
       # @!attribute description
+      #   An optional note describing this document, for example what it proves.
       #
       #   @return [String, nil]
       optional :description, String
@@ -31,7 +32,7 @@ module Telnyx
       #
       #   @param document_type [Symbol, Telnyx::Models::Document::DocumentType] Type of supporting document. Pick the closest match to what the file actually co
       #
-      #   @param description [String]
+      #   @param description [String] An optional note describing this document, for example what it proves.
 
       # Type of supporting document. Pick the closest match to what the file actually
       # contains; `other` triggers manual vetting and may slow approval. The matching

data/lib/telnyx/models/email_block.rb

@@ -59,6 +59,10 @@ module Telnyx
       optional :domain_id, String, nil?: true
 
       # @!attribute expires_at
+      #   Optional expiration time. An active row stops matching send-time suppression
+      #   checks as soon as `expires_at <= now()`. A maintenance worker later transitions
+      #   the row to `status: expired` and appends an `expired` audit event (normally
+      #   within 15 minutes).
       #
       #   @return [Time, nil]
       optional :expires_at, Time, nil?: true
@@ -76,6 +80,9 @@ module Telnyx
       optional :group_id, String, nil?: true
 
       # @!method initialize(id:, created_at:, reason:, record_type:, scope:, source:, status:, to:, updated_at:, domain_id: nil, expires_at: nil, from: nil, group_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailBlock} for more details.
+      #
       #   Suppression record. Schema fields hidden by the view: `account_id`,
       #   `bounce_category`, `dsn_code`, `meta`.
       #
@@ -99,7 +106,7 @@ module Telnyx
       #
       #   @param domain_id [String, nil] `null` ⇒ account scope. Stored on the row; exposed here.
       #
-      #   @param expires_at [Time, nil]
+      #   @param expires_at [Time, nil] Optional expiration time. An active row stops matching
       #
       #   @param from [String, nil] `null` ⇒ not address-scope. (schema: from_address)
       #

data/lib/telnyx/models/email_blocks/email_block_import.rb

@@ -49,7 +49,9 @@ module Telnyx
         optional :created_count, Integer
 
         # @!attribute error_count
-        #   Only when `status == completed`.
+        #   Rows that passed CSV parsing but failed suppression creation. This is the
+        #   creation-failure subset of `skipped_count`; parser-rejected rows equal
+        #   `skipped_count - error_count`. Only when `status == completed`.
         #
         #   @return [Integer, nil]
         optional :error_count, Integer
@@ -91,6 +93,9 @@ module Telnyx
         optional :skipped_count, Integer
 
         # @!method initialize(id:, created_at:, record_type:, status:, total:, updated_at:, completed_at: nil, created_count: nil, error_count: nil, errors: nil, existing_count: nil, failure_reason: nil, processed_rows: nil, provider: nil, skipped_count: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailBlocks::EmailBlockImport} for more details.
+        #
         #   Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
         #   Nullable fields use the omit-nullable pattern.
         #
@@ -110,7 +115,7 @@ module Telnyx
         #
         #   @param created_count [Integer] Only when `status == completed`.
         #
-        #   @param error_count [Integer] Only when `status == completed`.
+        #   @param error_count [Integer] Rows that passed CSV parsing but failed suppression creation.
         #
         #   @param errors [Hash{Symbol=>String}] `{row_number: reason}`; only rendered when non-empty.
         #

data/lib/telnyx/models/email_domain_rotate_dkim_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#rotate_dkim
+    class EmailDomainRotateDkimParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute domain_id
+      #
+      #   @return [String]
+      required :domain_id, String
+
+      # @!method initialize(domain_id:, request_options: {})
+      #   @param domain_id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_rotate_dkim_response.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#rotate_dkim
+    class EmailDomainRotateDkimResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   Result of rotating a domain's DKIM key. The new key is active and signing
+      #   switches to it immediately; the previous key is retired to a `retiring` state
+      #   (retained, not revoked) so it can be revoked after the DNS propagation grace
+      #   period. Selectors are fixed, so the DKIM DNS record's TXT value is replaced in
+      #   place at the shared `<selector>._domainkey.<domain>` host —
+      #   `old_selector_retained` is false and the returned dns_records carry the new
+      #   value the customer must publish promptly.
+      #
+      #   @return [Telnyx::Models::EmailDomainRotateDkimResponse::Data]
+      required :data, -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data }
+
+      # @!method initialize(data:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailDomainRotateDkimResponse} for more details.
+      #
+      #   @param data [Telnyx::Models::EmailDomainRotateDkimResponse::Data] Result of rotating a domain's DKIM key. The new key is active and signing switch
+
+      # @see Telnyx::Models::EmailDomainRotateDkimResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute dkim
+        #   The new active DKIM key.
+        #
+        #   @return [Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim]
+        required :dkim, -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim }
+
+        # @!attribute dns_records
+        #   The DKIM DNS records the customer must publish, carrying the new key's TXT value
+        #   with verification reset to pending.
+        #
+        #   @return [Array<Telnyx::Models::DNSRecord>]
+        required :dns_records, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DNSRecord] }
+
+        # @!attribute domain
+        #
+        #   @return [String]
+        required :domain, String
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute old_selector_retained
+        #   False for this service: one selector is fixed per domain, so rotation replaces
+        #   the TXT value at the existing \_domainkey host. There is no dual-selector
+        #   overlap; publish the replacement TXT promptly because signing switches
+        #   immediately.
+        #
+        #   @return [Boolean]
+        required :old_selector_retained, Telnyx::Internal::Type::Boolean
+
+        # @!attribute previous_dkim_key
+        #   The retired previous key, or null when the domain had no active key before
+        #   rotation. Retained in a `retiring` state so it can be revoked after the DNS
+        #   propagation grace period.
+        #
+        #   @return [Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey, nil]
+        required :previous_dkim_key,
+                 -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey },
+                 nil?: true
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::RecordType]
+        required :record_type, enum: -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::RecordType }
+
+        # @!method initialize(dkim:, dns_records:, domain:, domain_id:, old_selector_retained:, previous_dkim_key:, record_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailDomainRotateDkimResponse::Data} for more details.
+        #
+        #   Result of rotating a domain's DKIM key. The new key is active and signing
+        #   switches to it immediately; the previous key is retired to a `retiring` state
+        #   (retained, not revoked) so it can be revoked after the DNS propagation grace
+        #   period. Selectors are fixed, so the DKIM DNS record's TXT value is replaced in
+        #   place at the shared `<selector>._domainkey.<domain>` host —
+        #   `old_selector_retained` is false and the returned dns_records carry the new
+        #   value the customer must publish promptly.
+        #
+        #   @param dkim [Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim] The new active DKIM key.
+        #
+        #   @param dns_records [Array<Telnyx::Models::DNSRecord>] The DKIM DNS records the customer must publish, carrying the new key's TXT value
+        #
+        #   @param domain [String]
+        #
+        #   @param domain_id [String]
+        #
+        #   @param old_selector_retained [Boolean] False for this service: one selector is fixed per domain, so rotation replaces t
+        #
+        #   @param previous_dkim_key [Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey, nil] The retired previous key, or null when the domain had no active key before rotat
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::RecordType]
+
+        # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data#dkim
+        class Dkim < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute algorithm
+          #
+          #   @return [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Algorithm]
+          required :algorithm, enum: -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Algorithm }
+
+          # @!attribute key_length
+          #
+          #   @return [Integer, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::KeyLength]
+          required :key_length, enum: -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::KeyLength }
+
+          # @!attribute selector
+          #
+          #   @return [String]
+          required :selector, String
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Status]
+          required :status, enum: -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Status }
+
+          # @!attribute version
+          #   Monotonically increasing per-domain key version.
+          #
+          #   @return [Integer]
+          required :version, Integer
+
+          # @!attribute activated_at
+          #
+          #   @return [Time, nil]
+          optional :activated_at, Time, nil?: true
+
+          # @!method initialize(id:, algorithm:, key_length:, selector:, status:, version:, activated_at: nil)
+          #   The new active DKIM key.
+          #
+          #   @param id [String]
+          #
+          #   @param algorithm [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Algorithm]
+          #
+          #   @param key_length [Integer, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::KeyLength]
+          #
+          #   @param selector [String]
+          #
+          #   @param status [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim::Status]
+          #
+          #   @param version [Integer] Monotonically increasing per-domain key version.
+          #
+          #   @param activated_at [Time, nil]
+
+          # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim#algorithm
+          module Algorithm
+            extend Telnyx::Internal::Type::Enum
+
+            RSA_SHA256 = :"rsa-sha256"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim#key_length
+          module KeyLength
+            extend Telnyx::Internal::Type::Enum
+
+            KEY_LENGTH_2048 = 2048
+
+            # @!method self.values
+            #   @return [Array<Integer>]
+          end
+
+          # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data::Dkim#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            ACTIVE = :active
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data#previous_dkim_key
+        class PreviousDkimKey < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute selector
+          #
+          #   @return [String]
+          required :selector, String
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey::Status]
+          required :status,
+                   enum: -> { Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey::Status }
+
+          # @!attribute version
+          #
+          #   @return [Integer]
+          required :version, Integer
+
+          # @!method initialize(id:, selector:, status:, version:)
+          #   The retired previous key, or null when the domain had no active key before
+          #   rotation. Retained in a `retiring` state so it can be revoked after the DNS
+          #   propagation grace period.
+          #
+          #   @param id [String]
+          #   @param selector [String]
+          #   @param status [Symbol, Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey::Status]
+          #   @param version [Integer]
+
+          # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data::PreviousDkimKey#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            RETIRING = :retiring
+            REVOKED = :revoked
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Telnyx::Models::EmailDomainRotateDkimResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_DOMAIN_DKIM_ROTATION = :email_domain_dkim_rotation
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/email_webhook_event.rb

@@ -3,9 +3,11 @@
 module Telnyx
   module Models
     module EmailDomains
-      # Event types a webhook may subscribe to. The union of email._ events (published
-      # by email-api) and email_domain._ lifecycle events (published by this service).
-      # An event not listed here can never be subscribed to and is silently dropped.
+      # Event types accepted by domain webhook subscriptions. Allowlists match the
+      # legacy event_type, not canonical_event_type. Of the 22 accepted types,
+      # email.sending is stored but intentionally not published. Cancellation,
+      # daily-limit failures, and system failures publish after commit when a matching
+      # domain webhook is configured.
       module EmailWebhookEvent
         extend Telnyx::Internal::Type::Enum
 
@@ -23,11 +25,14 @@ module Telnyx
         EMAIL_CLICKED = :"email.clicked"
         EMAIL_UNSUBSCRIBED = :"email.unsubscribed"
         EMAIL_RECEIVED = :"email.received"
+        EMAIL_CANCELLED = :"email.cancelled"
+        EMAIL_DAILY_LIMIT_EXCEEDED = :"email.daily_limit_exceeded"
         EMAIL_DOMAIN_CREATED = :"email_domain.created"
         EMAIL_DOMAIN_VERIFIED = :"email_domain.verified"
         EMAIL_DOMAIN_DEGRADED = :"email_domain.degraded"
         EMAIL_DOMAIN_SUSPENDED = :"email_domain.suspended"
         EMAIL_DOMAIN_DELETED = :"email_domain.deleted"
+        EMAIL_DOMAIN_DKIM_ROTATED = :"email_domain.dkim_rotated"
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/email_event_list_params.rb

@@ -19,6 +19,17 @@ module Telnyx
       #   parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
       #   no matches.
       #
+      #   Dual-name compatibility: values are accepted bare or `email.`-prefixed. A legacy
+      #   value keeps matching the rows it matched pre-rename — no widening: `failed` also
+      #   matches the rows that now store the canonical names of the outcomes it covered
+      #   (`gw_reject`, `injection_timeout`, `expired`); `bounced` matches stored
+      #   `bounced` rows only (recipient-scoped Expirations stored `failed` pre-rename and
+      #   never matched `bounced`, so `expired` is deliberately not a `bounced`
+      #   expansion). A canonical value matches its own rows plus legacy rows whose
+      #   recorded payload evidence proves that outcome (`expired` also surfaces legacy
+      #   `bounced` rows with `bounce_category: transient`). The additive
+      #   `canonical_event_type` field in each response row names the canonical outcome.
+      #
       #   @return [String, Array<String>, nil]
       optional :event_type, union: -> { Telnyx::EmailEventListParams::EventType }
 
@@ -28,12 +39,6 @@ module Telnyx
       #   @return [Time, nil]
       optional :from, Time
 
-      # @!attribute page_cursor
-      #   Opaque URL-safe Base64 cursor returned by a previous list response.
-      #
-      #   @return [String, nil]
-      optional :page_cursor, String
-
       # @!attribute page_size
       #   Number of results to return. Defaults to 25; maximum is 100. Invalid values are
       #   clamped to the valid range.
@@ -41,6 +46,13 @@ module Telnyx
       #   @return [Integer, nil]
       optional :page_size, Integer
 
+      # @!attribute page_cursor
+      #   Opaque URL-safe Base64 cursor returned by a previous event list response. The
+      #   legacy `page[after]` and flat `page_cursor` forms are also accepted.
+      #
+      #   @return [String, nil]
+      optional :page_cursor, String
+
       # @!attribute to
       #   Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
       #   to `from + 30 days`.
@@ -48,20 +60,20 @@ module Telnyx
       #   @return [Time, nil]
       optional :to, Time
 
-      # @!method initialize(email_id: nil, event_type: nil, from: nil, page_cursor: nil, page_size: nil, to: nil, request_options: {})
+      # @!method initialize(email_id: nil, event_type: nil, from: nil, page_size: nil, page_cursor: nil, to: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::EmailEventListParams} for more details.
       #
       #   @param email_id [String] Filter events for a specific email message UUID. Invalid UUID values are silentl
       #
-      #   @param event_type [String, Array<String>] Comma-separated list of event types to include. Also accepts repeated query para
+      #   @param event_type [String, Array<String>] Comma-separated list of event types to include. Also accepts repeated
       #
       #   @param from [Time] Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
       #
-      #   @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
-      #
       #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100. Invalid values are
       #
+      #   @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous event list response. The le
+      #
       #   @param to [Time] Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
@@ -69,6 +81,17 @@ module Telnyx
       # Comma-separated list of event types to include. Also accepts repeated query
       # parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
       # no matches.
+      #
+      # Dual-name compatibility: values are accepted bare or `email.`-prefixed. A legacy
+      # value keeps matching the rows it matched pre-rename — no widening: `failed` also
+      # matches the rows that now store the canonical names of the outcomes it covered
+      # (`gw_reject`, `injection_timeout`, `expired`); `bounced` matches stored
+      # `bounced` rows only (recipient-scoped Expirations stored `failed` pre-rename and
+      # never matched `bounced`, so `expired` is deliberately not a `bounced`
+      # expansion). A canonical value matches its own rows plus legacy rows whose
+      # recorded payload evidence proves that outcome (`expired` also surfaces legacy
+      # `bounced` rows with `bounce_category: transient`). The additive
+      # `canonical_event_type` field in each response row names the canonical outcome.
       module EventType
         extend Telnyx::Internal::Type::Union