telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/email_validations/batch_retrieve_response.rbi

@@ -0,0 +1,386 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailValidations
+      class BatchRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailValidations::BatchRetrieveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Shape returned by the GET endpoint. Does not include duplicates_removed.
+        sig do
+          returns(Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data)
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Shape returned by the GET endpoint. Does not include duplicates_removed.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig do
+            returns(
+              Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          sig do
+            returns(
+              Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          sig { returns(Integer) }
+          attr_accessor :total
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :completed_at
+
+          sig { params(completed_at: Time).void }
+          attr_writer :completed_at
+
+          # Map keyed by original email address. Present only when the batch is completed.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result
+                ]
+              )
+            )
+          end
+          attr_reader :results
+
+          sig do
+            params(
+              results:
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::OrHash
+                ]
+            ).void
+          end
+          attr_writer :results
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :webhook_url
+
+          sig { params(webhook_url: String).void }
+          attr_writer :webhook_url
+
+          # Shape returned by the GET endpoint. Does not include duplicates_removed.
+          sig do
+            params(
+              id: String,
+              record_type:
+                Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType::OrSymbol,
+              status:
+                Telnyx::EmailValidations::EmailValidationBatchStatus::OrSymbol,
+              total: Integer,
+              completed_at: Time,
+              results:
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::OrHash
+                ],
+              webhook_url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            record_type:,
+            status:,
+            total:,
+            completed_at: nil,
+            # Map keyed by original email address. Present only when the batch is completed.
+            results: nil,
+            webhook_url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                record_type:
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType::TaggedSymbol,
+                status:
+                  Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol,
+                total: Integer,
+                completed_at: Time,
+                results:
+                  T::Hash[
+                    Symbol,
+                    Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result
+                  ],
+                webhook_url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EMAIL_VALIDATION_BATCH =
+              T.let(
+                :email_validation_batch,
+                Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Result < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks
+              )
+            end
+            attr_reader :checks
+
+            sig do
+              params(
+                checks:
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::OrHash
+              ).void
+            end
+            attr_writer :checks
+
+            sig { returns(String) }
+            attr_accessor :email
+
+            sig { returns(Float) }
+            attr_accessor :risk_score
+
+            sig { returns(T::Boolean) }
+            attr_accessor :valid
+
+            # Suggested correction for typo. Omitted when nil.
+            sig { returns(T.nilable(String)) }
+            attr_reader :did_you_mean
+
+            sig { params(did_you_mean: String).void }
+            attr_writer :did_you_mean
+
+            sig do
+              params(
+                checks:
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::OrHash,
+                email: String,
+                risk_score: Float,
+                valid: T::Boolean,
+                did_you_mean: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              checks:,
+              email:,
+              risk_score:,
+              valid:,
+              # Suggested correction for typo. Omitted when nil.
+              did_you_mean: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  checks:
+                    Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks,
+                  email: String,
+                  risk_score: Float,
+                  valid: T::Boolean,
+                  did_you_mean: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Checks < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Telnyx::EmailValidationCheck) }
+              attr_reader :disposable
+
+              sig do
+                params(disposable: Telnyx::EmailValidationCheck::OrHash).void
+              end
+              attr_writer :disposable
+
+              sig { returns(Telnyx::EmailValidationCheck) }
+              attr_reader :mx
+
+              sig { params(mx: Telnyx::EmailValidationCheck::OrHash).void }
+              attr_writer :mx
+
+              sig { returns(Telnyx::EmailValidationCheck) }
+              attr_reader :role_based
+
+              sig do
+                params(role_based: Telnyx::EmailValidationCheck::OrHash).void
+              end
+              attr_writer :role_based
+
+              sig { returns(Telnyx::EmailValidationCheck) }
+              attr_reader :syntax
+
+              sig { params(syntax: Telnyx::EmailValidationCheck::OrHash).void }
+              attr_writer :syntax
+
+              sig do
+                returns(
+                  Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::Typo
+                )
+              end
+              attr_reader :typo
+
+              sig do
+                params(
+                  typo:
+                    Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::Typo::OrHash
+                ).void
+              end
+              attr_writer :typo
+
+              sig do
+                params(
+                  disposable: Telnyx::EmailValidationCheck::OrHash,
+                  mx: Telnyx::EmailValidationCheck::OrHash,
+                  role_based: Telnyx::EmailValidationCheck::OrHash,
+                  syntax: Telnyx::EmailValidationCheck::OrHash,
+                  typo:
+                    Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::Typo::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(disposable:, mx:, role_based:, syntax:, typo:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    disposable: Telnyx::EmailValidationCheck,
+                    mx: Telnyx::EmailValidationCheck,
+                    role_based: Telnyx::EmailValidationCheck,
+                    syntax: Telnyx::EmailValidationCheck,
+                    typo:
+                      Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::Typo
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Typo < Telnyx::Models::EmailValidationCheck
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result::Checks::Typo,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                # Suggested correction for common typos. Omitted when nil.
+                sig { returns(T.nilable(String)) }
+                attr_reader :suggestion
+
+                sig { params(suggestion: String).void }
+                attr_writer :suggestion
+
+                sig { params(suggestion: String).returns(T.attached_class) }
+                def self.new(
+                  # Suggested correction for common typos. Omitted when nil.
+                  suggestion: nil
+                )
+                end
+
+                sig { override.returns({ suggestion: String }) }
+                def to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_validations/email_validation_batch_status.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    EmailValidationBatchStatus = EmailValidations::EmailValidationBatchStatus
+
+    module EmailValidations
+      module EmailValidationBatchStatus
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailValidations::EmailValidationBatchStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+          )
+        PROCESSING =
+          T.let(
+            :processing,
+            Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :completed,
+            Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailValidations::EmailValidationBatchStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/fax.rbi

@@ -40,6 +40,27 @@ module Telnyx
       sig { params(direction: Telnyx::Fax::Direction::OrSymbol).void }
       attr_writer :direction
 
+      # Customer-facing failure reason for the fax. Present on every fax object (null
+      # when the fax has not failed). Mapped from the more granular
+      # `internal_failure_reason`. Common values include: `receiver_call_dropped`,
+      # `sender_call_dropped`, `sender_canceled`, `carrier_lost`, `service_unavailable`,
+      # `fax_signaling_error`, `receiver_communication_error`,
+      # `sender_communication_error`, `receiver_decline`,
+      # `receiver_recovery_on_timer_expire`, `receiver_no_response`,
+      # `receiver_invalid_number_format`, `receiver_no_answer`,
+      # `receiver_incompatible_destination`, `receiver_unallocated_number`,
+      # `destination_unreachable`, `user_busy`, `invalid_ecm_response_from_receiver`,
+      # `fax_initial_communication_timeout`, `destination_not_in_service_plan`,
+      # `account_disabled`, `destination_invalid`, `no_outbound_profile`,
+      # `destination_not_in_countries_whitelist`, `user_channel_limit_exceeded`,
+      # `outbound_profile_channel_limit_exceeded`, `connection_channel_limit_exceeded`,
+      # `outbound_profile_daily_spend_limit_exceeded`, `unverified_origination_number`,
+      # `unverified_destination_not_allowed`, `file_format_invalid`,
+      # `file_download_failed`, `file_size_limit_exceeded`, `page_count_limit_exceeded`,
+      # `media_processing_exception`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :failure_reason
+
       # The phone number, in E.164 format, the fax will be sent from.
       sig { returns(T.nilable(String)) }
       attr_reader :from
@@ -55,6 +76,12 @@ module Telnyx
       sig { params(from_display_name: String).void }
       attr_writer :from_display_name
 
+      # Internal, more granular failure reason for the fax. Present on every fax object
+      # (null when the fax has not failed). Useful for deeper debugging beyond the
+      # customer-facing `failure_reason`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :internal_failure_reason
+
       # The media_name used for the fax's media. Must point to a file previously
       # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
       # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
@@ -156,8 +183,10 @@ module Telnyx
           connection_id: String,
           created_at: Time,
           direction: Telnyx::Fax::Direction::OrSymbol,
+          failure_reason: T.nilable(String),
           from: String,
           from_display_name: String,
+          internal_failure_reason: T.nilable(String),
           media_name: String,
           media_url: String,
           preview_url: String,
@@ -183,11 +212,34 @@ module Telnyx
         created_at: nil,
         # The direction of the fax.
         direction: nil,
+        # Customer-facing failure reason for the fax. Present on every fax object (null
+        # when the fax has not failed). Mapped from the more granular
+        # `internal_failure_reason`. Common values include: `receiver_call_dropped`,
+        # `sender_call_dropped`, `sender_canceled`, `carrier_lost`, `service_unavailable`,
+        # `fax_signaling_error`, `receiver_communication_error`,
+        # `sender_communication_error`, `receiver_decline`,
+        # `receiver_recovery_on_timer_expire`, `receiver_no_response`,
+        # `receiver_invalid_number_format`, `receiver_no_answer`,
+        # `receiver_incompatible_destination`, `receiver_unallocated_number`,
+        # `destination_unreachable`, `user_busy`, `invalid_ecm_response_from_receiver`,
+        # `fax_initial_communication_timeout`, `destination_not_in_service_plan`,
+        # `account_disabled`, `destination_invalid`, `no_outbound_profile`,
+        # `destination_not_in_countries_whitelist`, `user_channel_limit_exceeded`,
+        # `outbound_profile_channel_limit_exceeded`, `connection_channel_limit_exceeded`,
+        # `outbound_profile_daily_spend_limit_exceeded`, `unverified_origination_number`,
+        # `unverified_destination_not_allowed`, `file_format_invalid`,
+        # `file_download_failed`, `file_size_limit_exceeded`, `page_count_limit_exceeded`,
+        # `media_processing_exception`.
+        failure_reason: nil,
         # The phone number, in E.164 format, the fax will be sent from.
         from: nil,
         # The string used as the caller id name (SIP From Display Name) presented to the
         # destination (`to` number).
         from_display_name: nil,
+        # Internal, more granular failure reason for the fax. Present on every fax object
+        # (null when the fax has not failed). Useful for deeper debugging beyond the
+        # customer-facing `failure_reason`.
+        internal_failure_reason: nil,
         # The media_name used for the fax's media. Must point to a file previously
         # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
         # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
@@ -233,8 +285,10 @@ module Telnyx
             connection_id: String,
             created_at: Time,
             direction: Telnyx::Fax::Direction::TaggedSymbol,
+            failure_reason: T.nilable(String),
             from: String,
             from_display_name: String,
+            internal_failure_reason: T.nilable(String),
             media_name: String,
             media_url: String,
             preview_url: String,

data/rbi/telnyx/models/fax_failed.rbi

@@ -186,22 +186,12 @@ module Telnyx
           end
           attr_writer :direction
 
-          # Cause of the sending failure
-          sig do
-            returns(
-              T.nilable(
-                Telnyx::FaxFailed::Data::Payload::FailureReason::TaggedSymbol
-              )
-            )
-          end
+          # Customer-facing cause of the fax failure. Mapped from the more granular
+          # `internal_failure_reason`.
+          sig { returns(T.nilable(String)) }
           attr_reader :failure_reason
 
-          sig do
-            params(
-              failure_reason:
-                Telnyx::FaxFailed::Data::Payload::FailureReason::OrSymbol
-            ).void
-          end
+          sig { params(failure_reason: String).void }
           attr_writer :failure_reason
 
           # Identifies the fax.
@@ -218,6 +208,14 @@ module Telnyx
           sig { params(from: String).void }
           attr_writer :from
 
+          # Internal, more granular cause of the fax failure. Useful for deeper debugging
+          # beyond the customer-facing `failure_reason`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :internal_failure_reason
+
+          sig { params(internal_failure_reason: String).void }
+          attr_writer :internal_failure_reason
+
           # The media_name used for the fax's media. Must point to a file previously
           # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
           # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
@@ -270,10 +268,10 @@ module Telnyx
               client_state: String,
               connection_id: String,
               direction: Telnyx::FaxFailed::Data::Payload::Direction::OrSymbol,
-              failure_reason:
-                Telnyx::FaxFailed::Data::Payload::FailureReason::OrSymbol,
+              failure_reason: String,
               fax_id: String,
               from: String,
+              internal_failure_reason: String,
               media_name: String,
               original_media_url: String,
               status: Telnyx::FaxFailed::Data::Payload::Status::OrSymbol,
@@ -288,12 +286,16 @@ module Telnyx
             connection_id: nil,
             # The direction of the fax.
             direction: nil,
-            # Cause of the sending failure
+            # Customer-facing cause of the fax failure. Mapped from the more granular
+            # `internal_failure_reason`.
             failure_reason: nil,
             # Identifies the fax.
             fax_id: nil,
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
+            # Internal, more granular cause of the fax failure. Useful for deeper debugging
+            # beyond the customer-facing `failure_reason`.
+            internal_failure_reason: nil,
             # The media_name used for the fax's media. Must point to a file previously
             # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
             # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
@@ -318,10 +320,10 @@ module Telnyx
                 connection_id: String,
                 direction:
                   Telnyx::FaxFailed::Data::Payload::Direction::TaggedSymbol,
-                failure_reason:
-                  Telnyx::FaxFailed::Data::Payload::FailureReason::TaggedSymbol,
+                failure_reason: String,
                 fax_id: String,
                 from: String,
+                internal_failure_reason: String,
                 media_name: String,
                 original_media_url: String,
                 status: Telnyx::FaxFailed::Data::Payload::Status::TaggedSymbol,
@@ -365,33 +367,6 @@ module Telnyx
             end
           end
 
-          # Cause of the sending failure
-          module FailureReason
-            extend Telnyx::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(Symbol, Telnyx::FaxFailed::Data::Payload::FailureReason)
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            REJECTED =
-              T.let(
-                :rejected,
-                Telnyx::FaxFailed::Data::Payload::FailureReason::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Telnyx::FaxFailed::Data::Payload::FailureReason::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
           # The status of the fax.
           module Status
             extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/group_list_meta.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class GroupListMeta < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::GroupListMeta, Telnyx::Internal::AnyHash) }
+
+      sig { returns(Integer) }
+      attr_accessor :page_number
+
+      sig { returns(Integer) }
+      attr_accessor :page_size
+
+      sig { returns(Integer) }
+      attr_accessor :total_pages
+
+      sig { returns(Integer) }
+      attr_accessor :total_results
+
+      # Group list `meta` (consistent with `GET /v2/email_blocks`).
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(page_number:, page_size:, total_pages:, total_results:)
+      end
+
+      sig do
+        override.returns(
+          {
+            page_number: Integer,
+            page_size: Integer,
+            total_pages: Integer,
+            total_results: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end